Atlan ᴮᴱᵀᴬ

The Atlan integration allows Sifflet to retrieve metadata from Atlan and enrich business context, helping teams create more relevant monitors and better understand the impact of data issues.

With this integration, users can:

  • Import metadata from Atlan into Sifflet
  • View Atlan metadata directly on asset pages
  • Use selected metadata as Data Catalog filters
  • Open assets directly in Atlan from Sifflet

What Does the Integration Support?

The integration currently supports importing the following metadata from Atlan:

  • Official descriptions
  • Terms
  • Tags
  • Owners
  • Custom metadata fields defined in Atlan

Setting Up the Connection

The Atlan integration is configured as a source in Sifflet using OAuth authentication.

Before configuring the integration, you must:

  • Have access to an Atlan instance
  • Create OAuth credentials in Atlan

You can follow the official Atlan documentation here: Atlan OAuth Documentation


1. Create a New Source in Sifflet

Go to:

  • Integration Settings
  • Click Create New Source
  • Select Atlan

2. Configure Your Atlan Credentials

Provide the following information:

  • Source name

  • Atlan tenant URL (example: https://your-company.atlan.com)

    • Create a credential

      1. Click New Credential in Sifflet
      2. Copy-paste the text below and replace it with the Client ID and Client Secret provided by Atlan
      {
        "client_id": "<clientId>",
        "client_secret": "<clientSecret>"
      }

      iii. Save the configuration

      Create credential UI

Final settings

These credentials allow Sifflet to securely authenticate and retrieve metadata from Atlan.


3. Select Metadata to Import

Once the connection is configured:

  1. Click Load Metadata
  2. Select which metadata categories should be synchronized into Sifflet
  3. Enable the metadata you want to use as Data Catalog filters

Save the configuration once your selection is complete.

Managing Metadata Filters

Administrators can control which metadata appears as filters in the Data Catalog.

To update available filters:

  1. Edit the Atlan source configuration
  2. Enable or disable the desired metadata
  3. Save the source
  4. Run synchronization again

Once synchronization is complete, the selected metadata will appear as filters in the Data Catalog.


4. Asset Mapping

Assets are mapped based on the Atlan connection associated with the corresponding Sifflet source. This ensures metadata retrieved from Atlan is correctly linked to the corresponding assets already present in Sifflet

  1. Click Load Assets
  2. Select the Atlan integration
  3. Match it with the corresponding Sifflet source
  4. Choose the synchronization frequency
  5. Click Test before saving to ensure the configuration is valid.
ℹ️

Source Refresh Frequency

Sifflet has a default refresh frequency for each source type to keep your metadata up-to-date. For Atlan is Daily refresh.

We strongly recommend keeping the default frequency. If you have specific needs, you can provide a custom cron expression in the "Schedule" field during source configuration.


How Metadata Appears in Sifflet

Metadata imported from Atlan is treated as external metadata. This works similarly to metadata retrieved from external systems such as Snowflake and BigQuery.

📘

Read-Only Metadata

Metadata synchronized from Atlan cannot be modified directly in Sifflet, as Atlan remains the source of truth. Any updates made in Atlan will be reflected in Sifflet after the next synchronization. To make changes, please update the metadata directly in Atlan.

Asset Views

Imported metadata is visible:

  • On asset detail pages
  • Within Data Catalog filters (depending on enabled metadata)

This allows teams to enrich asset discovery and observability workflows with additional business context.

Data Catalog Filters

Imported metadata can be used as filters in the Sifflet Data Catalog based on the metadata enabled during source configuration.

Open Assets in Atlan

An Open in Atlan button is available when an asset is linked to Atlan.


ℹ️

Exceptions

  • Descriptions are not available as Data Catalog filters.
  • Atlan tags are merged with existing Sifflet tags under the same Tags filter category. There is no separate Atlan Tags section.

Error Handling

If synchronization errors occur:

  • Errors are surfaced similarly to other Sifflet source errors
  • Administrators can review logs directly from the source configuration
📘

For Atlan sources, the synchronization run name displayed in Sifflet corresponds to the Atlan integration ID, not the Sifflet source name.