Talend Data Integration - Import - 7.1

Talend Data Catalog Bridges

English (United States)
Talend Big Data Platform
Talend Data Fabric
Talend Data Management Platform
Talend Data Services Platform
Talend MDM Platform
Talend Real-Time Big Data Platform
Talend Data Catalog

Bridge Requirements

This bridge:
  • requires internet access to https://repo.maven.apache.org/maven2/ and/or other tool sites to download drivers into <TDC_HOME>/data/download/MIMB/. For more information on how to retrieve third-party drivers when the TDC server cannot access the internet, see this article.

Bridge Specifications

Vendor Talend
Tool Name Talend Data Integration
Tool Version 5.x to 7.x
Tool Web Site https://www.talend.com/products/data-integration/
Supported Methodology [Data Integration] Multi-Model, Data Store (Physical Data Model, Logical Data Model, Stored Procedure Expression Parsing), ETL (Source and Target Data Stores, Transformation Lineage, Expression Parsing), Graphical Layout via Eclipse Java API
Data Profiling
Remote Repository Browsing for Model Selection
Incremental Harvesting
Multi-Model Harvesting

Tool: Talend / Talend Data Integration version 5.x to 7.x via Eclipse Java API
See https://www.talend.com/products/data-integration/
Metadata: [Data Integration] Multi-Model, Data Store (Physical Data Model, Logical Data Model, Stored Procedure Expression Parsing), ETL (Source and Target Data Stores, Transformation Lineage, Expression Parsing), Graphical Layout
Component: Talend version 11.0.0

This bridge requires internet access to download third party libraries:
- such as https://repo.maven.apache.org/maven2/ to download open source third party libraries,
- and more sites for other third party software such as database specific jdbc drivers.

The downloaded third party libraries are stored into $HOME/data/download/MIMB/
- If https fails, the bridge then tries with http.
- If a proxy is used to access internet, you must configure that proxy in the JRE (see the -j option in the Miscellaneous parameter).
- If the bridge does not have full access to internet, that $HOME/data/download/MIMB/ directory can be copied from another server with internet access where the command $HOME/bin/MIMB.sh (or .bat) -d can be used to download all third party libraries used by all bridges at once.

By running this bridge, you hereby acknowledge responsibility for the license terms and any potential security vulnerabilities from these downloaded third party software libraries.

This bridge parses Talend Data Integration (DI) jobs, joblets and connections from a Talend DI project directory to extract the data models of their source and target data stores (e.g. database schema, tables, columns) as well as the Data Integration (DI/ETL/ELT) models for the data flow lineage between these data stores.


Q: How do we get lineage from hand written java code in tJavaRow ?
A: You can provide the data mapping specifications at the bottom of the comment parameter of the custom code components like tJavaRow with the following syntax:

*** lineage start ***
output_row.newColumn = input_row.newColumn;
output_row.newColumn1 = input_row.newColumn1;
*** lineage end ***

The user can specify data lineage dependencies using one or more statements with arithmetic operations and functions.
The following three examples produce the same dependencies but different operations.

output_row.newColumn = input_row.newColumn+input_row.newColumn1;

output_row.newColumn = input_row.newColumn;
output_row.newColumn = input_row.newColumn1;

output_row.newColumn = custom_function(input_row.newColumn, input_row.newColumn1);

The user can specify the control lineage dependencies using the Java ? : operator.

output_row.newColumn = (input_row.newColumn > 0) ? input_row.newColumn1 : 12;

Q: How do I import so that my connections will stitch to Talend Data Preparation?
A: This bridge can take advantage of the backup from Talend Data Preparation, and will produce connections that will properly stitch (match) what is in Talend Data Preparation.
1. To produce this backup, run the Data Preparation bridge with the "-backup" option under the Miscellaneous bridge parameter.
2. Specify the "talenddatapreparation.backup" option in the Miscellaneous parameter for this bridge along with the backup input folder pathname produced in step (1.)

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

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
Project directory File directory where the Talend project is located.
It should have either a process, metadata or joblet directory.
DIRECTORY     Mandatory
Project items Names of items, like Jobs or Connections separated with semicolon. An item is identified with its path in the Talend repository (file system). For example, a job's jobName within a folder's folderName should is identified as process/folderName/jobName.

The following types of items and their root path are supported:
Job Designs - process
Db Connections - metadata/connections
File delimited - metadata/fileDelimited
File delimited - metadata/filePositional

Specify a list of top level executable jobs which you would like to analyze their data lineage.
A job can execute another job. The list should not mention jobs that are only executed from other jobs. It can cause the resulting lineage to have false and duplicate information.

If a folder has only necessary jobs, its path can be mentioned in the list. It could be helpful when you have a lot of executable jobs and would rather reference them all with folders where they reside.

Sample list of jobs and folder names: 'process/jobName1; process/folder/jobName2; process/parentFolder/childFolder/'

When you have a well-documented Connection that has comments/business names for tables/columns you can forward engineer the metadata to other tools (e.g. data modeling).

When you would like to design mappings in Microsoft Excel you can prepopulate the design with source and target connections that are already available in Talend. Specify source and target connections of type database, file, etc.

Sample list of connections: 'metadata/connections/dbConnection1; metadata/connections/folder/dbConnection1; metadata/filePositional/file1'

Connections are ignored when Jobs are specified.
Job context Specify the Talend Job context. If this parameter is empty the 'Default' context will be used.
Sometimes jobs may have several contexts for example DEV/QA parameter sets. You may specify which parameter set to use while using import.
Context file directory Allows you to provide the path to the directory that contains Talend Context flat files (*.txt, *.prn, *.csv).
Files in the directory define 'global' parameter values that apply to all imported Jobs.
Talend DI organizes Jobs in folders. When you need to specify 'local' values for a particular job you should create the job's folder hierarchy under the directory and place the job's specific context files in the leaf folder representing the job.
File defines parameter as a key/value pair delimited by either '=' or ';' (semicolon) or ' '(whitespace) or ':' (colon) or ',' (coma).
For example:
Note: bridge will not trim any whitespace around paramter's value.
By default, this is 'data' folder under 'Project Directory'.
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.

Import only the changes made since the last import

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

-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= -Dhttp.proxyPort=3128 -Dhttps.proxyHost= -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.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"


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

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

These options are available on all ETL/DI tools and scripting import bridges in order to:
- Process all SQL parsing
- Build run time models from design models and runtime variables
- Calculate run time summary lineage

-etl.summary.add.ultimate (previously -ppus)

Adds the ultimate runtime lineage summary (may generate a very large model).

-etl.summary.only.ultimate (previously -ppsp)

Only produces the ultimate runtime lineage summary (may generate a very large model).

-etl.connections.add.internal.design (previously -pppd)

Adds the internal ETL design data connectors (needed for ETL conversion).

-etl.connections.remove.input (previously -ri)

Removes all input (source) data connections (to reduce the size of the generated model).

-context.file.delimiter <context file delimiter>

Used with Context File Directory bridge parameter. Context files are utilized to override parameters defined inside of the job metadata in the following format - [parameter name]=[value]. By default delimiter is "=". You may override this default delimiter with any symbol, e.g.
-context.file.delimiter :

-runtime.lineage <runtime lineage log folder>

Specifies a runtime lineage log folder (generated by Talend Data Integration) to import the externally defined SQL expressions that are dynamically loaded by specific job transformation components such as tDBRow.

-runtime.lineage.components <list of components requiring runtime lineage log>

Specifies the list of transformation components that will require the external runtime lineage log by providing a semicolon separated list of <components type> themselves optionally prefixed by their job name <job name>.<component type> e.g
where the external runtime lineage log will be taken into account for all use of the tDBInput and tDBOutput components, and only the job1 use of the tDBRow component.

-talenddatapreparation.backup <Talend Data Preparation backup input folder>

Specifies the Talend Data Preparation backup when tDataprepRun is used.
- Backup should be created by Data Prepration bridge with '-backup' option.
- File path should be to the input folder generated by Talend Data Preparation bridge.

-internal.parameter.overwrite <internal parameter name>=<value>

Allows to overwrite the value of an internal parameter involved in a connection component (e.g tOracleInput, tFileOutputDelimited etc.) when the input is assigned to internal parameters. This option can overwrite 3 types of internal parameters: Connection, Schema and Operation.
When the bridge fail to import any connection information or any operation internal parameters, this option might be used to help bridge understand complex cases dynamically. The internal parameter name consists of two parts: the component's native id and the parameter name delimited by $ and enclosed into $$ signs, e.g.
For example : $$tOracleInput_1$Connection$=NewConnectionName or $$tFileOutputDelimited_1$Connection$$=c:\new\path\for\file.txt
The Native Id can be found in Talend Studio (__UNIQUE_NAME__) or in the imported model at transformation's native Id.

-parameters.output.path <path>

Generates parameter files templates to ease parameterizing



Bridge Mapping

Mapping information is not available