CTMAPI - Control-M Application Program Interface

The Control-M Application Program Interface (CTMAPI) is an open interface between the application environment and Control-M. CTMAPI enables application programs to interface with Control-M, allowing access to IOA and Control-M services and enabling you to extract data from Control-M into your own programs.

CTMAPI is accessible from all application environments. It can be called from the following programs or environments:

• High Level Language or Assembler programs, running under various environments, such as CICS, IMS, or the like
• a batch job or step
• REXX or CLIST

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 AJF Action requests, cannot be processed by means of any other existing program or utility.

Future enhancements will be provided first to the API, rather than to the appropriate utility. Therefore, BMC recommends that you use CTMAPI for all requests, even functions that are supported using other utilities.

For a detailed description of CTMAPI see Appendix A, The Control-M Application Program Interface (CTMAPI) in the Control-M for z/OS User Guide.