Tableau Server (Repository) - Import - 7.1

Talend Data Catalog Bridges

author
Talend Documentation Team
EnrichVersion
7.1
EnrichProdName
Talend Big Data Platform
Talend Data Fabric
Talend Data Management Platform
Talend Data Services Platform
Talend MDM Platform
Talend Real-Time Big Data Platform
EnrichPlatform
Talend Data Catalog

Bridge Specifications

Vendor Tableau
Tool Name Tableau Server
Tool Version 8.x to 2019.x
Tool Web Site http://www.tableausoftware.com/
Supported Methodology [Business Intelligence] Multi-Model, BI Report (Relational Source, Expression Parsing, Report Structure) via
Incremental Harvesting
Multi-Model Harvesting
Remote Repository Browsing for Model Selection
Data Profiling

BRIDGE INFORMATION
Import tool: Tableau Tableau Server 8.x to 2019.x (http://www.tableausoftware.com/)
Import interface: [Business Intelligence] Multi-Model, BI Report (Relational Source, Expression Parsing, Report Structure) via from Tableau Server (Repository)
Import bridge: 'TableauServer' 10.1.0

BRIDGE DOCUMENTATION
The bridge relies on connectivity to the Tableau Server via the internet. The Tableau web functionality must be fully accessible from the machine where this bridge is running. This requirement may involve network proxy and firewall setup. In order to confirm that the bridge will have sufficient connectivity, make sure one can reach the Tableau Server with a web browser. If you cannot demonstrate proper connectivity, contact your Tableau Server Administrator or Tableau support as necessary.
The bridge does not support login using SAML. To import, users must log in to the server using the credentials of a user defined on the Tableau server.
For Tableau server v.9.2.0 and later the bridge will use REST API to access metadata. It's availability is controlled by configuration option 'api.server.enabled'. For more details see https://onlinehelp.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_auth.htm.

FREQUENTLY ASKED QUESTIONS

Q: How do I provide metadata to the support team to reproduce an issue?
A: The bridge can generate an archive with the debugging information if option -d is set in parameter 'Miscellaneous'. Please read documentation for parameter Miscellaneous for more details.
Alternatively, there is a way to generate .tsbak file that will contain a database backup for Tableau Server:
- Open a command prompt as an administrator;
- navigate to the directory where Tableau server has been installed:
'C:\Program Files\Tableau\Tableau Server\[version]\bin' (32-bit)
'C:\Program Files (x86)\Tableau\Tableau Server\[version]\bin' (64-bit)
- type the following command:
tabadmin backup tabserv --stop-server -d -t C:\mytemp\tableau
where 'tabserv' - backup file name;
'C:\mytemp\tableau' - path to the directory to save backup to.
*The Tableau server can stay online while making a backup if parameter '--stop-server' is replaced with '--unsafe'.
Q: What is the minimum set of permissions required for the Tableau user account?
A: Bridge uses HTTP or HTTPS protocol in order to login, send requests about available Workbooks and Data Sources and then download items that user picked in 'Repository Objects' parameter using browse menu. User account must be licensed as 'Interactor' (renamed to 'Explorer' in the latest versions) on the Tableau Server and must have 'View' and 'Download' rights for all of the Workbooks, Data Sources and Projects that he/she is about to import. However, we recommend to use an account that has 'Site Administrator' security role.


Bridge Parameters

Parameter Name Description Type Values Default Scope
Server The host name or IP address where the Tableau Server is running. You may define this parameter either with or without the internet protocol, e.g.:
- http://TableauHost:PortNumber
- 192.168.0.2
STRING   http://localhost:80 Mandatory
Site Can be specified in case of Tableau Server has multiple sites installed. The value is case sensitive. STRING      
User Name The username that the bridge will use to connect to the Tableau server. Be sure that this user has sufficient rights to the required metadata. It is recommended that you specify the full Administrator user name when first attempting to import with this bridge for a given subset of the Tableau server. Once successful, you may then consider specifying a username with only the precise permissions required. STRING     Mandatory
Password Enter the password matching the username specified. PASSWORD     Mandatory
Repository Objects The subset of repository objects (workbooks, datasources) to import. For any workbooks selected, any dependent datasources will also be included in the import. REPOSITORY_SUBSET      
Incremental import Specifies whether to import only the changes made in the source or to re-import everything (as specified in other parameters).

True - import only the changes made in the source.
False - import everything (as specified in other parameters).

An internal cache is maintained for each metadata source, which contains previously imported models. If this is the first import or if the internal cache has been deleted or corrupted, the bridge will behave as if this parameter is set to 'False'.
BOOLEAN
False
True
True  
Multiple threads Number of worker threads to harvest metadata asynchronously.
Leave the parameter blank to have the bridge compute the value, between 1 and 6, based on JVM architecture and number of available CPU cores.
Specify a numeric value greater or equal to 1 to provide the actual number of threads.
If the value specified is invalid, a warning will be issued and 1 will be used instead.
If you experience out of memory conditions when harvesting metadata asynchronously, experiment with smaller numbers.
If your machine has a lot of available memory (e.g. 10 Gb or more), you can try larger numbers when harvesting many documents at once.
Note that setting the number too high can actually decrease the performance due to resource contention.
NUMERIC      
Miscellaneous Specify miscellaneous options identified with a -letter and, if applicable, a value. For example: -d c:\debug.zip -a
-d: path to the debugging package. Allows to define a full path (including a file name) to the debugging archive which will be generated automatically and can be used to report issues about the bridge.
-a: import all datasource fields. For inventory purposes allows to import all the datasource fields, even those that are not used in the worksheets. It will also import unpublished worksheets.
-p: include published data sources into lineage. Allows to organize lineage between the workbooks and the ultimate data stores through the Tableau published data sources. If this option is not set, the bridge will embed connectivity information from the published data source directly into the workbooks.
-t: import thumbnale images for the views.
STRING      

 

Bridge Mapping

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"Tableau Server (Repository)"
Metamodel
Tableau (Connection)
Mapping Comments
     
Attribute Field  
Name Name  
Position Position  
Class Table  
Name Name  
DatabaseSchema Schema  
Name Name  
FileDirectory Directory  
Name Name  
FlatTextFile File  
Name Name  
StoreModel Connection  
Name Name  
StoreType Store Type  
SystemType System Type  

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"Tableau Server (Repository)"
Metamodel
Tableau (Datasource)
Mapping Comments
     
Attribute Field  
Name Name  
Position Position  
Stereotype Stereotype  
Class Table  
Name Name  
Condition Condition, Data Source Filter  
Name Name  
ConnectionClassifier Proxy Table  
Name Name  
ConnectionFeature Proxy Field  
ExternalId External Id  
Name Name  
ConnectionNamespace Directory  
Name Name  
ConnectionPackage Namespace  
Name Name  
DataAttribute Calculation Measure, Group, Set, Bin, Calculation Dimension, Temporary Field, Measure, Dimension, Parameter Dimension, Hierarchy field, Parameter Measure  
Description Comment  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
DataSet Hierarchy, Temporary Table, Parameters, Query, Dimension Table, Fact Table  
Name Name  
PhysicalName Physical Name  
DesignPackage Data Source, Data Source Joins, Session  
Name Name  
PhysicalName Physical Name  
FlatTextFile File  
Name Name  
Join Join  
PhysicalName Name  
Type Type  
StoreConnection Connection  
Comment Comment  
Connection Connection  
Name Name  
SystemType System Type  
StoreModel Tableau Data Source  
Comment URL  
Name Name  

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"Tableau Server (Repository)"
Metamodel
Tableau (TableauDirectory)
Mapping Comments
     
DirectoryStructureModel Tableau Server  
Name Name  
SystemType System Type  
Folder Project  
Author Owner  
Description Description  
LastModificationTime Modified  
Name Name  
StoreContent Data Source, Connection, Workbook  
Author Owner  
Description Description  
LastModificationTime Modified  
Name Name  
NativeId URL  

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"Tableau Server (Repository)"
Metamodel
Tableau (Tableau Browse)
Mapping Comments
     
DirectoryStructureModel Tableau Server  
ImportDate Import Date  
Name Name  
Folder Project, Publisher  
Name Name  
NativeId Native Id  
StoreContent Data Source, Workbook  
Name Name  
NativeId Native Id  

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"Tableau Server (Repository)"
Metamodel
Tableau (Workbook)
Mapping Comments
     
Attribute Field  
Name Name  
Position Position  
Stereotype Stereotype  
Class Table  
Name Name  
Condition Condition, Data Source Filter  
Name Name  
ConnectionClassifier Proxy Table  
Name Name  
ConnectionFeature Proxy Field  
ExternalId External Id  
Name Name  
ConnectionNamespace Directory  
Name Name  
ConnectionPackage Namespace  
Name Name  
DataAttribute Calculation Measure, Group, Set, Bin, Calculation Dimension, Temporary Field, Measure, Dimension, Parameter Dimension, Hierarchy field, Parameter Measure  
Description Comment  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
DataSet Hierarchy, Temporary Table, Parameters, Query, Dimension Table, Fact Table  
Name Name  
PhysicalName Physical Name  
DesignPackage Data Source, Data Source Joins, Published Data Source, Session  
Name Name  
PhysicalName Physical Name  
Filter Filter, Shared Filter  
PhysicalName Name  
FlatTextFile File  
Name Name  
Join Relationship, Join  
PhysicalName Name  
Type Type  
ReportField Column, Mark, Page, Row  
Comment Aggregation  
Name Name  
ReportPage Unpublished Worksheet, Worksheet, Dashboard, Story  
Comment URL  
Name Name  
StoreConnection Connection  
Comment Comment  
Connection Connection  
Name Name  
SystemType System Type  
StoreModel Tableau Workbook, Tableau Data Source  
Author Owner  
Comment URL  
ModificationTime Modified  
Name Name  
StoreType Store Type