Set up your Collibra environment for data products and data contracts

Before you start adding data products and data contracts, make sure your Collibra is set up to accommodate them.

  • Configure the required characteristics and widgets in the asset types.
  • Enable sampling, if needed.
  • Configure the data basket, if needed.

Configure the required characteristics and widgets

Data Product specific asset types show default attributes and relations. Make sure the following asset layout widgets are assigned the asset type layouts.

Prerequisites

You have a global role with the Product Rights > System administration global permission.

Steps

  1. On the main toolbar, click Products icon → Cogwheel icon Settings.
    The Settings page opens.
  2. Click the Operating model tab.
    Operating Model settings are shown.
  3. Make sure the Output port viewer widget is included in the Data Products asset type layout.
    The Output port viewer widget is crucial because it is where contract details will be available.
    1. On the Asset types tab, in the table, select the Data Product asset type.
      The asset type page opens.
    2. In the left pane, click the relevant assignment, and then click Characteristics.
      A table containing all the characteristic types assigned to the asset type is shown.
    3. Click Edit layout.
      The Edit layout page opens.
    4. In the layout editor, locate the Output ports viewer widget and drag it to the desired section on the asset page.
      • If needed, move the Output ports viewer widget to the required position using .
      • You can create a new section or modify an existing section's name to better fit the widget.
    5. In the Output ports viewer widget, click .
      The Settings dialog box appears.
      In the Widget card tab, you define the information that must always be shown for the output port in the Data Product asset page. In the Preview panel tab, you define the information that must be shown when a user clicks the output port card in the Data Product asset page.
    6. To update the card information:
      1. In the Widget card tab, from the Available attributes pane, drag the attributes you want to see to the Card attributes pane.
        You can choose any text attribute from the Data Product Port asset. You can include only one Text attribute.
        By default, the card shows the asset Title and Description, the Data Product Port status, and whether a Data Contract is available.
      2. Move the attributes to the required position using .
    7. To update the information shown in the Preview panel:
      1. Click the Preview panel tab.
      2. From the Available attributes pane, drag the attributes you want to see to the Text attributes pane. You can choose any attribute from the Data Product Port asset, the DQ Score, and the Data Product Port Status.
      3. Move the attributes to the required position using .
    8. Click Save.
    9. Click Publish.
      Your changes are published and applied to all the asset pages of the asset type.

      10. You can also include other asset layout widgets , such as Diagram and Data Categories.
      Diagram: Shows a diagram view that shows the data product and its related assets.
      Data Categories: Shows the data categories that are exposed in the data product. Data Categories can be shown based on the data classification of the columns related to the data product. For information, go to Automatically associating assets with Data Categories via Data Classification.

  4. Make sure the Data Contract Viewer widget is included in the Data Product Port asset type layout.
    1. On the Asset types tab, in the table, select the Data Product Port asset type.
      The asset type page opens.
    2. In the left pane, click the relevant assignment, and then click Characteristics.
      A table containing all the characteristic types assigned to the asset type is shown.
    3. Click Edit layout.
      The Edit layout page opens.
    4. In the layout editor, locate the Data Contract Viewer widget and drag it into the desired location.
    5. Click Save.
    6. Click Publish to apply the changes to the Data Product Port asset page layout.
      Any Data Product Port asset page now shows the data contract details.
  5. Make sure the version and manifest ID attributes are included in the Data Contract asset type layout.
    1. On the Asset types tab, in the table, select the Data Contract asset type.
      The asset type page opens.
    2. In the left pane, click the relevant assignment, and then click Characteristics.
      A table containing all the characteristic types assigned to the asset type is shown.
    3. Click Edit layout.
      The Edit layout page opens.
    4. Add the version and manifest ID attributes.
      1. In the layout editor, find or create the section where you want the version and manifest ID attributes to appear.
      2. Search for the version attribute and drag it into the desired location.
      3. Search for the manifest ID attribute and drag it into the desired location.
    5. Move the attributes to the required position using .
    6. Click Save.
    7. Click Publish.
      Any Data Contract asset page now immediately shows the current, active version and manifest ID of its associated manifest after initialization or an update.

Sample data for Data Products

To allow data consumers to get sample data for a table in a Data Product or Data Product Output asset, make sure the following are in place:

  • Sample data has been enabled and configured in your environment.
  • The selected table for the Data Product Port related to the Data Product is registered in Data Catalog and sample data is available for the table.
  • The user accessing the data product has the required permissions to view sample data.

Data Products in the data basket

To allow data consumers to add data products to their basket and request access to the data exposed through the data product, enable and configure the data basket.

What's next