CTMAPI supports various types of services, but not all of them are supported under all environments. Some of the functions can be executed using existing IOA or Control-M utilities. For example, CTMJOB can be used to order jobs. Other functions, such as the Status request or the Action request, cannot be processed by means of any existing program or utility.
Future enhancements will be provided first to the API rather than to the appropriate utility. BMC therefore recommends that you use CTMAPI for all requests, even functions that are supported using other utilities.
The following CTMAPI functions are available:
order or force existing jobs into Control-M This function can currently also be performed using CTMJOB.
create and/or order or force a new table into Control-M This function can currently also be performed using CTMBLT.
perform AJF actions equivalent to the following options of the Active Environment screen (Screen 3):
Hold
Free
Delete
Undelete
Confirm
Rerun
Restart
React
Force OK
Kill
BYPASS commands:
BYPJCL (for JCL only)
BYPTIME (for Time Limit)
BYPCOND (for IN Conditions)
BYPQRES (for Quantitative Resources)
BYPCRES (for CONTROL Resources)
BYPPIPE (for Pipes)
BYPWL (for Workload Limits)
BYPSCHD (for Scheduling Environment)
BYPQTIM (for Quiesce Time)
BYPALLC (for All IN Criteria)
BYPPOST (for Post Processing)
BYPDSUB (for Delayed Submission)
search and query the status and other details of jobs in Control-M
resolve, set, and checkpoint variables in the IOA Variables Database
add, delete, change, or query for conditions or quantitative and control resources. This function calls the IOACND utility
control which jobs in the Active Jobs File are to be excluded from download to Control-M/EM
check why jobs are in Wait Schedule status
perform actions on Load-Indexes (obtain a list of Load-Indexes, set the level of an external Load-Index, override the level of a Load-Index, or release an override on a Load-Index)
These functions are described in greater detail in this appendix. Differences in calling the service from different environments are also discussed.
IOAAPI, which is described in the INCONTROL for z/OS Administrator Guide, can be used to perform the following functions:
