API Components › The API Sample Client › Using the API Sample Client

Using the API Sample Client

This section describes how to utilize the API sample client as a standalone version and as an add-in component.

The standalone version of the sample program is ERwinSpy_Sample.vbp. You can build ERwinSpy_Sample.vbp to create the ERwinSpy_Sample.exe program. This program is a CA ERwin DM model data browser that you can use to research data internals, such as the metamodel, model data, and model objects and their properties.

Using ERwinSpy_Sample.exe, you can open an *.ERWIN file by clicking Open on the File menu. When a model is opened or selected from File 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 that is between the left and right panes of the program screen.

The File 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.

The add-in version of the sample program is ErwinSpy_Addin_Sample.vbp. You can build ERwinSpy_Addin_Sample.vbp to create an add-in component. The add-in component runs when you select it from the Tools, Add-Ins menu. After you build the add-in component with the ErwinSpy_Addin_Sample.vbp project, you must register it.