Archive Maintenance Utility (FDRARCH)


FDRARCH is an ABR utility that performs required maintenance on the Archive Control File (ACF) or Extended Archive Control File (EACF),, a database of archived data sets used by ABR Archive Backups (DUMP TYPE=ARC) as described in Working-with-FDRABR-Archiving-and-Superscratch. If you are doing Archive Backups (especially with RECALL=YES), you will need to use FDRARCH to create an ACF and to do periodic maintenance on it.

A Control File with the same format is also used by FDRAPPL Application Backup (DUMP TYPE=APPL) described in Working-with-FDRAPPL. In some circumstances, an Application Backup Control File may also need the attention of FDRARCH. In the following sections, references to the Archive Control File (ACF) will also apply to the Application Backup Control File. However, functions related to Auto-Recall and the DYNARC options will not apply, except where noted, references to the ACF also apply to the EACF. 

The Extended Archive Control File is not supported by Application Backup and therefore cannot be used as an Application Control File. 

FDRARCH statements and functions

The FDRARCH input may contain many statements. Each function is executed as it is encountered, except as noted below. The following FDRARCH statements provide general maintenance functions, including creation of new Archive Control Files:

FORMAT

Formats a new Archive Control File.

DUMP

Creates a sequential backup copy of an Archive Control File.

Important

This function is not supported for Extended Application Control Files.

RESTORE

Restores the backup copy of an Archive Control File created by DUMP. Can be used to move a control file to a new volume or device type, or to expand the file.

Important

This function is not supported for Extended Application Control Files.

MERGE

Merge multiple Archive Control Files into one.

This statement should be executed periodically to maintain your Archive Control File:

REORG

Reorganizes an Archive Control File, deleting obsolete records and compressing the active records to create space for new records at the end of the file. Obsolete records can includes those marked for deletion (by the DELETE statement), those that are expired (past their expiration dates), those that are flagged as having been restored by ABR, and those marked for Auto-Recall that are no longer cataloged. During the reorganization, Archive Backup files that are no longer referenced by any active record can be deleted and uncataloged.

Unlike the ACF, the EACF does not require compression. Descriptor records within the EACF that are deleted are reused during normal processing. Except where noted, the following options are supported for EACF clusters. 

These statements perform operations against selected records in the Archive Control File:

DELETE

Mark selected archive records for deletion by a subsequent REORG.

RESET

Remove deletion indicators set by DELETE on selected records.

Important

This function is not supported for Extended Application Control Files. Records that are marked for deletion in an ACF are dynamically removed and therefore cannot have their DELETE indicator reset. 

EXPIRE

Mark selected records as being expired.

MODIFY

Change fields within archive records in the Archive Control File (for example, expiration dates and backup pointers).

RECATALOG

Creates or updates Auto-Recall indicators for archived data sets in system catalogs, so that they can be successfully recalled.

SORECATALOG

Quickly execute the equivalent of RECATALOG SERVICE=PERFORM against the entire Archive Control File.

Each of the last six statements (DELETE, RESET, EXPIRE, MODIFY, RECATALOG, and SORECATALOG) requires that the entire Archive Control File be scanned for records to be updated. To avoid excessive passes through the file, the changes requested by these statements are saved until another type of statement (such as REORG) or the end of the control statements is encountered; then one pass of the file is performed, comparing each record to every request to see if an action is required. You may also explicitly request the update by entering:

UPDATE

Execute all of the immediately preceding DELETE, RESET, EXPIRE, MODIFY, and RECATALOG statements.

Undocumented functions

FDRARCH contains options and functions that are designed for special situations or special customer requests. To avoid confusion and lengthy descriptions, some of these are not documented in this manual. For a complete list of the supported functions, execute FDRARCH with the statement: HELP ALL.

Operand defaults

The defaults for many operands on FDRARCH statements may be permanently changed from the defaults shown in the descriptions that follow, by making changes in the FDR Global Options. See  Installing for details; most FDRARCH options are set on ISPF panel A.I.4.6 as shown here (with its default values):

Set ABR Archive Utility Defaults – Panel A.I.4.6

---------- FDR INSTALLATION -- SET ABR ARCHIVE UTILITY DEFAULTS ---------------
 COMMAND ===>                                                                    
                                                                                 
            FDRARCH UTILITY DEFAULTS                                             
 BLKF       DEFAULT NUMBER OF BLOCKS PER TRACK IN THE ARCHIVE FILE.... 2         
 RECS       DEFAULT NUMBER OF DATA SET ENTRIES IN THE ARCHIVE FILE.... 2000      
                                                                                 
 REORG%     PERCENTAGE OF FREE SPACE IN ARCHIVE FILE TO ISSUE WARNING. 10        
 ARCDD      DDNAME USED BY FDRARCH TO REFERENCE ARCHIVE FILE.......... ARCHIVE   
                                                                                 
 DYNARC     DYNAMIC ALLOCATION OF ARCHIVE FILE BY FDRARCH ALLOWED..... NO        
 ERASE      ARCHIVE FILE MAY BE RE-FORMATTED (WRITTEN OVER)........... NO        
 ARCRESV    PROTECT ARCHIVE FILE WITH RESERVE DURING UPDATE FUNCTION.. YES       
                                                                                 
            FDRARCH ARCHIVE FILE REORGANIZATION OPTIONS                          
 RECALL     UNCATALOG AUTO-RECALL DATA SETS THAT WERE DROPPED......... YES       
 UNCAT      UNCATALOG ARCHIVE TAPE FILES THAT ARE NO LONGER NEEDED.... YES       
 MSG        PRINT UNCATALOGED TAPE FILES THAT ARE NO LONGER NEEDED.... YES       
                                                                                 
 FDR514ERR  REMOVE ERROR INDICATIONS WHEN FDR514 ISSUED............... NO        
                                                                                 
CREXPDS    CREATE FILE FOR DATASETS EXPIRE IN DAYS IN FDRARCH REORG.. NO
EXPIREINDAYS   NUMBER OF DAYS IN FUTURE DATASET WILL EXPIRE.......... 5
                                                                                                     
                                                                                 
 ------------------- Copyright 1987,2025 BMC Software, Inc. --------------------  

FDR514ERR          

Removes error indications when FDR514 is issued.

If YES is specified, then when FDR514** is issued the error indication of two asterisks following the message number is removed and the return code is set to zero. 

If NO is specified, then the error appears with the asterisks following the message number, and the return code is set to 12.

Default: NO

CREXPDS=

If set to YES, FDRARCH REORG creates a data set which contains select statement of data sets 
that expire in EXPIREINDAYS. For EACF, this option is ignored. The data set is created with the name—hlq.EXPIRE.INDAYS.Dyyddd

Where, hlq is the first qualifier of ACF and yyddd is the Julian date. 
Default Value: NO

EXPIREINDAYS=

Specify the number of days for which the latest data set entry in ACF expires in nn days, is selected, and written into the data set. This keyword is ignored for EACF.
Where, the value of nn must be between 1 and 30.
Default value: 5

Special Consideration for using EXPIREINDAYS:

  • EXPIREINDAYS must be used with FDRARCH REORG keyword SORT=YES(SORT based REORG). When you set SORT=NO, EXPIREINDAYS is ignored.
  • If the EXPIREINDAYS keyword is provided in FDRARCH REORG statement, then you do not need to turn on the CREXPDS Global Option because the EXPIREINDAYS keyword overrides this global option.
  • If you provide the EXPIREINDAYS keyword, then any new data sets that have the SELECT statement, are created with the name as follows: 
    hlq.EXPIRE.INDAYS.Dyyddd, where hlq is the first qualifier of ACF and yyddd is the Julian date. 
  • Records are written as SELECT CATDSN=DSN_NAME.
  • If you run the FDRARCH REORG job multiple times with the same ACF in a single day, the same data sets are overwritten in each run. 
  • If a data set is dynamically created, then a new message FDR750 is printed.
  • You can override the dynamically created file by using the EXPSOON DD statement in your JCL. The file must be in FB format with LRECL=80.
  • If EXPSOON DD is provided in the JCL, then a new message FDR751 is printed.
  • If you have multiple application control files or archive files with the same first qualifier, we recommend that you use the EXPSOON DD and provide different files for each ACF.
  • A sample of a SELECT statement is as follows:
    SELECT CATDSN=DSN_NAME

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*