Interface to the exit

The Job-tracking log write exit is invoked in task mode, problem state, key 8; the job-step task is APF-authorized. The active task runs with the same access authority as the job-step task. The exit restores this state before returning to its caller.

Control is passed to the exit using the BAL instruction. The exit returns to the caller using the address and addressing mode passed to it in general register 14.

If the exit abends, it is flagged as not executable; Tivoli Workload Scheduler for z/OS does not try to call the exit again.

When the exit is entered, register 1 contains the address of the parameter list. Each address in this list is used to locate the parameter value. These parameters are passed to the exit:

EQQUX011 parameters 

MCAUSERF  DS   A        (User field)
JTLOGNUM  DS   F        (Current job-tracking log number)
SIZE      DS   F        (Size of current job-tracking log record)
TRL       DS   F        (Address of job-tracking log record)
TQTOT     DS   F        (Job-tracking log records since CP backup)
CPLCR     DS   CL10     (Current Plan Creation date and time)
CPLEND    DS   CL10     (DP PLAN PERIOD END)
BUGMT     DS   XL8      (Last CP backup date and time - GMT)
GMTOF     DS   F        (GMT offset minutes)
RETCODE   DS   F        (Return code)
MCAUSERF
A user field that is also passed to the EQQUX000 exit. Tivoli Workload Scheduler for z/OS does not use or update the MCAUSERF field.
JTLOGNUM
The job-tracking log number to which a job-tracking log record is about to be written.
SIZE
The size, in bytes, of the job-tracking log record that is about to be written.
TRL
The address of the job-tracking log record.
TQTOT
The total number of job-tracking log records (current job-tracking log record included) written since last CP backup.
CPLCR
The Current Plan Creation date and time in local time. It is in YYMMDDHHMM format. YY is the Tivoli Workload Scheduler for z/OS internal year representation - 00 is 1972, 24 is 1996 and 99 is 2071.
CPLEND
The Daily Planning period end date and time in local time. It is in YYMMDDHHMM format. YY is the Tivoli Workload Scheduler for z/OS internal year representation - 00 is 1972, 24 is 1996 and 99 is 2071.
BUGMT
Is the last CP backup date and time in GMT. It is in 0nYYDDDFHHMMSSTH format. If n = 0, year is 19YY. If n = 1, year is 20YY.
GMTOF
Is the GMT offset in minutes.
RETCODE
Is set by the exit. The following values are recognized:
0
Normal return. Processing continues.
8
Stop calling the job-tracking log record write exit. You must stop the controller and start it again to reactivate the exit.

All other return codes are processed as for return code 8.

Notes®:
  1. The scheduler performance might be degraded if the exit requires lengthy processing time.
  2. While this exit has control, the scheduler does not process any new requests requiring update of the job-tracking log.
  3. System waits, including implied waits for I/O operations, should be avoided.
  4. The scheduler Job-Tracking log writes is done by several different tasks, therefore the exit will be called from different tasks interchangeably.
  5. The above remarks should be taken into account when designing the exit.