Set Up Tableau¶
The following sections provide a guide to configuring the Tableau environment and enabling API access for metadata ingestion. Follow the steps, as each must be completed to fully set up the environment:
Enable the Metadata API¶
Note
The minimum version of Tableau Server supported is 2023.1 that matches with the API version 3.19.
Ensure that the Tableau Metadata API is enabled. By default, it is enabled in Tableau Cloud. If you are using Tableau Server, you need to enable it.
Configure User Roles and Permissions¶
For a complete metadata ingestion, the Tableau user used for metadata synchronization must have the Site Administrator Explorer or Site Administrator role on the site to be synchronized, as described in the official Tableau documentation. Alternatively, the Server Administrator role can be used, granting access to the entire Tableau Server. If a new user needs to be created, follow the steps in the Tableau documentation.
Additionally, ensure the user has at least the View capability on the Tableau projects, workbooks, data sources, and external assets to be ingested. For instructions on granting this permission, refer to the Tableau documentation.
Configure the Tableau Authentication Method¶
Data Catalog supports the following authentication methods for metadata ingestion from Tableau:
Username and password: This method relies on traditional login credentials, where a user provides their username and password to authenticate with Tableau Server or Tableau Cloud.
Personal Access Token: Instead of using a username and password, this method relies on a Personal Access Token (PAT), which is generated in Tableau and used for authentication. This method is generally more secure than username and password authentication, as it reduces the risk of credential exposure. However, it requires proper token management, as PATs can expire or be revoked by administrators, meaning they must be refreshed periodically to maintain access. If you need to authenticate using a PAT, you must first generate one by following the steps in the Tableau documentation.