Overview of CTMAPI

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

CTMAPI is open to 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

However, not all functions of the API are applicable to all environments.

The API can call the CTMAPI module and pass it requests through either of the following:

• a function (command line) passed to CTMAPI, as
  • a parameter from within a program
  • a parameter using PARM=variable in a JCL Batch step
  • an explicit command coded in a dedicated sequential file pointed to by the DAAPI special DD statement. Note that only bytes 1 through 72 of the records in DAAPI are processed.

  COBOL examples:

  To perform a job order (with FORCE), in the Working-Storage section code:

  01  WS-CONTROLM-PARMS.

     05 PARM-LENGTH              PIC 9(4) COMP VALUE 80.

     05 PARM-VALUE               PIC X(80) VALUE

     'ORDER DDNAME=ddname MEMBER=table-name JOB=job-name FORCE'.

  In the Procedure division code:

  CALL 'CTMAPI' USING WS-CONTROLM-PARMS.

  IF RETURN-CODE IS GREATER THAN 0 THEN GO TO error-routine.

• conversational mode (CTMBAPI mode), using an area mapped by CTMBAPI DSECT. It passes the request from an application program to CTMAPI, and the results are returned to the calling program

These methods, functions and conversational mode, are explained in more detail in this appendix.