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

MIMB Bridge Documentation

MIMB Import Bridge from Talend Data Integration

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

SPECIFICATIONS
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

DISCLAIMER
This bridge requires internet access to https://repo.maven.apache.org/maven2/ (and exceptionally a few other tool sites)
in order to download the necessary third party software libraries 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 access to internet, that directory can be copied from another server with internet access.
By running this bridge, you hereby acknowledge responsibility for the license terms and any potential security vulnerabilities from these downloaded third party software libraries.

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

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;

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

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

DATA FLOW 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 NewConnection=OldConnection
Renames an existing connection to a new name, e.g.
-connection.rename NewConnectionName=OldConnectionName
Multiple existing connections can be renamed and merged into one new connection, e.g.
-connection.rename MyDatabase=MySchema1 -connection.rename MyDatabase=MySchema2
-connection.rename MyFileSystem=MyUser1 -connection.rename MyFileSystem=MyUser2

-connection.split
Splits a connection into one or multiple 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 data store connection can be explicitly split creating a new connection by appending a schema name to a database, or a relative path to a file system, e.g.
-connection.split MySchema1=MyDatabase.schema1
-connection.split MyUser1=MyFileSystem/user1

-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 a symbolic link like /users/john, e.g.
-connection /data=/users/John

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

-script <file>
Runs additional javaScript. Sometimes expression uses custom code function call. Custom code is not supported by the bridge. Expression analyzer will fail in such case. User can write javaScript to create custom code stub. This javaScript will help to evaluate custom functions.

Additional semicolon separated parameters for debug purposes.
-zip <path>
Compress project into a zip file. Removes sensitive data with type 'password' or field name 'password'. E.g.
-zip C:\temp

-cfd <new delimiter>
Used with Context File Directory option. Replaces default name-value delimiter with new value. E.g.
-cfd ~#*#~
STRING      

 

Bridge Mapping

Mapping information is not available

Last updated on Fri, 25 Sep 2020 17:37:51

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.