erwin Data Modeler API Reference Release 2019 R1 Legal Notices This Documentation, which includes embedded help systems and electronically distributed materials (hereinafter referred to as the “Documentation”), is for your informational pur- poses only and is subject to change or withdrawal by erwin Inc. at any time. This Docu- mentation is proprietary information of erwin Inc. and may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of erwin Inc. If you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Docu- mentation for internal use by you and your employees in connection with that software, provided that all erwin Inc. copyright notices and legends are affixed to each reproduced copy. The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to erwin Inc. that all copies and partial copies of the Documentation have been returned to erwin Inc. or destroyed. TO THE EXTENT PERMITTED BY APPLICABLE LAW, ERWIN INC. PROVIDES THIS DOCUMENTATION “AS IS” WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL ERWIN INC. BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF ERWIN INC. IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE. The use of any software product referenced in the Documentation is governed by the applic- able license agreement and such license agreement is not modified in any way by the terms of this notice. The manufacturer of this Documentation is erwin Inc. Provided with “Restricted Rights.” Use, duplication or disclosure by the United States Govern- ment is subject to the restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19 (c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or their successors. Copyright © 2019 erwin Inc. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies. Contact erwin Understanding your Support Review support maintenance programs and offerings. Registering for Support Access the erwin support site and click Sign in to register for product support. Accessing Technical Support For your convenience, erwin provides easy access to "One Stop" support for all editions of erwin Data Modeler, and includes the following: Online and telephone contact information for technical assistance and customer ser- vices Information about user communities and forums Product and documentation downloads erwin Support policies and guidelines Other helpful resources appropriate for your product For information about other erwin products, visit http://erwin.com/products. Provide Feedback If you have comments or questions, or feedback about erwin product documentation, you can send a message to [email protected]. erwin Data Modeler News and Events Visit www.erwin.com to get up-to-date news, announcements, and events. View video demos and read up on customer success stories and articles by industry experts. 3 Contents Legal Notices 2 Contents 4 Introduction to API 15 Major Features 16 Typical Use Cases 17 Standalone Client 18 Add-in Component or Script 19 API Components 21 Overview 22 Application Tier 23 Model Directory Tier 25 Sessions Tier 26 Model Data Tier 27 Access to Model Data 29 Objects and Properties 31 Object Identifiers 32 Object Identifiers and Type Codes 33 Properties, Property Flags, and Value Facets 34 Scalar and Non-Scalar Property Values 36 Collections and Automation 37 _NewEnum Property of a Collection Object 39 Default Properties 40 4 Optional Parameter 41 The API Sample Client 42 Using the API Sample Client 43 Register the Add-in Component 44 Make a VB.NET Library COM Callable 44 API Tasks 46 Creating the ISCApplication Object 47 Application Properties 48 ISCApplication Interface 49 ISCApplicationEnvironment 50 Accessing a Model 54 Using the API as an Add-in Tool 55 ISCApplication Interface 56 ISCPersistenceUnitCollection Interface 57 ISCPersistenceUnit Interface 58 Property Bag Members for a Persistence Unit 59 ISCPropertyBag Interface 61 Using the API as a Standalone Executable 63 Creating a Model 64 ISCPersistenceUnitCollection Interface 65 ISCPropertyBag Interface 66 Opening an Existing Model 68 ISCPersistenceUnitCollection Interface 69 5 Opening a Session 71 ISCSessionCollection Interface 72 ISCSession Interface 73 Accessing a Model Set 75 ISCPersistenceUnit Interface 76 ISCModelSet Interface 77 ISCModelSetCollection Interface 78 ISCSession Interface 79 Accessing Objects in a Model 82 ISCSession Interface 83 ISCModelObjectCollection Interface 84 ISCModelObject Interface 85 Accessing a Specific Object 88 ISCModelObjectCollection Interface 89 Filtering Object Collections 91 ISCModelObjectCollection Interface 92 Accessing Object Properties 99 Iteration of Properties 100 ISCModelObject Interface 101 ISCModelPropertyCollection Interface 102 ISCModelProperty Interface 103 ISCModelProperty Interface 105 Iterating Over Non-Scalar Property Values 108 6 ISCModelProperty Interface 109 ISCPropertyValueCollection Interface 110 ISCPropertyValue Interface 111 Accessing a Specific Property 115 ISCPropertyValueCollection Interface 116 Filtering Properties 118 ISCModelObject Interface 119 Modifying the Model Using Session Transactions 122 Begin Transaction 124 ISCSession Interface 125 Commit Transaction 127 ISCSession Interface 128 Creating Objects 129 ISCModelObjectCollection Interface 130 Setting Property Values 133 Setting Scalar Property Values 134 ISCModelProperty Interface 135 Setting Non-Scalar Property Values 137 ISCModelProperty Interface 138 Deleting Objects 140 ISCModelObjectCollection Interface 141 Deleting Properties and Property Values 142 ISCModelPropertyCollection Interface 143 7 ISCModelProperty Interface 144 Deleting Non-Scalar Property Values 145 Saving the Model 146 ISCPersistenceUnit Interface 147 Accessing Metamodel Information 149 ISCApplicationEnvironment Interface 150 ISCSession Interface 151 Closing the API 153 ISCSession Interface 154 ISCSessionCollection Interface 155 Clearing Persistence Units 157 ISCPersistenceUnitCollection Interface 158 Error Handling 159 ISCApplicationEnvironment 161 Advanced Tasks 164 Creating User-Defined Properties 165 History Tracking 169 ISCSession Interface 170 API Interfaces Reference 173 ISCApplication 174 API Interfaces 175 ISCApplicationEnvironment 176 ISCApplicationEnvironment::PropertyBag Arguments 177 8 ISCModelDirectory 178 ISCModelDirectory::DirectoryExists Arguments 180 ISCModelDirectory::DirectoryUnitExists Arguments 181 ISCModelDirectory::IsOfType Arguments 182 ISCModelDirectory::LocateDirectory Arguments 183 ISCModelDirectory::LocateDirectoryUnit Arguments 184 ISCModelDirectory::PropertyBag Arguments (Get Function) 185 ISCModelDirectory::PropertyBag Arguments (Set Function) 186 ISCModelDirectoryCollection 187 ISCModelDirectoryCollection::Add Arguments 188 ISCModelDirectoryCollection::Item Arguments 189 ISCModelDirectoryCollection::Remove Arguments 190 ISCModelDirectoryUnit 191 ISCModelDirectoryUnit::IsOfType Arguments 193 ISCModelDirectoryUnit::PropertyBag Arguments (Get Function) 194 ISCModelDirectoryUnit::PropertyBag Arguments (Set Function) 195 ISCModelObject 196 ISCModelObject::CollectProperties Arguments 198 ISCModelObject::IsInstanceOf Arguments 200 ISCModelObjectCollection 201 ISCModelObjectCollection::Add Arguments 203 ISCModelObjectCollection::Collect Arguments 204 ISCModelObjectCollection::Item Arguments 206 9 ISCModelObjectCollection::Remove Arguments 207 ISCModelProperty 208 ISCModelProperty::DataType Arguments 211 ISCModelProperty::RemoveValue Arguments 212 ISCModelProperty::Value Arguments (Get Function) 213 ISCModelProperty::Value Arguments (Set Function) 214 ISCModelProperty::GetValueFacetIds Arguments 215 ISCModelProperty::GetValueFacetNames Arguments 216 ISCModelProperty::SetValueFacets Arguments 217 ISCModelPropertyCollection 218 ISCModelPropertyCollection::Add Arguments 221 ISCModelPropertyCollection::HasProperty Arguments 222 ISCModelPropertyCollection::HasPropertyFacets Arguments 223 ISCModelPropertyCollection::Item Arguments 225 ISCModelPropertyCollection::Remove Arguments 226 ISCModelSet 227 ISCModelSet::PropertyBag Arguments (Get Function) 229 ISCModelSet::PropertyBag Arguments (Set Function) 230 ISCModelSetCollection 231 ISCModelSetCollection::Item Arguments 232 ISCPersistenceUnit 233 ISCPersistenceUnit::PropertyBag Arguments (Get Function) 235 ISCPersistenceUnit::PropertyBag Arguments (Set Function) 236 10 ISCPersistenceUnit::Save Arguments 237 ISCPersistenceUnit::ReverseEngineer 238 ISCPersistenceUnit::ForwardEngineer 246 ISCPersistenceUnitCollection 248 ISCPersistenceUnitCollection::Add Arguments 249 ISCPersistenceUnitCollection::Create Arguments 250 ISCPersistenceUnitCollection::Item Arguments 251 ISCPersistenceUnitCollection::Remove Arguments 252 ISCPropertyBag 253 ISCPropertyBag::Add Arguments 254 ISCPropertyBag::Name Arguments 255 ISCPropertyBag::Value Arguments (Get Function)