Command reference for SLB API activation utility

ACTIVATE

The ACTIVATE command is used to either build a new dynamic API environment and make it active, or convert an existing environment to be the active environment.

If other environments exist when the ACTIVATE is performed, those environments remain intact but become inactive and are not used by the API. Only one dynamic API environment can be active at a time. Once the activation is completed successfully, the API can be called dynamically without specifying the load library and repository data sets in the JCL that uses the API.

If you want to use the API for an environment that is different from the active environment, you must specify the required DD statements in the IMS Database Recovery Facility or IMS Database Recovery Facility Extended Functions JCL.

ACTIVATE performs the following operations:

1. Ensure that all required DD statements are specified in the JCL.

   The utility terminates otherwise.

2. Check to see if there are any active users of the API.

   If there are active users, then no changes are allowed and the utility terminates.

   No changes are allowed (for example, ACTIVATE or DEACTIVATE) when there are active users of the API.

3. Check to see if the BSY#API interface module is loaded into LPA (Link Pack Area).

   If the module is not loaded, a copy is loaded into LPA and messages are displayed indicating it was loaded.

   Messages are also issued showing the maintenance level of the module and whether it was loaded or it already existed.

4. Check to see if there is a dynamic API environment that matches the DD statements allocated in the JCL.

   If a matching environment exists, and it is not currently the active environment, then the environment is converted and designated as the active environment.

   If a matching environment does not exist, then a new dynamic API environment is created and is designated the active environment.

DEACTIVATE

The DEACTIVATE command is used to remove one or more dynamic API environments. The DEACTIVATE parameter can be specified using the following formats:

DEACTIVATE

This form of the command deactivates only the dynamic API environment that matches the DD statements allocated in the JCL.

DEACTIVATE performs the following operations:

1. Ensure that all required DD statements are specified in the JCL.

   The utility terminates otherwise.

2. Check to see if there are any active users of the BSY#API interface module loaded in LPA (Link Pack Area).

   If there are active users, then no changes are allowed and the utility terminates.

   No changes are allowed (for example, ACTIVATE or DEACTIVATE) when there are active users of the API.

3. Locate the dynamic API environment that matches the DD statements allocated in the JCL.

   If none is found, a message is issued and the utility terminates.

4. If a dynamic API environment is found that matches the DD statements allocated in the JCL, the environment control blocks are unchained from the list and the storage is freed.

   If the deactivated environment was the active environment, the next environment in the chain is made active.

   If the last environment is deactivated, then the BSY#API interface module is also deleted from LPA.

Note: The DEACTIVATE command appears as DEACTIVATE(RVTE) in the output.

DEACTIVATE(ALL)

This form of the command deactivates all dynamic API environments. If this form is used, the API can no longer be called unless the necessary data sets are allocated in the job that uses the API.

DEACTIVATE(ALL) performs the following operations:

1. Check to see if there are any active users of the API.

   If there are active users, then no changes are allowed and the utility terminates.

   No changes are allowed (for example, ACTIVATE or DEACTIVATE) when there are active users of the BSY#API module that is loaded into LPA (Link Pack Area).

2. Run the chain of all dynamic API environments and deletes each control block.
3. Remove the BSY#API module from LPA.

LIST

The LIST command is used to display information about the dynamic API environment on a z/OS® system.

Messages are issued showing information related to the BSY#API interface module and each dynamic API environment that exists.