Create custom relationships between resources (CTK)
In this tutorial we will create a custom relationship between two resources.
Why would I do this?
While the system provides default relationships between resources, there are cases where resources need to be linked in a way that is not predefined. Custom relationships allows you to create meaningful connections that better reflect dependencies between resources.
By defining these relationships, you can improve data discovery, governance, and reporting, ensuring that resources are logically structured and easier to navigate. For example, if Data products are not linked to Tables by default, you could establish a custom relationship such as:
Data product is composed of Tables
Tables are used by Data products
Create a relationship
Note
Perform this task in the Catalog Configuration organization.
To add a new custom relationship:
On the Organization profile page, go to the Overview tab or Resources tab. Click the New button and select Catalog resource.
On the Create a new resource page, in the Select type tab, select Relationship. Click the Continue to configure fields button.
The Relationship page opens.
In the Configure fields tab, set the following in the About section.
In the Title field, provide a name of the relationship you want to add.
Important
If you change the title of the relationship after it is in use in the destination organizations, you must setup the IRI override to maintain seamless object visibility and functionality across all systems.
From the Collections dropdown, select the Metadata profile collection.
In the Description field, provide a brief description of the relationship.
In the Configure fields tab, set the following in the More information section.
Source types: Select the source resource type for the relationship. Click Add to confirm.
Source collection types: Select the source collection type for the relationship. Click Add to confirm.
Source to target label: Provide the relationship field name to appear in the UI. For example, is composed of.
Source to target label - plural: Provide the plural form of the field name. For example, are composed of.
Target types: Select the target resource type for the relationship. Click Add to confirm.
Target collection types: Select the target collection type for the relationship. Click Add to confirm.
Target to source label: Provide the relationship field name to appear in the UI. For example, is used by. This field is required if you want to create a bi-directional relationship.
Target to source label - plural: Provide the plural for the bi-directional relationship between the two objects. For example, are used by.
Filter by this relationship in search - source-to-target only: This setting allows you to use the relationship as a filter on the search results page, exclusively for source-to-target relationship displays.
For a consistent user experience, we highly recommend you only select Filter by this relationship in search when the relationship also has a field specified in Related field - source types. Read more about the relationship as fields feature. Note: When paired with a field, the filter label will match the name of the field you see in Related field - source types (for example, Data Steward), otherwise, the filter label will be the Source to target label - Plural (the plural of the type specified as the Target type (for example, People).
Click Continue to review Relationship.
In the Review Relationship tab, check the configuration details for any possible errors before saving it. If adjustments are needed, click Back to edit the configuration.
Click Create Relationship. The creation page is closed and you are taken to your new Relationship page. You can return to this page anytime to edit configurations or add additional resource types to the relationship.
Publish the changes
See: Publishing changes.
View the results!
Note
Perform this task in the Catalog Sandbox organization.
In the Catalog Sandbox organization, find a resource where you added a new custom relationship.
On the Resource page, from the Three dot menu, select Edit relationships.
Or, browse to the Related tab. Here you can see all the related resources. From the Actions dropdown, select Edit relationships.
Verify that the new relationship type appears and that you can successfully link resources. Once added, the relationship should be displayed as configured, confirming that it has been successfully applied.
If you enabled bi-directional relationships, you will be able to relate the resources from both the resource pages.
Once you have made all changes, click the Save change button. Your updates will now be visible in the Related tab and Relationships preview section of the resource.