Bridge Specifications
| Vendor | IBM |
| Tool Name | InfoSphere Data Architect (IDA) |
| Tool Version | 6.1 to 9.1 |
| Tool Web Site | http://www.ibm.com/software/data/integration/rda/ |
| Supported Methodology | [Data Modeling] Multi-Model, Data Store (Physical Data Model, Logical Data Model, Stored Procedure Expression Parsing), Graphical Layout via Eclipse Java API on LDM or DBM or DDM XML File |
SPECIFICATIONS
Tool: IBM / InfoSphere Data Architect (IDA) version 6.1 to 9.1 via Eclipse Java API on LDM or DBM or DDM XML File
See http://www.ibm.com/software/data/integration/rda/
Metadata: [Data Modeling] Multi-Model, Data Store (Physical Data Model, Logical Data Model, Stored Procedure Expression Parsing), Graphical Layout
Component: IbmRationalDataArchitect version 12.0.0
OVERVIEW
This import bridge generates physical or logical model files (.DBM or .LDM).
REQUIREMENTS
The import bridge depends on a set of plugin files that you can find under your Data Architect's plugins directories in version 6.1 or in the shared directory in version 7.
Here is the list of ids for the required plugin files:
org.eclipse.gmf.runtime.notation
org.eclipse.emf.common
org.eclipse.emf.ecore.xmi
org.eclipse.emf.ecore
org.eclipse.emf.commonj.sdo
org.eclipse.emf.ecore.sdo
org.eclipse.wst.rdb.models.sql
com.ibm.db.models.db2
com.ibm.datatools.datanotation
com.ibm.db.models.logical
com.ibm.db.models.oracle
com.ibm.db.models.teradata
LIMITATIONS
Refer to the current general known limitations at https://metaintegration.com/Products/MIMB/Help/#!Documents/mimbknownlimitations.html
FREQUENTLY ASKED QUESTIONS
n/a
Bridge Parameters
| Parameter Name | Description | Type | Values | Default | Scope | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Version | The version of Data Architect you want to connect to, which must must be installed on the computer running this import bridge. | ENUMERATED |
|
Latest | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Directory | Directory where to generate Data Architect physical and/or logical model files (.DBM or .LDM). | DIRECTORY | Mandatory | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Base file name | Base name of the file(s) to produce. The import bridge uses the target directory and base file name in combination with the file extension (.DBM or .LDM) to produce the complete output file pathname. When converting a single model, this import bridge may generate 1 or 2 LDM, DBM files, depending on the 'Design level' parameter and the design level of the source model. The name of these files may be specified in this import bridge parameter, or it will be computed from the source model name. When exporting from multi-model sources, this import bridge may generate many LDM and DBM files, named according to their original names from the source tool. |
STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Design level | Design level of the data model to generate: 'Auto detect' Generates a data model according to the design level set in the source tool. 'Logical only' Generate a Logical Data Model. 'Physical only' Generate a Physical Data Model. |
ENUMERATED |
|
Auto detect | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Target database | Specifies the database type of the generated physical model (if any). Database object 'Type' and 'Version' properties will be set accordingly. All column datatypes will be generated according to datatypes available for that database type. The Tables and Columns names are not automatically changed by this parameter. If the selected database has specific name length constraints, the names may have to be updated manually. E.g. 'Auto detect' The import bridge will attempt to auto-detect the target database from the source model. 'IBM DB2 UDB V9.8' 'Teradata 14.x' |
ENUMERATED |
|
Auto detect | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Installation directory | The full path to the Data Architect installation directory. This directory is used to search for proper JAR files used by the import bridge. For version 7.x, it should contain the Eclipse 'configuration' directory where the file 'platform.xml' exists. E.g. 'C:\Program Files\IBM\IDA7.6.0' For version 7.6.0 'C:\Program Files\IBM\IDA7.5.2' For version 7.5.2 'C:\Program Files\IBM\SDP' For version 7.5.x 'C:\Program Files\IBM\SDP70' For version 7.0.x For version 6.x, it should contain the Eclipse 'plugins' directory. E.g. 'C:\Program Files\IBM\Rational\RDA\V6.1' For version 6.1 |
DIRECTORY | Mandatory | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Connection | Allows selecting a connection by name, if the source model contains multiple database connections. If the source model contains multiple connections and this parameter value is left empty, the connection with the most objects is selected. |
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) |
STRING |
Bridge Mapping
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"IBM InfoSphere Data Architect (IDA)" Metamodel IbmRationalDataArchitect |
Mapping Comments |
| Name | Label | |
| Argument | Parameter | |
| DefaultValue | Not used | |
| Description | Documentation | |
| Kind | Mode | |
| Name | Label | |
| PhysicalName | Name | |
| Position | position of the argument in the Procedure or Function | |
| Association | Relationship / Foreign Key | |
| Aggregation | Identifying / Not Identifying | |
| Description | Documentation | Not used |
| ExtraConstraint | Not used | |
| Name | Label | Not used |
| PhysicalName | Name | Not used |
| UserDefined | Not used | |
| AssociationRole | Relationship / Foreign Key | Two roles are created for each Relationship |
| CppContainment | Not used | |
| CppFriend | Not used | |
| CppScope | Not used | |
| CppStatic | Not used | |
| Description | Not used | |
| ExtraConstraint | Not used | |
| Multiplicity | Existence, Cardinality | |
| Name | Verb Phrase, Inverse Verb Phrase / Label | |
| Navigable | Not used | |
| OnDelete | Referential Integrity: Delete | |
| OnInsert | Referential Integrity: Insert | |
| OnUpdate | Referential Integrity: Update | |
| Ordered | Not used | |
| PhysicalName | Not used | |
| Position | Not used | |
| Source | Identifies the parent side (PrimaryKey) of the relationship | |
| Attribute | Attribute / Column | |
| Description | Documentation | |
| ExtraConstraint | Not used | |
| InitialValue | DefaultValue | Not used |
| Name | Label | |
| Optional | Required / Not Null | Not used |
| PhysicalName | Name | |
| Position | position in the entity/table | |
| BaseType | Attribute / Column Datatype | No equivalent, Attributes linked to a BaseType are exported with their ItemType set to the equivalent DataType |
| DataType | Datatype | see datatype conversion array |
| Description | Not used | |
| Length | Length | |
| Name | Not used | |
| PhysicalName | Not used | |
| Scale | Scale | |
| BusinessRule | Domain Constraint, Entity Constraint, Check Constraint | BusinessRules related to Class and Attribute are exported as Entity Constraint BusinessRules related to user-defined DerivedType are exported as DomainConstraint (LDM). BusinessRules of type TextPhysical and associated to Attributes and Classes are exported as Table CheckConstraints (DBM) |
| Description | Documentation | |
| LowerBound | Not used | |
| Name | Label | |
| PhysicalName | Name | |
| Type | export Enumeration Constraint if set to ENUMERATED_LIST export Entity Constraint if set to PHYSICAL_TEXT and related to Class or Attribute (LDM). only BusinessRules of type TEXT_PHYSICAL are exported (DBM) | |
| UpperBound | Not used | |
| Value | Not used | |
| CandidateKey | PrimaryKey, AlternateKey, InversionEntry | |
| Comment | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| UniqueKey | InversionEntry if set to FALSE (LDM). A UniqueConstraint is created for each CandidateKey A PrimaryKey is created if the CandidateKey is Primary of its Class (DBM) | |
| Class | Entity / Table | |
| CppAbstract | Not used | |
| CppClassType | Not used | |
| CppConcurrency | Not used | |
| CppMultiplicity | Not used | |
| CppPersistent | Not used | |
| CppScope | Not used | |
| CppSpace | Not used | |
| Description | Documentation | |
| DimensionalRole | Not used | |
| DimensionalType | Not used | |
| Name | Label | |
| PhysicalName | Name | |
| ClassDiagram | Diagram | |
| Description | Not used | |
| Name | Name | |
| PhysicalName | Not used | |
| DatabaseSchema | Schema | |
| Comment | default in LDM | |
| Description | Documentation | default in LDM |
| Name | Label | default in LDM |
| PhysicalName | Name | default in LDM |
| DerivedType | AtomicDomain, Attribute DataType | |
| DataType | Item type | Use the parent DerivedType as ItemType if it defined as a Domain, otherwise, map the DataType to a base ItemType (see datatype conversion array) |
| Description | Documentation | |
| InitialValue | Not used | |
| Length | create a Length Constraint to represent the length | |
| LowerBound | create a MaximumInclusive Constraint to represent the lowerBound property | |
| Name | Label | Based on the datatype |
| NativeDataType | Not used | |
| NativeLogicalDataType | Not used | |
| PhysicalName | Name | Derived from the datatype (DBM) |
| Scale | create a FractionDigit Constraint to represent the scale | |
| UpperBound | create a MinimumInclusive Constraint to represent the upperBound property | |
| UserDataType | Not used | |
| UserDefined | Only UserDefined DerivedTypes are exported as Domain | |
| DesignPackage | Package | |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| UserDefined | Only UserDefined DesignPackages are exported | |
| ForeignKey | ForeignKey | |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| Generalization | Generalization | |
| CppFriend | Not used | |
| CppScope | Not used | |
| CppVirtual | Not used | |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| GeneralizationRole | Generalization | |
| Identity | Identity properties | |
| Cycle | Cycle | |
| IncrementValue | Increment By | |
| MaximumValue | Maximum Value | |
| MinimumValue | Minimum Value | |
| StartValue | Starting Value | |
| Index | Index | |
| Clustered | Clustered | |
| Description | Documentation | |
| Generate | Not used | |
| Name | Label | |
| PhysicalName | Name | |
| Unique | Unique | |
| IndexMember | IndexColumn | |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| Position | index member position in its Index | |
| SortOrder | SortOrder | |
| Operation | Function | |
| CppAbstract | Not used | |
| CppConcurrency | Not used | |
| CppFriend | Not used | |
| CppScope | Not used | |
| CppStatic | Not used | |
| CppVirtual | Not used | |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| Position | Not used | |
| Postcondition | Not used | |
| Precondition | Not used | |
| Semantics | Source | |
| Projection | Diagram Node | |
| BackgroundColor | FillColor | |
| Bold | Bold | |
| FontColor | FontColor | |
| FontName | FontName | |
| FontSize | FontSize | |
| Height | Height | The height is not exported in order to Autosize the box |
| Italic | Italic | |
| LineColor | LineColor | |
| Name | Not used | |
| Strike | StrikeThrough | |
| Underline | Underline | |
| Width | Width | The width is not exported in order to Autosize the box |
| X | X | |
| Y | Y | |
| PropertyElementTypeScope | User Defined Property | |
| Scope | Object type the property applies to | |
| PropertyType | User Defined Property | |
| DataType | set to VARCHAR | |
| Description | Not used | |
| DesignLevel | Not used | |
| Group | Not used | |
| InitialValue | Not used | |
| Name | Name | |
| PhysicalName | Not used | |
| Position | Not used | |
| Usage | only USER properties are exported | |
| PropertyValue | User Defined Property | |
| Value | Value | |
| RelationshipProjection | Diagram Edge | |
| BackgroundColor | FillColor | |
| Bold | Bold | |
| FontColor | FontColor | |
| FontName | FontName | |
| FontSize | FontSize | |
| Height | Not used | |
| Italic | Italic | |
| LineColor | LineColor | |
| LinePoints | BendPoints | |
| Name | Not used | |
| Strike | StrikeThrough | |
| Underline | Underline | |
| Width | Not used | |
| X | Not used | |
| Y | Not used | |
| SQLViewAssociation | View Dependency | |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| SQLTableSequence | Not used | |
| SQLViewAttribute | ViewColumn | |
| Description | Documentation | |
| Expression | Not used | |
| Name | Label | |
| Optional | Not Null | |
| PhysicalName | Name | |
| Position | column position | |
| SQLViewEntity | View | |
| Description | Documentation | |
| DimensionalRole | Not used | |
| Name | Label | |
| PhysicalName | Name | |
| WhereClause | SQL | |
| StoreModel | Package / Physical Data Model | A root Package is created to represent the Model |
| Description | Documentation | Not used in DBM |
| Name | Label / DBM File Name | |
| PhysicalName | Name | Not used in DBM |
| SystemMajorVersion | Not used | |
| SystemMinorVersion | Not used | |
| SystemReleaseVersion | Not used | |
| SystemType | Database Type and Version | set to <Logical> for LDM. The value can be overloaded with the "Target database" bridge option for DBM |
| SystemTypeOld | Database Type and Version | set to <Logical> for LDM. The value can be overloaded with the "Target database" bridge option for DBM |
| StoredProcedure | Procedure | |
| CppAbstract | Not used | |
| CppConcurrency | Not used | |
| CppFriend | Not used | |
| CppScope | Not used | |
| CppStatic | Not used | |
| CppVirtual | Not used | |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| Position | Not used | |
| Postcondition | Not used | |
| Precondition | Not used | |
| Semantics | Source | |
| Synonym | Alias | |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| Trigger | Trigger | |
| CppAbstract | Not used | |
| CppConcurrency | Not used | |
| CppFriend | Not used | |
| CppScope | Not used | |
| CppStatic | Not used | |
| CppVirtual | Not used | |
| Description | Documentation | |
| FireOnDelete | Delete | |
| FireOnInsert | Insert | |
| FireOnUpdate | Update | |
| Name | Label | |
| PhysicalName | Name | |
| Postcondition | Not used | |
| Precondition | Not used | |
| Semantics | SQL | |
| TriggerType | ActionTime | |
| TypeValue | Value | No equivalent and not exported in RDA DBM, only used in LDM.Each Value of an EnumerationConstraint is imported as TypeValue |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| Position | position in the list | |
| Value | Name |