How to set up Tableau

πŸ€“ Who can do this? You will probably need your Tableau administrator to run these commands β€” you may not have access yourself.

Enable the Tableau Metadata API

To enable the Tableau Metadata API, follow the steps in Tableau documentation.

🚨 Careful! Atlan needs the Tableau Metadata API to crawl metadata. Please ensure you are running the latest version of Tableau Server or Tableau Online (2022.x with REST API version 3.14+). Learn more about the permissions used to access metadata through the Tableau Metadata API.

Publish the worksheets you want to crawl

Ensure you publish the worksheets in Tableau that you want to crawl in Atlan.

To publish Tableau worksheets, follow the steps in Tableau documentation.

Choose authentication mechanism

Atlan supports the following authentication methods for fetching metadata from Tableau:

  • Basic β€” this method uses a username and password.
  • Personal access token β€” this method uses a personal access token.
  • JWT bearer β€” this method uses a username and JWT client ID, secret ID, and secret value.

Basic authentication

πŸ’ͺ Did you know? To crawl assets and extract asset lineage from Tableau, the user must have the Site Administrator Explorer role. Atlan requires the Site Administrator Explorer role in Tableau to extract data source fields and calculated fields and create field-level assets and lineage. It is not possible to fetch either with the Viewer role in the current version of the Tableau Metadata API.

Add a user

Ensure you add a user with the role Site Administrator Explorer to the site you want to crawl.

To add such a user, follow the steps in Tableau documentation.

Grant user permissions

Ensure you grant the View capability for all the assets you want to crawl.

To grant the permission, follow the steps in Tableau documentation.

Personal access token authentication

If you want to access Tableau using an access token, you can generate a personal access token.

To generate a personal access token, follow the steps in Tableau documentation.

JWT bearer authentication

🚨 Careful! To access the Tableau Metadata API using JWT bearer authentication, you must have Tableau Cloud October 2023 or Tableau Server 2023.3 version. In addition, JWT authorization currently does not support all REST API capabilities. Due to these limitations at source, Atlan will not be able to crawl Tableau flows if you use the JWT bearer authentication method.

Configure a connected app

If you want to access Tableau using a JSON web token (JWT), you can configure a Tableau connected app. There are two types of connected apps that you can configure β€” direct trust or OAuth 2.0 trust.

To authenticate the Tableau connection in Atlan using this method, you will need the following:

  • Username β€” your Tableau Server username or Tableau Online email address, the user must have a Site Administrator Explorer role
  • Connected app ID β€” client ID generated for the connected app

  • Secret ID β€” secret ID linked to the client ID of the connected app

  • Secret value β€” secret value used to sign the token

To configure a connected app, follow the steps in Tableau documentation:

Access scopes for connected apps

For JWT authorization, scopes define access permissions granted to the token holder. Scopes control the specific actions that an application or user can perform in Tableau while accessing content through a connected app.

The Tableau connector in Atlan uses two read scopes to extract metadata from Tableau. Note that the Tableau connector is preconfigured to use these scopes, no action required.

Atlan uses the following scopes for JWT authentication:

  • tableau:content:read β€” allows read access to your assets in Tableau, including:
    • Workbooks β€” can list, access, and retrieve metadata for workbooks.

    • Views β€” can fetch specific views or dashboards within workbooks.

    • Data sources β€” can access published data sources and associated metadata.

    • Projects β€” can retrieve project metadata.

    • Metrics β€” can read metrics associated with workbooks or dashboards.

    • Tables and databases β€” can access metadata for tables and databases connected to Tableau.

  • tableau:users:read β€” allows read access to user details. This enables Atlan to display the source owner property for supported Tableau assets, including in the impact analysis report.

Related articles

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