Relationship based Asset Enrichment¶
The relationship based asset enrichment package allows to enrich the target assets in bulk based on the attributes associated with related assets. The package gives the flexibility to select which metadata to enrich with the user-specified values.
Warning
The package enriches only those target assets which have any related assets in the supported relationships provided as input.
Configuration¶
Authentication¶
- Atlan API Token: This is required to generate the dynamic dropdowns (see the Target Filters and Related Asset Filters section)
Attribute Enrichment¶
- User Description: Provide the description text to be updated on target assets.
- Certificate Status: Select the certificate status to be updated on target assets.
- Tags: Select the tags to be updated on target assets.
- Supported Relationships: Select the asset relationships based on which the target assets will be updated.
- Update Mode: Select the update mode
- Append: whether to append the provided metadata to the ones already defined in the target assets. This option is valid only for User Description, Tags and Custom Metadata.
- Replace: whether to fully replace the metadata of the target asset with the one provided as input.
- Update only if empty: whether to update the metadata only if the corresponding metadata on the target asset is not populated.
Custom Metadata Enrichment¶
This section allows to provide values for custom metadata enrichment. Each filter has a custom metadata selector (dropdown menu) and a value. NOTE: A single property must be selected for each custom metadata filter.
Target Filters¶
This section allows to apply filters for the target asset selection. Only the metadata of the assets selected by this set of filters will be enriched.
Each filterable attribute has an operator and a value. The operator is always a dropdown menu while the value can be either a dropdown or a free text field. The package considers the filter only if both the operator and the value are filled. The only exceptions are the operators “Is Empty” and “Is Not Empty” where the value is not required (and ignored if filled). The available filters are:
- Connector
- Connection
- Asset Type
- Name
- Certificate
- Qualified Name
- Tag
- Description
- Announcement
- Owner User
- Owner Group
Related Asset Filters¶
This section provides a set of filters to be applied on the assets under the indicated relationships (in Supported Relationships field). Only those target assets with qualifying relationship assets based on these filters will eventually be enriched.
Each filterable attribute has an operator and a value. The operator is always a dropdown menu while the value can be either a dropdown or a free text field. The package considers the filter only if both the operator and the value are filled. The only exceptions are the operators “Is Empty” and “Is Not Empty” where the value is not required (and ignored if filled). The available filters are:
- Connector
- Connection
- Asset Type
- Name
- Certificate
- Qualified Name
- Tag
- Description
- Announcement
- Owner User
- Owner Group
Warning
Process, BIProcess, ColumnProcess, DbtColumnProcess, DbtProcess assets are filtered out by default.
What it does¶
The package performs the following steps:
- Translate the Target Filters UI input into an IndexSearch query.
- Retrieve assets from Atlan.
- Filter down the retrieved assets further by running another IndexSearch query with the Related Asset Filters.
- The final target assets to be updated would be the ones retrieved after related asset search and matching the supported relationships.
- Enrich the final target assets metadata based on the enrichment configurations provided and update-mode selected.