EQQCLEAN Pre-step insertion considerations

The HCL Workload Automation for Z controller can insert the pre-step EQQCLEAN into the JCL before submitting it, to perform:

The Cleanup together with the job, and/or
A Step Restart simulating the Restart and Cleanup and GDG, when you requested in the appropriate panel

This means that the EQQCLEAN pre-step can be inserted when requested by:

A user command in a panel, when Restart and Cleanup Step Restart was selected
A rerun of a job with the cleanup type set to Automatic

In both these situations, you cannot see or modify the EQQCLEAN pre-step when editing the JCL, because the submitted JCL is stored in JS VSAM without the pre-step. Only when you edit the JCL through the Restart and Cleanup, Step Restart or Job Restart, and the expanded JCL type was requested, you can see the EQQCLEAN pre-step, though the changes cannot be seen. The JCL of expanded type is never stored in JS VSAM.

When you insert the EQQCLEAN pre-step in a JCL, consider that:

It must be inserted after the JOB statement.
It must be inserted immediately before the first EXEC statement.
If there are INCLUDE statements before the first EXEC statement, insert the pre-step before the INCLUDE statements. However, if the INCLUDE statements are listed in the RCLOPTS SKIPINCLUDE keyword, this rule does not apply. In this case, insert the pre-step immediately before the first EXEC statement.

Because the HCL Workload Automation for Z Controller inserts the EQQCLEAN pre-step without knowing the contents of the INCLUDE statements (handled by JES), these type of statements in a JCL could cause, in particular conditions, a wrong positioning of the EQQCLEAN pre-step. To prevent EQQCLEAN pre-step from wrong positioning, use the RCLOPTS SKIPINCLUDE keyword. For details about RCLOPTS SKIPINCLUDE, refer to the Customization and Tuning.