How to manage custom metadata structures

Have more questions? Submit a request
πŸ€“ Who can do this? You must be an admin user to manage custom metadata structures, including defining new ones.

Before users or integrations can enrich assets with custom metadata, you must first define its structure.

Create custom metadata structure

To create a new custom metadata structure:

  1. From the left menu of any screen, click Governance.
  2. Under the Metadata heading, click Custom Metadata.
  3. Under the Custom Metadata heading, click the + button to add a new structure:
    1. For Name enter a name for the custom metadata structure. (In our examples, this would be IPR or ETL.)
    2. (Optional) To the left of the name click the image icon to select an emoji or upload an image for this custom metadata.
    3. (Optional) Add a description of the custom metadata below these.
    4. At the bottom right of the dialog, click the Create button.

Create properties in the structure

To create custom metadata properties within a custom metadata structure:

  1. From the left menu of any screen, click Governance.
  2. Under the Metadata heading, click Custom Metadata.
  3. Under the Custom Metadata heading, select the custom metadata structure you want to change.
  4. Click the New property button (no properties yet) or Add property button (to add more properties):
    1. For Name enter a name for one property. (In our examples, this would be one of License type, Provider, Job link, and so on.)
    2. For Type select the type of value you expect users to use for this property:
      • The String type allows free-form text values.
      • The Integer type allows only whole numbers (no decimals).
      • The Decimal type allows fractional numbers (those with decimal points).
      • The Boolean type allows only a Yes or a No value.
      • The Date type allows only calendar dates.
      • The Options type allows you to define your own set of predefined options for values that are valid.
      • The Users type allows only existing Atlan users as values.
      • The Groups type allows only existing Atlan groups as values.
      • The URL type allows only web links.
      • The SQL type allows only SQL code.
    3. (Optional) For Description enter an explanation for how you expect users to use this property.
    4. If you chose Options as the type, either:
      • Under Select Options select an existing set of options to reuse.
      • Click the Create New link to create a new set of options.
        1. Under Option name give the options a name.
        2. Under Values enter the list of values considered valid (separated by ;).
    5. (Optional) For Applicable asset types select the kinds of assets you want users to be able to enrich with this property. For example, you may want a property to only apply to SQL assets like tables and views, and not to BI assets.
    6. (Optional) Under Configurations toggle any extra settings for the property:
      • Allow multiple values controls whether users can enter more than a single value for this property. (Note: this is only available for some types.)
      • Show in filter controls whether users can filter on this property when doing asset discovery.
      • Show in overview controls whether the property will show up in the Overview sidebar tab of assets. (All properties will show in the custom metadata's own tab, but those with this Show in overview enabled will also show in the Overview tab.)

That's it, your users can now enrich assets with this custom metadata! πŸŽ‰

Delete properties from a structure

🚨 Careful! Deleting a custom metadata property will remove the values for that property from any assets.

To delete custom metadata properties from a custom metadata structure:

  1. From the left menu of any screen, click Governance.
  2. Under the Metadata heading, click Custom Metadata.
  3. Under the Custom Metadata heading, select the custom metadata structure you want to change.
  4. In the properties table on the right, click the vertical 3-dot menu on the far right of the row containing the property you want to delete.
  5. From the context menu, click Delete.
  6. When prompted for confirmation, click the Confirm button.

Delete custom metadata structure

You can also delete an entire custom metadata structure.

🚨 Careful! Deleting a custom metadata structure will remove all its properties and all its custom metadata values from any assets. You might want to consider using personas to hide the custom metadata, until you confirm it is no longer needed.

To delete a custom metadata structure:

  1. From the left menu of any screen, click Governance.
  2. Under the Metadata heading, click Custom Metadata.
  3. Under the Custom Metadata heading, select the custom metadata structure you want to delete.
  4. In the upper right of the custom metadata structure, click the red delete icon.
  5. When prompted for confirmation, click the Delete button.

Related articles

Was this article helpful?
1 out of 1 found this helpful