How to crawl Sigma

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 the top right of any screen in Atlan, navigate to +New and click New Workflow.
  2. From the Marketplace page, click Sigma Assets.
  3. In the right panel, click Setup Workflow.

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. Click the Test Authentication button to confirm connectivity to Sigma.
  6. 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.
    🚨 Careful! 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.)
πŸ’ͺ 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! πŸŽ‰

Related articles

Was this article helpful?
0 out of 0 found this helpful