Interface to the exit

The operation-status-change 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.

The exit is entered in AMODE 31 but must switch to AMODE 24 before performing any input or output operations, and then switch back to AMODE 31 before returning to the caller.

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:

EQQUX007 parameters

 NEWSTAT   DS   CL1   (New operation status)
 OLDSTAT   DS   CL1   (Old operation status)
 OPNUM     DS   H     (Operation number)
 CALLER    DS   CL4   (Caller identification)
 ERRCODE   DS   CL4   (Error code)
 WSNAME    DS   CL4   (Workstation name)
 ADNAME    DS   CL16  (Application name)
 OWNER     DS   CL16  (Application owner name)
 GROUP     DS   CL8   (Authority group name)
 JOBAREA   DS   A     (Address of job-related data)
 OPERAREA  DS   A     (Address of operation-related data)
 USRAREA   DS   A     (User-defined field)
 EXSTAT    DS   CL1   (Operation extended status)
 OCCPTR    DS   A     (Address of occurrence data)
 OPRPTR    DS   A     (Address of operation data)
 UFNUM     DS   F     (Number of user fields)
 UFPTR     DS   A     (User fields area address)

NEWSTAT

Defines the new status for the current operation. These values are possible:

A: Arrived at the workstation
C: Complete
E: Ended with errors
I: Interrupted
R: Ready for processing
*: Ready for processing (predecessor at nonreporting workstation complete)
S: Active (started)
W: Waiting.

OLDSTAT

Defines the previous status for the current operation. The same values are possible as for the new status, plus blank. Blank means that the operation has been added to the current plan by a function other than by daily-planning jobs. No call is made to EQQUX007 when operations are added by daily-planning jobs.

OPNUM

Is the operation number of the current operation.

CALLER

Identifies the function within Tivoli Workload Scheduler for z/OS that called the exit. These values are possible:

AR: Automatic-recovery task
EM: Event-manager task
GS: General-service task, but not modify-current-plan
MCP: Modify-current-plan function in the general-service task
NMM: Normal-mode-manager task
WSA: Workstation-analyzer task.

ERRCODE

The error code for the current operation if the new status is E.

WSNAME

The name of the workstation where the current operation is active or will become active.

ADNAME

The application name for the current operation.

OWNER

The name of the owner of the current application.

GROUP

The name of the authority group that the current operation belongs to.

JOBAREA

The address of an area that contains information about status changes that are related to a specific job. The job-related area is laid out as follows:

JOBAREA

JOBNAME  DS  CL8  (Job name)
JOBNUM   DS  CL8  (Job number)
DATE     DS  CL8  (Current date, format YY/MM/DD)
JOBSTART DS  CL8  (Job start time, format HH.MM.SS)
JOBEND   DS  CL8  (Job end time, format HH.MM.SS)
STEPNAME DS  CL8  (Step name)
ABCODE   DS  CL4  (System abend code, format Shhh)
USRCODE  DS  CL5  (User abend code, format Uhhh)
ORIGNJE  DS  CL8  (Name of origin NJE node)
PSTEPNAM DS  CL8  (Procedure step name)

The JOBNAME and DATE fields are always present for status changes at automatically reporting computer and printer workstations. JOBNUM is present when an operation at one of these workstations changes its status from S to C. When the job is submitted by a fault-tolerant workstation, the first three characters of the JOBNUM value are set to UNX by Tivoli Workload Scheduler for z/OS.

The status is changed to S (started). The JOBNUM value can change only if the operation is rerun. JOBSTART is present when the new status at automatically reporting computer and printer workstations is S (started), C (complete), E (ended-in-error), or I (interrupted). JOBEND is present when the new status at one of these workstations is C or E.

STEPNAME, PSTEPNAM, ABCODE, and USRCODE are present only for jobs that have abended during running. ORIGNJE is present for processing operations when the new status is C or E.

When the status of an operation is changed from C or E to S, C, E, or I, certain JOBAREA fields are set to their previous values for that operation.

Fields in the job-related area are blank if information is not available when the exit is called.

OPERAREA

The address of an area that contains information about the operation whose status is being changed. This area is mapped as follows:

OPERAREA

OPERTEXT DS CL24 (Operation description)
APPLIA   DS CL10 (Application input arrival,format YYMMDDHHMM)
OPERIA   DS CL10 (Operation input arrival, format YYMMDDHHMM) 
PSTART   DS CL10 (Planned start, format YYMMDDHHMM)           
PLEND    DS CL10 (Planned end, format YYMMDDHHMM)             
DEADLINE DS CL10 (Operation deadline, format YYMMDDHHMM) 
USERDAT  DS CL16 (User data field)
RSPRES   DS CL1  (Y=there is reason data, N=no reason data)
RSERR    DS CL4  (The error code set by the dialog user)
RSUSER   DS CL16 (The user data from the dialog: this is
*                 the same as USERDAT at entry to exit)
RSREASN  DS CL300(The dialog 'reason for restart' data)
RSPANEL  DS CL8  (The panel where the restart was initiated)
XJNAME   DS CL54 (Job extended name)
SAWS     DS CL1  (New automation work station)

USRAREA

A user field that is also passed to the EQQUX000 exit. It contains valid data only if you have an EQQUX000 exit that places some data in it. Tivoli Workload Scheduler for z/OS does not use or update this field.

EXSTAT

Defines the extended status code of the operation. Refer to IBM Tivoli Workload Scheduler for z/OS Managing the Workload for a description of the valid codes.

For performance reasons, user exit EQQUX007 does not currently provide the extended status 'X' (waiting for resource). A new value, 'Z', valid for all current status codes and types of workstation, has been added to signal that an error has occurred in the DOA updating process. In this case, message EQQE106I is issued in EQQMLOG.

OCCPTR

The address of the common data of record CPLREC3C.

OPRPTR

The address of the common data of record CPLREC3P.

USRFNR

The number of user field records in USRFAREA.

USRFAREA

The address of the user field area. It is laid out as follows:

USRFAREA

USRFNAME DS   CL16         (User field name)
USRFVAL  DS   CL54         (User field value)