> 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/integrations/atlan.md).

# Atlan

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="/files/yu5amDkSVoPfMydAdIur" alt=""><figcaption><p>In asset overview, Atlan displays Soda check results overview (top right).</p></figcaption></figure>

#### Soda scan & checks details

<figure><img src="/files/B998TMrkk0zubp9wa5IA" 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="/files/Fm93tnHTLbPJpEsnBDiV" 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="/files/65KHcaNuHXFXMY6WE2Vr" 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="/files/7pPS8ilPaVzc4u31Za5a" 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="/files/MdZ8vCUgMlrP1SnMqAlA" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Enter connection details

Follow the instructions to [Generate API keys](/reference/soda-apis/generate-api-keys.md) 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="/files/aaldF5fwKMveLURc2fvm" 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="/files/0rBvU4dsdz4NzlbfTePy" 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="/files/bgEFnMvL4xmdI9baxTyN" 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="/files/e7RdgWScwVdvqjY6k0KD" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

***

{% if visitor.claims.plan === 'datasetStandard' %}
{% hint style="success" %}
You are **logged in to Soda** and seeing the **Dataset Standard license** documentation. Learn more about [Documentation access & licensing](/reference/documentation-access-and-licensing.md).
{% endhint %}
{% endif %}

{% if visitor.claims.plan === 'enterprise' %}
{% hint style="success" %}
You are **logged in to Soda** and seeing the **Team license** documentation. Learn more about [Documentation access & licensing](/reference/documentation-access-and-licensing.md).
{% endhint %}
{% endif %}

{% if visitor.claims.plan === 'enterpriseUserBased' %}
{% hint style="success" %}
You are **logged in to Soda** and seeing the **Enterprise license** documentation. Learn more about [Documentation access & licensing](/reference/documentation-access-and-licensing.md).
{% endhint %}
{% endif %}

{% if !(visitor.claims.plan === 'enterprise' || visitor.claims.plan === 'enterpriseUserBased' || visitor.claims.plan === 'datasetStandard') %}
{% hint style="info" %}
You are **not logged in to Soda** and are viewing the default public documentation. Learn more about [Documentation access & licensing](/reference/documentation-access-and-licensing.md).

If you do have a Soda license, make sure to **log in to Soda Cloud in this same browser**.
{% endhint %}
{% endif %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.