TIBCO Spotfire 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 TIBCO Software Inc.
Tool Name Spotfire Server
Tool Version 7.13 or newer
Tool Web Site https://spotfire.tibco.com
Supported Methodology [Business Intelligence] Multi-Model, BI Report (Relational Source, Expression Parsing, Report Structure) via Java API
Data Profiling
Remote Repository Browsing for Model Selection
Multi-Model Harvesting
Incremental Harvesting

SPECIFICATIONS
Tool: TIBCO Software Inc. / Spotfire Server version 7.13 or newer via Java API
See https://spotfire.tibco.com
Metadata: [Business Intelligence] Multi-Model, BI Report (Relational Source, Expression Parsing, Report Structure)
Component: TibcoSpotfireServer version 11.0.0

OVERVIEW
This bridge imports from Tibco Spotfire Server.

REQUIREMENTS
This bridge connects to Spotfire server using the WebService API and OAuth 2.0 protocol for authentication and authorization.
Before the API can be used, an OAuth 2.0 API client must be registered.
You must complete the following configuration steps to register an OAuth 2.0 API client in the Spotfire server:
- On the computer running Spotfire Server, open a command line as an administrator
- Change the directory to the location of the command line configuration tool (config.bat on Windows, config.sh on Linux).
The default location is $server installation dir$/tomcat/bin
- Export the active server configuration from the Spotfire database into a local configuration.xml file by using the export-config command.
Example: config export-config --tool-password=mypassword
- Use the register-api-client command to register an OAuth API client.
Example: config register-api-client -n OAuthClient1 -Sapi.soap.library-service
All information needed to use the client, including a client ID and a client secret, will be shown after successful completion of the command.
For example:
Client ID: eeb2e41a2ae5d7df13cc600b5973727e.oauth-clients.spotfire.tibco.com
Client secret: 797fc101fbb1d0aa599e65413b33a90b713a65f7f667ee61f61506cc1e76a9a5
To view the full oauth client configuration, you can use the 'show-oauth2-client' command.

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

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)
To verify that the server is up and running and check the server properties, you may point your web browser to URL:
http://server:port/spotfire/manifest

To verify that the WebService API is available, you may point your web browser to URL:
http://server:port/spotfire/api/soap/LibraryService/wsdl
This WebService API is available since Spotfire server version 7.13.0
Older versions of the WebService API are deprecated, and therefore not supported.


Bridge Parameters

Parameter Name Description Type Values Default Scope
Server URL Specify here the Tibco Spotfire Server URL.
The default URL is usually: http://localhost:8080/spotfire

Accessing Spotfire Server via HTTPS:
In order to connect to the Spotfire Server via HTTPS, you need to import the server certificate into the client machine java trust store.
1. Copy the Spotfire Server certificate to the client machine, for example in jre\lib\security\server.cer
2. Open a command prompt window, and set the local directory:
cd jre\lib\security
3. If the jssecacerts trust store is missing, make a copy of the default cacerts file:
copy cacerts jssecacerts
4. Import the server certificate file into the trust store:
..\..\bin\keytool.exe -importcert -alias serveralias -file server.cer -keystore jssecacerts
Enter keystore password: changeit
Trust this certificate? [no]: yes
STRING   http://localhost:8080/spotfire Mandatory
Login User The username which the bridge will use to log in. Be sure this user name has necessary permissions to access the objects you wish to import.
This corresponds to the Client ID for an OAuth 2.0 authentication method.
STRING     Mandatory
Login Password The password associated with the username which the bridge will use to log in.
This corresponds to the Client secret for an OAuth 2.0 authentication method.
PASSWORD     Mandatory
Library subset This option is used to access objects stored in the Spotfire library.
You can specify here multiple IDs of reports and/or folders, to be retrieved, separated by semicolon (;) character.
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  
Import local connections Used to select documents stored in the Spotfire library, which have local connections.
You can specify here multiple IDs of documents, separated by semicolon (;) character.
REPOSITORY_SUBSET      
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.

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      

 

Bridge Mapping

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"TIBCO Spotfire Server (Repository)"
Metamodel
Tibco Spotfire (Server)
Mapping Comments
     
DirectoryStructureModel Server  
Name Name  
Folder Folder  
Author Created By  
CreationTime Creation Time  
Description Description  
LastModificationTime Modification Time  
Modifier Modified By  
Name Name  
NativeId Native Id  
NativeType Native Type  
StoreContent Data Source, Information Link, Connection Data Source, Data Connection, Local Connection, Document  
Author Created By  
CreationTime Creation Time  
Description Description  
LastModificationTime Modification Time  
Modifier Modified By  
Name Name  
NativeId Native Id  
NativeType Native Type