Configure business qualifier filtering for complex relation

You can configure business qualifier filtering for a complex relation.

Prerequisites

  • To edit a complex relation type, you need a global role that has the System administration global permission.
  • The Diagrams Business Qualifier Filter is enabled in Collibra Console.

Steps

Tip See the following example for detailed instruction on how to perform each step in this procedure.

  1. Edit the relevant complex relation type, for example, Field Mapping. Specifically, you need to add a relation leg pertaining to the Business Qualifier asset.
  2. If not already done, create the Business Qualifier asset that you will use to filter a diagram.
  3. Specify the Business Qualifier asset in the complex relation type.
  4. Add a relation between the relevant assets.
    Tip We are referring here to assets that are the head or tail of the complex relation type legs, for example, Column assets and the Business Qualifier asset.
  5. In the relevant diagram view, enable the Filtering by Business Qualifier option for both the Column asset node and the Field Mapping complex relation node.

In this example, we work with the commonly used Field Mapping complex relation type that comes out of the box with Collibra Platform. As the Field Mapping complex relation type is often used to track the flow of metadata from source column to target column, we also refer in this example to the Data Element asset type, which is a parent of the Column asset type. Lastly, the Field Mapping complex relation type is, by default, included the global role of the Data Element asset type.

  1. Start by editing the Field Mapping complex relation type. Specifically, you need to add a relation leg pertaining to a Business Qualifier asset:
    1. On the main toolbar, click Products icon → Cogwheel icon Settings.
      The Settings page opens.
    2. In the Operating Model section, click Complex relation types.
    3. In the table, find the Field Mapping row, and then click at the end of the row.
      The Edit Field Mapping dialog box appears.
    4. In the Relations section, click Add Relation.
    5. Enter the required information.
      • Role: We recommend entering the value is qualified by, but you can enter any text that suits your needs.
      • Asset Type: Business Qualifier.
      Tip Retain the default values in the remaining fields.
    6. Click Save.
  2. If no appropriate Business Qualifier asset exists, create one:
    1. On the main toolbar, click Plus icon.
      The Create dialog box appears.
    2. Click the Assets tab.
    3. In the list of asset types, click Business Qualifier.
      The Create Asset dialog box appears.
    4. Enter the required information.
      FieldDescription
      Asset type

      The asset type of the asset that you are creating: Business Qualifier

      Domain

      The domain to which the new assets will belong. You can create only an asset type in any domain of a domain type that is assigned to a selected asset type.

      Asset name

      The name of the new Business Qualifier asset: BQ1

    5. Click Create.
      A message stating that one or more assets are created appears.
  3. Specify the Business Qualifier asset in the complex relation type:
    1. Open one of the relevant leg assets, for example, a Column asset.
    2. Ensure that the Show empty values option is selected.
    3. In the Field Mapping section, hover your pointer over any asset, and then click .
      The Edit Field Mapping dialog box appears. Notice that the Is Qualified By relation leg is empty.
    4. In the Is Qualified By field, enter the Business Qualifier asset, for example, BQ1.
    5. Optional: In the Description field, enter a description of the Field Mapping complex relation.
    6. Click Save.
  4. Add a relation between a Column asset and the Business Qualifier asset:
    1. Open one of the relevant Column assets.
    2. Ensure that the Show empty values option is selected.
    3. Click the Is Qualified By field.
      The Business Qualified drop-down list box appears.
    4. Select the name of the Business Qualifier asset: BQ1
  5. In the relevant diagram view, enable the Filtering by Business Qualifier option for both the Column asset node and the Field Mapping complex relation node:
    1. Open a relevant Column asset page.
    2. Click the Diagram tab.
      The diagram is shown in the default diagram view.
    3. If needed, in the View field, select a different diagram view.
    4. Click .
      The General properties form appears.
    5. Select a node in the diagram.
      The Node properties form appears.
      Tip You need to follow Steps e-h for both the Column asset node and the Field Mapping complex relation node.
    6. In the Node properties form, go to the Filters section.
    7. Enable business qualifier filtering.
      Your Collibra versionAction
      2021.01Select the Filtering by business qualifier checkbox.
      2021.02 or newer

      In the Filtering by business qualifier drop-down list box, select Mandatory, so that the diagram will contain only the assets matching this view node that are qualified by the chosen business qualifier.

    8. Above the diagram, to the right, click Save.
    9. In the diagram toolbar, click the Business qualifier drop-down list, and then select BQ1.