Grab a spot →
Skip to main content

Preflight checks for Tableau

Connect docs via MCP

Before running the Tableau crawler, you can run preflight checks to perform the necessary technical validations. The following preflight checks will be completed:

Server REST API version​

The Server Info REST API is used to fetch the restApiVersion value.

✅ Check successful if the restApiVersion is greater than or equal to 2.4.

Projects view capability​

First, the list of projects in the Include Projects and Exclude Projects fields is determined. Next, the Query Projects REST API is used to fetch the actual list of projects for which the user has view capability.

✅ Check successful if all the projects from the first list are in the second one.

Did you know?

Atlan supports user credentials with Viewer role. Ensure that you grant View capability for all the assets you want to crawl.

Metadata API​

✅ Check successful

❌ Cannot run the query because the Metadata API has not been enabled yet. Run the 'tsm maintenance metadata-services enable' command to enable the Metadata API or contact the Tableau administrator

Site role​

The Get Users on Site REST API is used to fetch the siteRole of the authenticated user on the site being crawled.

✅ Check successful if the user's site role is SiteAdministratorExplorer, SiteAdministratorCreator, or ServerAdministrator.

⚠️ If the user's site role is lower than SiteAdministratorExplorer — for example Viewer, Explorer, ExplorerCanPublish, or Creator — the check still passes and the crawl still runs, but the preflight surfaces an advisory: Site role '<role>' is below 'SiteAdministratorExplorer'. The crawl will still run, but will have known limitations. Please refer the Atlan docs.

Known limitations when the site role is below Site Administrator Explorer​

  • Source owner may be missing on some assets. Owner enrichment uses the Tableau Get Users on Site REST API, which is restricted to Site Administrators. Non-admin callers receive 403 and Atlan cannot enrich the sourceOwners attribute for those assets.
  • Embedded dashboards are not crawled. Detecting dashboard-in-dashboard relationships reads workbook content via the Download Workbook REST API, which is restricted to Site Administrators and users with content-owner permission. This only applies when embedded-dashboard crawling is enabled in the workflow configuration.
  • Upstream table lineage may be incomplete. For workbooks and datasources whose upstream tables live on a Tableau Catalog Database or Table the caller has no explicit Read grant on, the Tableau Metadata API returns the row with upstreamTables[].name, schema, and database.name set to null. Site Administrators bypass content-level ACLs on the Metadata API and see these values populated.

How to get full metadata coverage​

Ask a Tableau site admin to raise the service account's site role to SiteAdministratorExplorer or higher, following the Set Users' Site Roles steps in Tableau's documentation. See also the role capability reference for what each Tableau site role can do.