HCL Workload Automation for Z exits

Read the following information to understand General-use Programming Interface and Associated Guidance Information. It describes exits that are called by HCL Workload Automation for Z. Your own programs can use the information passed by the exits to perform a variety of functions.

Exits with name prefix EQQUXnnn (where nnn is a number) are called when HCL Workload Automation for Z is started. Exits with name prefix EQQUXxxx (where xxx is not a number) are not called by the scheduler. For example, EQQUXCAT is called (if present) by the EQQDELDS sample or by the EQQCLEAN program, while EQQUXPIF is called by a PIF program during the application description update (INSERT AD or REPLACE AD).

Each exit is loaded if the exit module exists, if the exit has not been disabled, and if the exit has not been replaced by another exit name on the EXITS statement. See EXITS for a detailed description of the EXITS statement.

The JCL-variable-substitution exit is called at either job setup or job submission, when a JCL variable has retrieved its value. The JCL-imbed and automatic-recovery exits are called via HCL Workload Automation for Z JCL statements. None of these exits is affected by the EXITS statement.

The EQQDPUE1 exit is used by daily planning batch jobs and is not affected by the EXITS statement. The batch jobs use the exit if it is available. If the exit is not found, a message is written to the message log of the batch job.

Exits are invoked using standard linkage conventions. When the exit is entered, register 1 points to a parameter list. Each address in this list points to a parameter that is passed to the exit. HCL Workload Automation for Z exits contains information about the HCL Workload Automation for Z exits.

Table 1. HCL Workload Automation for Z exits
Exit name Loaded by AMODE at entry RMODE when linking Exit description
EQQUX000 tracker and controller 31 ANY HCL Workload Automation for Z start/stop
EQQUX001 controller 31 24 Job submit
EQQUX002 controller 31 24 Job library read
EQQUX003 controller 31 ANY Application description feedback
EQQUX004 tracker 24 24 Event filtering
EQQUX005 tracker 24 24 JCC SYSOUT archiving
EQQUX006 tracker 24 24 JCC incident-record create
EQQUX007 controller 31 ANY Operation status change
EQQUX009 controller 31 ANY Operation initiation
EQQUX011 controller 31 ANY Job-tracking log write
EQQUX013 controller 31 ANY Job-tailoring prevention
EQQUX014 controller 24 24 Scheduler time adjustment
EQQUXCAT EQQDELDS sample or EQQCLEAN program 31 ANY EQQDELDS/EQQCLEAN catalog exit
user-defined Fetch directive on //%OPC JCL statement 24/31 24 JCL imbed
user-defined JCL variable 24/31 24 Variable substitution
user-defined Rebuild parameter of AJR control statement 31 ANY Automatic job recovery
EQQDPUE1 Daily planning job 31 ANY Daily planning report
EQQUXPIF PIF 31 ANY Validation of changes done in AD (INSERT or REPLACE AD)
EQQUXGDG EQQCLEAN program 31 ANY EQQCLEAN GDG resolution
EQQUXSAZ controller 31 24 System Automation command
Note:
  1. All exits are entered with the RACF® authority of the HCL Workload Automation for Z subsystem.
  2. Calling the program-interface module, EQQYCOM, from exits that are taken by the controller address space is not recommended and will cause unpredictable results if attempted.

For more information about the running environment of the exits, see Sample library (SEQQSAMP) and Diagnosis Guide and Reference.

The following pages describe the HCL Workload Automation for Z exits and include information about:
  • Conditions that cause the exit to be called
  • The mapping of each parameter (described in assembler-language format).