Skip to main content

Connections and entities

Entities in a Semantic Model read data through authorised connections. Before importing an entity, verify that you have permissions on the connection and the model project.

Connection types​

Environment​

An Environment connection is set up and governed by the administrator. The editor displays only those compatible with the model roles and the user.

Manual​

A Manual connection can be created in the editor when the administrator has enabled this option.

Management allows you to:

  • assign a name;
  • choose the supported source type;
  • enter the required information in the protected form;
  • verify the connection;
  • update it;
  • revoke it;
  • delete it when it is no longer in use.

For Oracle, the form also requires you to choose whether the database name is a SID or a Service name.

Reserved values are not shown after saving. Do not include them in names, descriptions, or screenshots.

Import entities​

  1. Select Import entities.
  2. Choose the connection type.
  3. Select an authorised connection.
  4. Load the catalog.
  5. Search by schema, entity, field, or type.
  6. Select one or more tables or views.
  7. Select Import selected.

For each Sybot entity, initial fields are created and displayed in the Entities panel and the diagram.

The catalog shows all schemas containing readable tables or views, up to 500 entities per schema.

For SAP HANA, the catalog includes tables, views, and columns accessible to the connection user. Unauthorised objects are not shown; if an expected source is missing, request permission verification from the relevant administrator.

Entity properties​

By selecting an entity, you can configure:

  • technical name and label;
  • active status;
  • source;
  • fields;
  • calculated dimensions;
  • measures;
  • update behaviour for Import models;
  • header style in the diagram.

A field can be hidden from View users without being removed from the model.

Configure the source​

The Configure query command allows you to choose:

  • table;
  • view;
  • Query Builder;
  • read-only custom SQL.

The Query Builder supports a starting object, joins, conditions organised into groups, sorting, and row limits.

Custom SQL mode accepts only read queries. Use the editor controls and do not include reserved data in the query text.

Preview​

Two checks are available:

  • Preview configuration, before applying the source to the draft;
  • Preview entity, on the current model definition.

The Preview shows a limited sample and does not publish the model.

If it returns no data, check the connection, selected object, conditions, and authorisations. If a message with a diagnostic reference appears, report it to the administrator without adding credentials or source data.

Source changes​

When the Editor is opened, Sybot checks in the background whether the tables and views used directly by entities have changed. The check can detect:

  • added or removed columns;
  • data type changes;
  • deleted tables or views;
  • model configurations involved by the change.

The check does not automatically modify the model. If differences are found, a warning appears with the Details button.

In detail, changes are grouped by entity and also show the expected effects on relationships, formulas, calculated fields, measures, hierarchies, and incremental updates.

To align the draft:

  1. select Details;
  2. review all changes and impacts;
  3. select Update model;
  4. re-verify Preview entity and semantic query;
  5. save and publish a new version only after validation.

If a source is unreachable, Sybot does not consider its entities deleted and prevents alignment until the check is complete.

Query Builder or custom SQL-based entities are not automatically realigned, as the returned columns depend on the query configuration. Calendar tables remain managed by the model.