Order Extension

The value that should be set in the BAPICMD field for this function is 1 (BAPI_M_ORDER).

You can use the Order function to order jobs to the AJF. You can call this function from any environment, but only by using the CTMBAPI mode. The function uses the usual Control-M order process to put the requested job on the AJF. The return code will appear in the BAPIURC (Utility Return Code) field.

If CTMAPI fails to invoke the order process, register R15 will contain a value of 8 or higher, and the reason code will appear in the BAPIRSN field.

You can request a detailed reply from the order process, using the following procedure:

1. Prepare a memory area.
2. Pass the start address in the BAPIRPLS field.
3. Pass the address of the last byte of this area in the BAPIRPLE field.

   After returning from the order process, the BAPIRPLC field will point to the last byte replied. The BAPIRPL# field will contain the number of reply lines. For each job processed by the order process, a reply line will be returned detailing the job identifiers and the RC of the order for this specific job. This is in contrast to the usual output lines of the order process that are issued only for jobs that have actually been ordered. Details of the reply line are specified in the CTMBAPO DSECT.

   Table 291 contains a summary of the CTMBAPI Order input fields. You must ensure that all fields whose type is CL are initialized with BLANKS, and those with type X are initialized to binary zeros.

   Table 291 Order Fields

   Field Name	Optional	In or Out	Type	Usage
   BAPIODSN	N	I	CL44	Table DS name. Mutually exclusive with BAPIODD.
   BAPIOMEM	N	I	CL8	Member name
   BAPIODD	O	I	CL8	Table DD name. Mutually exclusive with BAPIODSN.
   BAPIOJOB	O	I	CL8	Job name. Enter ‘  ‘ (Blank) to order all jobs in the table.
   BAPIODAT	O	I	CL6	ODATE. Default is the current Odate.
   BAPIORBA	O	I	CL6	RBA of the SMART Table Entity when a Dynamic SMART Table Insert is performed.
   BAPIOF1	O	I	XL1	Flags byte. Valid values are: X’80’ – Force the table X’40’ – Insert the job into a SMART Table Entity that already exists on the AJF X’20’ – Allow duplicate jobs in the group when dynamically inserting a job into the group From X’10’ through X’01’ – These bits are reserved for internal use
   BAPIRBC#	O	I	XL2	Number of rule-based calendar statements that follow this field. This field is for users who want to implement the IGNORE and/or SELECT RBC logic that is discussed on connection with the utility CTMJOB in the Control-M chapter of the INCONTROL for z/OS Utilities Guide. After this field, you should code the matching number of BAPITGNM statements that define the rule-based calendars themselves.
   BAPITGIN	O	I	CL1	Ignore or Select indicator. Valid values are: I – Ignore S – Select
   BAPITGNM	O	I	CL20	RBC name