Managing derived relation types (in preview)

This topic guides you through the derived relation type editor in the Operating Model settings to create, edit, and delete derived relation types (DRTs).

For comprehensive information about how to create a derived relation type, with practical examples and instructions for using the Relation type builder tab and the JSON tab, go to Building derived relation types (in preview).

Common prerequisites

• Your environment uses the latest user interface.
• You have a global role with the Product Rights > System administration global permission.
• The Derived relation support setting in Collibra Console is activated. If activated, the Add derived relation type button is shown on the Relation types page in the Operating Model settings.

Create a derived relation type

You can create a derived relation type if the out-of-the-box derived relation types don't meet your needs.

1. On the main toolbar, click → Settings.
   The Settings page opens.
2. In the Operating model section, click Relation types.
3. On the Relation types page, click Add derived relation type.
   
4. In the derived relation type editor, on the Details tab, enter the following information.

   Field	Description
   Role	The description of the relation type's meaning when originated from the head asset and directed toward the tail asset. A role represents the direction in a relationship between two assets. It describes how the head asset interacts with or is related to the tail asset. For example, in the relation type "Column is part of / contains Table", the role is is part of, which indicates the relationship from the perspective of the head asset (Column) toward the tail asset (Table).
   Co-role	The description of the relation type's meaning when originated from the tail asset and directed toward the head asset. A co-role represents the inverse direction in a relationship between two assets. It describes how the tail asset interacts with or is related to the head asset. For example, in the relation type "Column is part of / contains Table", the co-role is contains, which indicates the relationship from the perspective of the tail asset (Table) toward the head asset (Column).

5. On the Relation type builder tab, in the Head field, select the asset type of the assets that can be the head of the derived relation type.
   
6. In the Select relation field, define the relation path from head to tail by selecting the required relation type to the path.
   The tail asset type is automatically suggested in the Tail field.
   
7. To change the suggested tail, in the Tail field, select the asset type of the assets that can be the tail of the derived relation type.
8. Click Save relation type.
   The derived relation type is created. You can now assign it to an asset type.

Edit a derived relation type

You can edit a custom derived relation type. For information about what you can edit in an out-of-the-box derived relation type, go to Customizing an OOTB DRT.

1. On the main toolbar, click → Settings.
   The Settings page opens.
2. In the Operating model section, click Relation types.
3. On the Relation types page, in the Actions column of the derived relation type, click → Edit.
   Tip You can use the Kind column to filter the table by the relation kind Derived.
4. In the derived relation type editor, edit the derived relation type.
   
   Note Changing the public ID of a derived relation type can affect any existing integrations.
5. Click Save relation type.
   Your changes are saved.
   

Copy a derived relation type

You can create a new derived relation type by copying an existing one. Copying is useful when you want to define a similar relation type and only need to change certain properties, such as the role and co-role, without rebuilding the relation paths and filters from scratch.

You can start a copy from two places: the Relation types page or the derived relation type editor. At least one derived relation type must already exist in your operating model.

Copy from the Relation types page

1. On the main toolbar, click → Settings.
   The Settings page opens.
2. In the Operating model section, click Relation types.
3. Locate the derived relation type you want to copy. You can identify derived relation types by the value Derived in the Kind column.
   Tip Use the Kind column filter to show only derived relation types.
4. In the row of the derived relation type you want to copy, click to the right of the delete button, then click Make a copy.
   The derived relation type editor opens, pre-filled with the configuration of the original derived relation type. The Role and Co-role fields are empty.
5. Enter a Role and a Co-role for the new derived relation type. These values must form a unique combination with the head and tail asset types.
6. Review and, if needed, update any other settings, such as relation paths and filters.
7. Click Save relation type.
   The new derived relation type is created as a separate, independent derived relation type.

Copy from the derived relation type editor

Use this option when you are already viewing or editing a derived relation type and want to create a copy without navigating back to the list.

1. Open the derived relation type you want to copy in the editor.
2. In the top-right area of the editor, click to the left of the Cancel button, then click Make a copy.
   The editor reloads pre-filled with the configuration of the current derived relation type. The Role and Co-role fields are empty.
3. Enter a Role and a Co-role for the new derived relation type. These values must form a unique combination with the head and tail asset types.
4. Review and, if needed, update any other settings, such as relation paths and filters.
5. Click Save relation type.
   The new derived relation type is created as a separate, independent derived relation type.

The copied derived relation type is independent of the original: changes to either derived relation type do not affect each other. The new derived relation type appears on the Relation types page and can be edited, tested, or deleted like any other derived relation type.

Delete a derived relation type

You can delete a custom derived relation type only if it isn't used in another derived relation type. Out-of-the-box and system-managed derived relation types can't be deleted.

You can delete a derived relation type from two places: the Relation types page or the derived relation type editor.

Delete from the Relation types page

1. On the main toolbar, click → Settings.
   The Settings page opens.
2. In the Operating model section, click Relation types.
3. On the Relation types page, in the Actions column of the derived relation type, click .
   Tip You can use the Kind column to filter the table by the relation kind Derived.
4. In the Delete this derived relation type dialog box, click Delete.
   The derived relation type is deleted.
   

Delete from the derived relation type editor

Use this option when you are already viewing or editing a derived relation type and want to delete it without navigating back to the list.

1. Open the derived relation type you want to delete in the editor.
2. In the top-right area of the editor, click to the left of the Cancel button, then click Delete.
3. In the Delete this derived relation type dialog box, click Delete.
   The derived relation type is deleted.

Related topics

• Testing derived relation types (in preview)
• Deploying derived relation types (in preview)
• FAQ on derived relations (in preview)