Create and manage the semantic layer manually or with Collibra AI (in preview)

By creating a semantic layer you can later connect the physical layer with this semantic layer, making the information more meaningful and searchable. As a data steward, the Semantic Models page in the Stewardship application allows you to create the semantic layer step by step and manage it. Depending on the setup, you can create all assets manually or ask Collibra AI to provide suggestions.

Create a new data model

A Data Model asset in the semantic layer contains Data Entity and Data Attribute assets. You can group all in one data model or create various data models depending on your needs.

Prerequisites

Steps

  1. Create a Logical Data Dictionary domain.
    For information on how to create a domain, go to Create a domain.
    We recommend storing each Data Model in a dedicated domain.
  2. On the main toolbar, click Products iconStewardshipSemantic Layer.
    The Semantic Models page opens. This page shows all Data Model assets in your environment.
  3. Click Create model.
  4. Complete the fields as follows.

    Field

    Description

    Model nameEnter the name of the data model.

    If Collibra AI is enabled, it uses this name when making suggestions.

    Model description

    Enter the description of the data model.

    If Collibra AI is enabled, it uses this description when making suggestions.

    Owner

    Select the user who needs to be assigned as the owner of the Data Model asset.
    Target domainSelect the domain that you just created.
    Collibra creates the data model in this domain.
    SystemOptionally, select the System asset that you want to link the data model to. Collibra links the Data Model and System assets through "is implemented in System" relation.
  5. Click Create.
    The Data Model asset is created and becomes visible in the Semantic Models page. You can now add elements manually or, if enabled, use Collibra AI generated suggestions.

Manually create data entities and data attributes

You can add new data entities and data attributes to the Data Model yourself. If you do, the relations between the assets are automatically taken care of. New Data Entity assets are linked to the Data Model and new Data Attribute assets are linked to their corresponding Data Entity.

Prerequisites

Steps

  1. On the main toolbar, click Products iconStewardshipSemantic Layer.
    The Semantic Models page opens.
  2. Select the model to which you want to add entities and data attributes.
  3. Add an entity.
    1. Click + Add.
      The Add entity dialog box appears.
    2. Enter a name and a description for the entity.
    3. Click Add.
      The entity is saved as a Data Entity asset in the Data Model.
  4. Add an attribute.
    1. Select the data entity you created.
    2. In the Attributes pane, click +.
      The Add Data Attribute dialog box appears.
    3. Enter a name and a description for the attribute.
    4. Click Add.
      The attribute is saved as a Data Attribute asset in the Data Model.

Create entities and data attributes with help of Collibra AI

Collibra AI can help you create the semantic layer by providing data entity and data attribute suggestions. These suggestions are based on physical data and, optionally, business assets found within your Glossary domains. Once the suggestions are available, you can review them to build your model.

Important 
  • This feature isn't supported in Collibra Platform for Government or Collibra Platform Self-Hosted (CPSH) environments.
  • For information on how we leverage AI in our products, including how we handle data used for training and input, please visit the Collibra Trust Site.

Steps overview

  1. Check the prerequisites.
  2. Start the generation of suggestions.
  3. Review the generated data entity suggestions.
  4. Review the generated data attribute suggestions.

Prerequisites

  • The Semantic Model Generation setting has been enabled.
  • You have added physical data assets to your Collibra environment, such as Schema, Table, and Column assets.
  • Optionally, you have created business glossaries; these are business assets found within your Glossary domains.
  • Optionally, you have created KPIs and measures within your Report Catalog domains.
  • You have created a Data Model asset.
  • You have the required permissions.
  • Ensure that your environment uses the latest user interface.

Start the generation of suggestions

  1. On the main toolbar, click Products iconStewardshipSemantic Layer.
    The Semantic Models page opens.
  2. Select the data model to which you want to add data entities and data attributes.
    The first time you open the model to generate data entities and data attributes, the Generate entities and attributes button is available. If you already have data entities with data attributes, the Extend model button is shown instead.
  3. Click Generate entities and attributes or Extend model, respectively.
    A dialog box appears showing a wizard.
  4. Complete the wizard as follows:
    1. Select the input data through the Database and Schemas fields.
      The input data is the data that you want Collibra AI to reference when generating suggestions.
      You can select one database and up to 3 schemas in that database. In the next step, you are able to select specific tables from the selected schemas.
    2. Click Next.
      The Manage tables step appears showing all tables in the selected schemas.
    3. Refine your data selection by selecting the tables to be analyzed from the schemas you previously specified.
      • You can select up to 50 tables.
      • To select all tables, navigate through each page in the table and select all.
      • You can filter tables by Schema, Table name, and Status by hovering over the header and clicking the Search icon .
      • Tables with the Missing from Source status aren't shown.
    4. Click Next.
      The Select business data step appears.
    5. Optionally, in the Business terms field, select one or more domains.
      By providing business assets, Collibra AI has an idea of the conceptual layer and is able to provide better suggestions.
      • You can select from all domains that can contain the Business Term asset type. For information, go to Asset type assignments.
      • You can select up to 10 domains.
      • Collibra AI can process a maximum of 1,000 business terms, across all selected domains.
    6. Optionally, in the Measures field, select one or more domains.
      By providing measure or KPI assets, Collibra AI can map suggested data attributes to these assets.
      • You can select from all domains that can contain the Measure or KPI asset type. For information, go to Asset type assignments.
      • You can select up to 10 domains.
      • Collibra AI can process a maximum of 1,000 KPIs and measures, across all selected domains.
    7. Click Next.
    8. If the Add preference step appears, define if you want Collibra AI to update any existing non-approved suggestions, and click Next.
      This step appears only if you are extending the model.
      Switch the Allow editing of existing entity & attribute suggestions on if you want to allow Collibra AI to update non-approved suggestions.
      Approved entities and attributes will not get updated.
    9. In the Summary step, the completeness of the metadata for the selected tables is shown through the following metrics:
      • % of Table assets that have a description or description from source.
      • % of Column assets that have a description or description from source.
      • % of Column assets that have an assigned data class.
      • % of Business Terms assets that have a definition.
      • % of Measure (KPI) assets that have a definition.
      • % of Measure (KPI) assets that have a calculation rule.

      Higher percentages indicate more complete and accurate metadata, which increases the likelihood of more relevant and precise suggested entities and attributes. Fetching the metrics can take some time. It doesn't prevent you from proceeding. You can generate a model without a full summary.

  5. Click Generate.
    Collibra AI starts the generation process. Collibra AI checks the metadata of the selected tables. Then it creates suggestions for entities and attributes based on the analysis and provided information. Once finished, the suggestions are available for both the entities and attributes.
    Suggestions are indicated with the Collibra AI icon.

    A Ready for review tag shows that suggestions were created. Hover over the tag to see the date the suggestions were created. The date updates whenever Collibra AI creates new suggestions. The tag remains visible until all suggestions are approved or rejected.
    Image of the "Ready for review" tag

Review the generated data entity suggestions

For each suggested data entity, click the suggested data entity in the Entities list, validate the suggestion, and edit, approve, or reject it.

  • To edit the name or description of the entity:

    1. Double-click the name or the description in the details pane.
    2. Make your changes and click the Save icon.
    3. Approve the entity.
  • To approve an entity, click Approve entity.
    The suggested entity is saved as a Data Entity asset in the data model and the icon of the entity in the page changes.

  • To reject it, click Reject.
    The data entity, including the suggested data attributes for that data entity are rejected.

  • To request more suggestions, based on different data, click Extend model. If you do, you can define if you want to modify existing suggestions.

  • To discard all unapproved AI suggestions, click Discard all suggestions.

Review the generated data attribute suggestions

For each suggested data attribute available for an approved Data Entity, validate the suggestion, and edit, approve, or reject it.

To view the suggested attributes, select the Data Entity from the Entities list. Each page can show up to 20 attributes.

  • To edit an attribute name, double-click the name, make your changes, and click the Save icon.

  • To edit an attribute description, double-click the description, make your changes, and click the Update button.

  • If the suggested mapping of the attribute to a physical column is incorrect, click the x icon for the column in the Column cell.

  • To approve a single attribute, in the Actions column, click the Check icon.
    To approve multiple attributes at the same time, select the attributes on the page and click Approve above the table.
    As a result:

    • The suggested attribute is saved as a Data Attribute asset in the data model.
    • The icon of the attribute in the page changes
    • The "Data Attribute represents Column" relation is automatically added to the columns for which this data attribute was suggested, linking the physical layer with the semantic layer.
  • To reject a single attribute, in the Actions column, click the Reject icon.
    To reject multiple attributes at the same time, select the attributes on the page and click Reject above the table.
    If you select both suggested and approved attributes, and click Reject, only the suggested attributes are deleted.

  • To delete approved or suggested attributes, select the attributes on the page and click Delete above the table.
    If you select both suggested and approved attributes, and click Delete, all selected attributes are deleted.

Note 
  • You can't approve a data attribute if you haven't approved the data entity.
  • The Select all checkbox applies only to the attributes on the current page.

What's next

You can now map the physical layer and the created semantic layer. You can do this manually or by using the mapping automation.