FDRARCH REORG Statement
REORG statement syntax
REORGANIZE | |
---|---|
ADAYS=0|nnnnn | |
,DATACLAS=dataclas | |
,DELETE=IGNORE|PURGE|RETAIN | |
,DISABLE=([BYPASSCATERR][DSNCK][DYNARC][EXPANDREASON][IFNOTAUTOREC] [IFNOTCAT][PRINTALIAS][PRINTALL][PRINTSELECT][RESERVE][RETAINDATE] [SIMLOCATE][SMSEXPIRE][TAPEDETAIL][TAPELOCATE][TMS][TTRZEROVALID) | |
,DUMPDEVICE=DISK|TAPE | |
,ENABLE=([BYPASSCATERR][DSNCK][DYNARC][EXPANDREASON][IFNOTAUTOREC] [IFNOTCAT][PRINTALIAS][PRINTALL][PRINTSELECT][RESERVE][RETAINDATE] [SIMLOCATE][SMSEXPIRE][TAPEDETAIL][TAPELOCATE][TMS][TTRZEROVALID]) | |
,EXPIRE=IGNORE|PURGE|RETAIN | |
,LOG|NOLOG | |
,MAXGENERATIONS=nnnnn | |
,MAXOCCURRENCES=nnnnn | |
,MAXUNCATALOG=8000|nnnnn | |
,MSG=NO|YES | |
,NOALIAS=CATERROR|VALID | |
,RECALL=NO|YES | |
,RESTORE=IGNORE|PURGE|RETAIN | |
,SEARCH=CVAF|NO|OBTAIN | |
,SIMULATE | |
,SORT=NO|YES | |
,SORTALLOC=NO|YES|([SORTLIB][SORTMSG][SORTOUT][SORTWORK]) | |
,SORTCORE=100000|nnnnnnn | |
,SORTLIB=SYS1.SORTLIB|dsn | |
,SORTMSGDDNAME=SYSOUT|ddn | |
,SORTPFX=SORT|cccc | |
,STORCLAS=storclas | |
,UNCAT=NO|YES | |
,WORKDDNAMES=3|n | |
,WORKUNIT=SYSALLDA|unit |
REORGANIZE statement
The REORGANIZE statement first creates a backup copy of the Archive Control File on TAPE1, similar to the DUMP statement. Then it restores the backup back to the ACF, but while doing so it removes entries that are no longer required. You can specify various criteria for determining the unneeded entries. The space occupied by the removed records is recovered and there are additional unused blocks at the end of the file for the addition of new entries.
During this reorganization, REORG may perform other support functions:
- All Archive Backup files no longer referenced within the Archive Control File may optionally be deleted (if on DASD) and uncataloged from the ABR catalog. For Archives that are on cloud storage, REORG deletes and uncatalogs the backup control file, which is on DASD; you must periodically run FDRTCTUT with the DELETEBACKUPS command, as shown in FDRTCTUT – FDR Transparent Cloud Tiering Batch Utility, to clean up the actual backups in the cloud.
- Any data sets within the Archive Control File that are marked for auto recall may also be optionally uncataloged if they are removed.
- Any data sets marked for auto recall which are actually on DASD (no longer archived) can be re-cataloged normally.
REORG can be a high-overhead operation because of the large number of catalog accesses (SVC 26) and VTOC accesses required for data sets flagged for auto recall. Improvements of the performance of REORG on large control files have been made in recent releases of ABR. REORG can optionally use a SORT to improve performance on large control files (typically over 100,000 records), sorting the ARCHIVE records, and then accessing catalogs sequentially. You can request the SORT-based REORG by specifying SORT=YES or it is automatically invoked if certain options are specified (such as MAXOCCURRENCES= or EDMEXITNAME=). However, if SORT is invoked, you may need to add JCL statements required by your installation's SORT product or add the SORTALLOC= operand to REORG to request that FDRARCH dynamically allocate SORT files for you. Some SORT products may require neither.
REORGANIZE statement operands
Specifies that data sets archived with the last “n” days (from 0 to 32000) are to be protected from REORG processing. They will not be purged regardless of other REORG operands.
Default: 0 (no data sets protected).
DATACLAS=
Specifies the SMS data class name (1 to 8 characters) to use when dynamically allocating any of the temporary work files, including sort work files if requested by SORTALLOC=. It must be a value valid for DATACLAS= in JCL. WORKUNIT= is mutually exclusive with the STORCLAS= operand. DATACLAS= is required only when the SORTOUT temporary work file must be allocated with more than 65,535 tracks (when the used space in the Archive Control File exceeds about 39,000 tracks); the DATACLAS specified must have attributes that allocate an Extended Format (EF) striped data set on multiple volumes in order to accommodate this allocation. STORCLAS= is required if DATACLAS= is specified.
Specifies the processing required for data sets previously marked by the DELETE statement of FDRARCH for removal from the Archive Control File:
Do not test the DELETE indicator.
Drop the data set from the Archive Control File unless prevented by other selection criteria (for example, EXPIRE=RETAIN).
Retain the data set even if other selection criteria calls for its removal.
Default: PURGE but if EXPIRE= and/or RESTORE= is also specified, the default is IGNORE.
DISABLE=
ENABLE=
The options specified are disabled or enabled for this REORG operation. Multiple options are enclosed in parentheses and separated by commas. The options and their meaning if enabled are:
Does not report catalog processing errors detected by FDRARCH.
Validates the data set name of the Archive Control File. It requires that some index level in the name, not the first, is ARCHIVE.
DYNARC
Dynamically allocates the common Archive Control File named in the ARCDSN option of the FDR Global Options if the ARCHIVE DD statement is not present.
Prints expanded drop reasons during ARCHIVE reorganize.
Deletes all entries that are not marked for auto recall, regardless of other operands.
Deletes all entries that have been archived for auto recall but are not currently cataloged for auto recall, regardless of other operands. If a data set was archived, recalled, and re-archived, the record of the older copy will also be deleted by IFNOTCAT. The PRINTxxxx options below are effective only if IFNOTCAT is enabled. IFNOTCAT allows users to delete data sets from the Archive Control File simply by uncataloging them. It also deletes GDG generations that were archived but are no longer cataloged. The TTRZEROVALID and NOALIAS options affect IFNOTCAT processing; see their descriptions.
Prints all ALIAS catalog entries processed by FDRARCH.
Prints all catalog entries processed by FDRARCH, even those not selected.
Prints all catalog entries selected for processing by FDRARCH.
RESERVE
Protects the Control File with a RESERVE macro against the volume on which it resides.
Retain data sets that have an expiration date of 99.366 for either COPY1 or COPY2. Do not remove these data sets during a “Sort Based” REORG for any reason.
Retrieve backup file information from the catalog during REORG simulations.
Requests that a COPY1 backup on DASD is deleted when the COPY1 expiration date has been reached on all entries that point to that backup. If disabled, the COPY1 on DASD is deleted only when all entries that point to it are being deleted from the control file (usually because both copies have reached their expirations). This is used to support the SMSEXPIRE= option of ABR (see SMSEXPIRE= in Archive-DUMP-and-SCRATCH-Statements and System-Managed-Storage-SMS).
Print the backup tape detailed information when executing the REORG command under DEFAULT DIAG.
Use the LOCATE SVC when retrieving backup file information from the catalog under the REORG command.
Indicates that an automated tape management system, such as CA 1, CA TLMS, or DFSMSrmm is in use in the system. Enabling this option means FDRARCH will only uncatalog and/or re-catalog an Archive Backup file if the expiration date recorded in the control file is 99000 (“catalog control” in most tape management systems). If disabled (the default), all expired tape files are uncataloged when they are deleted from the ACF.
Affects the operation of REORG when it checks the catalog entry for a data set to see if it is archive (such as the IFNOTCAT option, if enabled). When REORG examines a catalog entry to see if the data set is still marked for auto-recall, it checks the DSCBTTR field which can have 3 types of values: it can point to a DSCB in a VTOC (not auto-recallable), it can point to an entry in the Archive Control File (recallable), or it can be zero (indeterminate). Unfortunately, when the IDCAMS command REPRO MERGECAT is used to move entries from one catalog to another, DSCBTTR is zero to zero. If TTRZEROVALID is disabled, REORG will consider such data sets potentially recallable and will not delete them, to protect against undesired mass deletions after a REPRO MERGECAT; if it is enabled, REORG will delete them.
Default: DSNCK and RESERVE are enabled and all others are disabled, unless overridden in the FDR Global Options (the exception is the TMS option that is always disabled by default regardless of the option table).
DUMPDEVICE=
Specifies the device type that is eligible to be used as TAPE1 (dump output).
Permits the DUMP data set to be placed on either DASD or tape devices.
Restricts the DUMP data set to tape devices only.
Default: TAPE.
Specifies the processing required for any expired data sets, entries whose expiration date has been passed. If the data set has 2 backup copies, the expiration for both COPY1 and COPY2 must be passed. FDRARCH will not consider data sets with expirations of 99.000, 99.365, or 99.366 to be expired.
Do not test the expiration dates.
Drops the data set from the Archive Control File unless prevented by other selection criteria (for example, RESTORE=RETAIN).
Retains the data set even if other selection criteria calls for its removal.
Default: PURGE but if DELETE= or RESTORE= is specified the default is IGNORE.
Specifies that the messages detailing the entries dropped from the Archive Control File are to be printed.
Suppresses detail messages and prints only a summary.
Default: LOG.
MAXGENERATIONS=
nnnnn
Specifies the maximum number of archived generations of any given Generation Data Group (GDG) that will reside in the Archive Control File at the end of the reorganization. The number may be any number from 1 to 32000.
Default: The GDG status is not tested.
MAXOCCURRENCES=
nnnnn
Specifies the maximum number of archived copies of any given data set that will reside in the Archive Control File at the end of the reorganization. The number may be any number from 1 to 32000.
Default: The maximum occurrences of a given data set are not tested.
MAXUNCATALOG=
nnnnn
If RECALL=YES is specified or defaulted, and a SORT-based REORG is being done (SORT=YES or other options implying SORT), this specifies the maximum number (from 1 to 32000) of auto recall data sets that are uncataloged in one SORT pass. If more than this number of uncatalogs is required, additional SORT passes are required.
Default: 8000.
Do not print uncatalog processing messages.
Print messages for every archive backup file uncataloged during this REORG.
Default: YES unless overridden in the FDR Global Options.
NOALIAS=
Specifies processing when the IFNOTCAT option is enabled but no alias is found for a data set in the master catalog.
Do not delete the data set. This protects against the possibility that the alias for a set of data sets was inadvertently deleted from the master catalog, which might otherwise cause many data sets to be deleted from the Archive Control File.
Delete the data set from the Archive Control File
Default: CATERROR.
RECALL=
Specifies the processing requirements for those Archive Control File records marked for auto recall.
Ignore the auto recall indicator.
Uncatalog the special auto recall entry in the system catalog whenever a data set flagged for auto recall is removed from the Archive Control File during REORG.
Default: YES.
RESTORE=
Specifies the processing required for any restored data sets (data sets that are marked as having been successfully restored by FDRABR) that are encountered.
Do not test the RESTORED indicator.
Drops the data set from the Archive Control File unless prevented by other selection criteria (for example, EXPIRE=RETAIN).
Retains the data set even if other selection criteria calls for its removal.
Default: IGNORE.
Specifies if and how REORG is to verify that data sets flagged for auto recall are accurately cataloged for recall (not on DASD).
Uses Common VTOC Access Facility macros.
Bypasses this verification.
Uses the OBTAIN DADSM macro.
If CVAF or OBTAIN is specified, for every Auto-Recall entry that is being removed from the control file, if the original DASD volume recorded in the control file is online and of the right type (for example, 3390), REORG accesses the VTOC to see if the data set is on that volume. If it is, the data set is recataloged to that volume instead of removing the catalog entry.
Default: CVAF.
SIMULATE
Specifies that the reorganization of the Archive Control File is only to be simulated. No entries are uncataloged. The Archive Control File is not rewritten. If the TEMPARCH DD statement (see TEMPARCH DD Statement in FDRARCH-JCL-Requirements) is present, it contains a copy of what the control file would have looked like after the reorganization.
Default: Actually reorganize the Archive Control File.
The SORT-based version of the REORG statement is not to be used unless one or more operands are specified that are requiring sorting; these include: MAXGENERATIONS, MAXOCCURRENCES, SORTALLOC, SORTCORE, SORTLIB, SORTMSG, SORTMSGDDNAME, SORTPFX, WORKDDNAMES, EDMEXITNAME, ZARAEXITNAME (the last 2 are on the DEFAULT statement).
The SORT-based version of the REORG statement is to be used
Default: NO unless one of the operands above is specified.
SORTALLOC=
Specifies if FDRARCH is to dynamically allocate sort related DD statements.
Do not dynamically allocate SORT related data sets. If sorting is required, any necessary DD statements must be included in the JCL or dynamically allocated by your SORT product.
SORTLIB
Dynamically allocate the SORTLIB data set using the value in the operand SORTLIB= for the DSNAME. Users of the SYNCSORT product should see the note under the SORTLIB= operand.
SORTMSG
Dynamically allocate the SORT message output to SYSOUT using the value in the operand SORTMSGDDNAME= for the ddname.
Dynamically allocate a temporary SORTOUT data set as directed by the WORKUNIT= or STORCLAS= operand.
Dynamically allocate the number of SORTWKnn data sets specified in the operand WORKDDNAMES, as directed by the WORKUNIT= or STORCLAS= operand.
Dynamically allocate all of the above.
Multiple values may be specified for this operand in parenthesis separated by commas. For example, REORG SORTALLOC=(SORTWORK,SORTOUT) specifies that SORT work and output DD statements are to be dynamically allocated to temporary data sets
Default: NO.
SORTCORE=
nnnnnnn
Specifies the amount of storage (from 10000 to 8000000, in bytes) SORT is to use.
Default: Taken from the FDR Global Options and is usually 100000. It can be changed on ISPF panel A.I.4.9 (see SORTCORE in ABR-Options).
SORTLIB=
Specifies the data set name to be allocated to the ddname SORTLIB.
Default: SYS1.SORTLIB.
SORTMSGDDNAME=
Specifies the ddname to be used by the program SORT if messages are to be printed.
Default: SYSOUT.
SORTPFX=
Specifies the ddname prefix to be used by the program SORT if external sorting is required. If the string specified is less than 4 characters, a dollar sign ($) fill character is used.
Default: Taken from the FDR Global Options and is usually “SORT”.
STORCLAS=
Specifies the SMS storage class name (1 to 8 characters) to use when dynamically allocating any of the temporary work files, including sort work files if requested by SORTALLOC=. It must be a value valid for STORCLAS= in JCL. STORCLAS= is mutually exclusive with the WORKUNIT= operand.
Default: The WORKUNIT= operand value is used to allocate temporary work files.
UNCAT=
Specifies whether archive DASD or tape backup files that are no longer referenced in the Archive Control File due to this REORG (all data sets that were archived into those files have been purged) are to be scratched and/or uncataloged. If the TMS option is in effect (see ENABLE=), tapes are uncataloged only if they have an expiration date of 99.000 (catalog control).
Do not uncatalog archive backup files that are no longer referenced.
Uncatalog archive backup files that are no longer referenced, and delete them if they are on DASD. For Archives that are on cloud storage, REORG deletes and uncatalogs the backup control file, which is on DASD; you must periodically run FDRTCTUT with the DELETEBACKUPS command, as shown in Section 92.3 “FDRTCTUT – FDR Transparent Cloud Tiering Batch Utility”, to clean up the actual backups in the cloud.
Default: YES.
WORKDDNAMES=
Specifies the number of SORT work ddnames to allocate, from 1 to 5.
Default: 3.
WORKUNIT=
Specifies the unit name (1 to 8 characters) to use when dynamically allocating any of the temporary work files, including sort work files if requested by SORTALLOC=. It must be a value valid for UNIT= in JCL, and the volumes included on those units must include some in STORAGE or PUBLIC status for the allocation to be successful.
Default: SYSALLDA, which is valid on all z/OS systems and includes all DASD.