erwin 9.x and 2019 R1 Mart - Import - 7.1

Talend Data Catalog Bridges

author
Talend Documentation Team
EnrichVersion
7.1
EnrichProdName
Talend Big Data Platform
Talend Data Fabric
Talend Data Management Platform
Talend Data Services Platform
Talend MDM Platform
Talend Real-Time Big Data Platform
EnrichPlatform
Talend Data Catalog

Bridge Requirements

This bridge:
  • is only supported on Microsoft Windows.

  • requires the tool to be installed to access its SDK.

Bridge Specifications

Vendor erwin, Inc.
Tool Name erwin Mart
Tool Version 9.x to 2019
Tool Web Site https://erwin.com/products/erwin-data-modeler/
Supported Methodology [Data Modeling] Multi-Model, Metadata Repository, Data Store (Physical Data Model, Logical Data Model, Stored Procedure Expression Parsing), Graphical Layout via COM API
Incremental Harvesting
Multi-Model Harvesting
Remote Repository Browsing for Model Selection
Data Profiling

BRIDGE INFORMATION
Import tool: erwin, Inc. erwin Mart 9.x to 2019 (https://erwin.com/products/erwin-data-modeler/)
Import interface: [Data Modeling] Multi-Model, Metadata Repository, Data Store (Physical Data Model, Logical Data Model, Stored Procedure Expression Parsing), Graphical Layout via COM API from erwin 9.x to 2019 Mart
Import bridge: 'CaMart9' 10.1.0

BRIDGE DOCUMENTATION
This bridge connects to the erwin Data Modeler Workgroup Edition mart using its COM API.
Thus, erwin Data Modeler Workgroup Edition must be installed with a valid license on the machine where the bridge is running. This erwin installation must be able to connect to and open models in the same mart instance with the same connection information as specified in the bridge parameters. Successful import depends upon the erwin API connecting to the mart server.
The erwin libraries used are EAL.dll and ERXML.dll
Starting with Erwin Data Modeler 9.8 / 2019, Erwin requires the user to re-confirm the license in the UI if the tool has not been used for more than 72 hours.
In order to avoid this inconvenience, Erwin Data Modeler should be installed through the 'Offline Activation' email process which is available only on a node locked license.

ERWIN WINDOWS USER:
The bridge must run on behalf of the Windows user that can run the erwin software.
If the bridge is running as part of a Windows desktop application, then you must log on windows with that user.
If the bridge is running as part of a Windows service, then go to the Windows services and click on the 'Properties' menu of such service, go to the 'Log On' tab, select 'This account' and specify the same user name and password used as Windows session when testing connectivity from erwin to the mart, and restart the Windows service.

ERWIN WINDOWS COM API:
The bridge uses the Erwin Windows COM API via simple scripts (ErwinApi.js and ErwinXml.js).
If these scripts are not working properly, contact Erwin support to debug the issue (which may require re-installing erwin).
The scripts can be tested as follows:
cscript.exe //E:jscript //Nologo .\conf\MIRModelBridgeTemplate\ERwin\ERwinApi.js -version 9 -GetVersion
cscript.exe //E:jscript //Nologo .\conf\MIRModelBridgeTemplate\ERwin\ERwinXml.js -version 9 -from eMovies.erwin -to eMovies.xml -log eMoviesLog.txt

FREQUENTLY ASKED QUESTIONS

Q: What are the supported versions?
A: The bridges should work with all versions of 9.x.
Only Marts using SQLServer and Oracle databases are supported.
Marts on Oracle databases are only supported with erwin and Mart version 9.1 or later.

Q: What are the required configuration steps to support large models?
A: First, configure the Mart server with larger java memory settings for the Tomcat application server.
Read this Knowledge Base article for details: http://erwin-knowledgebase.com/index.php?View=entry&EntryID=3724
Then, configure MIMB with larger java memory settings to use in the bridge.
Update the file $MetaIntegration/conf/conf.properties with appropriate -Xmx parameter for a 64 bit JVM, for example:
M_JAVA_HOME=..\jre
M_JAVA_OPTIONS=-Xmx7G
The bridge Miscellaneous parameter can also be used to specify the amount of java memory to allocate.

WARNING ON POTENTIAL POPUP MESSAGES

When importing .erwin models, there is a possibility that erwin may present a popup window that is unavailable for the bridge to respond to.
The result is the bridge will hang during import. A possible workaround recommended by the vendor is to modify the registry as follows, to avoid popup messages:
* Edit the registry on the machine where the bridge is running, using Regedit.exe
* Look for the key:
for version 9.0 to 9.6: HKEY_CURRENT_USER\Software\CA\ERwin Data Modeler\9.0\Messages
for version 9.7: HKEY_CURRENT_USER\Software\erwin\Data Modeler\9.7\Messages
* Add data 'GDM-46=1;' to the value 'Message Status'


Bridge Parameters

Parameter Name Description Type Values Default Scope
Server name Specify here the Mart Server you want to connect to.
For example: localhost
STRING   localhost Mandatory
Server port Specify here the network port number to connect to, on the Mart Server. NUMERIC   18170  
Use IIS This optional parameter is applicable if the Mart server is configured with Microsoft IIS web server.
'True' - Connects to MartServer using IIS, the port number may be dynamically assigned.
'False' - Use the specified port number to connect to MartServer, in which case the port number must be specified.
BOOLEAN
False
True
False  
Use SSL This optional parameter is controls the type of connection to the MartServer.
'True' - Connects to MartServer using SSL (encrypted HTTPS connection).
'False' - Connect to MartServer using a standard HTTP connection.

This parameter is only applicable for erwin Mart version 9.1 or later.
BOOLEAN
False
True
False  
Application name Specify here the name of the application to connect to, on the Mart Server. STRING   MartServer Mandatory
Authentication Specify here the authentication mode you want to use:

'Server Authentication' - Mart Server user name and password.

'Windows Authentication' - windows username and password for secure database access.

In Windows Authentication mode, the bridge parameters 'User name' and 'password' are not used. Instead, the login credentials are inferred from the current windows session running the bridge. If the bridge is executed from a parent application running as a windows service, the bridge uses the credentials under which the windows service was started.
ENUMERATED
Server Authentication
Windows Authentication
Server Authentication  
User name Specify here your user name for Server Authentication. In Windows Authentication mode, this parameter is not used. STRING      
Password Specify here your user password for Server Authentication. In Windows Authentication mode, this parameter is not used. PASSWORD      
Browse mode Specifies what will be retrieved when browsing for available objects in the Mart:

'Libraries and Models' - The tree of Libraries and Models is retrieved. This is the default mode.

'Libraries only' - Only of the list of Libraries is retrieved. Only libraries may be selected in this mode. This mode is more efficient on large Marts.
ENUMERATED
Libraries and Models
Libraries only
Libraries and Models  
Models Specify here a list of erwin model locator strings, separated by semicolon.
For example: mart://Mart/Samples/eMovies
REPOSITORY_SUBSET      
Incremental import Specifies whether to import only the changes made in the source or to re-import everything (as specified in other parameters).

True - import only the changes made in the source.
False - import everything (as specified in other parameters).

An internal cache is maintained for each metadata source, which contains previously imported models. If this is the first import or if the internal cache has been deleted or corrupted, the bridge will behave as if this parameter is set to 'False'.
BOOLEAN
False
True
True  
Import UDPs A User Defined Property (UDP) is usually defined with a property definition object that has a default value. The objects the property applies to may also specify an explicit value for this property, or no value at all in which case the default value of the property definition applies.

This option allows you to control how property definitions and values are imported:

- By default, the bridge imports the property definition as a Property Type.

- 'As metadata' - Import an explicit value as Property Value, implicit values are not imported, the default value is kept on the Property Type only. This is the default behavior.

- 'As metadata, migrate default values' - Import explicit and implicit values as Property Value objects.

- 'In description, migrate default values' - Append the property name and value, even if implicit, to the object's description and/or comment (depending upon the design level). This allows you to export the UDP values to another tool which does not support the notion of UDP.

- 'Both, migrate default values' - Import the UDP value, even if implicit, both as metadata and in the object's description and/or comment (depending upon the design level).
ENUMERATED
As metadata
As metadata, migrate default values
In description, migrate default values
Both, migrate default values
As metadata  
Import relationship name Specifies how to import the relationship names from erwin

'From relationship name' - from the name property. This is the default.

'From derived name' - from the verb phrase derived name.
ENUMERATED
From relationship name
From derived name
From relationship name  
Import column order from Specifies how to import the position of columns in tables
'Column order' - Order of the columns displayed in the erwin physical view.
'Physical order' - Order of the columns in the database, as generated in SQL DDL. This is the default value.

To view the columns physical order in erwin, edit the current subject area 'Stored Display Settings', then click on tab 'Physical', group 'Display Level', then on the 'Physical Order' radio button.
ENUMERATED
Column order
Physical order
Physical order  
Import owner schemas Specifies if owner schemas should be imported.

'True' - The owner schema for Tables, Views and other database objects is imported. This is the default value.

'False' - The owner schema for Tables, Views and other database objects is ignored. This option may be useful for models where physical names are not unique, to indicate the model should be treated as a logical model (not ready for SQL DDL generation) while physical information is still maintained the model.
BOOLEAN
False
True
True  
Import diagrams Specifies if diagrams should be imported.

'None' - Diagrams are not imported.

'Current view' - Only the current view of the diagrams are imported. This is the default value.

'All' - Diagrams are imported twice: once for the logical view and once for the physical view.
ENUMERATED
None
Current view
All
Current view  
Move entities to subject areas erwin entities belong under the model and may be assigned to one or more subject areas. This parameter is useful if the erwin modeler wished to use subject areas as conventional (UML) design packages with their own namespace where any entity may belong to ONLY one subject area.
Specifically, if entities belong to only one subject area, they will be placed in the corresponding package. Other entities are placed under the model. Additionally, this option assumes that all entities are defined within a user defined subject area.
BOOLEAN
False
True
False  
Miscellaneous Specify miscellaneous options identified with a -letter and value.

For example, -m 4G

-v set environment variable(s) (e.g. -v var1=value -v var2="value with spaces").
-m the maximum Java memory size whole number (e.g. -m 4G or -m 2500M ).
-j the last option that is followed by Java command line options (e.g. -j -Dname=value -Xms1G).
STRING      

 

Bridge Mapping

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"erwin 9.x to 2019 Mart"
Metamodel
CA ERwin Data Modeler (Mart)
Mapping Comments
     
DirectoryStructureModel Mart  
CreationTime Creation Time  
Description Description  
ImportDate Import Date  
Name Name  
NativeId Native Id  
NativeType Native Type  
Folder Library  
Author Author  
CreationTime Creation Time  
Description Description  
LastModificationTime Last Modification Time  
Modifier Modifier  
Name Name  
NativeId Native Id  
NativeType Native Type  
StoreContent Model, Template  
Author Author  
CreationTime Creation Time  
Description Description  
LastModificationTime Last Modification Time  
Modifier Modifier  
Name Name  
NativeId Native Id  
NativeType Native Type  

Meta Integration Repository (MIR)
Metamodel
(based on the OMG CWM standard)
"erwin 9.x to 2019 Mart"
Metamodel
CA ERwin Data Modeler (Model)
Mapping Comments
     
Argument Argument  
Comment Comment  
DefaultValue Default Value  
Description Definition  
DesignLevel Design Level  
Kind Kind  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
Position Position  
Association Relationship  
Aggregation Identifying True if identifying
Comment Comment  
Description Definition  
DesignLevel Design Level  
ExtraConstraint Constraint  
Name Name  
NativeId Native Id  
AssociationRole Unnamed RelationshipEnd, Named RelationshipEnd  
Multiplicity Cardinality  
Name Name  
OnDelete On Delete  
OnInsert On Insert  
OnUpdate On Update  
Source Source Based on the multiplicity of each role and the Identifying/Non Identifying property
Attribute Attribute, Column, Primary Key Column - Attribute, Primary Key Attribute, Column - Attribute, Primary Key Column  
Comment Comment  
Description Definition  
DesignLevel Design Level  
ExtraConstraint Constraint if the validation rule cannot be set on the type
Generate Generate  
InitialValue Default Value imported from the default value tag associated to this type
Name Physical Name, Name  
NativeId Native Id  
Optional Nullable  
PhysicalName Physical Name  
Position Position  
BusinessRule Min - Max, Valid Values List, Default Value, User-Defined  
Comment Comment  
Description Definition  
DesignLevel Design Level  
LowerBound Min  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
UpperBound Max  
Value Default Value, Text  
CandidateKey Candidate Key Group  
Comment Comment  
Description Definition  
DesignLevel Design Level  
Name Name  
NativeId Native Id  
PhysicalName Physical Name if set by the user
UniqueKey Unique Key True for Primary Key/Alternate Key, False for Inversion Entries
Class Entity, Table, Table - Entity, Data Source Table  
Comment Comment  
Description Definition  
DesignLevel Design Level  
DimensionalRole Dimensional Role  
DimensionalType Dimensional Type  
Generate Generate  
Name Physical Name, Name  
NativeId Native Id  
PhysicalName Physical Name  
ClassDiagram ER Diagram  
Comment Comment  
Description Definition  
DesignLevel Design Level  
MaxDefinitionLength Max Definition Length  
Name Name  
NativeId Native Id  
Notation Notation  
PhysicalName Physical Name  
Condition Condition  
Name Name  
ConnectionNamespace Folder  
Comment Comment  
Description Definition  
DesignLevel Design Level  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
ConnectionPackage Data Source Schema, Directory  
Comment Comment  
Description Definition  
DesignLevel Design Level  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
DatabaseSchema Database Schema  
Comment Comment  
Description Definition  
DesignLevel Design Level  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
DerivedType Domain The MIR UserDefined property is set to True for User Defined Domains
Comment Comment  
DataType Data Type See datatype conversion arrays
Description Definition  
DesignLevel Design Level  
InitialValue Initial Value imported from the default value tag associated to this type
Length Length extracted from the datatype
LowerBound Lower Bound imported from the validation rule associated to this type
Name Name  
NativeDataType Native Data Type  
NativeId Native Id  
NativeLogicalDataType Native Logical Data Type  
PhysicalName Physical Name computed from the datatype, length and precision
Scale Scale extracted from the datatype
UpperBound Upper Bound imported from the validation rule associated to this type
UserDataType User Data Type  
DesignPackage Subject Area  
Comment Comment  
Description Definition  
DesignLevel Design Level  
Name Name  
NativeId Native Id  
FlatTextFile Data Source File, File  
Comment Comment  
Description Definition  
DesignLevel Design Level  
Name Physical Name, Name  
NativeId Native Id  
PhysicalName Physical Name  
ForeignKey Foreign Key Group  
Comment Comment  
Description Definition  
DesignLevel Design Level  
Generate Generate  
Name Name  
NativeId Native Id  
PhysicalName Physical Name if set by the user
Generalization Subtype Relationship  
Complete Complete  
Description Definition  
DesignLevel Design Level set to Logical Only if involved in a transformation
Exclusive Exclusive  
Name Name  
NativeId Native Id  
GeneralizationRole Subtype Relationship Role  
Description Definition  
DesignLevel Design Level  
Name Name  
NativeId Native Id  
OnDelete On Delete  
OnInsert On Insert  
OnUpdate On Update  
Identity Identity  
Cache Cache  
Cycle Cycle  
IncrementValue Increment Value  
MaximumValue Maximum Value  
MinimumValue Minimum Value  
Name Name  
StartValue Start Value  
Index Index  
Clustered Clustered  
Comment Comment  
Description Definition  
DesignLevel Design Level  
Generate Generate  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
Unique Unique  
IndexMember Index Member  
Comment Comment  
Description Definition  
DesignLevel Design Level  
NativeId Native Id  
Position Position  
SortOrder Sort Order  
Note Note  
Author Author  
Importance Importance  
ModificationTime Modification Time  
Name Name  
NativeId Native Id  
Status Status  
Value Note  
PropertyElementTypeScope UDPs used for UDP values and column physical information specific to Teradata: COMPRESS, CASE and FORMAT
Name Name  
Scope Scope  
PropertyType UDP UDP design level: Logical and/or Physical
DataType Data Type  
Description Definition  
DesignLevel Design Level  
Group Group  
InitialValue Initial Value  
Name Name  
NativeId Native Id  
Position Position  
Usage Usage set to User
SQLViewAssociation View Relationship  
AliasName Alias Name  
Comment Comment  
Description Definition  
DesignLevel Design Level  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
SQLTableSequence Sequence  
SQLViewAttribute View Column  
Comment Comment  
Description Definition  
DesignLevel Design Level  
Expression Expression  
InitialValue Default Value  
Name Name  
NativeId Native Id  
Optional Nullable  
Position Position  
SQLViewEntity View  
Comment Comment  
Description Definition  
DesignLevel Design Level  
DimensionalRole Dimensional Role  
Generate Generate  
GroupByClause Group By Clause  
HavingClause Having Clause  
Name Name  
NativeId Native Id  
OrderByClause Order By Clause  
SelectType Select Type  
ViewStatement View Statement  
ViewStatementType View Statement Type  
ViewType View Type  
WhereClause Where Clause The View SQL if user defined or else the Where clause
Sequence Sequence  
Comment Comment  
DataType Data Type  
Description Definition  
DesignLevel Design Level  
Generate Generate  
Length Length  
Name Name  
NativeDataType Native Data Type  
NativeId Native Id  
Scale Scale  
StoreConnection Model Source, Data Source  
Comment Comment  
Connection Connection  
Description Definition  
DesignLevel Design Level  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
StoreType Store Type  
SystemMajorVersion System Major Version  
SystemMinorVersion System Minor Version  
SystemReleaseVersion System Release Version  
SystemType System Type  
SystemTypeOld System Type Old  
StoreModel Model  
Author Author  
Comment Comment  
CreationTime Creation Time  
Description Definition  
DesignLevel Design Level  
ModificationTime Modification Time  
Modifier Modifier  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
StoreType Store Type  
SystemMajorVersion System Major Version  
SystemMinorVersion System Minor Version  
SystemReleaseVersion System Release Version  
SystemType System Type  
SystemTypeOld System Type Old  
StoredProcedure Stored Procedure  
Comment Comment  
Description Definition  
DesignLevel Design Level  
Generate Generate  
Name Name  
NativeId Native Id  
Postcondition Postcondition  
Precondition Precondition  
Semantics Code  
Synonym Synonym  
Comment Comment  
Description Definition  
DesignLevel Design Level  
Generate Generate  
Name Name  
NativeId Native Id  
Trigger Trigger  
Comment Comment  
Description Definition  
DesignLevel Design Level  
FireOnDelete Fire On Delete  
FireOnInsert Fire On Insert  
FireOnUpdate Fire On Update  
Generate Generate  
Name Name  
NativeId Native Id  
Semantics Code  
TriggerType Trigger Type  
TypeValue Type Value  
Comment Comment  
Description Definition  
DesignLevel Design Level  
Name Name  
NativeId Native Id  
PhysicalName Physical Name  
Position Position  
Value Value