How to add custom metadata badges

πŸ€“ Who can do this? You must be an admin user to be able to add badges for custom metadata.

Bringing visibility to custom metadata and enriching it with additional context are critical requirements for data teams. Atlan enables you to highlight the most critical custom metadata with badges.

Admin users can use badges to highlight custom metadata right in the asset overview, ensuring greater visibility. Custom metadata badges can help users quickly get the context they need for their data assets, for instance:

  • If an Airflow DAG was successful
  • If a table's data quality checks failed

Create custom metadata badges

🚨 Careful! Before creating a new badge, you'll need to have created at least one custom metadata structure.


To create a custom metadata badge:

  1. From the left menu of any screen, click Governance.
  2. Under the Metadata heading, click Badges.
  3. Under the Badges heading, click +Create new.
  4. In the Create new badge popover, add the following details:
    • For Custom Metadata property, select the property you want to create a badge for β€” in this example, we'll select Last Run Status for Airflow ETL Details as the property. 
    • For Name, add a name to your badge, such as Airflow Run Status.
    • (Optional) For Description, add a description.
  5. Click Create to create your badge.
  6. To add options to your custom metadata badge, click +New option.
  7. To define the options for your custom metadata badge, add the following details:
    • To set a matching condition for your values, select Equals (=) or Not Equals (!=).
    • For Enter value, enter a value β€” such as, Successful.
    • Click the grey box to choose a color for your badge.
    • (Optional) Click the eye icon to preview the badge. 
    • (Optional) Click +New option to add more options to your badge. 
  8. Click Save to save your badge options.

Your custom metadata badge is now live! πŸŽ‰

Add custom metadata badges to assets

Once you've created your custom metadata badges, you can add them to your assets. 

πŸ’ͺ Did you know? If you edit the custom metadata properties of an asset, the badges will appear automatically.


To add a custom metadata badge to an asset:

  1. From the left menu of any screen, click Assets
  2. On the Assets page, select an asset to add a badge.
  3. In the asset sidebar on the right, click the custom metadata tab β€” in this example, we'll select Airflow ETL Details.
  4. In the custom metadata panel in the sidebar, click Start editing.
  5. Enter the value(s) you want for the custom metadata properties on the asset and click Update.

The custom metadata badge will now be displayed in the asset profile and sidebar! πŸŽ‰

Related articles

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