User-supplied Completion Checking Routine

It is the installation's responsibility to check whether the command has achieved what it has been asked to do within the specified time interval.

A completion checking routine can be used to examine whether the command has achieved the expected result. SA z/OS uses the maximum wait time to set up a timer. When the timer interval expires, SA z/OS invokes the checking routine. The routine sets a return code for the outcome of the operation. SA then posts the operation as complete or in error.

Note:
  • A command is considered to be asynchronous if a checking routine is provided.
  • The maximum wait time can be prefixed with the letter 'I' (for example, I00:00:10 ). If the letter 'I' is present within the maximum wait time string, the result checking is invoked immediately after the command finished. The maximum duration of the command processing is the specified time.
  • If the maximum wait time is 00:00:00 or omitted, the checking runtime is immediately invoked after the execution of the asynchronous command. The maximum duration of the command matches the CORRWAIT time defined in the environment.
  • The OPCAPOST command is used to post the status of an operation back to the workload scheduler as finished. When issuing OPCAPOST, provide the parameters IDATE and ITIME to uniquely determine the running operation within the automation environment.

INGREQ and INGMOVE are synchronous commands, therefore a maximum wait time is required. The command is considered to be complete when the specified resource has reached or is already in the requested state. If more than one resource is specified in the INGREQ or INGMOVE command, all resources must be in the requested state before the command is considered complete. The timer value specified should be large enough to accommodate the longest interval of time that the requested function may take under normal operating conditions.