Environment and Allocations

CTMAPI is a callable Load module that resides in the IOA LOAD library. It is located below the line (RMODE=24), works in 31 bit addressing mode (AMODE=31), and can be called by programs running in any AMODE.

The following requirements must be satisfied before CTMAPI can be called:

• The calling application must have access to the IOA LOAD library, either using STEPLIB or using Linklist.
• The standard IOA DD statement DAPARM must be allocated to the calling address space before calling CTMAPI, and must correctly point to the IOA PARM and IOA IOAENV libraries. This allocation is essential for the correct loading of CTMPARM, IOAPARM and other required parameter members, and to provide the ability to issue messages, dynamically allocate files, and so on.

In addition to the above allocations, each service requires specific data sets to be allocated for successful execution of the service. For example, to successfully order jobs to Control-M, the Active Jobs file (AJF) must be allocated.

CTMAPI relies on IOA dynamic allocation services to allocate the files appropriate to the function, using an ALC member. This means that your program, REXX or batch requires no knowledge of dynamic allocation.

For more information about IOA dynamic allocation and ALC members, see the INCONTROL for z/OS Administrator Guide.

You can tailor CTMAPI to allocate the appropriate files in either of the following ways:

• Let the function itself dynamically allocate the default data sets based on the site standard naming convention (using the default ALC member). Under each function, you can find which ALC member is used to dynamically allocate the necessary files. If you do not require any unusual allocations, this is the recommended method.
• If you want to use other allocations, you can prepare your own ALC member and pass it to CTMAPI using the standard DAALOCIN DD statement pointing to your own ALC member. If this method is chosen, it is recommended that you use the default ALC member specified in the function as a basis for your own ALC member.

If the caller is not allocated to DAALOCIN DD at the time CTMAPI is called, it is assumed that the default allocations are to be performed. In this case, CTMAPI will dynamically allocate files using the default ALC member.

If CTMAPI is called under the IOA environment, none of the above is applicable. It is assumed that all the necessary files are already correctly allocated, so no dynamic allocation is performed by CTMAPI.