Skip to main content Skip to complementary content

Tableau Data Source and Workbook (File) - Import

Availability-note AWS

Bridge Specifications

Vendor Tableau
Tool Name Tableau Desktop
Tool Version 8.x to 2023.x
Tool Web Site https://www.tableau.com/products/desktop
Supported Methodology [Business Intelligence] BI Report (Relational Source, Expression Parsing, Report Structure) via TWB(X) or TDS(X) File
Data Profiling
Incremental Harvesting
Multi-Model Harvesting
Remote Repository Browsing for Model Selection

SPECIFICATIONS
Tool: Tableau / Tableau Desktop version 8.x to 2023.x via TWB(X) or TDS(X) File
See https://www.tableau.com/products/desktop
Metadata: [Business Intelligence] BI Report (Relational Source, Expression Parsing, Report Structure)
Component: Tableau version 11.2.0

OVERVIEW
This import bridge imports Business Intelligence (BI) reporting metadata from Tableau Data Source file (.tds or .tdsx) or Tableau WookBook file (.twb or .twbx).

REQUIREMENTS
n/a

FREQUENTLY ASKED QUESTIONS
n/a

LIMITATIONS
Refer to the current general known limitations at https://metaintegration.com/Products/MIMB/Help/#!Documents/mimbknownlimitations.html

If your import is missing connections, this may occur because a Hyper file has been embedded directly into a workbook.
In order to create the missing connection(s), you need to create a shared data source connected to the Hyper file. Then, the Server import would create an appropriate connection, thus enabling the import with the "Tableau Server Extract (Hyper) Data Store".

SUPPORT
Provide a troubleshooting 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 -backup option, although this common option is not implemented on all bridges for technical reasons).


Bridge Parameters

Parameter Name Description Type Values Default Scope
File The Tableau Data Source file (.tds or .tdsx)
or Tableau WookBook file (.twb or .twbx).
FILE
*.tds
*.tdsx
*.twb
*.twbx
  Mandatory
Miscellaneous INTRODUCTION
Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g.
-connection.cast MyDatabase1="MICROSOFT 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
-java.memory <Java Memory's maximum size> (previously -m)

1G by default on 64bits JRE or as set in conf/conf.properties, e.g.
-java.memory 8G
-java.memory 8000M

-java.parameters <Java Runtime Environment command line options> (previously -j)

This option must be the last one in the Miscellaneous parameter as all the text after -java.parameters is passed "as is" to the JRE, e.g.
-java.parameters -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.
Note: The majority of proxies are concerned with encrypting (HTTPS) the outside (of the company) traffic and trust the inside traffic that can access proxy over HTTP. In this case, an HTTPS request reaches the proxy over HTTP where the proxy HTTPS-encrypts it.
-java.parameters -java.parameters -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass

MODEL IMPORT OPTIONS
-model.name <model name>

Override the model name, e.g.
-model.name "My Model Name"

-prescript <script name>

This option allows running a script before the bridge execution.
The script must be located in the bin directory (or as specified with M_SCRIPT_PATH in conf/conf.properties), 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"

-postscript <script name>

This option allows running a script after successful execution of the bridge.
The script must be located in the bin directory (or as specified with M_SCRIPT_PATH in conf/conf.properties), 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:
-postscript "script.bat arg1 arg2"

-cache.clear

Clears the cache before the import, and therefore will run a full import without incremental harvesting.

If the model was not changed and the -cache.clear parameter is not used (incremental harvesting), then a new version will not be created.
If the model was not changed and the -cache.clear parameter is set (full source import instead of incremental), then a new version will be created.

-backup <directory>

Allows to save the input metadata for further troubleshooting. The provided <directory> must be empty.

-restore <directory>

Specify the backup <directory> to be restored.

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 option 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"="MICROSOFT SQL SERVER".
The list of supported data store connection types includes:
ACCESS
APACHE CASSANDRA
DB2/UDB
DENODO
GOOGLE BIGQUERY
HIVE
MYSQL
NETEZZA
ORACLE
POSTGRESQL
PRESTO
REDSHIFT
SALESFORCE
SAP HANA
SNOWFLAKE
MICROSOFT SQL AZURE
MICROSOFT SQL SERVER
SYBASE SQL SERVER
SYBASE AS ENTERPRISE
TERADATA
VECTORWISE
HP 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 SourcePath=DestinationPath

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 /user1/folder=hdfs://host:8020/users/user1/folder/file.csv
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 /data=/users/John -connection.map /data=/users/paul
On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g.
-connection.map C:\data=M:\ -connection.map C:\data=N:\

-connection.casesensitive ConnectionName...

Overrides the default case insensitive matching rules for the object identifiers inside the specified connection, provided the detected type of the data store by itself supports this configuration (e.g. Microsoft SQL Server, MySql etc.), e.g.
-connection.casesensitive "My Database"

-connection.caseinsensitive ConnectionName...

Overrides the default case sensitive matching rules for the object identifiers inside the specified connection, provided the detected type of the data store by itself supports this configuration (e.g. Microsoft SQL Server, MySql etc.), e.g.
-connection.caseinsensitive "My Database"

-connection.level AggregationLevel

Specifies the aggregation level for the external connections, e.g.-connection.level catalog
The list of the supported values:
server
catalog
schema (default)
STRING      

 

Bridge Mapping

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"Tableau Data Source and Workbook (File)"
Metamodel
Tableau (Datasource)
Mapping Comments
     
Attribute Field  
Name Name  
Position Position  
Stereotype Stereotype  
Class Table  
Name Name  
PhysicalName Physical Name  
Condition Condition, Data Source Filter  
Name Name  
ConnectionClassifier Proxy Table  
Name Name  
NativeType Type  
ConnectionFeature Proxy Field  
ExternalId External Id  
Name Name  
ConnectionNamespace Project, External Data Source, Directory  
Name Name  
NativeId GUID  
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, Data Field  
Description Comment  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
Position Position  
DataSet Stored Procedure Parameters, Hierarchy, Temporary Table, Parameters, Query, Dimension Table, Fact Table, Pivot, Union, Stored Procedure Results  
Name Name  
PhysicalName Physical Name  
DatabaseSchema Extract  
Name 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  
Description Description  
Name Name  
StoredProcedure Stored Procedure  
Name Name  
PhysicalName Physical Name  

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"Tableau Data Source and Workbook (File)"
Metamodel
Tableau (Workbook)
Mapping Comments
     
Attribute Field  
Name Name  
Position Position  
Stereotype Stereotype  
Class Table  
Name Name  
PhysicalName Physical Name  
Condition Condition, Data Source Filter  
Name Name  
ConnectionClassifier Proxy Table  
Name Name  
NativeType Type  
ConnectionFeature Proxy Field  
ExternalId External Id  
Name Name  
ConnectionNamespace Project, External Data Source, Directory  
Name Name  
NativeId GUID  
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, Data Field  
Description Comment  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
Position Position  
DataSet Stored Procedure Parameters, Hierarchy, Temporary Table, Parameters, Query, Dimension Table, Fact Table, Pivot, Union, Stored Procedure Results  
Name Name  
PhysicalName Physical Name  
DatabaseSchema Extract  
Name 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  
PhysicalName Physical Name  
StoreConnection Connection  
Comment Comment  
Connection Connection  
Name Name  
SystemType System Type  
StoreModel Tableau Data Source, Workbook  
Author Owner  
Comment URL  
Description Description  
ModificationTime Modified  
Name Name  
StoreType Store Type  
StoredProcedure Stored Procedure  
Name Name  
PhysicalName Physical Name  

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!