> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dqlabs.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Connect Prizm to Atlan to push data quality metrics to assets, attributes, domains, and products and pull tags, domains, and products back into Prizm.

## What is the Atlan integration?

The Atlan integration creates a two-way connection between Prizm and the Atlan data catalog. Prizm pushes data quality metrics, alerts, and issues to Atlan, and pulls tags, domains, and products from Atlan into Prizm.

## What this integration enables

| Capability | Description |
| - | - |
| **Push asset and attribute quality data** | Pushes summary, alerts, issues, and measures to Atlan assets and attributes. |
| **Push domain and product quality data** | Pushes the same metrics to Atlan domains and data products. |
| **Automatic custom metadata** | Prizm creates the custom metadata fields it needs in Atlan during setup. |
| **Pull tags, domains, products, and terms** | Imports these from Atlan, and optionally asset and attribute descriptions. Pulled items appear on the semantics page with source type "Atlan". A filter lets you pull only certified terms and products. |
| **Scheduled sync** | Catalog sync jobs run on a schedule, with logs, restart, and stop controls. |

## Metrics pushed to Atlan

| Field | Description |
| - | - |
| **DQ Score** | Overall data quality score of the entity |
| **Total Rows** | Row count of the entity |
| **Freshness** | Recency of the data |
| **Active Rules** | Number of active data quality rules |
| **Scoring Rules** | Number of rules contributing to the score |
| **Duplicate Rows** | Number of duplicate rows found |
| **Alerts** | Number of alerts generated |
| **Issues** | Number of issues generated |
| **Prizm Alerts Url** | Link to the alerts page in Prizm |
| **Prizm Issues Url** | Link to the issues page in Prizm |
| **Prizm Metrics Url** | Link to the metrics page in Prizm |

For domains and products, these values appear under the Prizm custom metadata on the Atlan overview page.

## Authentication

Prizm connects to Atlan with an **API key** generated for a service account. Credentials can be fetched from a connected vault.

## Out of scope

* Editing Atlan assets directly from Prizm
* Running queries in Atlan
* Pushing standalone measure-level metrics

## Prerequisites

* An Atlan instance URL that Prizm can reach over HTTPS
* A valid, active Atlan API key for a service account with permission to read and edit assets, glossary terms, domains and products, and custom metadata, and to manage workflows
* A configured vault, if you want Prizm to fetch the API key from one
* Admin or privileged user access in Prizm

> [card] [Setup](https://docs.dqlabs.ai/integrations/atlan/setup.md)
>
> Connect Atlan to Prizm, configure push and pull, and schedule syncs.

> [card] [Alation integration](https://docs.dqlabs.ai/integrations/alation/overview.md)
>
> Another catalog integration with the same push and pull model.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.