2.0 Installation Considerations
2.1 Installing ERwin SPY
2.2 Installing the ERwin API Sample Client
3.0 General Considerations—ERwin Data Modeler API 4.1.4
3.1 Changes to the API for ERwin Data Modeler 4.1.4
3.2 Enhancement to HasProperty Method
3.3 Changes to the ERwin MetaModel for ERwin Data Modeler 4.1.4
4.0 General Considerations—ERwin Data Modeler API 4.1 Service Pack 1
4.1 Changes to the API for ERwin Data Modeler 4.1 Service Pack 1
4.2 Changes to the ERwin MetaModel for ERwin Data Modeler 4.1 Service Pack 1
4.3 Using the ERwin API Sample Client
4.4 Using the ERwin SPY Utility
Welcome to the AllFusion™ ERwin® Data Modeler API. This file presents last-minute product information for version 4.1.4 of the API and its related documentation and sample programs. See the API Reference Guide, which was updated for this release, for detailed information about the API. The API Reference Guide is provided in PDF format in the file ERwinAPI.pdf, and is automatically installed to the \Doc directory beneath the ERwin install directory.
The API is installed automatically during the setup procedure for ERwin Data Modeler. You can choose to install two optional API components during the setup procedure: ERwin SPY, and the ERwin API Sample Client.
When prompted for components to install during setup, select the ERwin SPY Utility check box. After installation, you can access the SPY utility from the Samples\ERwin API subdirectory beneath the ERwin installation directory.
When prompted for components to install during setup, select the ERwin API Sample Client check box. After installation, you can access the two sample Visual Basic 6.0 projects from the Samples\Sample Client subdirectory beneath the ERwin installation directory.
The keyword Trusted Connection (abbreviation: TRC) was added to the list of Locator param keywords for use with the mmart type of provider for models stored in AllFusion Model Manager (ModelMart). This feature applies to SQL Server Version 7 or later, and Oracle Version 8 or later and was added to support the use of Windows authentication for connection to the server.
| Keyword | Description |
|---|---|
| Trusted Connection (TRC) | When set to Yes, it instructs the database driver to use Windows authentication mode for login validation. When omitted, or set to No, it instructs the database driver to use a SQL Server username and password for login validation. |
| User (UID) | Login user name. Need not be specified when using Windows authentication. |
| Password (PSW) | User login password. Need not be specified when using Windows authentication. |
See Chapter 4 of the API Reference Guide, for more information about using Windows authentication to connect to Model Manager. This is discussed under the heading Location and Disposition in Model Directories and Persistence Units.
The ISCModelPropertyCollection, HasProperty method, has been enhanced for this release of the API. In earlier releases an error was returned if the property name was invalid for the current model type. With this release, the HasProperty method returns FALSE if the property name is invalid or not valid for the current model type.
"Metadata Version" is a property of the Model object. The property reflects changes in the metadata. If two models have different values for the property it indicates that the models are based upon different metadata. The property is read-only. A current metadata value for running this version of ERwin can be accessed using ISCApplicationEnvironment PropertyBag method. See the sections ISCApplicationEnvironment Properties and ISCApplicationEnvironment Methods in Chapter 4 of the API Reference Guide for more details. The following objects were added:
Complete Compare Options Report—This is a child of the Model and keeps the settings for the Complete Compare Options Report. This object type has the following properties:
Oracle Overflow Segment—Supports a new Oracle Index Organized Tables feature.
Oracle Physical File—Provides improved support for Oracle Tablespace.
The following properties were added or changed:
Changes to Domain Object Type—An object of Domain type with Object ID {39146A35-A713-4CAA-9FBF-9AA575FA9F44}+00000006 is a top domain in a model's domain hierarchy. This domain is a "default" object. It always exists in every model, cannot be removed, and has a constant object ID. As a top domain in the hierarchy, it does not have a parent domain. The property "Parent Domain" used to have a value of {00000000-0000-0000-0000-000000000000}+00000000. The "Parent Domain" property for the top domain was removed beginning with Version 4.1.4. Instead of looking for the "Parent Domain" property with zero values as an indication of the top of the hierarchy, use one of the following techniques:
New Property Types for Model—Default Table Owner, Default Index Owner.
New Property Types for Entity—Data Organization Type, Table Mapping, PCT THRESHOLD, Compress Prefix Length, Compress Type, Including Column, Index Overflow, Use Parallel, Build Clause, Use Index, Refresh State, Refresh Type, Refresh On What, Refresh Start Date, Refresh Next Date, Refresh With Key, Refresh Master Rollback Seg State, Refresh Master Rollback Seg Reference, Refresh Local Rollback Seg State, Refresh Local Rollback Seg Reference, Updateable, Query Rewrite State. This applies only when the target database is Oracle.
New Property Types for Entity—Sybase TABLELOCK. This applies only when the target database is Sybase.
New Property Types for Oracle Tablespace—Blocksize Value, Local Exten Management Type, Extent Size, Extent Management Type, Minimum Extent, Oracle File Size, Optimal Size Type, Segment Management Type, Undo Tablespace, Oracle Datafile Backup.
New Property Type for Attribute—ATM Linkage.
New Property Type for Attribute—System Maintained. This applies only when the target database is Advantage Ingres.
New Property Types for Attribute—Character Semantics, Timezone Option. This applies only when the target database is Oracle.
Object Order—A positive number to represent a relative position of an object among peers. Used to arrange the proper order for Oracle Partitions, Drawing Objects, Stored Procedures, Script Templates, unified Attributes, Stored Displays, and Subject Areas.
Font and Color Properties—New objects are introduced to represent font and color properties: Font, Color, Default Fonts and Colors Object. New reference properties are introduced as well, as follows:
New Font and Color objects as well as new reference properties should be used to associate Attribute, Drawing Object Entity, Drawing Object Relationship and drawing objects with font and color attributes.
The following properties of Attribute, Drawing Object Entity, Drawing Object Relationship and drawing objects are marked as retired and should no longer be used:
Note: It is still possible to set font and color attributes using these properties. However, since the properties are retired, their values will be converted in new properties and objects. It is not possible to retrieve values for the retired properties, and retired and new properties and objects cannot be mixed in the same transaction.
In this release, the ERwin API introduces a group of new components— Application Environment and Model Directories, and the interfaces associated with them. No changes to the existing ERwin API interfaces were made for this release. The following is a short list of features for the new components. For more detailed information, see the API Reference Guide.
The following features of the new components are not implemented in the API for this service pack:
The following properties were added:
Two Visual Basic 6.0 sample projects are provided with the API. ERwinSpy_Sample.vbp is a stand-alone version of a sample program. ErwinSpy_Addin_Sample.vbp is an add-in version of a sample program.
ERwinSpy_Sample.vbp—You can build ERwinSpy_Sample.vbp to create the ERwinSpy_Sample.exe program. This program is an ERwin model data browser that you can use to research ERwin data internals, such as the ERwin metamodel, ERwin model data, and model objects and their properties.
Using ERwinSpy_Sample.exe, you can open an ER1 file by choosing Open from the File menu. When a model is opened or selected from Model menu, model objects from the model are displayed in the left pane. You can view a model object's hierarchy (parents and children) by double-clicking on the object. You can view the properties of an object by clicking the button between the left and right panes in the center of the program screen.
The Modules menu shows in-memory models that are currently open. You can use the upper part of the menu to access model data, and you can use the lower part to access the metamodel information associated with the model.
ErwinSpy_Addin_Sample.vbp—You can build ERwinSpy_Addin_Sample.vbp to create an add-in component that runs from the ERwin Tools/Add-Ins menu.
After you build the add-in component by using the ErwinSpy_Addin_Sample.vbp project, you must register the component using the ERwin Tools/Add-ins/Customize menu.
In the Add-In Manager dialog, click the Add Menu Item button on the toolbar. In the Add New Menu Item dialog, set Name to AddIn Sample; COM ProgId to ERwinSpy_AddIn_Sample.ErwinSpy and Function Name to Run. Note that in the Menu Type box on the dialog, you should select Com Object. Click Save to save your settings. When the sequence is executed, a new menu item is created in the ERwin Tools menu under Add-Ins. The name of the item matches the text that was typed in Name field of the customization dialog (in this case, AddIn Sample). You can select this new menu item to activate the add-in sample component. The Models menu of the add-in shows the models opened in ERwin.
The ERwin SPY Utility is found in the Samples\ERwin API\ERwin Spy subdirectory, beneath the directory where you installed ERwin. This utility consists of a standalone version of the program, ERwinSpy.exe, and an add-in version, ErwinSpy_Addin.dll. The directory also has a help file to provide information about the ERwin SPY Utility.
To register the ERwin SPY component with ERwin, first register the add-in component with the system registry:
regsvr32.exe <ERwin installation directory\Samples\ERwin API\ERwin Spy>ErwinSpy_Addin.dll
Use the following procedure to register the add-in with ERwin so that it appears on the Add-Ins option on the Tools menu in ERwin:
Note: The ERwin SPY Utility uses one of the standard Microsoft grid controls— MSFLXGRD.OCX. The control is usually located in your system directory. You can also find a copy of the control in the ERwin SPY directory. If you are working with an earlier version of MSFLXGRD.OCX (before 6.x.x) you may see a message indicating that the grid control needs to be upgraded. In that case, please copy the MSFLXGRD.OCX file in your system directory and register it by using the regsvr32.exe utility described earlier.
For further technical assistance with this product, contact Technical Support at ca.com/supportconnect for a complete list of locations and phone numbers. Technical support is available 24 hours a day, 7 days a week.