Interface to the exit

The event-filtering exit is invoked in task mode, problem state, and key 8 and the job-step task is APF-authorized. The active task runs with the same access authority as the job-step task. The exit must restore this state before returning to its caller.

Control is passed to the exit using the BAL instruction. The exit must return to its 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:

EQQUX004 parameters

 JOBNAME   DS   CL8    (Name of current job)
 RETCODE   DS   F      (Return code)
 EXR       DS   CL80   (Exit record)
 CDSP      DS   A      (Address of data set information)
 CCMACT    DS   CL1    (Catalog management action, blank or D)

JOBNAME

The name of the job for which a job-tracking event has been recognized and for which an event record is about to be written to the event data set.

RETCODE

Is set by the exit. These values are recognized by the job completion checker:

0: Normal return. The event writer continues normal processing; the event is written to the event data set. If the event is a job-termination event (type 3P), it is passed to the JCC if the JCC is active.
4: No JCC processing for this event. The event is written to the event data set but is not passed to the JCC for processing.
8: This is not a scheduler event. The event is not written to the event data set and is not passed to the JCC for processing. However, if the event is a reader event (type 1) and the job was held by a scheduler job-tracking exit, the job is released from hold by the event writer.

EXR

The exit record describing the job-tracking event. This record is built by the SMF or JES exit that recognized the event. The job number offset, EXRJOBID, in the exit record contains JOB as the first three characters if the event is created for a job. EXRJOBID contains STC as the first three characters if the event is created for a started task.

CDSP

In earlier releases, the address pointing to a list of data sets that might be eligible for catalog-management actions.

The catalog-management function has been replaced by a new function called restart and cleanup. The CDSP parameter is retained only for compatibility with the exits already written.

CCMACT

The catalog-management-operation action.

This old catalog-management has been completely restructured and substituted with a new function called restart and cleanup, where this parameter is no more applicable. It is kept only for compatibility with the exits already written.