Crawl Sigma

✦TL;DR

Connect Atlan to Sigma, configure the crawler, and run it to catalog your Sigma assets

||

Your AI can read this via Docs MCPcurl -fsSL "https://docs.atlan.com/install-docs-mcp" | bashConnect

Once you have configured the Sigma permissions, you can establish a connection between Atlan and Sigma.

To crawl metadata from Sigma, review the order of operations and then complete the following steps.

Select the source

To select Sigma as your source:

1. In your Atlan workspace, click Connectors in the left sidebar.

   • If you are using the Old UI (Classic), click New Workflow in the top navigation.

2. Click Marketplace.

3. Search for Sigma Assets and select it.

4. Click Install.

5. Once installation completes, click Setup Workflow on the same tile.

Provide your credentials

To enter your Sigma credentials:

1. For Endpoint, from the dropdown, select your organization's cloud.

2. For Authentication, API Token is the default method.

3. For Client ID, enter the client ID associated with your API token.

4. For API Token, enter the API token that you created.

5. For Sigma admin API client, set the switch to match the owner of the API token. For the permissions each option needs, see Verify necessary permissions.

   • Keep the switch on (default) if the owner is a Sigma admin. Atlan crawls every workbook, dataset, and data model in your Sigma organization.
   • Turn off the switch if the owner isn't a Sigma admin. Atlan crawls only the assets that the owner can access, and data model lineage can be incomplete.
   warning

   If you turn off the switch on an existing credential, the next crawler run removes from Atlan the Sigma assets that the owner can't access.

6. Click the Test Authentication button to confirm connectivity to Sigma.

7. Once authentication is successful, navigate to the bottom of the screen and click Next.

Configure the connection

To complete the Sigma connection configuration:

1. Provide a Connection Name that represents your source environment. For example, you might use values like production,development,gold, or analytics.

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

   warning

   If you do not specify any user or group, no one will be able to manage the connection - not even admins.

3. Navigate to the bottom of the screen and click Next to proceed.

Configure the crawler

Before running the Sigma crawler, you can further configure it.

On the Metadata Filters page, you can override the defaults for any of these options:

• To select the Sigma workbooks you want to include in crawling, click Include Workbooks. (This will default to all workbooks, if none are specified.)
• To select the Sigma workbooks you want to exclude from crawling, click Exclude Workbooks. (This will default to no workbooks if none are specified.)
• To crawl only the workbooks that the owner of the API token can access, set Advanced Config to Custom and turn off Crawl all workbooks in the Sigma org. Atlan still crawls data models across the whole Sigma organization. This setting only takes effect when the Sigma admin API client switch is on, and turning it off removes the other workbooks from Atlan at the next crawler run.

Did you know?

If an asset appears in both the include and exclude filters, the exclude filter takes precedence.

Run the crawler

To run the Sigma crawler, after completing the steps above:

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, you will see the assets on Atlan's asset page! 🎉

See also

What does Atlan crawl from Sigma?: Learn about the Sigma assets and metadata that Atlan extracts.