|
|
|
|
|
The DSECT that formats reply area entries is CTMBJSE. Each entry is 240 bytes long. For REXX parsing, fields in this DSECT are separated by a blank.
You must always allocate an area of 12,000 bytes and code its address in the BAPIRPLS field.
The search criteria can fit multiple jobs on the AJF, up to a maximum of 50 jobs. For example, if you want to process 25 jobs, prepare an area of 12,000 bytes and code its address in the BAPIRPLS field. After returning from the API, the area will contain the details of the 25 jobs. Each job line is detailed in the CTMBJSE DSECT and contains relevant information about the located job.
The number of lines is returned in the BAPIRPL# field. When this field points to the maximum, 50, it is possible that there are more lines that can be returned. In that case, the value of the Utility Return Code field BAPIURC will be 4, and the Reason Code field BAPIRSN will have the value "BAPI_HAVE_MORE_LINES." In such a case, the user program can set bit BAPISPF8 in byte BAPISF1 and call CTMAPI again. This call will retrieve the next 50 lines of output that match the search criteria. When multiple lines are returned, the lines are in the order from the end (the most recent job) to the beginning. There is an option for the calling program to receive only one line of output, by specifying as the value in the BAPISF1 flag byte either BAPIS1ST (first line) or BAPISLST (last line).
Except for field JSESTAT, the meanings of the fields are as described (internally) in the macro CTMBJSE, which is in the IOA MAC library. The JSESTAT field returns the status of the job in the AJF. The CTMAPI status function does not return all the statuses detailed in the Control-M for z/OS User Guide. A list of the statuses that can be returned appears in Table 288.
Table 288 Statuses Returnable under the Status Function
Status |
Description |
|---|---|
DEL |
The job was deleted. |
ENDED |
The job ended. |
END_NOK_ABND |
The job ended NOTOK because of an abend. |
END_NOK_CC |
The job ended NOTOK because of the Condition Code of the job. |
END_NOK_DISA |
The job ended NOTOK. It disappeared. |
END_NOK_JCLE |
The job ended NOTOK because of a JCL error. |
END_NOK_NSUB |
The job ended NOTOK. It was not submitted by JES. |
END_NOK_UNKW |
The job ended NOTOK for an unknown reason. |
END_OK |
The job ended OK. |
END_OK_FOK |
The job was ForcedOK. |
EXEC |
Job is executing. |
EXEC_ERR |
Relevant only to SMART Table Entities. Several of the jobs in the group are still executing, but at least one of them has ended NOTOK. |
EXEC_INQ |
The job was submitted to JES, but is not yet processing. |
EXEC_NJE |
The job is being executed at a remote NJE node. |
EXEC_WSUB |
Wait submission. The job was selected, but it is still waiting for Control-M to submit it to JES. |
NOT_DELETED |
The job was not deleted. |
WAIT_CONF |
Wait for confirmation. |
WAIT_ORD |
The ordering of a group is not yet complete. The group is still in the order process. |
WAIT_PIPE |
Waiting for all members of the pipe to be ready for submission. |
WAIT_SCH |
Wait Schedule. |
WAIT_TIME |
Wait for Time Limit. |
EXIST |
The job exists on the Active Jobs file. |
NOT_ENDED |
The job did not end. |
NOTEXIST |
The job does not exist on the Active Jobs file. |
Parent Topic |