You can configure certain criteria of the MVSSPLHK housekeeping process. Refer to
Sample Parameters File for a sample JCL file that contains some of the parameters listed below:
- Parameter specification
- You can either specify the parameters in-stream or in a configuration file:
- SYSIN DD specifies that the parameters are in-stream.
- CONFIGI DD DSN=<dataset> specifies the file in which the parameters are stored.
- Output files
- You can specify an indexed output file that lists all the files archived by the housekeeping process.
- INDEXO DD DSN=<dataset> specifies the file in which a list of the archived files is stored.
- You can view this file in ESMAC, or with the aid of the copybook
SPLHKARC.CPY, you can read the file and output the details to a location of your choice.
- A SYSPRINT file is also produced, which contains additional information about the housekeeping process. It specifies the parameters used, the archive locations, and the actions performed on each archived file.
- A SYSOUT DD also displays a summary of the process, including its progress, and any errors displayed via the SYSERR DD.
- All these files together provide a comprehensive audit trail for the housekeeping process.
- The type of archiving to run
- Select one of the following:
- NONE
- The spool clean-up is performed, but no files are archived.
- DATA
- The spool clean-up is performed, and only the spool data files are archived
- FULL
- The spool clean-up is performed, and all files are archived. They are moved to a new directory at the archive location, specified by the MF_SPOOL_ARCHIVE_LOC environment variable. The name of the directory consists of the date and time that the archive ran; a directory of this name should not already exist in order for the housekeeping to run.
- FULL, ALL
- As FULL.
- FULL, HELD
- The spool clean-up is performed, and only held data sets are archived.
- Setting the retain period
- You can specify the default retain period (in days) for the housekeeping process:
MAX-RETAIN-PERIOD 006
- sets the default retain period to 6 days.
- Override the retain period for individual jobs
- You can specify a retain period for individual jobs, overriding the default retain period.
JOB_KEEP XXX* 002
JOB_KEEP BCCRSD35 012
JOB_KEEP YYY*
- sets the retain period for any job beginning with XXX to 2 days, sets the retain period for the BCCRSD35 job to 12 days, and keeps any jobs beginning with YYY indefinitely.
- Override the retain period for jobs in a particular class
- You can specify a retain period for jobs in a particular class, overriding the default retain period.
CLASS A 003 Y
CLASS Z 999 N
- sets the retain period for jobs within class A to 3 days, and any older than that are archived, and sets the retain period for jobs in class Z to 999 days (the maximum allowed), and any older than that are not archived.
- Override the spool housekeeping run date/time
- You can override the date and time that the housekeeping is due to run by setting an environment variable:
MF_SPOOL_HK_TESTDATE=YYYYMMDD
or by passing a parameter to MVSSPLHK when it is invoked:
EXEC PGM=MVSSPLHK,PARM='2014051510303002
sets the spool housekeeping and archiving to run on 05/15/2014 10:30:30:02.
