Create a Tableau metadata collector
Create a collector to import metadata from Tableau.
Before you begin
Before you begin, verify the following:
- A MID Server is setup for the collectors. For more information, see MID Server for metadata collectors.
- All per-requisite tasks are completed. For more information, see Prepare to run the Tableau collector.
- Role required: connection-admin
Procedure
Navigate to All > Workflow Data Fabric > Workflow Data Fabric Home.
Select the Connect Hub
Connect Hub icon icon in the left sidebar.
Select Create > Metadata collector.
From the System list, select Tableau.
From the Connection type list, select one of the following:
Select New connection to configure a new connection.
Select Existing connection to reuse an existing connection and select an existing connection from the Connections list.
The configuration form is filled with details from the existing connection. The name is appended with the word Copy and sensitive details like password aren't copied.
Complete the form.
Field Description Connection name Unique identifier for the connection. This field can't be modified once the connection is established. Short description Purpose and details of the connection. Configure the API base URL and authentication options.
Field Description Tableau API base URL Base URL for the Tableau API. For example: https://8bank/api/3.10/.Configure the authentication options.
| Field | Description |
|---|---|
| Authenticate using username and password | |
| Username | Tableau user name for authentication. |
| Password | Tableau password for authentication. |
| Authenticate using a private access token \(PAT\) | |
| Tableau personal access token name | Tableau personal access token name. |
| Personal Access Token Secret | Tableau personal access token secret. |
| Authenticate using JSON Web Tokens \(JWT\) | |
| username | Username associated with the connected app for JWT authentication. |
| Connected App Client ID | Client ID of the connected app required for JWT authentication. |
| Connected App secret ID | Secret ID of the connected app required for JWT authentication. |
| Connected App Secret Value | Secret value of the connected app required for JWT authentication. |
| JWT Token Expiration Minutes | Number of minutes the JWT token remains valid.Default: 5 minutes |
- Configure the harvesting scope and filtering options.
| Field | Description |
|---|---|
| Skip cataloging of preview images | Option to exclude preview images from cataloging. |
| Tableau site | ID or name of the Tableau site to catalog. Leave blank to catalog all accessible sites. |
| Tableau pagination size | Number of records per page for GraphQL queries. |
| Tableau project | ID or name of the Tableau project to catalog. Leave blank to catalog all projects.Note: Specify nested projects individually. |
| Exclude object types | Tableau object types to exclude from cataloging.Supported object types: - View - Dashboard - Database - PublishedDataSource - EmbeddedDataSource - CalculatedField - ColumnField - BinField - GroupField - DatasourceField - CustomSQLTable - Metric |
| Tableau project exclude | ID or name of a project to exclude from cataloging. This field overrides the Tableau project field. |
| Whether to include/exclude descendant projects | Option to apply project settings to descendant projects. |
Configure the content and data source options
Field Description Catalog personal space workbooks Option to catalog personal space workbooks. Personal space workbooks are workbooks that are not associated with a project. Convert Database Identifier Option to convert database identifiers to the default case used by the target database (for example, lowercase for PostgresSQL, uppercase for Oracle). Exclude Unpublished Views Option to exclude unpublished views and dashboards from cataloging. Hostname mapping file If you have configured hostname mapping in the hostnames.yaml file, upload the file. Exclude Hidden Fields Option to exclude hidden fields within published data sources from cataloging. Select Save.
Result
The metadata collector is created and appears on the Connectors page with a Configured status. It is now ready to connect to the source system and harvest metadata.
What to do next
After creating the collector, you can perform any of the following tasks:
- Run the collector manually to harvest metadata immediately. See Run metadata collectors manually.
- Automate metadata collection by scheduling regular collector runs. See Schedule metadata collector runs.
- Monitor execution status and troubleshoot issues by viewing the runtime logs. See View runtime logs for collector runs.
- Discover and evaluate the harvested data assets in the Data Catalog. See Governing the Data Catalog.
Parent Topic:Tableau metadata collector