Using Windows and UNIX APIs

Use this information if you want to develop programs that use the CA Gen Encyclopedia or Workstation Application Program Interface (API).

The Encyclopedia and Workstation APIs provide a set of C subroutines to read schema and administration information, and to read or update a model in the CSE or Workstation. These functions are provided as static and dynamic load libraries along with additional development files.

These APIs have two functional sets:

The read-only API provides access to encyclopedia and model information but cannot change that information. The components for the read-only API are installed when their appropriate companion product is installed. The read-only Workstation API is installed with the workstation; the read-only Encyclopedia API is installed with the Encyclopedia Server.
The Update API provides read access to encyclopedia information, and it provides read and update access to model information. Installation of the Update API is optional. The Update API is a licensed product and should be installed only if you have purchased a license for it. The Update API also depends on the read-only API. Install the Update API only if you have installed the corresponding read-only component.

This chapter covers these APIs:

Local Windows Oracle and MS SQL Server Encyclopedia API
Remote Windows Oracle client to Windows or UNIX Oracle server Encyclopedia API
Remote Windows to z/OS API
Windows Workstation API

Demo program source code and executables are installed with the read-only and Update APIs. These programs allow you to exercise the functions available in the APIs. You can select which functions to use through menus. You are prompted for inputs for each function. The completion status, or return code, and information collected by each function displays when the function completes. You can use the demo program executables to determine whether the Encyclopedia or Workstation API program is able to reach the model data source, or to explore each API function. You can also read the source code to see how the various API functions are called. The link control files and other build articles provide examples that you can use when you build your own Encyclopedia or Workstation API programs.