Running the Archive Database Cleanup program

Run the Cleanup program periodically on the Archive Database to determine whether archived data sets are eligible for expiration. The Cleanup program also determines how full the archive tapes are, and if they no longer contain archived data, Cleanup expires the archive tape in the tape management system.

About this task

The Cleanup program processes every data set record in the Archive Database to determine whether the corresponding data set is eligible for expiration due to any of these circumstances:

Its expiration date has passed.
It no longer has an entry in the ICF catalog.
Its ICF catalog entry does not specify RCHIVE as its volume serial number.
It has met the conditions that were specified by the SMS management class to which it is assigned.

For every archived data set that is eligible for expiration, the Cleanup program does the following:

Deletes the corresponding Archive Database record
Deletes the corresponding ICF catalog entry (if an entry exists)
Writes the data set information to the Cleanup report

For every archived data set that is not eligible for expiration, the Cleanup program adds to an active block counter the number of blocks that the data set occupies on the archive tape.

After all of the Archive Database records have been processed, the Cleanup program processes every archive tape record to determine whether the tape record has a matching entry in the active block counters.

If there is no such entry in the active block counters, the tape can be expired and Cleanup performs the following tasks:
- Deletes the tape’s record in the Archive Database
- Expires the tape’s record (and the records for any secondary archive tape volumes) in the tape management system
- Writes a record to the Cleanup report, listing the expired volumes
If there is such an entry in the active block counters, the tape still contains archived data sets, so Cleanup updates the tape record with a newly calculated Active Capacity in megabytes.

Finally, the Cleanup process writes the summary totals to the Cleanup report.

Note:

You can run the Cleanup program in simulate mode to generate a Cleanup report without updating the Archive Database, the ICF catalog, or the tape management system. While this is an optional step, reviewing the information in the Cleanup report before the Archive Database is modified can prevent accidental deletions.
You can use console commands to monitor and control the Cleanup process as it executes. See step 3 for more information.

Procedure

Edit JCL sample library member AXQCLNUP:

Provide valid job card information for the AXQCLNUP JCL.
Replace all occurrences of @HLQ with your data set prefix.

If you do not want to run Cleanup in simulate mode, go directly to step 2. Otherwise, add the PARM=SIM specification to the EXEC statement, as shown in the following figure.

//AXQCLNUP JOB (ACCT1,ACCT2),'PROG.NAME',REGION=0M,TYPRUN=HOLD,        
//             CLASS=A,MSGCLASS=A,MSGLEVEL=(1,1),NOTIFY=&SYSUID        
//*                                                                    
//*-------------------------------------------------------------------*
//*                                                                   *
//*      © ROCKET SOFTWARE, INC. OR ITS AFFILIATES 2014-2018.         *
//*      ALL RIGHTS RESERVED.                                         *
//*                                                                   *
//*                                                                   *
//*      CLEAN UP ARCHIVED FILES AND ARCHIVE TAPES                    *
//*                                                                   *
//*                                                                   *
//*      THIS JOB IS USED TO CLEAN UP ARCHIVED FILES THAT ARE         *
//*      ELIGIBLE FOR EXPIRATION  AND ANY ARCHIVE TAPES THAT ARE      *
//*      EMPTY.                                                       *
//*                                                                   *
//*      BEFORE YOU RUN THIS JOB, DO THE FOLLOWING:                   *
//*         1) ENSURE THAT THE JOBCARD IS VALID FOR YOUR              *
//*            ENVIRONMENT                                            *
//*         2) SUBSTITUTE YOUR DATA SET PREFIX FOR @HLQ               *
//*                                                                   *
//*-------------------------------------------------------------------*
//*                                                                    
//S010     EXEC PGM=AXQCLNUP,PARM=SIM                                 
//STEPLIB  DD DISP=SHR,DSN=@HLQ.SAXQLOAD                               
//AXQPRLIB DD DISP=SHR,DSN=@HLQ.SAXQPARM                               
//

//AXQCLNUP JOB (ACCT1,ACCT2),'PROG.NAME',REGION=0M,TYPRUN=HOLD,        
//             CLASS=A,MSGCLASS=A,MSGLEVEL=(1,1),NOTIFY=&SYSUID        
//*                                                                    
//*-------------------------------------------------------------------*
//*                                                                   *
//*      5698-AAD                                                     *
//*      © ROCKET SOFTWARE, INC. OR ITS AFFILIATES 2014-2018.         *
//*      ALL RIGHTS RESERVED.                                         *
//*                                                                   *
//*                                                                   *
//*      CLEAN UP ARCHIVED FILES AND ARCHIVE TAPES                    *
//*                                                                   *
//*                                                                   *
//*      THIS JOB IS USED TO CLEAN UP ARCHIVED FILES THAT ARE         *
//*      ELIGIBLE FOR EXPIRATION  AND ANY ARCHIVE TAPES THAT ARE      *
//*      EMPTY.                                                       *
//*                                                                   *
//*      BEFORE YOU RUN THIS JOB, DO THE FOLLOWING:                   *
//*         1) ENSURE THAT THE JOBCARD IS VALID FOR YOUR              *
//*            ENVIRONMENT                                            *
//*         2) SUBSTITUTE YOUR DATA SET PREFIX FOR @HLQ               *
//*                                                                   *
//*-------------------------------------------------------------------*
//*                                                                    
//S010     EXEC PGM=AXQCLNUP,PARM=SIM                                 
//STEPLIB  DD DISP=SHR,DSN=@HLQ.SAXQLOAD                               
//AXQPRLIB DD DISP=SHR,DSN=@HLQ.SAXQPARM                               
//

Submit the job.
Review the Cleanup report to confirm that nothing that needs to be retained will be deleted from the database when Cleanup is run without the SIM parameter.
Remove PARM=SIM from the EXEC statement.
Go on to step 2.

Submit AXQCLNUP for execution.

Note: Should you need to shut down HSM, you must first stop the Cleanup job.

To monitor or stop the Cleanup process, use the appropriate console command.

Console command Description

Console command	Description
STATUS	When you issue the STATUS command, the Cleanup process issues a WTO message that shows the following information: The current number of requests that are queued The number of requests that completed successfully The number of requests that failed to complete Syntax: `F jobname,STATUS` where `jobname` is the jobname of the job currently executing.
HALT	When you issue the HALT command, the Cleanup process terminates after the current group of queued requests has been processed. Any remaining Archive Database records that have not yet been processed are ignored without any additional processing or reporting. Syntax: `F jobname,HALT` where `jobname` is the jobname of the job currently executing.

STATUS

When you issue the STATUS command, the Cleanup process issues a WTO message that shows the following information:

The current number of requests that are queued
The number of requests that completed successfully
The number of requests that failed to complete

Syntax: F jobname,STATUS

where jobname is the jobname of the job currently executing.

HALT

When you issue the HALT command, the Cleanup process terminates after the current group of queued requests has been processed. Any remaining Archive Database records that have not yet been processed are ignored without any additional processing or reporting.

Syntax: F jobname,HALT

where jobname is the jobname of the job currently executing.

Example

The following figure shows an example Archive Expiration Report that was created by running Cleanup in simulate mode:

VER X.X            ***SIMULATE***           R O C K E T   A R C H I V E   M A N A G E R  FOR  Z/OS ***SIMULATE***  AXQCLNUP JOBXXXXX

DATE: XX/XX/XXXX.XXX  TIME: XX:XX:XX                 ARCHIVE EXPIRATION REPORT FOR COMPANY_NAME                          PAGE      1

                                               ARCH     ARCHIVE      CREATE     LAST USED  EXPIRATION
DATA SET NAME                                 VOLUME   SIZE IN MB     DATE        DATE        DATE     MGMTCLAS  REASON
--------------------------------------------  ------  -----------  ----------  ----------  ----------  --------  -------------------
AXBW0101.COPY                                 VD0997        0.868  08/15/2016  08/15/2016    -NONE-    STANDARD  NOT CATALOGED
AXBW0101.HTTT.WORK1                           VD0997        3.260  01/01/2015  01/01/2015    -NONE-    TMMBKUP   NOT CATALOGED
AXBW0101.HTTT.WORK2                           VD0997        3.490  01/01/2015  08/15/2016    -NONE-    TMMBKUP   NOT CATALOGED
AXBW0101.RZZ.MS.CLUSTER                       VD0997        0.082  01/01/2015  01/01/2015    -NONE-    TMMBKUP   NOT CATALOGED
AXBW0101.RZZ.MS.CLUSTER1                      VD0997        0.082  08/15/2016  08/15/2016    -NONE-    STANDARD  NOT CATALOGED
AXBW0101.RZZ.Z00.CLUSTER                      VD0997        0.082  08/15/2016  08/15/2016    -NONE-    STANDARD  NOT CATALOGED
AXBW0101.RZZ.Z00.CLUSTER1                     VD0997        0.082  08/15/2016  08/15/2016    -NONE-    STANDARD  NOT CATALOGED
CSTS.CST1.B1.D140506.T030429.U415434          VD0710        0.066  08/15/2016  08/15/2016    -NONE-    STANDARD  NOT CATALOGED
CSTS.CST1.B1.D141028.T040339.U013474          VD0710        0.049  08/15/2016  08/15/2016    -NONE-    STANDARD  NOT CATALOGED
CSTS.CST1.B1.D141028.T040507.U379072          VD0710        0.066  08/15/2016  08/15/2016    -NONE-    STANDARD  NOT CATALOGED
CSTS.CST1.B1.D141028.T111251.U736589          VD0710        0.049  08/15/2016  08/15/2016    -NONE-    STANDARD  NOT CATALOGED
CSTS.CST1.B1.D141028.T111419.U867448          VD0710        0.066  08/15/2016  08/15/2016    -NONE-    STANDARD  NOT CATALOGED
CSTS.CST1.B1.D150417.T044822.U865088          VD0710        0.049  08/15/2016  08/15/2016    -NONE-    STANDARD  NOT CATALOGED
CSTS.CST1.B1.D150417.T044941.U921151          VD0710        0.066  08/15/2016  08/15/2016    -NONE-    STANDARD  NOT CATALOGED
CSTS.CST1.B1.D150710.T155307.U585838          VD0710        0.049  08/15/2016  08/15/2016    -NONE-    STANDARD  NOT CATALOGED
.
.
.
VER X.X            ***SIMULATE***           R O C K E T   A R C H I V E   M A N A G E R  FOR  Z/OS ***SIMULATE***  AXQCLNUP JOBXXXXX

DATE: XX/XX/XXXX.XXX  TIME: XX:XX:XX                 ARCHIVE EXPIRATION REPORT FOR COMPANY_NAME                          PAGE    198

ARCHIVE TAPE(S) EXPIRED VOL=VD0234  COPY 2 VOL=C10148  COPY 3 VOL=C60002                                                            
ARCHIVE TAPE(S) EXPIRED VOL=VD0710  COPY 2 VOL=C10139  COPY 3 VOL=C60000                                                            
ARCHIVE TAPE(S) EXPIRED VOL=VD0955  COPY 2 VOL=C10144  COPY 3 VOL=C60001                                                            
ARCHIVE TAPE(S) EXPIRED VOL=VD0981                                                                                                  
ARCHIVE TAPE(S) EXPIRED VOL=VD0997  COPY 2 VOL=C10152  COPY 3 VOL=C60003                                                            
                                                                                                                                    
                                                                                                                                    
                                                                                                                                    
                               ACTIVE         EXPIRED                                                                               
                           -------------- --------------                                                                            
ARCHIVED DATA SETS                      0            249                                                                            
                                                                                                                                    
ARCHIVE CLOUD DATA (MB)                 0              0                                                                            
                                                                                                                                    
ARCHIVE TAPE VOLUMES                    0             13                                                                            
ARCHIVE TAPE DATA (MB)                  0            937                                                                            
ARCHIVE TAPE CAPACITY (MB)              0  1,299,987,000

VER X.X            ***SIMULATE***                 A D V A N C E D   A R C H I V E  FOR  DFSMShsm   ***SIMULATE***  AXQCLNUP JOBXXXXX

DATE: XX/XX/XXXX.XXX  TIME: XX:XX:XX                 ARCHIVE EXPIRATION REPORT FOR COMPANY_NAME                          PAGE      1

                                               ARCH     ARCHIVE      CREATE     LAST USED  EXPIRATION
DATA SET NAME                                 VOLUME   SIZE IN MB     DATE        DATE        DATE     MGMTCLAS  REASON
--------------------------------------------  ------  -----------  ----------  ----------  ----------  --------  -------------------
AAWP.CATERING.AAWP0301.DT.AP.DIS.G0352V00     V00001        0.492  XX/XX/XXXX  XX/XX/XXXX    -NONE-    GDG       NOT CATALOGED
AAWP.CATERING.AAWP0301.DT.AP.DIS.G0353V00     V00001        0.524  XX/XX/XXXX  XX/XX/XXXX    -NONE-    GDG       NOT CATALOGED
AAWP.CATERING.AAWP0301.DT.AP.DIS.G0355V00     V00001        0.524  XX/XX/XXXX  XX/XX/XXXX    -NONE-    GDG       NOT CATALOGED
AAWP.CATERING.AAWP0304.CH.LWN.GL.G0087V00     V00001        0.672  XX/XX/XXXX  XX/XX/XXXX    -NONE-    GDG       NOT CATALOGED
AAWP.CATERING.AAWP0304.CH.LWN.GL.G0091V00     V00001        0.492  XX/XX/XXXX  XX/XX/XXXX    -NONE-    GDG       NOT CATALOGED
AAWP.CATERING.AAWP0305.HOSP.LWN.GL.G0088V00   V00001       13.009  XX/XX/XXXX  XX/XX/XXXX    -NONE-    GDG       NOT CATALOGED
AAWP.CATERING.AAWP0305.HOSP.LWN.GL.G0090V00   V00001       13.238  XX/XX/XXXX  XX/XX/XXXX    -NONE-    GDG       NOT CATALOGED
AAWP.CATERING.AAWP0306.FH.LWN.GL.G0084V00     V00001        1.999  XX/XX/XXXX  XX/XX/XXXX    -NONE-    GDG       NOT CATALOGED
AAWP.CATERING.AAWP0306.FH.LWN.GL.G0085V00     V00001        1.802  XX/XX/XXXX  XX/XX/XXXX    -NONE-    GDG       NOT CATALOGED
AAWP.CATERING.AAWP0306.FH.LWN.GL.G0086V00     V00001        1.868  XX/XX/XXXX  XX/XX/XXXX  XX/XX/XXXX  GDG       EXPDT DATE PASSED
AAWP.CATERING.AAWP0306.FH.LWN.GL.G0087V00     V00001        0.803  XX/XX/XXXX  XX/XX/XXXX  XX/XX/XXXX  GDG       EXPDT DATE PASSED
AAWT.ACS.AZ                                   V00001       35.078  XX/XX/XXXX  XX/XX/XXXX  XX/XX/XXXX  MT6       NOT CATALOGED
AAWT.ACS.AZ.FTP                               V00001        3.801  XX/XX/XXXX  XX/XX/XXXX    -NONE-    MT6       NOT CATALOGED
AAWT.AZ.BADGE                                 V00001        3.801  XX/XX/XXXX  XX/XX/XXXX    -NONE-    MT6       NOT CATALOGED
AAWT.AZ.BADGE.FTP                             V00001       35.078  XX/XX/XXXX  XX/XX/XXXX    -NONE-    MT6       NOT CATALOGED
AAWT.EXPORT.BADGE.AZ                          V00001       35.078  XX/XX/XXXX  XX/XX/XXXX    -NONE-    MT6       NOT CATALOGED
ADRP.UPDADR.REPORT                            V00001        7.504  XX/XX/XXXX  XX/XX/XXXX    -NONE-    YR2       NOT CATALOGED
.
.
.
VER X.X            ***SIMULATE***                 A D V A N C E D   A R C H I V E  FOR  DFSMShsm   ***SIMULATE***  AXQCLNUP JOBXXXXX

DATE: XX/XX/XXXX.XXX  TIME: XX:XX:XX                 ARCHIVE EXPIRATION REPORT FOR COMPANY_NAME                          PAGE    198

ARCHIVE TAPE(S) EXPIRED VOL=V00221  COPY 2 VOL=W00221  COPY 3 VOL=X00221  COPY 4 VOL=Y00221
ARCHIVE TAPE(S) EXPIRED VOL=V00222  COPY 2 VOL=W00222
ARCHIVE TAPE(S) EXPIRED VOL=V00223  COPY 2 VOL=W00223  COPY 3 VOL=X00223  COPY 4 VOL=Y00223
ARCHIVE TAPE(S) EXPIRED VOL=V00224
ARCHIVE TAPE(S) EXPIRED VOL=V00225  COPY 2 VOL=W00225  COPY 3 VOL=X00225
ARCHIVE TAPE(S) EXPIRED VOL=V00226  COPY 2 VOL=W00226
ARCHIVE TAPE(S) EXPIRED VOL=V00227  COPY 2 VOL=W00227  COPY 3 VOL=X00227  COPY 4 VOL=Y00227
ARCHIVE TAPE(S) EXPIRED VOL=V00228
ARCHIVE TAPE(S) EXPIRED VOL=V00229  COPY 2 VOL=W00229  COPY 3 VOL=X00229  COPY 4 VOL=Y00229
ARCHIVE TAPE(S) EXPIRED VOL=V00230  COPY 2 VOL=W00230
ARCHIVE TAPE(S) EXPIRED VOL=V00231  COPY 2 VOL=W00231  COPY 3 VOL=X00231
ARCHIVE TAPE(S) EXPIRED VOL=V00232
ARCHIVE TAPE(S) EXPIRED VOL=V00233  COPY 2 VOL=W00233  COPY 3 VOL=X00233  COPY 4 VOL=Y00233
ARCHIVE TAPE(S) EXPIRED VOL=V00234  COPY 2 VOL=W00234
ARCHIVE TAPE(S) EXPIRED VOL=V00235  COPY 2 VOL=W00235  COPY 3 VOL=X00235  COPY 4 VOL=Y00235
ARCHIVE TAPE(S) EXPIRED VOL=V00236
ARCHIVE TAPE(S) EXPIRED VOL=V00237  COPY 2 VOL=W00237  COPY 3 VOL=X00237
ARCHIVE TAPE(S) EXPIRED VOL=V00238  COPY 2 VOL=W00238
ARCHIVE TAPE(S) EXPIRED VOL=V00239  COPY 2 VOL=W00239  COPY 3 VOL=X00239  COPY 4 VOL=Y00239
ARCHIVE TAPE(S) EXPIRED VOL=V00240
ARCHIVE TAPE(S) EXPIRED VOL=V00241  COPY 2 VOL=W00241  COPY 3 VOL=X00241  COPY 4 VOL=Y00241
ARCHIVE TAPE(S) EXPIRED VOL=V00242  COPY 2 VOL=W00242
ARCHIVE TAPE(S) EXPIRED VOL=V00243  COPY 2 VOL=W00243  COPY 3 VOL=X00243
ARCHIVE TAPE(S) EXPIRED VOL=V00244
ARCHIVE TAPE(S) EXPIRED VOL=V00245  COPY 2 VOL=W00245  COPY 3 VOL=X00245  COPY 4 VOL=Y00245
ARCHIVE TAPE(S) EXPIRED VOL=V00246  COPY 2 VOL=W00246


                               ACTIVE         EXPIRED
                           -------------- --------------
ARCHIVED DATA SETS                      0         10,000
ARCHIVE TAPE VOLUMES                    0            636
ARCHIVE TAPE DATA (MB)                  0      5,719,262
ARCHIVE TAPE CAPACITY (MB)              0        636,000