Bridge Specifications
| Vendor | IBM |
| Tool Name | InfoSphere Information Governance Catalog (IGC) |
| Tool Version | 11.x |
| Tool Web Site | http://www.ibm.com/software/products/en/infosphere-information-governance-catalog |
| Supported Methodology | [Metadata Management] Multi-Model, Metadata Repository, Data Store (Record Model, Xml Schemas, Object Model UML Class Diagrams, Physical Data Model, Logical Data Model, OLAP Dimensional Model, Stored Procedure Expression Parsing), OLAP/ROLAP/MOLAP, BI Design (RDBMS Source, OLAP Source, Dimensional Target, Transformation Lineage), BI Report (Relational Source, Dimensional Source, Report Structure) via REST API on XML File |
SPECIFICATIONS
Tool: IBM / InfoSphere Information Governance Catalog (IGC) version 11.x via REST API on XML File
See http://www.ibm.com/software/products/en/infosphere-information-governance-catalog
Metadata: [Metadata Management] Multi-Model, Metadata Repository, Data Store (Record Model, Xml Schemas, Object Model UML Class Diagrams, Physical Data Model, Logical Data Model, OLAP Dimensional Model, Stored Procedure Expression Parsing), OLAP/ROLAP/MOLAP, BI Design (RDBMS Source, OLAP Source, Dimensional Target, Transformation Lineage), BI Report (Relational Source, Dimensional Source, Report Structure)
Component: IbmOpenIGC version 11.2.0
OVERVIEW
The IBM Information Governance Catalog (IGC) application is based on the IBM InfoSphere Information Server (IIS).
This export import bridge uses the OpenIGC REST API to produce XML files for IGC only in the case of import bridge from:
- Data Integration (DI / ETL / ELT, SQL DML Scripts)
- Business Intelligence (BI) import bridges (e.g. Tableau, PowerBI)
This export import bridge also detects when a data store import bridge was used:
- RDBMS import bridges via JDBC or DDL (e.g. SQL Server, Snowflake)
- Data Modeling (e.g. Erwin DM)
- File System (e.g. Amazon S3) not hierarchical (e.g. JSON)
and automatically invokes the IBM InfoSphere Information Server (IIS) export import bridge to produce IIS XML files, and then invokes the IBM ISTOOL utility to load these files into IIS. In such case, OpenIGC is not used, but the data stores are populated in IIS and can be visible in IGC.
REQUIREMENTS
When exporting a data integration or business intelligence model, you must use the "Connections" parameter to reconcile these connections with already imported actual data stores, that the DI/BI models connect from and/or to. Please see details in the parameter tooltip.
When exporting a data store model, you must use the "IBM InfoSphere Information Server installation directory" parameter for the IIS export import bridge to work.
FREQUENTLY ASKED QUESTIONS
Q: Why is the column level lineage not visible for for DI/BI imports?
A: Verify that the "%MIMB_HOME%\conf\MIRModelBridgeTemplate\IbmOpenIGCExport\MitiDataIntegration\MitiDataIntegration_v_1_0_asset_type_descriptor.zip\asset_type_descriptor.xml"
XML file contains the following under the Class element:
<class canHaveImage="true" localId="Class" containerClassRefs="DatabaseSchema,DiRuntimeContent,Transformation">
<label inDefaultLocale="Table" key="class.Class"/>
<pluralLabel inDefaultLocale="Table" key="class-plural.Class"/>
</class>
LIMITATIONS
Refer to the current general known limitations at https://metaintegration.com/Products/MIMB/Help/#!Documents/mimbknownlimitations.html
1- Hierarchy Levels
The Open IGC interface is limited in the number of hierarchy levels it supports. As an IGC expert explained:
- The best practice is to only go 5 levels deep for five "available for lineage" levels (it is a limit of IGC).
- Organizational levels beyond that (hopefully) will not affect the algorithm.
The result is the export bridge to Open IGC cannot export lineage inside of transformations, and thus it supports lineage at the transformation level only and uses the SummaryMap to map column level lineage as a summary overview.
2- Data flow Control Lineage
As there is no concept of data flow control lineage in Open IGC, no control lineage will be exported.
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 |
| URL | IBM InfoSphere Information Governance Catalog REST API base URL. Example: https://IbmIs115:9443/ibm/iis/igc-rest/v1/metadata |
STRING | https://IbmIs115:9443/ibm/iis/igc-rest/v1/metadata | Mandatory | |
| User | Name of the user account on the services tier. The account should have rights to import metadata using ISTOOL and access Open IGC REST API. |
STRING | Mandatory | ||
| Password | Password for the account that is specified in the User parameter. | PASSWORD | Mandatory | ||
| IBM InfoSphere Information Server installation directory | The full path to the IBM InfoSphere Information Server installation directory or the /ASBNode/lib/java directory where the IBM JAR files reside. If the installation directory is specified, it should contain the /ASBNode/lib/java directory with JAR files that the import bridge depends on, e.g. c:\IBM\InformationServer on Windows and /opt/IBM/InformationServer on Linux. The IIS libraries have internal references with absolute, rather that relative paths. Therefore, if you copy these libraries from a machine with IIS installed, you must place them in the same exact location as where you copied from. The import bridge uses IBM JAR files residing in the \ASBNode\lib\java directory and ISTOOL executable file residing in the \Clients\istools\cli directory. ISTOOL is a command line tool that is used to import assets into the metadata repository of InfoSphere Information Server (IIS). You can install the tool by selecting the Client option of the IIS installer. The tool is necessary when you need to get "implemented data resources", including database schemas and database tables, from databases and DDL scripts to IGC. The tool is NOT necessary when you need to get into IGC a data flow metadata from DI tools and SQL scripts. In this case, leave the parameter value empty. Databases and DDL scripts can have the lineage metadata of Views and Stored procedures. You can import this metadata for a database that is already in IGC by leave this parameter value empty and specifying the database identify information using host and database parameters. |
DIRECTORY | |||
| Mapping system name | Name of the top folder in the mapped directory structure where to import the mapping metadata (e.g. ETL, SQL script). Leave it empty to use the root name (e.g. ETL repository name, top SQL script folder) from the import. |
STRING | |||
| Host system name | Name of the computer that hosts the actual database that the design is for. This value is important for reconciling the identity of the object in the repository. The name that you enter is used if it cannot be determined from the import. |
STRING | Unknown | ||
| Database name | Name of the actual database that the design is for. This value is important for reconciling the identity of the object in the repository. The name that you enter is used if it cannot be determined from the import |
STRING | Unknown | ||
| Schema name | Name of the actual database schema that the design is for. This value is important for reconciling the identity of the object in the repository. The name that you enter is used if it cannot be determined from the import. |
STRING | Unknown | ||
| Connections | When exporting metadata (e.g. Data Integration / ETL) that connects to datastores (e.g., databases, filese, etc.), after the metadata is exported to IGC, it will still not be connected withing IIS to those (already imported) datastores. However, instead of manually connecting after the face, you may use this parameter to reconcile these connections with the (already imported) actual database models that the data integration metadata is for (connects to). Use this parameter to instruct the import bridge to resolve connections against databases and files directly by specifying their details that identify them in IIS, like host, database and schema names in the following format: "Connection_name"="Host_name"."Database_Name"."Schema_Name" or for file store: "Connection_name"="Host_name"."URL_path"."URL_scheme" When you specify multiple connections, please separate them with a comma (","). For example: "c1"="192.168.3.4"."db"."schema","c2":="localhost"."db2"."schema" When you leave this parameter empty (default), the import bridge creates Virtual Connections that you can reconcile manually by going to the Lineage Administration/Data Connection Mappings in IIS. Note that Virtual Connections are different from the connections produced when you specified connection name mappings within this parameter. You can request the import bridge to output all available connections as a string in the log by specifying a single question mark ("?") and nothing else. Then replace the default Host_name, Database_Name and Schema_Name in the string with the actual names used in IIS for the host, database and schema. Once you have a proper string, then execute the export import bridge again with that edited string as this parameter. |
STRING | |||
| 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> Allows to save the input metadata for further troubleshooting. The provided <directory> must be empty. -restore <directory> Specify the backup <directory> to be restored. 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.caseinsensitive ConnectionName... Overrides the default case sensitive 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.caseinsensitive "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) OPEN IGC OPTIONS -control.export Export the control summary map dependency. By default, the bridge will not do so. |
STRING |
Bridge Mapping
Mapping information is not available