Editing and submitting the AXQRECYC job

The AXQRECYC member of the JCL sample library provides template JCL for running the Recycle function.

Before you begin

The Advanced Archive for DFSMShsm Recycle function is controlled by the values that were specified for two parameters:

RECYCLE-FROM-ARCHIVE-COPY-NUM
The value that is assigned to this parameter determines which archive tape or copy is the input for the Recycle process. Consider an example in which you have two copies of all of your recycle tapes (copy 1 and copy 2). You can specify RECYCLE–FROM–ARCHIVE–COPY–NUM 1 or RECYCLE–FROM–ARCHIVE–COPY–NUM 2 to control which copy is used for input to Recycle processing. Such flexibility is useful in situations where one of the copies is stored offsite.

For more information about this parameter, see RECYCLE-FROM-ARCHIVE-COPY-NUM.

RECYCLE-THRESHOLD-PERCENTAGE
The value that is assigned to this parameter sets the threshold for tape under-utilization. When a tape’s utilization percentage drops below this threshold, the tape qualifies for Recycle processing.

For more information about this parameter, see RECYCLE-THRESHOLD-PERCENTAGE.

If you did not customize the RECYCLE-FROM-ARCHIVE-COPY-NUM and RECYCLE-THRESHOLD-PERCENTAGE parameters in the Advanced Archive for DFSMShsm parameter library member AXQUSETS before the started task AXQTINIT was initialized, do one of the following:
  • Customize RECYCLE-FROM-ARCHIVE-COPY-NUM and RECYCLE-THRESHOLD-PERCENTAGE in AXQUSETS and issue the F AXQTINIT-stcname,REFRESH,PARMSF MXQTINIT-stcname,REFRESH,PARMS operator command to refresh the parameter settings..
  • Alternatively, you can add a AXQPSETS DD to the AXQRECYC JCL and specify the RECYCLE-FROM-ARCHIVE-COPY-NUM and RECYCLE-THRESHOLD-PERCENTAGE parameters and their values there.

About this task

Note: You can use console commands to monitor and control the Recycle process as it executes. See step 7 for more information.

Procedure

  1. Open JCL sample library member AXQRECYC for editing.
  2. Provide the appropriate job card information.
  3. Replace all occurrences of @HLQ with your data set prefix.
  4. Verify that RECYCLE-FROM-ARCHIVE-COPY-NUM and RECYCLE-THRESHOLD-PERCENTAGE have been assigned the appropriate values.
  5. Optional: If you want to run the Recycle job in simulation mode to produce a report that shows what would be selected for recycling and the expected results (see the Example section, below), based on your parameter settings, add PARM=SIM to the EXEC control card in the JCL and run the job. 
    //AXQRECYC JOB (ACCT1,ACCT2),'PROG.NAME',REGION=0M,TYPRUN=HOLD,        
//             NOTIFY=&SYSUID,CLASS=A,MSGCLASS=A,MSGLEVEL=(1,1)        
//*                                                                    
//*-------------------------------------------------------------------*
//*                                                                   *
//*      © ROCKET SOFTWARE, INC. OR ITS AFFILIATES 2014-20XX.         *
//*      ALL RIGHTS RESERVED.                                         *
//*                                                                   *
//*                                                                   *
//*      ARCHIVE TAPE RECYCLE                                         *
//*                                                                   *
//*                                                                   *
//*      THIS JOB IS USED TO RECYCLE UNDERUTILIZED ARCHIVE TAPES      *
//*      BASED ON PERCENT UTILIZED.                                   *
//*                                                                   *
//*      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=AXQRECYC,PARM=SIM                                 
//STEPLIB  DD DISP=SHR,DSN=@HLQ.SAXQLOAD                               
//AXQPRLIB DD DISP=SHR,DSN=@HLQ.SAXQPARM                               
//                                         
    //AXQRECYC JOB (ACCT1,ACCT2),'PROG.NAME',REGION=0M,TYPRUN=HOLD,        
//             NOTIFY=&SYSUID,CLASS=A,MSGCLASS=A,MSGLEVEL=(1,1)        
//*                                                                    
//*-------------------------------------------------------------------*
//*                                                                   *
//*      5698-AAD                                                     *
//*      © ROCKET SOFTWARE, INC. OR ITS AFFILIATES 2014-2018.         *
//*      ALL RIGHTS RESERVED.                                         *
//*                                                                   *
//*                                                                   *
//*      ARCHIVE TAPE RECYCLE                                         *
//*                                                                   *
//*                                                                   *
//*      THIS JOB IS USED TO RECYCLE UNDERUTILIZED ARCHIVE TAPES      *
//*      BASED ON PERCENT UTILIZED.                                   *
//*                                                                   *
//*      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=AXQRECYC,PARM=SIM                                 
//STEPLIB  DD DISP=SHR,DSN=@HLQ.SAXQLOAD                               
//AXQPRLIB DD DISP=SHR,DSN=@HLQ.SAXQPARM                               
//
    If the simulation results are not as you expected them to be, adjust the parameter settings accordingly and run the simulation again. When the simulation results are as you expected them to be, remove the SIM value from the EXEC control card then go to step 6.
  6. When you have finished editing the AXQRECYC JCL, submit the job for execution.
    Recycle processing writes the Candidate Records Passed to Recycle Task report to DD name RCYCRPT and the Recycle Report to DD name RCYRPT.
    Note: Should you need to shut down HSM, you must first stop the Recycle job.
  7. Optional: To monitor or stop the Recycle process, use the appropriate console command.
    Console command Description
    STATUS When you issue the STATUS command, the Recycle 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 Recycle process terminates after the current group of queued requests has been processed. Any remaining candidate data sets that are not yet queued for processing are ignored without any additional processing or reporting.

    Syntax: F jobname,HALT

    where jobname is the jobname of the job currently executing.
    HALT,I When you issue the HALT,I command, the Recycle process terminates when the current data set in the group of queued requests has been processed. Any remaining candidate data sets that are not yet queued for processing are ignored without any additional processing or reporting.

    Syntax: F jobname,HALT,I

    where jobname is the jobname of the job currently executing.

Example

The following figure shows an example of the Candidate Records Passed to Recycle Task report that was generated by running the Recycle function in simulation mode. The report is a high-level summary of each subgroup of files that were processed by Recycle.
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***  MAXQRECYC JOBXXXXX

DATE: XX/XX/XXXX.XXX  TIME: XX:XX:XX          CANDIDATE RECORDS PASSED TO RECYCLE TASK FOR COMPANY_NAME                  PAGE      1

ARCHIVE   ARCH   BLK/ID                 DATA SET NAME                 SIZE IN KB  UT%                    RESULTS                    
<GRP ID> <VSER> <IN HEX> <------------------------------------------> <--------> <--> <-------------------------------------------->

------------------------------------------------------------------------------------------------------------------------------------

START OF GROUP:                                                                                                                     

GROUP2   V00010 00000004 AP00131.PACP.KPPMVMD.PA.VISIT                     5,964   4% SIM: RECYCLE FUNCTIONS BYPASSED
GROUP2   V00010 00000033 AP00131.PACP.KPPMVMD.PA.VISIT.SSF                    16   4% SIM: RECYCLE FUNCTIONS BYPASSED
GROUP2   V00010 00000034 AP00131.PACP.KUPHYMT.PA.HIST.RMH.Y2007               33   4% SIM: RECYCLE FUNCTIONS BYPASSED
GROUP2   V00010 00000035 AP00131.PACP.KUPHYMT.PA.HIST.RMH.Y2010               82   4% SIM: RECYCLE FUNCTIONS BYPASSED
GROUP2   V00010 00000036 AP00131.PACP.KUPHYMT.PA.HIST.YTD                  3,588   4% SIM: RECYCLE FUNCTIONS BYPASSED
GROUP2   V00010 00000053 AP00131.PACP.KUPHYMT.PA.HIST.YTD.AU13                33   4% SIM: RECYCLE FUNCTIONS BYPASSED
.
.
.
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***  AXQRECYC JOBXXXXX

DATE: XX/XX/XXXX.XXX  TIME: XX:XX:XX          CANDIDATE RECORDS PASSED TO RECYCLE TASK FOR COMPANY_NAME                  PAGE      4

ARCHIVE   ARCH   BLK/ID                 DATA SET NAME                 SIZE IN KB  UT%                    RESULTS                    
<GRP ID> <VSER> <IN HEX> <------------------------------------------> <--------> <--> <-------------------------------------------->

------------------------------------------------------------------------------------------------------------------------------------

GROUP4   V00008 00001653 AP00131.MAY06.PACT.PACCB504.KPBALWD.SORTED           16  15% SIM: RECYCLE FUNCTIONS BYPASSED
GROUP4   V00008 00001654 AP00131.MAY06.PACT.PACCB537.KPCERWD                  16  15% SIM: RECYCLE FUNCTIONS BYPASSED
GROUP4   V00008 00001655 AP00131.MA23.PACP.KW894BC.KPPTCWD                24,887  15% SIM: RECYCLE FUNCTIONS BYPASSED
GROUP4   V00008 00001714 AP00131.MRAT.KMDRGMD.DRG.MASTER                 443,466  15% SIM: RECYCLE FUNCTIONS BYPASSED
GROUP4   V00008 0000244D AP00131.PACI.KPA01BC.KP837WD.V5                     983  15% SIM: RECYCLE FUNCTIONS BYPASSED
GROUP4   V00008 00002456 AP00131.PACI.SORT.KP837W2.V5                      2,359  15% SIM: RECYCLE FUNCTIONS BYPASSED
GROUP4   V00136 00000004 AP00132.PACP.KP434BC.KPCRSWD.MAY136               3,752   0% SIM: RECYCLE FUNCTIONS BYPASSED
GROUP4   V00140 00000004 AP00132.PACP.KP445BC.KPOBPWD.OP.MAY155        1,101,775  14% SIM: RECYCLE FUNCTIONS BYPASSED
GROUP4   V00232 00000004 AP00414.SAACTYTD.SMH.YTD.ACTIVITY             1,555,022  19% SIM: RECYCLE FUNCTIONS BYPASSED

SIZE OF PROCESSED GROUP:          3.877GB #DATASETS IN GROUP:                    36                                                 

************************************************************************************************************************************


TOTAL RECYCLED:                   7.424GB #DATASETS:                            147  #GROUPS PROCESSED:           3                 
VER X.X            ***SIMULATE***                 A D V A N C E D   A R C H I V E  FOR  DFSMShsm   ***SIMULATE***  AXQRECYC JOBXXXXX

DATE: XX/XX/XXXX.XXX  TIME: XX:XX:XX          CANDIDATE RECORDS PASSED TO RECYCLE TASK FOR COMPANY_NAME                  PAGE      1

ARCHIVE   ARCH   BLK/ID                 DATA SET NAME                 SIZE IN KB  UT%                    RESULTS                    
<GRP ID> <VSER> <IN HEX> <------------------------------------------> <--------> <--> <-------------------------------------------->

------------------------------------------------------------------------------------------------------------------------------------

START OF GROUP:                                                                                                                     
                                                                                                                                    
CATDS    VD0710 00000004 CSTS.CST1.B1.D140506.T030429.U415434                 66   0% SIM: RECYCLE FUNCTIONS BYPASSED
CATDS    VD0710 00000008 CSTS.CST1.B1.D141028.T040339.U013474                 49   0% SIM: RECYCLE FUNCTIONS BYPASSED
CATDS    VD0710 0000000B CSTS.CST1.B1.D141028.T040507.U379072                 66   0% SIM: RECYCLE FUNCTIONS BYPASSED
CATDS    VD0710 0000000F CSTS.CST1.B1.D141028.T111251.U736589                 49   0% SIM: RECYCLE FUNCTIONS BYPASSED
CATDS    VD0710 00000012 CSTS.CST1.B1.D141028.T111419.U867448                 66   0% SIM: RECYCLE FUNCTIONS BYPASSED
CATDS    VD0710 00000016 CSTS.CST1.B1.D150417.T044822.U865088                 49   0% SIM: RECYCLE FUNCTIONS BYPASSED              
.
.
.
VER X.X            ***SIMULATE***                 A D V A N C E D   A R C H I V E  FOR  DFSMShsm   ***SIMULATE***  AXQRECYC JOBXXXXX

DATE: XX/XX/XXXX.XXX  TIME: XX:XX:XX          CANDIDATE RECORDS PASSED TO RECYCLE TASK FOR COMPANY_NAME                  PAGE      4

ARCHIVE   ARCH   BLK/ID                 DATA SET NAME                 SIZE IN KB  UT%                    RESULTS                    
<GRP ID> <VSER> <IN HEX> <------------------------------------------> <--------> <--> <-------------------------------------------->

------------------------------------------------------------------------------------------------------------------------------------

VSAM     VD0997 000001D2 AXBW0101.RZZ.MS.CLUSTER                              82   0% SIM: RECYCLE FUNCTIONS BYPASSED               
VSAM     VD0997 000001D7 AXBW0101.RZZ.MS.CLUSTER1                             82   0% SIM: RECYCLE FUNCTIONS BYPASSED               
VSAM     VD0997 000001DC AXBW0101.RZZ.Z00.CLUSTER                             82   0% SIM: RECYCLE FUNCTIONS BYPASSED               
VSAM     VD0997 000001E1 AXBW0101.RZZ.Z00.CLUSTER1                            82   0% SIM: RECYCLE FUNCTIONS BYPASSED               
                                                                                                                                    
SIZE OF PROCESSED GROUP:          0.008GB #DATASETS IN GROUP:                     7                                                 
                                                                                                                                    
************************************************************************************************************************************
                                                                                                                                    
                                                                                                                                    
TOTAL RECYCLED:                   0.893GB #DATASETS:                            156  #GROUPS PROCESSED:           2                 
                                                                                                                                    
TOTAL REJECTED:                   0.005GB #DATASETS:                             93

What to do next

If the Recycle results are not as you expected them to be, you can generate a candidate rejection report. For more information about candidate rejection reports, see Creating a candidate rejection report.

If the Recycle results are acceptable, you can run the Cleanup function to delete obsolete database records and expire the empty archive tapes from the tape management system. For more information, see Running the Archive Database Cleanup program.