Metadata Rule - Developer Documentation
Skip to content

Metadata Rule

Metadata Rule is a set of predefined conditions that determines the metadata associated with a custom collection that applies for the Integrated Data Lake resources. A metadata collection rule is associated with two functions:

  • Rule key: The rule key is characterized as a metadata key with an enum data type in the global collection, facilitates the implementation of custom collection attributes in the system. By choosing a value for the rule key, users can activate specific keys in the custom collection to their unique requirements.

  • Custom collection attributes: Custom collection attributes are only accessible when a particular value for the rule key(Enum values) is selected. This selection ensures the availability of accurate metadata information for Integrated Data Lake resources.

Rules Status

Rules are created to trigger custom metadata collection and provide metadata for the keys defined within the collection. They are applicable only when the metadata collection is defined with a rule which should be in published status. Following are the rules scenarios:

Scenarios Create a collection Adding Keys to collection Keys in draft status Keys in published status Rule creation Result
Scenario 1 tick tick error tick tick Collection is created.
Scenario 2 tick error error error tick Collection is saved only in draft status as there are no keys added to it.
Scenario 3 tick tick tick error tick Collection is saved only in draft status as none of the keys are published.
Scenario 4 tick tick tick tick error Collection is saved only in draft status as rule is not created.
Scenario 5 tick error error error error Collection is saved only in draft status as keys are not published and rules are not created.

Last update: February 13, 2024