Tableau permissions and ingestion results

Warning The end of life of Jobserver and all related Jobserver integrations has been announced for September 30, 2024. This means that the Tableau via Jobserver integration method is deprecated and will also reach its end of life on September 30, 2024. To integrate Tableau metadata and create lineage, please use Edge or lineage harvester.

When you synchronize Tableau, you need certain permissions to access the data in Tableau. The extent of your permissions dictates the scope of the ingestion results

The following table shows the minimum role and permissions requirements for successful synchronization and the scope of the ingestion results in Data Catalog.

Tip 

The Tableau permissions depend on your Tableau version.

Tableau site role Minimum required permissions Result in Data Catalog
Project Workbook Data Source
Viewer View View View

Tableau Workbooks and Tableau Data Sources are not parsed.

Interactor

View

View

View, Download/Save As

Tableau Data Sources are parsed.

Interactor

View View, Download/Save As View

Tableau Report Attributes are synchronized and Tableau Workbooks are parsed.

Interactor

View View, Download/Save As View, Download/Save As

Tableau Report Attributes are synchronized, and Tableau Data Sources and Tableau Workbooks are parsed.

Tableau site role Minimum required permissions Result in Data Catalog
Project Workbook Data Source
Viewer View View View

Tableau Workbooks and Tableau Data Sources are not parsed.

Explorer

View

View

View, Download/Save As

Tableau Data Sources are parsed.

Explorer

View View, Download/Save As View

Tableau Report Attributes are synchronized and Tableau Workbooks are parsed.

Explorer

View View, Download/Save As View, Download/Save As

Tableau Report Attributes are synchronized, and Tableau Data Sources and Tableau Workbooks are parsed.

Tableau site role Minimum required permissions on Project, Workbook and Data Source Metadata API in Tableau Metadata API flag in Collibra Console Result in Data Catalog

Viewer or Explorer with access to REST API

View

Disabled

Disabled

Tableau reports and data sources are ingested into Data Catalog, but with a limited scope.

Viewer or Explorer with access to REST API

View

Enabled

Disabled

Tableau reports and data sources are ingested into Data Catalog, but with a limited scope.

Viewer or Explorer View

Enabled

Enabled

Data Catalog creates new assets according to your content in Tableau without accessing metadata in Tableau databases and tables.

Tableau Server Administrator or Tableau Site Administrator

View

Enabled

Enabled

Data Catalog creates new assets according to your content in Tableau using metadata in Tableau databases and tables.

Tip Tableau users with a Server Administrator role have access to the entire Tableau Server. Tableau users with a Site Administrator role can only be assigned to specific Tableau sites. As a result, if you have the Site Administrator role, only metadata from specific Tableau sites can be ingested in Data Catalog.

Warning We do not support a full ingestion of Tableau Server or Tableau Online version 2020.2 or newer, if the Tableau metadata API is disabled. If you try to synchronize a Tableau Server or Tableau Online asset after a Tableau upgrade to 2020.2 or newer, without the Tableau metadata API enabled, the synchronization result in Data Catalog will fail. This prevents data loss of manually added relations and attributes.

Tip For more information about Tableau permissions, site roles and licenses, see the Tableau Online Help.

Tableau data structure

You can only synchronize Tableau elements if the Tableau user specified in the connection settings has permissions to access them. If you have permissions to access a Tableau element, but not its parent elements, the parent elements are skipped when synchronizing Tableau and do not appear in Data Catalog.

This happens in the following situations:

  • The Tableau user has permissions to access a Tableau workbook, but not its parent, the Tableau project.
  • The Tableau user has permissions to access a Tableau view, but not its parent, the Tableau workbook.
  • The Tableau user has permissions to access a Tableau view, but not its parent, the Tableau project.

Metadata API

If you register a Tableau Server or Tableau Online version 2020.2 or newer, Data Catalog requires the metadata API to synchronize Tableau assets.

Tableau metadata consists of information about Tableau content and assets. Data Catalog creates GraphQL queries to collect metadata from Tableau Online or Tableau Server. If the metadata API is enabled in Tableau and in Collibra Console, Collibra Data Intelligence Platform uses this metadata to create new assets in Data Catalog.

Upgrading Tableau to 2020.2 or newer

If you have previously ingested and synchronized a version of Tableau older than 2020.2 and have since upgraded to version 2020.2 or newer, you have to enable the metadata API in Tableau and in Collibra Console. If you synchronize using the metadata API, Data Catalog removes all Tableau assets created via XML mapping and creates new ones using the metadata API. This means that all manually added relations, attributes, tags, comments and stitching results will be lost.

Tip We highly recommend to contact your Collibra Customer Success Manager before you synchronize a Tableau Server or Tableau Online asset after upgrading to Tableau version 2020.2 or newer.

Parsing Tableau metadata

Parsing Tableau metadata is an automated procedure that allows the metadata to be captured and identified in Data Catalog at a more granular level. Typically, the result is that you have more assets of different types in Data Catalog, which leads to more complete information and better lineage diagrams.

Parsing takes place automatically during Tableau synchronization, depending on the Tableau permissions of the Tableau user who launched the synchronization process.

Parsing Tableau workbooks

Without parsing, Tableau Workbooks contain Tableau Views, without further details. However, if your Tableau user has the Download/Save As permission for the Workbook, the Tableau workbook is parsed. As a consequence, there is no Tableau View asset, but there is at least one Worksheet asset, and, if they exist on Tableau: Tableau Story assets and Tableau Dashboard assets.

Without Parsing With Parsing
  • Tableau Workbook
  • Tableau View
  • Tableau Workbook
  • Tableau Story
  • Tableau Dashboard
  • Tableau Worksheet

Parsing Tableau Data Source

Without parsing, Tableau Data Sources do not contain further information about the data source. However, if your Tableau user has the Download/Save As permission for the Data Source , the Tableau Data Source is parsed. As a consequence, there is at least one Tableau Data Model asset and one or more Tableau Data Entity assets and Tableau Data Attribute assets. These assets are required for Tableau stitching.

Without parsing With parsing
  • Tableau Data Source
  • Tableau Data Source
    • Tableau Data Model
    • Tableau Data Entity
    • Tableau Data Attribute