IBM InfoSphere DataStage - Import - Cloud

Talend Cloud Data Catalog Bridges

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

Bridge Specifications

Vendor IBM
Tool Name InfoSphere DataStage
Tool Version 7.5 to 11.x
Tool Web Site http://www.ibm.com/software/data/infosphere/datastage/
Supported Methodology [Data Integration] Multi-Model, ETL (Source and Target Data Stores, Transformation Lineage, Expression Parsing) via XML and DSX File
Data Profiling
Remote Repository Browsing for Model Selection
Incremental Harvesting
Multi-Model Harvesting

SPECIFICATIONS
Tool: IBM / InfoSphere DataStage version 7.5 to 11.x via XML and DSX File
See http://www.ibm.com/software/data/infosphere/datastage/
Metadata: [Data Integration] Multi-Model, ETL (Source and Target Data Stores, Transformation Lineage, Expression Parsing)
Component: AscentialDataStage version 11.0.0

OVERVIEW
This bridge reads a DSX or XML file generated by DataStage.

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

Some models contain special characters which require encoding in order to transfer correctly. When exported from DataStage, often the XML format has problems, while the DSX provides the correct encoding information. The problem is likely to manifest as XML parsing errors. Export DSX files from DataStage to avoid these errors.

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 DataStage provides 2 export formats, XML and DSX. This import bridge supports both, though there are sometimes problems with XML. To create one of these files:
- Open a project in the Designer Client
- Select the job folder you wish to export as a model
- Select the Export menu
- Select the DataStage Components... menu item
If a DataStage XML file produces a 'Failed to parse' error, this is usually due to an encoding error in the XML file. To work around this problem, export the model to a DSX file.
FILE
*.dsx
*.xml
  Mandatory
Import scope This parameter is used to limit the scope of metadata imported from the XML file selections.

Options include:
- Table definitions only
- Sequences and standalone jobs, including table definitions that are used in them
- All objects, all that are present in the selected XML file.

Note that for nearly all applications, including the analysis of lineage and impacts, this parameter should be set to sequences and standalone jobs, as this setting will import all sources, destinations, and transformations present in the DataStage file.
ENUMERATED
Table definitions only
Sequences and standalone jobs
All supported objects
Sequences and standalone jobs  
Variable values file File defining list of DataStage variable values in format:
variable1_name=variable1_value
variable2_name=variable2_value
...
variableN_name=variableN_value

DataStage uses substitution variables within many of the parameters that may be specified within jobs and connections. In many cases, the values which must be assigned to these variables are not provided by the XML file that this bridge parses. In such cases, the bridge will report a warning in the log saying that it 'could not determine the value of a variable' and will simply leave that variable name without any substitution in the resulting model. In order to determine the correct substitution values for these variables, the bridge reads a variable value file with the variable names and concludes with the correct value to substitute.

Place the pathname of a variable value file in this parameter.

If you have DataStage parameter sets place their directory's path in this parameter. DataStage store parameter sets into predefined directory structure:

ParameterSets
...ParameterSetName1
......ValuesFileName
...ParameterSetName2
......ValuesFileName

Typically, variable names that refer to environment variables start with a dollar sign ('$'). Variable names are not case sensitive and trimmed of all leading and trailing spaces.

If a variable is found and its value is not found in the in the variable value file, or there is no variable value file specified here, the bridge will try to use operating system environment variables (at the time the bridge executes) to resolve the value.
The parameter file could be used to specify system type for any connection name. Use format:
'CONNECTION.'<ConnectionName>=<SystemType>
<SystemType>:={'DB2/UDB'|'MICROSOFT SQL SERVER'|'ORACLE'|'TERADATA'|'SYBASE SQL SERVER'|'INFORMIX'|'HIVE'}
It would be useful for ODBC connection if you know the real DB system behind such connection.
FILE *.*    
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.

IBM DATA STAGE OPTIONS
-Statistics <Statistics_file_path>
To produce ETL import statistics, e.g.
-Statistics C:\Temp\Stats.csv

-cd: split or merge file system connections by a directory path.
Useful to split a connection into two or more root folders, that can be stitched to two or more file stores. To split the connection 'orig_con' into two connections: 'a_con' based upon the 'a' folder and the rest remains in the orig_con connection:
-cd a_con=orig_con:/a

To split the connection 'orig_con' into two connections: 'a_con" based upon the 'root/a' folder:
-cd a_con=orig_con:/root/a -

Useful to merge several connections into one. To merge two connections 'C:' with a root folder 'R1' and 'B:' with a root folder 'R2' into one connection 'C:' with two root folders - 'R1' and 'R2':
-cd C:\=B:\
STRING      

 

Bridge Mapping

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"IBM InfoSphere DataStage"
Metamodel
AscentialDataStage
Mapping Comments
     
Association ForeignKey  
AssociationRole ForeignKey  
Multiplicity   Based on Foreign Key information
Source   Based on Foreign Key information
AssociationRoleNameMap ForeignKey  
Attribute Column  
Description Description  
Name Name  
Optional Nullable  
BaseType Column, StageVariable  
DataType SQL Type See datatype conversion array
Name   Based on the datatype
PhysicalName   Derived from the datatype
CandidateKey Column  
Class Table Definition  
CppClassType   Set to ENTITY
CppPersistent   Set to True
Description Description  
Name Table name Class Name. Computed if not set
PhysicalName   Class Physical Name.Computed from the 'name' if not set
ClassifierMap Stage 1 for Stage Variables (if any), plus 1 per input or output pin
Name Name  
Operation Constraint, SqlRef, SqlPrimary, SqlInsert  
DataAttribute Column, Stage Variable  
Description Description  
Name Name  
DataSet Stage 1 for Stage Variables (if any), plus 1 per input or output pin
Name Name  
DatabaseSchema Table Definition  
Name Owner in record identifier
DerivedType Column, StageVariable  
DataType SQL Type See datatype conversion array
Length Precision  
Name SQL Type  
PhysicalName   Derived from the datatype
Scale Scale  
UserDefined   Set to False
DesignPackage Jobs Categories, Shared Continers Categories, Table Definitions Catagories  
Name Name, Source.DBDName from category
UserDefined   Set to False
FeatureMap Column, Stage Variable  
Name Name  
Operation Expression, Derivation, Initial Value  
ForeignKey ForeignKey  
StoreModel DataStage file  
Name   Based on the file name