Using the CICSPlex SM API

You need to understand a number of concepts before you use the CICSPlex SM API, including managed objects, resource tables, and result sets.

CICSPlex SM managed objects
CICSPlex SM is an object-oriented system. This means that each resource in the CICSPlex SM environment is an instance of an object. Each object is considered to be a specific type and each has a unique, formally defined name.
CICSPlex SM resource tables
Each CICSPlex® SM managed object is represented externally by a resource table.
Selecting managed objects
Any given API program is likely to be interested in only a subset of the CICSPlex SM managed objects.
Working with result sets
CICSPlex SM places the resource table records that you select in a result set. A result set is a logical group of resource table records that can be accessed, reviewed, and manipulated by an API program.
Modifying managed resources
You can modify the resources managed by CICSPlex SM in various ways. The actions described here are issued against resource table records in a result set. However, the changes that you request are made to the actual resources which those records represent.
Asynchronous processing
Most CICSPlex SM API commands normally function in a synchronous manner, where your program issues a request and then waits until command processing is complete.
Using CICSPlex SM tokens
Many of the CICSPlex SM API commands are interrelated; you use them in conjunction with each other to accomplish the objectives of your program. For example, you issue a GET command to build a result set and then issue a FETCH command to access the resource table records in that result set.
Using metadata resource tables
The GETDEF command is used to obtain records describing the structure of the CICSPlex SM managed objects, including general characteristics, valid actions, and object attributes.
Using CRESxxxx resource tables
The CRESxxxx resource tables are externalized versions of the topology resource maps, and are usually updated when a resource is installed, added, discarded or removed. This information is captured via the CICS® XRSINDI global user exit, or for CRESIPCN, via the XMEOUT message exit.
Querying the CICSPlex SM API exit
In a CICS LMAS environment the CICSPlex SM API function is implemented via a task-related user exit. CICS application programs can use the EXEC CICS INQUIRE EXITPROGRAM command to retrieve information about the CICSPlex SM API task-related user exit.

Parent topic: Developing CICSPlex SM applications