Utilities › TMSCLEAN Utility—List Scratch, Clean and Scratch Inventory Volumes › Scratch and Clean Listing

Scratch and Clean Listing

The Scratch and Clean Listing reports on all volumes that were scratched during the execution of TMSCLEAN with the SCRATCHLIST parameter and without the TEST parameter. A volume is considered eligible for scratch if the expiration date for File 1 is less than or equal to the execution date and the OUTCODE field contains hexadecimal zeros or a blank in the first position (but not (blank)LIB).

All multivolume pointers (1STVOL, NEXTVOL and PREVVOL) are cleared when volumes are scratched. Multi-data set pointers (1STDSNB, LSTDSNB and NUMDSNB) are cleared from the Volume record, and the DSNB records associated with the secondary files are cleared of information and returned to the free chain of available DSNBs.

Execution of various CA 1 utilities may be required prior to TMSCLEAN, depending on the CA 1 keyword dates in use.

• TMSEXPDT may be executed to reset the expiration criteria for eligible data sets. This utility is necessary only if you are using a Retention Data Set (RDS). Normally, TMSEXPDT overrides expiration dates only for data sets that used the CA 1 default (specified to the RP parameter in the TMOOPTxx member of hlq.CTAPOPTN). Optionally, JCL-supplied values can be overridden if the RO parameter in TMOOPTxx is set to YES or if the DEFAULT indicator was turned on when the TMC was initially formatted.
• TMSCTLG must be executed if you have data sets using Catalog Control on systems not yet running r5.2 or above. The program determines which Catalog Controlled data sets no longer have an entry in the MVS catalog and resets the expiration date to the current date plus any catalog extension (the number of days specified to the R9 parameter in the TMOOPTxx member of hlq.CTAPOPTN). Once all systems have been upgraded to r5.2 or higher and the TMSOSCAT utility has been run with the SYNC parameter, TMSCTLG no longer needs to be run.
• TMSCYCLE must be executed if you have data sets using Cycle Control. The program determines which data sets should be removed from Cycle Control, and resets the expiration date to the current date plus any cycle extension (the number of days specified to the RC parameter in the TMOOPTxx member of hlq.CTAPOPTN).
• TMSCLEAN may issue a return code four (RC=4). The possible causes are listed, refer to the report to diagnose the cause:
  1. SMS was unable to obtain MGMTCLAS definitions.
  2. SMS was unable to calculate the maximum retention period.
  3. Tape volume was not scratched due to chaining errors.
  4. Uncatalog or locate error occurred on a tape file.