Tableau Server (Repository) - Import - Cloud

Talend Cloud Data Catalog Bridges

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend Data Catalog

Bridge Specifications

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

SPECIFICATIONS
Tool: Tableau / Tableau Server version 8.x to 2020.x via
See http://www.tableausoftware.com/
Metadata: [Business Intelligence] Multi-Model, BI Report (Relational Source, Expression Parsing, Report Structure)
Component: TableauServer version 11.0.0

OVERVIEW
This bridge imports Business Intelligence (BI) reporting metadata from a Tableau Server.

REQUIREMENTS
This bridge needs network connectivity to the Tableau server which may require network SSL or proxy setup (see the Server parameter for more details). Therefore, the Tableau server must be accessible with the same setup over a web browser on the machine where the bridge is running.

The user must have proper permission (see the User parameter for more details).

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
n/a

LIMITATIONS
Refer to the current general known limitations at http://metaintegration.com/Products/MIMB/MIMBKnownLimitations.html or bundled in Documentation/ReadMe/MIMBKnownLimitations.html

This bridge does not support login using SAML.

SUPPORT
Provide a trouble shooting package with:
- the debug log (can be set in the UI or in conf/conf.properties with MIR_LOG_LEVEL=6)
- the metadata backup if available (can be set in the Miscellaneous parameter with option -backup)

The troubleshooting purpose a Tableau backup can be automatically generated using the -backup option of the Miscellaneous parameter.
Alternatively, a Tableau server backup (.tsbak) can be manually generated as follows:
1- Open a command prompt as an administrator;
2- Navigate to the directory where the 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)
3- Type the following command:
tabadmin backup tabserv --stop-server -d -t C:\temp\tableau
- 'tabserv' - backup file name;
- 'C:\temp\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'.


Bridge Parameters

Parameter Name Description Type Values Default Scope
Server The Tableau Server URL (by default http://localhost:80)
or IP address (e.g. 192.168.0.2)
If SSL is used, the URL must start by https (and possibly end with a custom port if the SSL default port of 443 is not used).
STRING   http://localhost:80 Mandatory
Site The Tableau Site is only required when connecting to an online Tableau server with multiple sites installed.
The value is case sensitive, and must not contain any space as it is used in the URL to connect to Tableau.
STRING      
User Name The Tableau user name used by this bridge.
That user must have proper access rights to read all metadata. It is recommended to try as Administrator first (all bridges are warrantied to be ready only and only extract metadata) and possibly on a subset of the metadata. Once successful, a user with only the necessary access rights can be used.

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. It is however preferable to use an account that has 'Site Administrator' security role.
STRING     Mandatory
Password The Tableau user password. PASSWORD     Mandatory
Repository Objects The subset of repository objects (workbooks, data sources) to import.
For any workbooks selected, any dependent data sources will also be included in the import.
REPOSITORY_SUBSET      
Exclude Repository Objects The subset of repository objects (workbooks, datasources) to be excluded from the import.
For any workbooks selected, any dependent data sources will also be excluded from the import.
REPOSITORY_SUBSET      
Incremental import Incremental import only extracts what has changed since the last import. The initial full metadata harvesting (model import) of a very large source system can take a long time. However the extracted metadata are organized as a multi-model, where each model is a unit of change (e.g. Schema of a RDBMS server, or report of BI server). Subsequent model imports are dramatically faster than the initial import as this bridge will automatically try to detect changes in the source system, in order to only process the modified, added or deleted models and reuse all unchanged metadata from the model cache. Note however that the detection of change is more or less efficient depending on the sources system: e.g. BI servers can quickly provide the list of new, modified or deleted reports, but not all data stores offer a schema level change detection.

'True'
Import only the changes made since the last import

'False'
import all metadata. This option is required after upgrading the bridge in particular to take full advantage of any additional metadata coverage.

For debugging purpose, the option -cache.clear of the Miscellaneous parameter can be used to clear one model from the cache which is located (by default) in: $HOME/data/MIMB/cache/<BridgeId>/<ModelId>
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 INTRODUCTION
Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g.
-connection.cast MyDatabase1="SQL Server"
Some options can be used multiple times if applicable, e.g.
-connection.rename NewConnection1=OldConnection1 -connection.rename NewConnection2=OldConnection2;
As the list of options can become a long string, it is possible to load it from a file which must be located in ${MODEL_BRIDGE_HOME}\data\MIMB\parameters and have the extension .txt. In such case, all options must be defined within that file as the only value of this parameter, e.g.
ETL/Miscellaneous.txt

JAVA ENVIRONMENT OPTIONS
-m <Java Memory's maximum size>
1G by default on 64bits JRE or as set in conf/conf.properties, e.g.
-m 8G
-m 8000M

-j <Java Runtime Environment command line options>
This option must be the last one in the Miscellaneous parameter as all the text after -j is passed "as is" to the JRE, e.g.
-j -Dname=value -Xms1G
The following option must be set when a proxy is used to access internet (this is critical to access https://repo.maven.apache.org/maven2/ (and exceptionally a few other tool sites) in order to download the necessary third party software libraries.
-j -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttps.proxyHost=127.0.0.1 -Dhttps.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass -Dhttps.proxyUser=user -Dhttps.proxyPassword=pass

-jre <Java Runtime Environment full path name>
It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g.
-jre "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe"

-v <Environment variable value>
None by default, e.g.
-v var1=value1 -v var2="value2 with spaces"

MODEL IMPORT OPTIONS
-model.name <model name>
Override the model name, e.g.
-model.name "My Model Name"

-prescript <script name>
The script must be located in the bin directory, and have .bat or .sh extension.
The script path must not include any parent directory symbol (..).
The script should return exit code 0 to indicate success, or another value to indicate failure.
For example:
-prescript "script.bat arg1 arg2"

-cache.clear
Clears the cache before the import, and therefore will run a full import without incremental harvesting.
Warning: this is a system option managed by the application calling the bridge and should not be set by users.

-backup <directory>
Full path of an empty directory to save the metadata input files for further troubleshooting.

DATA CONNECTION OPTIONS
Data Connections are produced by the import bridges typically from ETL/DI and BI tools to refer to the source and target data stores they use. These data connections are then used by metadata management tools to connect them (metadata stitching) to their actual data stores (e.g. databases, file system, etc.) in order to produce the full end to end data flow lineage and impact analysis. The name of each data connection is unique by import model. The data connection names used within DI/BI design tools are used when possible, otherwise connection names are generated to be short but meaningful such as the database / schema name, the file system path, or Uniform Resource Identifier (URI). The following options allows to manipulate connections. These options replaces the legacy options -c, -cd, and -cs.

-connection.cast ConnectionName=ConnectionType
Casts a generic database connection (e.g. ODBC/JDBC) to a precise database type (e.g. ORACLE) for SQL Parsing, e.g.
-connection.cast "My Database"="SQL SERVER".
The list of supported data store connection types includes:
ACCESS
CASSANDRA
DB2
DENODO
HIVE
MYSQL
NETEZZA
ORACLE
POSTGRESQL
PRESTO
REDSHIFT
SALESFORCE
SAP HANA
SNOWFLAKE
SQL SERVER
SYBASE
TERADATA
VECTORWISE
VERTICA

-connection.rename OldConnection=NewConnection
Renames an existing connection to a new name, e.g.
-connection.rename OldConnectionName=NewConnectionName
Multiple existing database connections can be renamed and merged into one new database connection, e.g.
-connection.rename MySchema1=MyDatabase -connection.rename MySchema2=MyDatabase

-connection.split oldConnection.Schema1=newConnection
Splits a database connection into one or multiple database connections.
A single database connection can be split into one connection per schema, e.g.
-connection.split MyDatabase
All database connections can be split into one connection per schema, e.g.
-connection.split *
A database connection can be explicitly split creating a new database connection by appending a schema name to a database, e.g.
-connection.split MyDatabase.schema1=MySchema1

-connection.map DestinationPath=SourcePath
Maps a source path to destination path. This is useful for file system connections when different paths points to the same object (directory or file).
On Hadoop, a process can write into a CSV file specified with the HDFS full path, but another process reads from a HIVE table implemented (external) by the same file specified using a relative path with default file name and extension, e.g.
-connection.map hdfs://host:8020/users/user1/folder/file.csv=/user1/folder
On Linux, a given directory (or file) like /data can be referred to by multiple symbolic links like /users/john and /users/paul, e.g.
-connection.map /users/John=/data -connection.map /users/paul=/data
On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g.
-connection.map M:\=C:\data -connection.map N:\=C:\data

-pppd
Create the connections and connection data sets in DI/ETL design models. This feature should only be used when intending to export to another DI/ETL tool.

TABLEAU OPTIONS
-a
Import all datasource fields. For inventory purposes allows to import all the data source fields, even those that are not e.g. 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.

-pi
Import the Preview Image for each Tableau object (Worksheet or Dashboard) as a custom attribute Preview storing the PNG image in base64.
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  
NativeType Type  
ConnectionFeature Proxy Field  
ExternalId External Id  
Name Name  
ConnectionNamespace Directory  
Name Name  
ConnectionPackage Namespace  
Name Name  
DataAttribute Calculation Measure, Group, Pivot Field, Set, Bin, Temporary Field, Dimension, Parameter Dimension, Hierarchy Field, Union Field, Calculation Dimension, Measure, Parameter Measure  
Description Comment  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
DataSet Hierarchy, Temporary Table, Parameters, Query, Dimension Table, Fact Table, Pivot, Union  
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  
Author Owner  
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  
NativeType Type  
ConnectionFeature Proxy Field  
ExternalId External Id  
Name Name  
ConnectionNamespace Directory  
Name Name  
ConnectionPackage Namespace  
Name Name  
DataAttribute Calculation Measure, Group, Pivot Field, Set, Bin, Temporary Field, Dimension, Parameter Dimension, Hierarchy Field, Union Field, Calculation Dimension, Measure, Parameter Measure  
Description Comment  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
DataSet Hierarchy, Temporary Table, Parameters, Query, Dimension Table, Fact Table, Pivot, Union  
Name Name  
PhysicalName Physical Name  
DesignPackage Data Source, Data Source Joins, Published Data Source, Session  
Name Name  
PhysicalName Physical Name  
Filter Filter, Shared Filter  
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