HCL Workload Automation, Version 9.4

Configuring exit EELUX004 (event filtering)

This section describes the event filtering exit (EELUX004)

EELUX004 is called when the agent for z/OS event writer is about to write an event to the event data set. In this exit, you can choose to discard events created by JES and SMF exits.

This exit is commonly used to filter the events created by nonproduction work. If you run a significant number of test jobs and other work, and your job naming standards let you do so, consider using EELUX004 to filter the nonproduction work. The sample library SEELSAMP, that was created during installation, contains the EELUX004 exit, which is a sample of event filtering exits.

Installing the exit

The load module implementing the event filtering exit must be link-edited into an APF-authorized library in the LNKLST concatenation or defined by the STEPLIB DD statement in the agent for z/OS JCL procedure. The load module should be link-edited with RMODE(24) according to normal z/OS® restrictions.

The agent for z/OS invokes the exit in AMODE 24; the AMODE parameter specified at link-edit time has no effect.

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; the agent 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:

EELUX004 parameters
 JOBNAME   DS   CL8    (Name of current job)
 RETCODE   DS   F      (Return code)
 EXR       DS   CL80   (Exit record) 
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.
Is set by the exit. The following values are recognized by the job completion checker:
Normal return. The event writer continues normal processing; the event is written to the event data set.
This is not a scheduler event. The event is not written to the event data set. 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.
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.