> For the complete documentation index, see [llms.txt](https://docs.telm.ai/telmai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.telm.ai/telmai/integrations/catalog-integration/atlan.md).

# Atlan Catalog

Sync your Atlan catalog into Telmai to discover datasets and choose what to monitor.

Connect Atlan as Telmai's catalog to bring Atlan's tables and their metadata into Telmai. Telmai reads the catalog to learn which datasets exist, then uses Atlan's context to recommend what to monitor first. You set it up in Telmai, in **Administration** > **Atlan**.

This page covers reading from Atlan. To show Telmai's data quality results on your Atlan assets, set up the Telmai workflow in Atlan; see [Data Quality in Atlan](/telmai/integrations/atlan-integration.md). You can use either one, or both.

## What Telmai reads

| Metadata                             | How Telmai uses it                                                                                             |
| ------------------------------------ | -------------------------------------------------------------------------------------------------------------- |
| Tables and views, with their columns | Lists them on the [Catalog tab](/telmai/integrations/catalog-integration.md#the-catalog-tab), ready to monitor |
| Glossary terms                       | Adds business definitions to recommended rules                                                                 |
| Tags                                 | Marks tables with PII and critical data elements                                                               |
| Owners                               | Shows each table's steward                                                                                     |
| Lineage                              | Shows each table's upstream and downstream tables                                                              |
| Data products                        | Lets you filter the Catalog tab by data product                                                                |

Telmai syncs tables from these Atlan connection types: **Snowflake**, **BigQuery**, **Databricks**, **Redshift**, **MS SQL Server** and **Trino**.

## Before you connect

1. In Atlan, create an OAuth client for Telmai in **Admin** > **API access** > **OAuth clients**, and note its client ID and secret. Atlan recommends an OAuth client for integrations. You can use an API token instead.
2. Give the client's persona:
   * **Read-only** metadata access to each connection you want to sync, and to the BI or orchestration connections that hold lineage.
   * **Read** on each glossary.

If the client can see no glossary, the connection still works, but Telmai reports that no glossary terms are visible.

## Connect Atlan

In Telmai, go to **Administration** and, under **Catalogs**, select **Atlan**.

| Field                      | Description                                                                                                       |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| Atlan tenant URL           | Your Atlan URL, starting with `https://`, for example `https://your-tenant.atlan.com`.                            |
| Authentication             | **OAuth client** (the default) or **API token**.                                                                  |
| OAuth client ID            | The client ID from Atlan. Shown only for **OAuth client**.                                                        |
| Client secret or API token | The OAuth client's secret, or the API token. Leave it blank when you change other settings to keep the saved one. |
| Sync Interval (hours)      | How often Telmai syncs metadata from Atlan, from 1 to 168 hours.                                                  |

Under **Connections to sync**, click **Load connections**, then pick the Atlan connections to sync, or check **All connections**. Each connection shows how many tables and views Telmai would read from it.

Click **Connect**. Telmai tests the settings before it saves them:

* the credentials are accepted;
* every connection you picked is visible to the client and is a supported type;
* the client can see at least one table or view.

After the first sync, the setting shows the result of the last sync, with a **View in Catalog** link. Click **Sync now** to sync at any time, and **Disconnect** to stop syncing.

{% hint style="info" %}
A tenant can connect one catalog at a time. If another catalog is connected, the Atlan setting says so and links to it; disconnect that one first. If **Atlan** isn't listed under **Catalogs**, contact Telmai support.
{% endhint %}

### Advanced settings

Under **Advanced settings**, click **Add setting** to change how Telmai reads Atlan. Leave them empty to use the defaults.

| Setting                   | Default         | Description                                                                                |
| ------------------------- | --------------- | ------------------------------------------------------------------------------------------ |
| `connections-exclude`     | None            | Atlan connections to skip, separated by commas.                                            |
| `schemas-exclude`         | None            | Regular expressions for schemas to skip, separated by commas.                              |
| `include-views`           | `true`          | Sync views as well as tables.                                                              |
| `verified-only`           | `false`         | Sync only assets certified as **Verified** in Atlan.                                       |
| `pii-tags`                | `PII`           | Atlan tags that mark a column as PII, separated by commas.                                 |
| `cde-tier1-tags`          | None            | Atlan tags that mark a table as a tier 1 critical data element.                            |
| `cde-tier2-tags`          | None            | Atlan tags that mark a table as a tier 2 critical data element.                            |
| `include-propagated-tags` | `true`          | Count tags that Atlan propagates from other assets, not only tags set on the asset itself. |
| `max-datasets`            | `100000`        | The most tables Telmai syncs, from 1 to 1,000,000.                                         |
| `lineage-mode`            | `process-sweep` | How Telmai reads lineage: `process-sweep`, `per-asset`, or `off` to skip lineage.          |

## Link sources and start monitoring

Open **Connections** from the side menu and choose the **Catalog** tab. It lists the Atlan connections as sources, and their tables.

1. In the sources panel, **Link** each source to an existing Telmai connection, or click **Create connection**. A new connection is prefilled with what Atlan knows, such as the Snowflake account or the server and port.
2. Start with the **Recommended** view. The **Why it's recommended** column explains each recommendation.
3. Click a table for its **Catalog details**, then **Create Asset & Monitor** to start monitoring it, or select several tables and click **Monitor N tables**.

See [The Catalog tab](/telmai/integrations/catalog-integration.md#the-catalog-tab) for everything on the tab.
