Preflight checks for Sigma
Before running the Sigma crawler, run preflight checks to perform necessary technical validations
Before running the Sigma crawler, you can run preflight checks to perform the necessary technical validations. The following preflight checks will be completed:
Workbook view permission
First, the list of workbooks in the Include Workbooks and Exclude Workbooks fields is determined. Next, the List Workbooks REST API is used to fetch the actual list of workbooks for which the user credentials have view permission.
✅ Check successful if all the workbooks from the first list are in the second one.
❌ Check failed for $missingWorkbookId workbook
Admin API access
This check appears as Admin Api Access in the preflight results. It verifies that the owner of the API token is a Sigma admin. The result depends on the Sigma admin API client switch on the Sigma credential.
If the switch is on:
✅ Admin-level API access confirmed (org-wide crawl enabled).
❌ The Sigma credential is not an admin, so the connector cannot list the whole organization.
To fix a failed check, use an API token that a Sigma admin owns, or turn off the switch. Turning off the switch removes the assets that the owner can't access from Atlan at the next crawler run. For details, see Verify necessary permissions.
If the switch is off, Atlan skips the check and reports it as passed:
✅ Skipped: the credential is not a Sigma admin API client, so Atlan crawls only what its owner can access.
See also
- Crawl Sigma: Run the crawler after preflight checks pass
- Set up Sigma: Create the API token and grant the permissions Atlan needs