Interface to the exit

The incident-record-create 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:

 AREA      DS   CL1024 (Record build area)
 NRECS     DS   F      (Number of records created)
 RSIZE     DS   F      (Incident data set record size)
 DATE      DS   CL8    (Current date, format YY/MM/DD)
 JOBNAME   DS   CL8    (Job name)
 JOBNUM    DS   CL8    (Job number)
 JOBSTART  DS   CL8    (Job start time, format HH.MM.SS)
 JOBEND    DS   CL8    (Job end time, format HH.MM.SS)
 SYSTEM    DS   CL5    (Name of z/OS system)
 EID       DS   CL8    (Error code)
 TID       DS   CL8    (Tracking identification)
 STEPNAME  DS   CL8    (Step name)
 RFLAG     DS   CL1    (Record flag)
 RECORD    DS   CL72   (Start of current SYSOUT record)
 RETCODE   DS   F      (Return code)

AREA

The record build area to be updated by the exit. This area is blank when the exit is called.

NRECS

Is set by the exit to tell the JCC how many records have been built in the record build area.

RSIZE

Gives the size of each record built. The exit must build these records in the build area, each record must be contiguous to the preceding one, and the exit must not update storage outside the build area.

DATE

The date of the job that caused the incident-record-create exit to be called.

JOBNAME

The name of the job that caused the incident-record-create exit to be called.

JOBNUM

The job number of the job that caused the incident-record-create exit to be called.

JOBSTART

The start time of the job that caused the incident-record-create exit to be called.

JOBEND

The end time of the job that caused the incident-record-create exit to be called.

SYSTEM

Identifies the system that the job was run on.

EID

Contains the error code that is set for this job.

TID

Contains tracking information from the current message-table entry.

STEPNAME

Identifies the name of the step in the current job that the exit is called for.

RFLAG

Has the value T if the incident-record-create exit is called because a match has been found in a message table for a SYSOUT record. If RFLAG has any other value, the exit is called for an incident that does not relate to a particular SYSOUT record.

RECORD

Contains the first 72 characters from the current SYSOUT record when RFLAG has the value T.

RETCODE

Is set by the exit. The JCC updates the incident log data set only if this parameter has the value zero.