About the Tableau collector

Note

The latest version of the Collector is 2.159. To view the release notes for this version and all previous versions, please go here.

Use this collector to:

Discover Tableau workbooks and dashboards across your enterprise
Perform impact analysis to understand how changes to upstream data sources impact Tableau reports

Tableau version supported

The collector supports Tableau API versions 3.7-3.10 on Tableau Server v 2022.1

Authentication supported

The Tableau collector supports the following methods for authentication:

SAML via Personal Access Token
Username and password

These authentication details are used while generating the CLI or YAML file for the collector.

What is cataloged

The collector catalogs the following information.

Table 1.

Object	Information cataloged
Databases	Name, Description, Database Connection Type
Database tables	Name
Database columns	Name
Projects	Name, Description
Workbooks	Name, Description, Creator Email, Creator Name, Creator Tableau User, Preview Image, and Workbook URL
Dashboards	Name, Creator Email, Creator Name, Creator Tableau User, Preview Image, and Dashboard URL
Views	Name, Creator Email, Creator Name, Creator Tableau User, Number of Views, Number of Favorites, Preview Image, and View URL
Fields	Name, Identifier, Description
Calculated fields	Name, Description, Calculation Formula
Dimensions	Name, Identifier, Description
Measures	Name, Identifier, Description
Metrics	Name, Identifier, Creator, Creation Date, Modified Date, Metrics UrlField Data Type, Field Format, Field Type
Custom SQL tables	Name, Identifier, Description, Query
Embedded data sources	Name, Identifier, Description
Published data sources	Name, Identifier, Description

Relationships between objects

By default, the harvested metadata includes catalog pages for the following resource types. Each catalog page has a relationship to the other related resource types. If the metadata presentation for this data source has been customized with the help of the data.world Solutions team, you may see other resource pages and relationships.

Table 2.

Resource page	Relationship
Databases	Schemas contained within database Tables contained within database
Database tables	Views that use database table Schema containing database table Database containing the database table
Database columns	Table that a database column is part of
Projects	Views contained within the project Workbooks contained within the project Dashboards contained within project Subprojects contained within project
Workbooks	Projects that contain workbook Data sources embedded within workbook Views contained within workbook
Dashboards	Fields used by dashboard Projects containing dashboard Tables used by dashboard Workbooks containing dashboard Views embedded in dashboard
Views	Fields used by view Projects containing view Tables used by view Workbooks containing view Dashboards which embed the view
Fields	Data Sources containing field Views using field
Calculated fields	Views that use the calculated field Data sources that contain the calculated field
Dimensions	Data sources containing dimension Table related to dimension
Measures	Data Source containing measure Views using measure
Custom SQL tables	Views using Custom SQL table
Embedded data sources	Fields contained within embedded data source Workbook embedding embedded data source
Published data sources	Fields contained within published data source

Lineage for Tableau

Table 3.

Object	Lineage available
Database columns and tables	Fields that use database columns and tables
Dashboards	Fields and tables that dashboards source their data from
Views	Fields and tables that views source their data from
Fields	Columns, tables, and other fields that a field uses its data from
Embedded data sources	Published data sources

Important things to note about improving the performance of collector runs

Depending on the size of your Tableau instance, you may want to exclude or include specific resources from your catalog.

Exclude object types: Use the --tableau-exclude parameter to exclude harvesting of certain object types. The supported object types are: View, Dashboard, Database, PublishedDataSource, EmbeddedDataSource, CalculatedField, ColumnField, BinField, GroupField, DatasourceField, CustomSQLTable, Metric
Filter to specific Tableau site: Use the --tableau-site parameter to filter to a specific site.
Filter to specific Tableau projects: Use the --tableau-project parameter to harvest from multiple tableau projects. Use the parameter multiple times for multiple projects.
GraphQL page size: Use the --tableau-graphql-page-size parameter to adjust the GraphQL page size. The maximum page size is 1000.
Increase Docker resources: If you run into out of memory errors, increase the memory on the machine running the collector, or increase the java heap size when running a jar file, or use filtering.

In this section: