Job Control Statements

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

Job Control Statements

//stepname EXEC PGM=TMSCLEAN,PARM='[TEST,]SCRATCHLIST[,F][,HOLDDAYS=n]'
//STEPLIB  DD  DSN=CAI.CTAPLINK,DISP=SHR
//TMSRPT   DD  SYSOUT=A
//TMSOPTNS DD  DSN=hlq.CTAPOPTN(TMSOPTNS),DISP=SHR
//EARLOUT  DD  DSN=scratch.list.earlout,                *NOTES
//             DISP=(NEW,CATLG,DELETE),
//             UNIT=SYSDA,
//             VOL=SER=VOLSER,
//             SPACE=(CYL,5),
//             DCB=RECFM=FB,LRECL=376,BLKSIZE=15416)    *NOTES
[//SCRACCT  DD  DSN=tape.acctng.info,UNIT=TAPE,DISP=(NEW,KEEP)      ]
[//             [,DCB=BLKSIZE=n*340]                     *NOTES    ]
[//TMSRPT89  DD SYSOUT=A]
[//SYSIN     DD *]
[VOL=ssssss-eeeeee]
[EXCLUDE=ssssss-eeeeee]
[SCRPOOL=xxxxx]
[FILE1DSN=pattern]

Consider the following:

If the EARLOUT data set is used with TMSUNCAT to uncatalog data sets on other systems, catalog and save the data set. Use the EARLOUT data set as input to TMECLNxx to produce the reports for TMSCLEAN. The sample JCL provided has a step to execute CA Earl.
The BLKSIZE can be any multiple of 376.
The BLKSIZE can be any multiple of the LRECL, which is 340. If no BLKSIZE is specified and the release of the operating system supports system determined blocksize, the operating system selects the blocksize. Otherwise the BLKSIZE for SCRACCT and OUTAREA defaults to 32640 for tape or 8840 for DASD devices.

Parameter Definitions

The parameters must be specified in this order. All parameters except SCRATCHLIST are optional.

TEST: Process normally, but do not update any TMC records. The records processed are written to EARLOUT to subsequently produce the Scratch and Clean Listing, but the TMC is not updated.When the TEST parameter is used, the Scratch and Clean Listing does not include tapes expired from CATALOG, CATLG/ddd or LDATE/ddd control.
SCRATCHLIST: Indicates that tapes eligible for scratch are to be output to the EARLOUT data set, and subsequently used to produce the Scratch and Clean Listing.
F: The FAST paremeter can be used if tapes are under CATALOG control and the OCTLG option is set to NO in TMOOPTnn in CTAPOPTN. This parameter causes TMSCLEAN to stop processing on a DSNB chain as soon as it finds a DSNB that is still cataloged to the OS catalog. Without this parameter, TMSCLEAN processing will continue through the entire DSNB chain checking the OS catalog for all of them and expiring them if not found. This parameter is not recommended if you use CA 1 Copycat's FILECOPY with a control statement of FILES=ACTIVE. This will cause files to be copied that would have otherwise been expired.
HOLDDAYS=n: The HOLDDAYS parameter can be used if tapes are under CATALOG control and the OCTLG option is set to NO in TMOOPTnn in CTAPOPTN. This parameter indicates the minimum protection time of tape data sets under catalog control which were never cataloged. TMSCLEAN keeps these data sets n days before checking their catalog status, to protect long-running tape jobs. Valid values for n are 2 through 9. The default is HOLDDAYS=2.

JCL Considerations

SCRACCT DD

A TMC record image is written for every tape being scratched. You can use this information to determine the elapsed time of ownership for accounting and billing purposes (assuming CA 1 has been directed to capture accounting data). This DD statement is optional.

SYSIN DD

If the SYSIN DD is found, the TMC is processed based on the volumes that are specified in the range control statements. If no control statements are coded, the complete TMC is processed. A maximum of 20,000 range control statements is allowed. If the SYSIN DD is not found, then TMSCLEAN processes the complete TMC.

Example

//SYSIN DD *¨ 
VOL=ssssss-eeeeee¨    
EXCLUDE=ssssss-eeeeee¨ 
SCRPOOL=xxxxx¨

TMSRPT89 DD

This DD must be coded, if the SYSIN DD is used. The range control statements are printed to this DD and any errors that found in the control statements are printed to this DD.

Range Control Statements

VOL=ssssss-eeeeee

The VOL statement is used to select the volumes to be processed based on a starting and ending volume number. You can specify a single volume by only coding a start volume.

Example: This control card processes volumes 001500-001524 and 001531-001550:

	//SYSIN    DD  *
	       VOL=001500-001550
	       EXCLUDE=001525-001530
	//

Note: Start and end volumes must be six digit numbers. If the volume number has five or fewer digits, it must be padded with 0 s, such as VOL=001500-001575.

SCRPOOL=xxxxx

The SCRPOOL statement is used to select the volumes to be processed based on a scratch subpool name.

FILE1DSN=pattern

The FILE1DSN statement is used to select the volumes based on the DSN of the first file on the volume, using standard CA 1 pattern masking. When the FILE1DSN statement is the only selection statement that is used, the complete TMC is processed and only volumes that match the specified pattern are processed. If FILE1DSN= statement is used with VOL and/or SCRPOOL statements, then only volumes within the requested ranges that match the pattern are processed.

EXCLUDE=ssssss-eeeeee

The EXCLUDE statement selects the volumes you want to exclude from processing based on a starting and ending volume number. To specify a single volume, code only a start volume.

Start and end volumes must be six digit numbers. If the volume number has five or fewer digits, it must be padded with 0s.

EXCLUDE=001500-001575

The EXCLUDE control statement can be used without a VOL control statement.

Example: The control statement excludes the volser range of 001500-001550 from being processed by TMSCLEAN.

EXCLUDE=001500-001550

Note: If the volumes included match the volumes excluded, the exclude control statement overrides the include control statement.