Crawl Omni

||Connect docs via MCP

Extract metadata from your Omni workspace into Atlan to discover and catalog BI assets. After providing your Omni API key, you can crawl models, topics, folders, dashboards, and workbooks, and emit Process lineage from your warehouse tables through Omni topics to Omni documents. Review the order of operations and then complete the following steps.

Select the source

To select Omni as your source:

1. In the top navigation, click Marketplace.
2. Search for Omni and select it.
3. Click Install.
4. Once installation completes, click Setup Workflow on the same tile.

If you navigated away before installation completed, go to New > New Workflow and select Omni to proceed.

Provide credentials

Provide the Omni API key you generated when setting up Omni:

1. For Omni API base URL, enter your Omni base URL with the /api suffix and no trailing slash—for example https://your-org.omniapp.co/api.
2. For Authentication, API Key is the default and only selection.
3. For Omni API Token, paste the token you generated in Omni (format omni_osk_...). The field is masked.
4. Click the Test Authentication button to confirm connectivity to Omni using these details.
5. Once successful, at the bottom of the screen, click Next.

Token scope

The API key inherits the permissions of the Omni user that created it. A key created by a user without organization-wide read access passes Test Authentication but returns an incomplete catalog—only the models, topics, folders, and documents that user can see. If you observe missing assets after a crawl, re-check the key's source user. See setting up Omni for the recommended service-user approach.

Configure connection

To complete the Omni connection configuration:

1. For Connection Name, enter a name that uniquely identifies your Omni workspace within Atlan—for example omni-production or omni-prod. Atlan uses this to derive the Omni asset namespace; all Omni models, topics, folders, and documents from this run live under this connection.

2. (Optional) To change the users able to manage this connection, change the users or groups listed under Connection Admins.

   warning

   If you don't specify any user or group, nobody can manage the connection—not even admins.

3. At the bottom of the screen, click Next to proceed.

Configure crawler

Before running the crawler, you can tune the extraction settings. You can override the defaults for any of these options:

• For Page size, set the number of records to request per page from Omni's list endpoints. Larger pages reduce request count but use more memory per page. Defaults to 50.
• For Max concurrent requests, set the number of concurrent workers for per-model and per-document detail fetches. The connector's rate limiter still enforces Omni's per-minute cap regardless of this value. Defaults to 10.
• For Rate limit (requests/min), set the per-minute request cap. Lower it if your Omni organization has been provisioned a tighter API rate limit. Defaults to 60.

Configure warehouse lineage (optional)

To render end-to-end lineage from your warehouse tables through Omni topics and into Omni documents, populate the Atlan source-connection map field. This is a JSON object that maps each Omni connection ID to the qualified name of the corresponding upstream warehouse connection already cataloged in Atlan:

{
  "snow-prod-uuid": "default/snowflake/1234567890",
  "bq-staging-uuid": "default/bigquery/9876543210"
}

The connector uses this map to emit Process lineage from Table assets on the mapped warehouse connection into the Omni topics that project them. See warehouse sources supported for lineage for the databases where lineage currently resolves.

warning

The upstream warehouse connection (Snowflake, BigQuery, Redshift, Databricks, or another supported source) must already exist in Atlan and have been crawled at least once, so its Table assets are present when the Omni App runs. Leave the field empty to skip warehouse lineage—the Omni crawl still completes successfully; you simply won't see warehouse → Omni lineage in the graph.

Run the crawler

To run the Omni crawler, after completing the steps in this guide:

1. To check for any permissions or other configuration issues before running the crawler, click Preflight checks.
2. You can either:
   • To run the crawler once immediately, at the bottom of the screen, click the Run button.
   • To schedule the crawler to run hourly, daily, weekly, or monthly, at the bottom of the screen, click the Schedule Run button.

Once the crawler has completed running, your Omni assets are available under the Assets page and can be governed with terms, classifications, ownership, and custom metadata like any other Atlan asset! 🎉

What's next?

• Browse the Omni asset reference to understand which Omni properties land on which Atlan asset.
• If you hit a snag, see troubleshooting Omni connectivity.