Meta Integration® Model Bridge (MIMB)
"Metadata Integration" Solution

MIMB Bridge Documentation

MIMB Import Bridge from TIBCO Spotfire Analyst (DXP Format) (File)

Bridge Specifications

Vendor TIBCO Software Inc.
Tool Name Spotfire Analyst (DXP Format)
Tool Version 7.x
Tool Web Site https://spotfire.tibco.com
Supported Methodology [Business Intelligence] BI Report (Relational Source, Expression Parsing, Report Structure) via DXP File

SPECIFICATIONS
Tool: TIBCO Software Inc. / Spotfire Analyst (DXP Format) version 7.x via DXP File
See https://spotfire.tibco.com
Metadata: [Business Intelligence] BI Report (Relational Source, Expression Parsing, Report Structure)
Component: TibcoSpotfireDocument version 11.0.0

OVERVIEW
This bridge imports a Tibco Spotfire Analysis Document dxp file.

REQUIREMENTS
n/a

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
The dxp format may not always contain the precise database connection type for each database connection. If some database connection(s) are just defined as generic ODBC for example, their database specific SQL query may not be parsed successfully. Please refer to the Miscellaneous parameter to specify the connection type explicitly for each connection.

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)
bridge_spec_tibcospotfirestdf_import_description: |-2
This bridge imports a Tibco Spotfire Stdf file.

REQUIREMENTS
n/a

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

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)


Bridge Parameters

Parameter Name Description Type Values Default Scope
File The file path of the model to import. FILE *.dxp   Mandatory
Document name The name of the Analysis Document model. DXP files do not contain the document name. If the name is not specified, the file name is used as the document name. STRING      
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
-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.
-java.parameters -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

-java.executable <Java Runtime Environment full path name> (previously -jre)

It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g.
-java.executable "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe"

-environment.variable <name>=<value> (previously -v)

None by default, e.g.
-environment.variable 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

-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"

TIBCO SPOTFIRE OPTIONS
-r

Remove the report pages and their graphical structure.

-c <list of connection database types>

If databases are accessed via generic ODBC connections, then it is critical to know the exact database type in order to properly parse that database specific SQL syntax for lineage.
The list of connection database types must be specified as a semi-column separated value pairs: <Connection name>=<Database type>, e.g.
-c Connection1=ORACLE;Connection2=TERADATA;
The supported database types for SQL parsing is:
ACCESS
CASSANDRA
DB2
DENODO
HIVE
MYSQL
NETEZZA
ORACLE
POSTGRESQL
PRESTO
REDSHIFT
SALESFORCE
SAP HANA
SNOWFLAKE
SQL SERVER
SYBASE
TERADATA
VECTORWISE
VERTICA

-pi

Import the document's preview image, storing the PNG image in base64.
STRING      
__Connection list Internal semicolon delimited list of connection names and their data types. STRING      

 

Bridge Mapping

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"TIBCO Spotfire Analyst (DXP Format) (File)"
Metamodel
Tibco Spotfire (Document)
Mapping Comments
     
Argument Parameter  
Description Description  
Name Name  
PhysicalName Physical Name  
Position Position  
Stereotype Type  
Attribute Column  
Name Name  
Position Position  
Class Table  
Name Name  
PhysicalName Physical Name  
ConnectionClassifier Connection Classifier  
Name Name  
NativeType Native Type  
PhysicalName Physical Name  
ConnectionFeature Connection Feature  
ExternalId External Id  
Name Name  
ConnectionNamespace Folder, Excel Workbook  
Name Name  
ConnectionPackage Schema  
Name Name  
DataAttribute Result Attribute, Data Column  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
PhysicalName Physical Name  
Position Position  
Stereotype External Id  
DataSet Data Transformation, Data Source, Data Table, Custom Query, View, Data Producer  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
PhysicalName Physical Name  
Stereotype Producer Type, Transformation Type, Data Source Type  
Filter Filter  
Name Name  
NativeId Native Id  
NativeType Native Type  
FlatTextFile Text File, SBDF File, STDF File, File, Excel Worksheet, ESRI Shape File  
Name Name  
NativeId Native Id  
NativeType Native Type  
Join Relation, Column Match  
Name Name  
NativeType Native Type  
Note Annotation  
ModificationTime Modification Time  
Name Name  
NativeId Native Id  
Value Text  
PropertyType Property  
Description Description  
InitialValue Default Value  
Name Name  
NativeId Native Id  
NativeType Native Type  
Report Report  
Name Name  
ReportAttribute Script, Expression, Document Property  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
Stereotype Language  
ReportAxis Axis  
Name Name  
NativeId Native Id  
Position Position  
Role Role  
ReportChart Report Chart  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
ReportDataSet Document Properties, Scripts, Expressions  
Name Name  
ReportField Field  
Name Name  
NativeId Native Id  
Position Position  
ReportMatrix Report Cross Table  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
ReportPage Page  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
Position Position  
ReportRectangle Panel, Control, KPI, Report Chart Layer, Graphical Table Column  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
ReportTable Report Table  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
ReportText Text Area  
Name Name  
NativeId Native Id  
NativeType Native Type  
Value Value  
StoreConnection Data Connection  
Connection Connection  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
Stereotype Library Id  
StoreType Store Type  
SystemType System Type  
StoreModel Analysis Document  
Author Author  
CreationTime Creation Time  
Description Description  
ModificationTime Modification Time  
Modifier Modifier  
Name Name  
NativeId Native Id  
Stereotype Keywords  
StoreType Store Type  
StoredProcedure Data Function, Stored Procedure  
Description Description  
Name Name  
NativeId Native Id  
NativeType Native Type  
PhysicalName Physical Name  
Semantics Script  

Last updated on Wed, 18 Nov 2020 17:34:26

Copyright © Meta Integration Technology, Inc. 1997-2020 All Rights Reserved.

Meta Integration® is a registered trademark of Meta Integration Technology, Inc.
All other trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.