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

# Atlan

Learn how to integrate Atlan with Soda.

Integrate Soda with Atlan to access details about the quality of your data from within the data catalog.

* Run data quality checks using Soda and visualize quality metrics and rules within the context of a data source, dataset, or column in Atlan.
* Use Soda Cloud to flag poor-quality data in lineage diagrams.
* Give your Atlan users the confidence of knowing that the data they are using is sound.

***

When integrating Soda with Atlan, you can access Soda information directly in your Atlan dashboards and assets:

#### Check results overview

<figure><img src="https://1123167021-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FA2PmHkO5cBgeRPdiPPOG%2Fuploads%2F8dvWZMyED0Kn06wSbphL%2Fimage.png?alt=media&amp;token=90d8fe67-4cc3-41ed-90b6-78fdbc54540f" alt=""><figcaption><p>In asset overview, Atlan displays Soda check results overview (top right).</p></figcaption></figure>

#### Soda scan & checks details

<figure><img src="https://1123167021-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FA2PmHkO5cBgeRPdiPPOG%2Fuploads%2FQXP8J29VJa7Q4UPBmZxi%2Fimage.png?alt=media&amp;token=8f79d5ee-0229-4089-858e-44d7854ed714" alt=""><figcaption><p>Atlan displays a Soda icon on the vertical right menu. The panel shows Soda scan details, such as check results, last scan and sync time. From this screen, users can directly open the dataset in Soda Cloud (top right).</p></figcaption></figure>

#### Lineage + Soda check results

<figure><img src="https://1123167021-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FA2PmHkO5cBgeRPdiPPOG%2Fuploads%2FMnBncZwTKIx9mzGTeHh5%2Fimage.png?alt=media&amp;token=880a9b24-7496-4c9a-801c-da2b8f27889a" alt=""><figcaption><p>Lineage diagrams will display a Soda icon over integrated datasets, allowing to directly view Soda check results without leaving the Atlan Lineage page.</p></figcaption></figure>

## Prerequisites <a href="#prerequisites" id="prerequisites"></a>

* You have verified some contracts and published the results to Soda Cloud.
* You have an Atlan account with the privileges necessary to allow you to set up a Connection in your Atlan workspace.

## Set up the integration <a href="#set-up-the-integration" id="set-up-the-integration"></a>

You can integrate Atlan and Soda from your Atlan account.

{% stepper %}
{% step %}

#### Add a new workflow

On the main page, create a **New workflow**.

<figure><img src="https://1123167021-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FA2PmHkO5cBgeRPdiPPOG%2Fuploads%2FbN18zsqa5MnrfWqaKVR8%2Fimage.png?alt=media&amp;token=1688da4c-0afb-4e67-b73c-4e9985f8430c" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Select the Soda package

Creating a new workflow will redirect you to the **Marketplace** page. There, look for the **Soda package** and select it.

<figure><img src="https://1123167021-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FA2PmHkO5cBgeRPdiPPOG%2Fuploads%2FohG1omCqbOOf3hlWvW7q%2Fimage.png?alt=media&amp;token=c8b1c4a5-707b-4e3a-a2f3-b33d460f0b10" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Create a new connection

After selecting the Soda package, click on **Setup Workflow** to create a new connection between Atlan and Soda.

<figure><img src="https://1123167021-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FA2PmHkO5cBgeRPdiPPOG%2Fuploads%2FQRfL63jUp0av7RWtfqDM%2Fimage.png?alt=media&amp;token=522c58ba-cbb0-4def-8135-ad5a876fcaf5" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Enter connection details

Follow the instructions to [Broken mention](broken://pages/H6Piqnv5lUFCAv1Cvm75) in Soda Cloud to get your API keys.

<i class="fa-octagon-check">:octagon-check:</i> Test Authentication > Authentication successful > **Next** (bottom right)

<figure><img src="https://1123167021-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FA2PmHkO5cBgeRPdiPPOG%2Fuploads%2FaBUmmi06lRdPYdeEKrq9%2Fimage.png?alt=media&amp;token=082d059d-eb32-4603-af0d-4496dac57dab" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Name the connection and select admins

Enter a connection name and, optionally, add or remove connection admins. Click on **Next**.

<figure><img src="https://1123167021-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FA2PmHkO5cBgeRPdiPPOG%2Fuploads%2FjP0fOkFF5thMiu3Y2dXk%2Fimage.png?alt=media&amp;token=302e2aa5-b4b7-4239-8743-e0e8f329b437" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Advanced configuration

You can include or exclude **filters**, select **specific connections** for assets to which you want to map Soda checks, or run **preflight checks**.

> For more details on advanced configuration, visit [Atlan's documentation](https://docs.atlan.com/apps/connectors/observability/soda/how-tos/crawl-soda).

<figure><img src="https://1123167021-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FA2PmHkO5cBgeRPdiPPOG%2Fuploads%2FxoJcEFRav0HedoNgynuA%2Fimage.png?alt=media&amp;token=de4ab3d0-8bf6-49a3-b7cc-6ef0c348adc5" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Run the connection

**Run** the connection immediately or **Schedule & Run** to run periodically.
{% endstep %}

{% step %}

#### <i class="fa-octagon-check">:octagon-check:</i> Review the monitoring page

Once the workflow has run (you will be redirected if you choose to **Run** immediately), you will be able to see the status in the **Workflow center**.

<figure><img src="https://1123167021-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FA2PmHkO5cBgeRPdiPPOG%2Fuploads%2FV786gQV7sTVP2IHbQqpQ%2Fimage.png?alt=media&amp;token=bd2458ca-8d46-4b10-8a06-affe01a5e817" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

<br>

***

{% hint style="info" %}
You are **not logged in to Soda** and are viewing the default public documentation. Learn more about [Licensing & documentation access](/soda-documentation/reference/documentation-access-and-licensing.md).
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.soda.io/soda-documentation/integrations/atlan.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
