IBM InfoSphere Data Architect (IDA) - Import
Availability-note
AWS
AWS-only features are available at any of the following URLs: us.cloud.talend.com, eu.cloud.talend.com, ap.cloud.talend.com
Bridge Requirements
This bridge:requires the tool to be installed to access its SDK.
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] Data Store (Physical Data Model, Logical Data Model, Stored Procedure Expression Parsing), Graphical Layout via Eclipse Java API on LDM or DBM XML File |
| Data Profiling |  |
| Incremental Harvesting | |
| Multi-Model Harvesting | |
| Remote Repository Browsing for Model Selection | |
SPECIFICATIONS
Tool: IBM / InfoSphere Data Architect (IDA) version 6.1 to 9.1 via Eclipse Java API on LDM or DBM XML File
See http://www.ibm.com/software/data/integration/rda/
Metadata: [Data Modeling] Data Store (Physical Data Model, Logical Data Model, Stored Procedure Expression Parsing), Graphical Layout
Component: IbmRationalDataArchitect version 12.0.0
OVERVIEW
This import bridge imports data models from the Data Architect software, including selected models from a project with logical Entities, Attributes, Domains, and/or (related) physical models with Tables, Columns, Data Types. This import bridge also imports all relationships and their implementation (e.g. PK/FK) as well as the graphical layout of the data models (diagrams).
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 MIMB Known Limitations
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 | ||||||||||||||||
| File | File path of the Data Architect physical, logical or domain model file (.DBM, .LDM or .DDM) to import. | FILE |
|
Mandatory | ||||||||||||||||
| Project | The directory path of the Data Architect project. It is used to detect references to Domain Models. | DIRECTORY | ||||||||||||||||||
| Import dimensional diagrams as | Data Architect models may use dimensional notation, allowing tables to be marked as a Dimension or Fact. The model may contain one or more relational diagrams in addition to one or more dimensional diagrams. In order to ensure the correct forward engineering into Business Intelligence tools, specify how diagrams are converted: 'Dimensional diagrams only' The diagram will only display the dimensions and facts. 'Relational diagrams only' The diagram will only display the relational tables. This is the default option. 'Relational and dimensional' The diagram will display both the dimensions, facts, and the associated relational tables. |
ENUMERATED |
|
Relational and dimensional | ||||||||||||||||
| 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 | |||||||||||||||||
| 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 | |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| AssociationRole | Relationship / Foreign Key | Two roles are created for each Relationship |
| Description | Documentation | |
| Multiplicity | Existence, Cardinality | |
| Name | Verb Phrase, Inverse Verb Phrase / Label | |
| OnDelete | Referential Integrity: Delete | |
| OnInsert | Referential Integrity: Insert | |
| OnUpdate | Referential Integrity: Update | |
| PhysicalName | Name | |
| Source | set to True on the Primary/Candidate Key side | |
| Attribute | Attribute / Column | |
| Description | Documentation | |
| InitialValue | Default Value | |
| Name | Label | |
| Optional | Required / Not Null | |
| PhysicalName | Name | |
| Position | derived from the position in the Entity/parent table | |
| BaseType | Attribute / Column Datatype | |
| DataType | See datatype conversion array | |
| Name | Based on the datatype | |
| PhysicalName | Derived from the datatype | |
| BusinessRule | Domain Constraint, Entity Constraint, Check Constraint | Each constraint is imported as a BusinessRule and connected to its applicable object (LDM). Table level CheckConstraints are imported as BusinessRules (DBM) |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| Type | set to ENUMERATION_LIST for Domain Enumeration Constraint set to PHYSICAL_TEXT for Entity SQL Constraints set to LOGICAL_TEXT for Entity non-SQL Constraints | |
| Value | Expression | |
| CandidateKey | PrimaryKey, AlternateKey, InversionEntry | |
| Comment | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| UniqueKey | set to TRUE for PrimaryKey, AlternateKey set to FALSE for InversionEntry | |
| Class | Entity / Table | |
| CppClassType | Set to ENTITY | |
| CppPersistent | Set to True | |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| ClassDiagram | Diagram | |
| Description | Not used | |
| Name | Name | |
| PhysicalName | Not used | |
| DatabaseSchema | Schema | A default schema is created to connect the entities to the default catalog in LDM |
| Comment | default in LDM | |
| Description | Documentation | default in LDM |
| Name | Label | default in LDM |
| PhysicalName | Name | default in LDM |
| DerivedType | Attribute Type, Domain / Column DataType, Distinct UserDefined Type | |
| DataType | Item type | See datatype conversion array |
| Description | Documentation | |
| Length | Length | or inherited from a Domain Length Constraint, if any |
| LowerBound | inherited from a MinimumInclusive (or MinimumExclusive) constraint | |
| Name | Label | Based on the datatype |
| NativeDataType | Item type / DataType | If the Item type is another Domain, use the parent Domain Item type see the DataType conversion array |
| PhysicalName | Name | Derived from the datatype (DBM) |
| Scale | Scale | or inherited from a Domain FractionDigit Constraint, if any |
| UpperBound | inherited from a MaximumInclusive (or MaximumExclusive) constraint | |
| UserDataType | set to FALSE(LDM), set to TRUE for Distinct UserDefined Type, FALSE otherwise (DBM) | |
| UserDefined | set to TRUE for Domains (LDM), set to TRUE for Distinct UserDefined Type, FALSE otherwise (PDM) | |
| DesignPackage | Package(LDM) / Schema (DBM) | An equivalent DesignPackage is created for each DatabaseSchema |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| UserDefined | set to TRUE (LDM), False (DBM) | |
| ForeignKey | ForeignKey | |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| Generalization | Generalization | |
| 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 | |
| Name | Label | |
| PhysicalName | Name | |
| Unique | Unique | |
| IndexMember | IndexColumn | |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| Position | column position | |
| SortOrder | SortOrder | |
| Note | Diagram Note | Notes attached to Entities are imported as Notes |
| Name | Not used | |
| Value | Description | |
| Projection | Diagram Node | |
| BackgroundColor | FillColor | |
| Bold | Bold | |
| FontColor | FontColor | |
| FontName | FontName | |
| FontSize | FontSize | |
| Height | Height | The height is not available if the box is in AutoSize mode |
| Italic | Italic | |
| LineColor | LineColor | |
| Name | Not used | |
| Strike | StrikeThrough | |
| Underline | Underline | |
| Width | Width | The width is not available if the box is in AutoSize mode |
| X | X | |
| Y | Y | |
| PropertyElementTypeScope | User Defined Property | |
| Scope | Object type the property applies to | |
| PropertyType | User Defined Property | |
| DataType | set to VARCHAR | |
| Name | Name | |
| Usage | set to USER | |
| 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 | |
| SQLViewAttribute | ViewColumn | |
| Description | Documentation | |
| Name | Label | |
| Optional | Not Null | |
| PhysicalName | Name | |
| Position | column position | |
| SQLViewEntity | View | |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| WhereClause | SQL | |
| StoreModel | Logical Data Model/Physical Data Model | The model is built using the elements contained in the .LDM file |
| Name | file name | |
| SystemType | Database Type and Version | set to <Logical> for LDM |
| SystemTypeOld | Database Type and Version | set to <Logical> for LDM |
| 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 | |
| Description | Documentation | |
| Name | Label | |
| PhysicalName | Name | |
| Trigger | Trigger | |
| Description | Documentation | |
| FireOnDelete | Delete | |
| FireOnInsert | Insert | |
| FireOnUpdate | Update | |
| Name | Label | |
| PhysicalName | Name | |
| Semantics | Source | |
| TriggerType | ActionTime | |
| TypeValue | Value | No equivalent in RDA DBM, only used in LDM.Each Value of an EnumerationConstraint is imported as TypeValue |
| Description | Description | |
| Name | Label | |
| Position | derived from the Value position in the Enumeration List | |
| Value | Name |