Contribute in GitHub:

Tableau Resource Configuration

Note: Before you configure your scanner, make sure you meet the prerequisites. Read our guide Tableau Integration Requirements to double-check.

Source System Properties

This configuration can be setup by creating a new connection on Admin UI > Connections tab or editing an existing connection in Admin UI > Connections > Reporting & BI > Tableau > specific connection. New connection can also be created via Manta Orchestration API General Walkthrough Example.

One IBM Manta Data Lineage connection for Tableau corresponds to one site on Tableau Online or Tableau Server. The workbooks that are stored there will be analyzed.

Property name	Property code	Description	Example
Tableau site name	tableau.site.id	Name of the site on Tableau Online or Tableau Server; the site name can be found in the site URL, which has the format `http://example.com/#/site/sitename/projects/...` Use sitename as the property value Leave blank for the default site; the URL of a default site has no site name in it: `http://example.com/#/projects/...`	finance development
Tableau site unique ID	tableau.site.uniqueid	Unique site identifier, which must be unique across all Tableau sites registered in Manta Data Lineage; it will only be used to identify the site in Manta Data Lineage It can be `tableau.site.id` (recommended), but any unique value is allowed Even the default site must have an ID	finance development
Tableau server URL	tableau.extractor.uri	Tableau server URL including the protocol but not including the site name Note that for Tableau Online, the address must contain a pod name such as 10az or 10ay; this means that `https://online.tableau.com` is not sufficient but `https://10ay.online.tableau.com` is	`https://10ax.online.tableau.com` `http://192.168.0.5`
Authentication method	tableau.extractor.authenticationMode	Specifies which credentials should be used for authentication; possible values are: Username and password — Username and password of a user with access to all extracted workbooks and data sources. The user must have at least an "Explorer (can publish)" role. Code for Orchestration API: `USERNAME_PASSWORD`. If the authentication method is not specified, this value is used. If Tableau is configured to use multi-factor authentication, the username and password login method will not work. In this scenario, the Personal Access Token method will be required. Personal Access Token — Personal Access Token (PAT) generated in the Tableau user settings specifically for Manta Data Lineage. See Tableau documentation for more information. Code for Orchestration API: `PERSONAL_ACCESS_TOKEN` (Available as of R41)
Username	tableau.extractor.user	Name of the user used to download data from Tableau Server Required only if the “Username and password” authentication method is selected	username@company.com
Password	tableau.extractor.password	Password of the user from the previous parameter Required only if the “Username and password” authentication method is selected	`**********`
Token name	tableau.extractor.token.name	Name of the token used to sign in to Tableau Server Required only if the “Personal Access Token” authentication method is selected (Available as of R41)	Manta Data Lineage token
Token secret	tableau.extractor.token.secret	Secret (value) of the token Required only if the “Personal Access Token” authentication method is selected (Available as of R41)	49P+CxmFRY6A2GHxyvHHAA==:e3d3fe0b-1980-478e-81d8-61f1caf1c700
Extracted workbooks	tableau.extractor.include	(Optional) Regular expression describing the workbooks that should be downloaded; the full name of the workbook includes the names of all parent projects and the file name delimited by slashes (like project_name/subproject_name/Workbook name) It's case sensitive Leaving this parameter empty means "download everything" (except for excluded items) Note that if the name of the resource you are trying to match includes a regex meta-character such as "`[ ]{ } - ( )<>+?*`", such characters must be preceded by an escape character "\" to cancel the regex special meaning/interpretation To include a workbook called `data report` inside the project `Personal Project`, enter `Personal Project/data report`. Do not include the `.twb` suffix of the workbook or a slash at the beginning of the path.	`^sales/.$` `./workbookname` `project/subproject/.*`
Excluded workbooks	tableau.extractor.exclude	(Optional) Regular expression describing the full names of the workbooks that should NOT be downloaded; the full name of the workbook includes the names of all parent projects and the file name delimited by slashes (like project_name/subproject_name/Workbook name) It's case sensitive Leaving this parameter empty means "download everything possible" (if it's not against "include") (Note that if the name of the resource you are trying to match includes a regex meta-character such as "[ ]{ } - ( )<>+?*", such characters must be preceded by an escape character "\" to cancel the regex special meaning/interpretation)	`^sales/.$` `./workbookname` `project/subproject/.*`
REST API version	tableau.extractor.api.version	Version of the Tableau REST API to connect to It is recommended to leave this field empty — it is only required for Tableau 2019.1 and older Enter a specific REST API version (at least 2.3) if the default version is not supported by your Tableau instance; see the Tableau documentation to find the appropriate version of the API for your version of Tableau	3.4
Input encoding	tableau.input.encoding	Encoding of provided Tableau files; only needed if input has been served manually by the client. See Encodings for applicable values.	UTF-8

Common Scanner Properties

This configuration is common for all Tableau source systems and for all Tableau scenarios, and is configure in Admin UI > Configuration > CLI > Tableau > Tableau Common. It can be overridden on individual connection level.

Property name	Property code	Description	Example (default value)
Input directory	tableau.input.dir	Directory with files extracted from the Tableau Content Store	${manta.dir.temp}/tableau/${tableau.site.id}