Bridge Specifications
| Vendor | Talend |
| Tool Name | Talend Data Integration |
| Tool Version | 5.x to 8.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 |
SPECIFICATIONS
Tool: Talend / Talend Data Integration version 5.x to 8.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.2.0
DISCLAIMER
This import 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 import 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 import 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 import bridge, you hereby acknowledge responsibility for the license terms and any potential security vulnerabilities from these downloaded third-party software libraries.
OVERVIEW
This import bridge parses Talend Data Integration (DI) jobs, joblets and connections from a Talend Data Integration 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.
REQUIREMENTS
n/a
FREQUENTLY ASKED QUESTIONS
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.)
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 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 |
| 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. |
REPOSITORY_SUBSET | Mandatory | ||
| 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. |
STRING | |||
| 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 Data Integration 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: parameter1=somestring parameter2=1000 Note: bridge will not trim any whitespace around paramter's value. By default, this is 'data' folder under 'Project Directory'. |
DIRECTORY | |||
| 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> This option allows to save the bridge input metadata for further troubleshooting. The provided <directory> must be empty. The primary use of this option is for data store import bridges, in particular JDBC based database import bridges. Note that this option is not operational on some bridges including: - File based import bridges (as such input files can be used instead) - DI/BI repository import bridges (as the tool's repository native backup can be used instead) - Some API based import bridges (e.g. COM based) for technical reasons. 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.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) ETL OPTIONS These options are available on all ETL/DI tools and scripting import bridges in order to: - Process all SQL parsing - Build runtime models from design models and runtime variables - Calculate runtime 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). -etl.transformations.enable.xml This option enables the parsing and support of XML transformations in DI/ETL import bridges such as Informatica PowerCenter, Informatica Developer, Microsoft SSIS, IBM DataStage, and Talend Data Integration. In case of Informatica, such XML transformations corresponds to the following PowerCenter features https://docs.informatica.com/data-integration/powercenter/10-5/xml-guide/midstream-xml-transformations.html https://docs.informatica.com/data-integration/powercenter/10-5/xml-guide/xml-source-qualifier-transformation.html Note that this option may significantly slow down the import. TALEND DATA INTEGRATION OPTIONS -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. The syntax of this option should contain the "Output path" as designated under Talend DI "Project Settings", as well as the "Project Name". For example: -runtime.linage <Output path>/<project name> -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 Job1.tDBRow;tDBInput;tDBOutput where the external runtime lineage log will be taken into account for all use of the tDBInput and tDBOutput components, and only the job 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 fails to import any connection information or any operation internal parameters, this option may be used to help the 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. $$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 from transformation's Native ID. -parameters.output.path <path> Generates parameter files templates to ease parameterizing |
STRING |
Bridge Mapping
Mapping information is not available