Archive DUMP and SCRATCH Statements


Archive DUMP statement syntax

DUMP|SIM

TYPE=ARC


,ALTINDEX=NO


,ARCBACKUP=ABR|DSF|NO


,ARCCAT=ALL|NO|NORMAL


,BUFNO=nn|MAX


,CLOUD=cloudname


,COMPRESS=ALL|COPY1|COPY2


,CONTAINER=FDR.ABR.ARCHIVE|cloudcontainer


,DATA=ALL|USED


,DSNENQ=HAVE|NONE|TEST|USE


,DYNARC


,EMSG=OK


,ENQ=OFF|ON|RESERVE


,ENQERR=BYPASS|PROCESS


,EXCPVR=NO|YES


,EXPD=NONE


,FORMAT=NEW|SPLIT


,ICFCORE=nnnnnnn


,MAXBTRKS=4096|nnnnn


,MAXCARDS=100|nnnnn


,MAXDD=nnnnn


,MAXERR=20|nnnn


,MAXFILE=nnnnn


,MGMTCLAS=(mgmtclas,…)


,MIGRAT=NO|YES


,NOINIT


,NOUNCAT


,ONLINE


,ONLVOL


,POOLSORT=NO


,PRINT=ABR


,RECALL=NO|YES


,RETPD=dddd


,RETPD2=dddd


,RTC=NO|YES


,SCRATCH[=IBM]|SCRATCH=CAT


,SELTERR=NO|YES


,SMSCOMMAND=NO|ONLY|YES


,SMSCONSTRUCT=NO|YES


,SMSEXPIRE=ALL|NO|PRT|YES


,SMSMANAGE=NO|YES


,SMSMINRET=30|nnnn


,SMSTHRESHOLD=NO|YES


,THRESHOLD=HIGH|LOW|NO|nnn


,VEXPD=NONE


,VOLSORT=NO|YES


,ZEDC=NO|YES

Archive SCRATCH statement syntax

DUMP|SIM

TYPE=SCR


,DSNENQ=HAVE|NONE|TEST|USE


,ENQ=OFF|ON|RESERVE


,ENQERR=BYPASS|PROCESS


,EXPD=NONE


,ICFCORE=nnnnnnn


,MAXCARDS=100|nnnnn


,MAXDD=nnnnn


,MGMTCLAS=(mgmtclas,…)


,NOINIT


,ONLINE


,ONLVOL


,PRINT=ABR


,SCRATCH[=IBM]|SCRATCH=CAT


,SELTERR=NO|YES


,SMSCONSTRUCT=NO|YES


,SMSMANAGE=NO|YES


,SMSTHRESHOLD=NO|YES


,THRESHOLD=HIGH|LOW|NO|nnn


,VEXPD=NONE

General archive selection criteria

If a data set meets any one of these General Archive Selection Criteria, it is archived unless it matches a SELECT or EXCLUDE statement.

DUMP|SIM



,ADATE=[yyddd|yyyyddd]|ADAYS=dddd


,CRDAYS=adddd


,EXPIRED


,IFNOTCAT


,MAXGDG=nnn


,REMOTEb

aCRDAYS= is not a selection criterion. When used with other criteria, it restricts selected data sets to those created at least dddd days ago.

bREMOTE is not really a selection criterion. It enables Archive to select data sets flagged for archive by the FDRABRUT program.

DUMP statement

The DUMP statement invokes the Archive Backup (TYPE=ARC) or Superscratch (TYPE=SCR) of data sets. Only one DUMP statement is allowed per execution of ABR.

Archive backup

DUMP TYPE=ARC invokes the ABR Archive Backup facility. Based on Archive criteria operands, ABR backs up and scratches data sets from a DASD volume. The volume must be enabled for Archive. These data sets are recorded in the Archive Control File. At the completion of the Archive step, ABR optionally backs up the Archive Control File as the last file of the last backup tape used.

Superscratch

DUMP TYPE=SCR invokes the ABR Superscratch facility. This statement accepts the same criteria as Archive Backup. ABR scratches and uncatalogs any data sets selected without taking a backup. These data sets are not recorded in the Archive Control File or the ABR scratch catalog. The volume must be enabled for Superscratch.

SIM statement

If SIM is specified, ABR performs the Archive or Superscratch function in a simulation mode. The TAPEx DD Statement must specify DD DUMMY. ABR does not perform the actual Archive or Superscratch operation, only reporting the data sets that would be archived in the PRINT VTOC format. This allows various options to be tested without danger of archiving or scratching undesired data sets

Data set selection

If the ABR input contains one or more SELECT statements, any data sets matching a given SELECT is controlled by that SELECT, which may or may not select it for Archive or Superscratch. If you supply DUMP statement operands from the box labeled General Archive Selection Criteria, they are used to make decisions about data sets not controlled by any SELECT statement. See FDRABR-Data-Set-Selection for details.

DUMP and SCRATCH statement operands

TYPE=

Specifies the type of operation to be performed. It is required.

ARC

An Archive Backup is done. Data sets selected are backed up, recorded in the Archive Control File, and scratched and uncataloged.

SCR

A Superscratch is done. Data sets selected are scratched and uncataloged. No backup are created.

See FDRABR-Data-Set-Selection for details on the selection of data sets for Archive and Superscratch.

Warning

DUMP TYPE=SCR is a dangerous function since there is no backup of the data sets. A simulation should be run prior to the actual Superscratch run.

ADATE=

Any data set that has not been opened since the date specified is archived or scratched. The last reference date is stored in the Format 1 DSCB of a data set by IBM when it is opened. The date is specified in Julian format with a 2-digit year (yyddd) or a 4-digit year (yyyyddd). If the 2-digit year is used, year numbers less than 70 are assumed to be in the 21st century (for example, 03123 = 2003.123).

ADAYS=

dddd

Any data set that has not been opened in “dddd” days is archived or scratched. The last reference date is stored in the Format 1 DSCB of a data set by IBM when it is opened. The value specified is subtracted from today's date to calculate a date “dddd” days in the past. If the result is greater than the last reference date, the data set is selected.

Important

ADAYS and ADATE are mutually exclusive. One of the above must be specified to activate archiving based on the last reference date.

If you want to archive by last reference date, but only within a particular data set group, specify ADATE or ADAYS on a SELECT statement, and do not specify ADATE or ADAYS on the DUMP Statement.

ALTINDEX=
NO

ABR backs up to the Archive Backup any VSAM clusters that have an associated alternate index on the same volume as the primary, but does not delete them.

Default: ABR does not test for Alternate Indexes (AIXs).

ARCBACKUP=

Specifies how ABR is to backup the Archive Control File at the completion of an Archive run.

ABR

An ABR Volume Backup of just the ACF to be taken. This increments the cycle and possibly the generation of the volume on which it resides. (A full-volume backup might be forced).

DSF

A DSF backup of the ACF is to be taken. ABR creates and catalogs this backup using the name of the Archive Control File itself, except that the index level “ARCHIVE” is changed to “ARCBKUP” for TAPEx and “ARCBKU2” for TAPExx. This cataloged name only keeps track of the most current backup of the Archive Control File. This option cannot be used if the Archive Control File has a non-standard name not containing an index level of “ARCHIVE”. ARCBACKUP=DSF should not be used when archiving to DASD since duplicate names are created on the DASD.

NO

The Archive Control File is not dumped at the end of the ARCHIVE.

Default: ABR if the Archive is to tape; NO, if the TAPEx backup is to DASD.

ARCCAT=

Specifies how ABR is to handle cataloging of backup files created by Archive Backup.

ALL

All backup files are cataloged in the ABR catalog.

NO

No backup files are cataloged, except for any backup file that exceeds five tape volumes and the backup of the Archive Control File.

NORMAL

The first backup file created on each TAPEx DD Statement or TAPExx DD Statement is cataloged. Backups are also cataloged when the output volume list is different from that of the previous backup to the same DD statement, for example, any file that requires a new output tape, and the first file after a file that requires a new output tape.

Default: NORMAL, except that ARCCAT=ALL is forced if the backup is on DASD or on cloud storage, or EXPDT=99000 (catalog control to some tape management systems) is specified on the TAPEx DD Statement or TAPExx DD Statement.

BUFNO=

Specifies how many buffers are used for dumping each DASD volume. Each buffer holds one DASD track. The buffers acquired are divided into 2 sets in order to overlap input and output I/O operations; each DASD I/O reads DASD tracks into one-half of the buffers.

MAX

Buffers sufficient to read 1 cylinder of the input DASD are acquired (usually 16).

nn

The specified number of buffers is acquired.

Default: MAX, unless RTC=YES is specified on the DUMP statement or as a global option.

Important

  • RTC=YES overrides BUFNO= if both are specified on the DUMP statement.
  • BUFNO= on the DUMP statement overrides RTC=YES in the FDR Global Options table.

Tip

We recommend that you specify RTC=YES in the FDR Global Options table and do not specify RTC= or BUFNO= on the DUMP statement.

CLOUD=

cloudname

The name of the cloud where the backup is directed.

Default: The backup is created on tape or disk, as indicated by the TAPEx DD statement.

COMPRESS=

Controls the use of FDR software compression. Values for COMPRESS= are:

ALL

The backup file for both copies (TAPEx and TAPExx) is to be compressed.

COPY1

Only the backup on TAPEx DD Statements is compressed.

COPY2

Only the backup on TAPExx DD Statements is be compressed.

See Memory Requirements in Processing-Options-and-Requirements for the additional storage required by COMPRESS=.

Default: Backups are not compressed.

Important

  • RTC=YES overrides COMPRESS= if both are specified on the DUMP statement.
  • COMPRESS= on the DUMP statement overrides RTC=YES in the FDR Global Options table.
  • COMPRESS= must be specified if using ZEDC=YES; otherwise, ZEDC=YES is ignored.
  • Do not specify COMPRESS= with the CLOUD= operand.

Tip

  • COMPRESS is recommended for backups to DASD files. If you have z/OS 2.1 or higher and have zEDC support, we recommend that you specify COMPRESS= and ZEDC=YES.
  • For tapes attached on ESCON or FICON channels, use of tape hardware compression usually results in better performance.

CONTAINER=

cloudcontainer

The name of the container in the cloud where the backup is stored. The name must start with FDR.. If the specified or defaulted container name does not exist, it is created automatically, provided that the FDRTCTSR started task is running (Installation-Checklist). The name may be up to 128 characters long. If the name does not fit on one line, then break it any point and code CONTAINER= on subsequent lines with the next part of the name. Example:

CONTAINER=THIS_IS_THE_FIRST_OF_A_REALLY_LONG_CONTAIN,
CONTAINER=ER_NAME_AND_THIS_IS_THE_LAST_PART_OF_,
CONTAINER=THE_REALLY_LONG_CONTAINER_NAME


Default: FDR.ABR.ARCHIVE

CRDAYS=

ABR is not to select any data set based on the General Archive Selection Criteria on the DUMP statement unless it was created at least “n” days ago. For example, CRDAYS=0 means “today” and all data sets would be eligible regardless of date; CRDAYS=1 means “yesterday” and all data sets created yesterday or before would be eligible.

Default: 2 days if IFNOTCAT was specified; otherwise, default is 0 days.

Important

CRDAYS on the DUMP statement functions as an EXCLUDE facility for the General Archive Selection Criteria. If none of the other criteria is specified (ex: ADAYS, IFNOTCAT) CRDAYS is ignored. If you wish to select data sets solely based on creation date specify CRDAYS on SELECT statements.

DATA=
ALL

All allocated tracks of all selected data sets are backed up.

USED

Only the used portion of Physical Sequential (PS) and PO (partitioned, PDS) data sets is backed up. On most volumes, this makes the dump run faster.

Default: USED.

DSNENQ=

Specifies whether a SYSDSN enqueue should be issued for each of the data sets on a volume during the archive or Superscratch of the volume. See Data Set Enqueue Option in Processing-Options-and-Requirements for more details. The options for DSNENQ= are:

HAVE

Enqueue the data sets. If an enqueue fails, ask the operator what to do.

NONE

No data set enqueue is issued.

TEST

Do not enqueue the data sets, but test to see if they are enqueued to another task.

USE

Enqueue the data sets. This is the most frequently used option.

Default: NONE.

Tip

Use DSNENQ=USE to be sure that the data sets being archived or scratched are not in use by some other task. You may suppress enqueues for specific data sets by the DSNENQ=NONE operand on SELECT statements.

DYNARC

For Archive Backup, ABR dynamically allocates and uses the common Archive Control File (ACF) whose name is stored in the FDR Global Options. The default name for this ACF is “FDRABR.ARCHIVE”, but your site may have changed it during FDR Installation. It is dynamically allocated using DD statement name ARCHIVE#. Since all data sets that are archived for Auto-Recall (RECALL=YES) must be recorded in the common ACF, this option is used for most Archive Backup jobs.

Default: The user must supply an ARCHIVE DD Statement pointing to the Archive Control File in which these backups are to be recorded.

EMSG=

Used when the FDR e-mail notification facility has been invoked by including an FDREMAIL DD Statement in the FDR execution JCL.

OK

E-mail notifications are sent from successful FDR operations as well as failures.

Default: E-mail notifications are sent only for FDR failures.

ENQ=

Specifies whether a SYSVTOC enqueue should be done on the VTOC of each DASD volume while data sets from it are being processed. See VTOC Enqueue Option in FDRABR-Processing-Options-and-Requirements for more details.

OFF

The VTOC is not enqueued or RESERVEd during the backup.

ON

The VTOC of each DASD volume is enqueued during its backup. This enqueue may be effective only on the system where the backup is executing; other systems may still be able to update the VTOC.

RESERVE

In addition to the enqueue, a hardware RESERVE is issued on each DASD volume during its backup.

Default: ON.

ENQERR=

Specifies processing if the DSNENQ= option finds that a data set is in use (enqueued):

BYPASS

Do not archive or scratch an active data set.

Important

A data set in use will not be considered an error and will not cause a condition code or abend at step termination.

PROCESS

Archive or scratch a data set even if it is active, (a warning message will still be produced). If IBM SCRATCH or DELETE is used to scratch the data set (see SCRATCH=), the scratch may fail anyway if the data set is enqueued by another task, so ENQERR=PROCESS is not recommended.

Default: BYPASS.

EXCPVR=
YES

If RTC=YES is in effect, then page-fix the disk and tape I/O buffers in real storage for the duration of the DUMP operation, and pass real channel programs to the system instead of virtual channel programs. This saves considerable CPU time that the system would otherwise consume for fixing and unfixing pages at the beginning and end of each I/O operation, and for translating the channel programs from virtual to real. EXCPVR=YES may reduce elapsed time by 5 to 20 percent and may reduce CPU time and CPU service units by 40 to 60 percent.

NO

If RTC=YES is in effect, then pass virtual channel programs to the system, and allow the system to fix and unfix the pages of the I/O buffers at the beginning and end of each I/O operation.

If RTC=YES is not in effect, then EXCPVR= is ignored.

Default: YES.

Tip

Do not specify EXCPVR=NO.

EXPD=
VEXPD=

These control what ABR does when it finds that a data set about to be scratched has a non-zero expiration date that has not yet been reached (unexpired). It is not used for selection of data sets (see the EXPIRED operand).

EXPD=NONE

ABR overrides the expiration date for all data sets and scratches them.

VEXPD=NONE

ABR overrides the expiration date for VSAM clusters and deletes them. Either EXPD=NONE or VEXPD=NONE must be specified for ABR to delete unexpired VSAM clusters.

Default: ABR does not scratch unexpired data sets. For unexpired non-VSAM data sets, ABR asks the operator for permission before scratching the data set (console message FDRW23). For unexpired VSAM files, ABR does not issue an operator message and the scratch fails.

EXPIRED

ABR is to archive or scratch data sets if their expiration date is less than or equal to today's date. ABR does not select data sets with an all-zero expiration date or a special expiration (99.000, 99.365, 99.366) unless they are selected by other criteria. The expiration date is not checked on VSAM files unless they are SMS-managed.

FORMAT=

Specifies the format of the sequential backup file.

NEW

The backup is created using a maximum block size of 56K. A block contains the image of one or more tracks from the input DASD volume.

SPLIT

The backup is created using a maximum block size of 32K. For blocks that are more than 32K, they are written as 2 blocks of 32K or less. However, FORMAT=SPLIT causes use of a DASD I/O technique that is less efficient than that used by FORMAT=NEW, which affects backup performance.

Warning

If you use a normal copy program (ex: IEBGENER) to copy a backup file created with FORMAT=NEW, you do not get any error messages, but the resulting tape is not usable for a restore. Tapes in the NEW format must only be copied with the utilities FDRTCOPY and FDRTSEL (see FDR-and-ABR-Backup-Maintenance).

Default: FORMAT=NEW if all (TAPE1/TAPE11) backups on tape; FORMAT=SPLIT if any (TAPE1/TAPE11) backups on DASD.

ICFCORE=

nnnnnnn

Specifies the size, in bytes, of the table used to the store the VSAM cluster and component names while matching them with VTOC DSCBs. Specifying ICFCORE= increases the backup region requirement by the value specified. The default is large enough for most volumes.

IFNOTCAT

ABR is to archive non-VSAM data sets that are either not cataloged at all, or cataloged to a volume other than the one they are selected from. If the proper catalog is not available or any other catalog error exists, ABR will not use this selection criterion. By default, ABR soes not archive uncataloged data sets if they are less than 2 days old, unless overridden by using the CRDAYS= operand. A time delay is necessary to avoid archiving active data sets that are cataloged at the end of the step or job that is creating them.

Important

IFNOTCAT can be expensive to run if a large number of data sets must be checked by ABR, due to the large number of expensive catalog accesses.

Default: The catalog status of data sets is not checked.

MAXBTRKS=

If more than the specified number of DASD tracks are selected for Archive Backup from a given DASD volume, ABR makes multiple passes on that DASD, creating multiple Archive Backup files. This reduces the size of individual archive backups, and improves recall performance. The size of each backup varies, since archived data sets are not split among backup files. MAXBTRKS=65536 or more disables this feature.

Default: 4096.

MAXCARDS=

nnnnn

Enables ABR to accept additional SELECT, EXCLUDE, and MOUNT statements during this execution. You can specify values up to 65535, but values over 100 increase the region required by ABR.

Default: 100 statements.

MAXDD=

Specifies the maximum number of DASD volumes that ABR can process in this execution. ABR builds its volume list from DISKxxxx DD Statements and/or online volumes if ONLINE, ONLVOL, or MOUNT is coded. Once this limit is reached, additional volumes are ignored.

Default: 256 volumes, unless overridden by the MAXONLINE option in the FDR Global Options (see MAXONLINE in ABR-Options).

MAXERR=

nnnn

Specifies the number of tape or DASD errors (1 to 9999) that, if reached, cause the operation to abend. Each error is indicated by a message and possible mini-dump.

Default: 20, except when the output is a tape where MAXERR=1 is forced.

Warning

On ARCHIVE operations, although MAXERR= allows the DUMP operation to proceed without an abend, no data sets are scratched or uncataloged from a given DASD volume if any tape or DASD errors occur during its backup. This option should only be used when necessary and with care.

MAXFILE=

nnnnn

Specifies the maximum file number ABR creates on tape (1 to 65534). When the maximum file number is exceeded, ABR starts a new scratch tape using file sequence number 1. A MAXFILE= over 255 may be appropriate when you are outputting to high-capacity tapes.

Default: 255, unless overridden in the FDR Global Options (see MAXFILES in ABR-Options).

If you are outputting to a Virtual Tape System (VTS), you may wish to specify MAXFILE=1 to avoid having to stage many tape files when only one file is actually needed. See TAPEx DD Statement in Archive-and-Superscratch-Job-Control-Requirements

MAXGDG=

nnn

ABR is to Archive any Generation Data Group (GDG) data sets that exist on the DASD volumes to be scanned and are not within “n” generations (1-255) of the most current generation recorded in the catalog. (Example: MAXGDG=2 causes ABR to keep the two most current generations of every GDG, archiving all other generations if found). It also archives any generations that have higher generation numbers than the current generation in the catalog.

Warning

If you use MAXGDG, you should specify CRDAYS=2 or higher, or specify DSNENQ=, to avoid archiving GDG generations that are in the process of being created.

MGMTCLAS=

On SMS-managed volumes, only those data sets whose SMS management class matches one of the class names specified are considered for selection. Multiple class names are specified in parentheses; however, the list must be contained on a single input record; it cannot be continued. You may also specify multiple MGMTCLAS= parameters with the same result. SMSMANAGE=YES must also be specified.

If you also specify SMSCOMMAND=YES, then all data sets on the volume are compared to the ABR control statements for selection, regardless of management class name. But if you specify SMSCOMMAND=ONLY, then only those data sets whose management class matches are compared to the ABR control statements.

MIGRAT=

YES

Specifies that when ABR recatalogs an archived data set for Auto-Recall (see the RECALL= in Archive DUMP and SCRATCH Statements operand), the first volume serial number in the catalog entry is changed to “MIGRAT” (except for multi-volume VSAM). MIGRAT=YES is required if SMS-managed data sets are being archived for auto-recall. It is recommended for all Archive jobs.

NO

Specifies that the recatalog for Auto-Recall preserve the original volume serial in the catalog entry.

Default: NO unless overridden in the FDR Global Options (see MIGRAT in ABR-Options).

NOINIT

For SIM only. ABR is to perform the simulation on the volumes specified, even if they are not initialized for ABR processing or disabled for Archive or Superscratch processing. An ABR error message is still issued but the volumes are processed.

Default: Simulation cannot be performed on a volume unless contains an ABR Model DSCB (see Overview-of-FDRABR-Volume-Backups) that is enabled for Archive or Superscratch.

NOUNCAT

Specifies that ABR is not to uncatalog any non-VSAM data sets that are archived or scratched.

Default: ABR uncatalogs all non-VSAM data sets archived or scratched unless they are cataloged to a different volume. For multi-volume data sets, the catalog entry is not deleted until the data set has been archived or scratch from each of its volumes. If RECALL=YES is in effect for Archive, ABR updates the catalog entry.

VSAM clusters are always uncataloged when they are deleted.

Important

NOUNCAT and RECALL=YES are mutually exclusive.

ONLINE
ONLVOL

If these operands are omitted, ABR only processes volumes specified by DISKxxxx DD Statements or ABR MOUNT statements.

ONLINE

Specifies that ABR is to process every volume that is online to the system; if there are more than 255 online volumes, you need to specify MAXDD= to increase that limit.

ONLVOL

Specifies that ABR is to scan all SELECT statements for the operands VOL=, VOLG=, or CATDSN= (for volume selected from the catalog). These volumes, if online, are appended to the ABR volume list.

If ABR finds that the user specified EXCLUDE statements with ALLDSN and VOL or VOLG, these volumes are not included in the ONLINE list unless a DISKxxxx DD statement is present for this volume. This is a way of excluding certain volumes, for example, EXCLUDE ALLDSN,VOLG=WORK.

POOLSORT=
NO

The DASD volumes specified on TAPEx DD Statements or TAPExx DD Statements in the ABR step (see Archive-and-Superscratch-Job-Control-Requirements) are used in the order specified in the JCL.

Default: The DASD volumes are sorted based on the amount of available space on each, first using those with the most free space.

PRINT=
ABR

Specifies that ABR is to use the PRINT VTOC format of program FDRABRP (see FDRABRP-VTOC-Report) for each data set that was selected.

Default: The names of selected data sets are simply listed on SYSPRINT. However, SIM (simulation) defaults to PRINT=ABR.

RECALL=

NO

Specifies that ABR uncatalogs archived data sets if they are cataloged to this volume unless NOUNCAT is specified.

YES

(or just RECALL) – ABR is to keep archived data sets cataloged for Auto-Recall by the ABR Catalog Locate exit (see Auto-Recall Implementation Step 1 in FDRARCH-DUMP-Statement), but only if the data set is currently cataloged to the volume it was backed up from. If the data set is cataloged to another volume or not already cataloged, it is not cataloged for RECALL. If a VSAM cluster is archived, ABR re-catalogs the cluster name as non-VSAM. Unless you have not installed the ABR Catalog Locate exit or have special reasons for archiving data sets that cannot be automatically recalled, RECALL=YES is recommended.

Default: NO, unless overridden in the FDR Global Options (see ARCRECALL in ABR-Options).

RECALL=YES and NOUNCAT are mutually exclusive.

Important

  • For data sets archived from volumes whose VTOCs are located at relative track 32767 or above, RECALL=YES may not work properly in all cases.
  • If you plan to use RECALL=YES for most of your archived data sets, set the default to “YES” in the FDR Global Options and use RECALL=NO for those few jobs where it is not desired.
  • We recommend that VTOCs be placed at the beginning of each volume to avoid this problem.

REMOTE

ABR is to archive the data sets requested by the remote queue (program FDRABRUT). REMOTE is ignored on TYPE=SCR. REMOTE is required only if data sets were flagged on DASD with the DISKUPDATE=YES option of FDRABRUT, and is automatically included if any other General Archive Selection Criteria keywords are specified on the DUMP statement.

RETPD=

nnnn

Specifies the number of days (1 to 9999) that COPY1 (TAPEx) backups are kept. ABR calculates an expiration date from this value. If RETPD2= is omitted, this same expiration applies to all COPY2 backups created in the same step.

See Backup Retention and Tape Management in Introduction-to-FDRABR-Archiving-and-Superscratch for a discussion of backup retention. Also see SMSEXPIRE= in Archive DUMP and SCRATCH Statements.

Default: 365 days, unless overridden by RETPD= or EXPDT= on individual TAPE DD statements.

RETPD2=

nnnn

Specifies the number of days (1 to 9999) that COPY2 (TAPExx) backups are kept. ABR calculates an expiration date from this value. If RETPD2= is omitted, the RETPD= expiration is used.

See Backup Retention and Tape Management in Introduction-to-FDRABR-Archiving-and-Superscratch for a discussion of backup retention. Also see SMSEXPIRE= Archive DUMP and SCRATCH Statements

Default: 365 days, unless overridden by RETPD= or EXPDT= on individual TAPE DD statements.

RTC=
NO

Use other techniques to read DASD data tracks.

YES

Use READ TRACK CCWs to read DASD data tracks. RTC=YES also causes:

vUp to 1 cylinder of DASD data is read at a time.

vFDR buffers are moved above the 16MB line (about 2MB per concurrent backup), allowing more concurrent backups to be run in one step.

vThe elapsed time of FDR backups when the backup data set is itself on DASD is significantly improved.

vThe elapsed time of FDR backups on fast tapes and DASD, especially on FICON channels, may be improved

It can also be specified as READTRACKCCW=.

Default: NO, unless RTC=YES is specified as a global option.

Important

  • RTC=YES overrides BUFNO= if both are specified on the DUMP statement.
  • RTC=YES overrides COMPRESS= if both are specified on the DUMP statement.
  • BUFNO= on the DUMP statement overrides RTC=YES in the FDR Global Options table.
  • COMPRESS= on the DUMP statement overrides RTC=YES in the FDR Global Options table.

Tip

We recommend that you specify RTC=YES in the FDR Global Options table and do not specify RTC= or BUFNO= on the DUMP statement.

SCRATCH=
SCRATCH
SCRATCH=IBM

Specifies that ABR issue the IBM SCRATCH SVC or VSAM DELETE to scratch each data set.

SCRATCH=CAT

Same as SCRATCH except that ABR is to record this data set in the ABR scratch catalog (if enabled) if it has a current ABR Volume Backup (see Chapter 50 “FDRABR Volume Backups), in addition to following all of the above rules. This may be useful with Superscratch to allow ABR to restore a backup copy of the data set as long as the backup is still available.

Tip

SCRATCH=CAT is recommended.

Default: Use the IBM SCRATCH SVC or VSAM DELETE if the DASD volume has an active INDEXED VTOC (VTOCIX) or if VSAM clusters are to be deleted, otherwise ABR uses its own technique for scratching data set entries from the VTOC. This technique involves zeroing the DSCBs of the scratched data sets; at the end of successful Archive or Superscratch, ABR forces the IBM VTOC conversion routine to recalculate the new free space by setting the DOS bit in the Format 4 DSCB and allocating a dummy data set.

Important

The dummy data set that ABR allocates to invoke the VTOC conversion routine has a name that starts with “FDRABR.V”. If your installation has a data security system, then the user running the Archive or Superscratch job must be authorized to create this DSNAME. If this is not possible then specify SCRATCH=IBM.

SELTERR=

If ABR finds that a SELECT or EXCLUDE statement was never referenced (no data set on any input DASD was selected by the statement):

NO

A condition code or abend is not to be issued at step termination. You might use SELTERR=NO when you expect some unmatched SELECT or EXCLUDE statements, perhaps because some data sets may not exist.

YES

A condition code or abend is issued at step termination to call attention to a possible control statement error.

Default: YES unless overridden in the FDR Global Options (see SELTERR” in Section 90.6 ).

SMSCOMMAND=
NO

When selecting data sets from SMS-managed volumes by management class attributes (SMSMANAGE=YES), SELECT and EXCLUDE statements are NOT honored. Data sets are selected based ONLY on management class attributes. Data sets with the attribute COMMAND-OR-AUTO-MIGRATE=COMMAND are not selected.

ONLY

SMS-managed data sets with the attribute COMMAND-OR-AUTO-MIGRATE=NONE are not selected but other SMS-managed data sets are selected based only on ABR SELECT and EXCLUDE statements. SMSMANAGE=YES with SMSCOMMAND=ONLY allows you to select data sets based on management class name (see MGMTCLAS=” in Section 51.5) without using the management class criteria; only data sets with the specified management class names are compared to the ABR selection statements.

YES

For SMS-managed data sets with the attribute COMMAND-OR-AUTO-MIGRATE=COMMAND or BOTH, SELECT and EXCLUDE statements in the ABR run may be honored (see Chapter 70 “System Managed Storage (SMS) for details). EXCLUDE statements do not exclude data sets selected by SMS criteria, but exclude data sets from selection by following SELECT commands.

Important

  • SMSCOMMAND=YES should be specified on an ARCHIVE run that takes input from the ARCHIVE REMOTE QUEUE if user requests for SMS-managed data sets are to be honored.
  • If MGMTCLAS= is specified to filter data sets by management class names, it only affects data sets selected by management class criteria; all data sets, regardless of management class name, are compared to the ABR selection statements.

SMSCOMMAND= applies only to DUMP TYPE=ARC.

Default: NO.

SMSEXPIRE=

ALL

Same as “YES”, except that data sets that were not selected because of management class attributes but which are selected because of ABR SELECT statements also receive individual expirations calculated from the attributes of their associated SMS management class. SMSCOMMAND=YES or SMSCOMMAND=ONLY must also be specified for the SELECT statements to be honored. If you want to print the assigned expirations, specify SMSEXPIRE=ALL,SMSEXPIRE=PRT.

NO

Specifies that no special processing be done for the expiration of Archived SMS-managed data sets. They receive the normal ABR expirations set from JCL parameters or the RETPD= operand.

PRT

Same as “YES”, except that the calculated expirations for each Archived SMS-managed data set are displayed.

YES

Specifies that archived SMS-managed data sets selected based on their management class attributes receive individual expirations calculated from the attributes of their associated SMS management class. Honored only if SMSMANAGE=YES is also specified. See Chapter 70 “System Managed Storage (SMS) for more details.

SMSEXPIRE= applies only to DUMP TYPE=ARC.

Default: NO.

SMSCONSTRUCT=

NO

ABR bypasses selected volumes based only on the Archive or Superscratch options in the ABR Model DSCB, ignoring the SMS storage group attribute. In addition, volume thresholds from the storage group are not used (see SMSTHRESHOLD=” in Section 51.5).

YES

ABR does not process SMS-managed volumes unless their associated SMS storage group has the attribute AUTO-MIGRATE=YES (and the ABR Model DSCB for the volume is also enabled for Archive or Superscratch as appropriate).

Default: YES.

SMSMANAGE=

NO

ABR does not select data sets from SMS-managed volumes based on the attributes of their SMS management class. ABR Archive selection criteria is used to select both SMS-managed and non SMS-managed data sets.

YES

Data sets on SMS-managed volumes are to be selected for Archive or Superscratch based primarily on the attributes of their associated SMS management class (see Chapter 70 “System Managed Storage (SMS) for complete details). Non SMS-managed data sets processed in the same run use the ABR Archive selection criteria.

Default: NO.

Warning

If you specify SMSMANAGE=YES, the archive PROTECT List is ignored, except for entries with ALLDSN (such as PROTECT ALLDSN,VOLG=PROD) that cause the volume to be completely bypassed.

SMSMINRET=

If SMSEXPIRE= is also specified, this specifies the minimum COPY2 retention to be calculated. This insures a reasonable retention for data sets that would otherwise expire quickly under management class rules.

Default: 30 days.

SMSTHRESHOLD=

NO

Thresholds from the ABR Model DSCB are used for thresholding on all volumes.

YES

ABR uses threshold values from the SMS storage group for SMS-managed volumes.

SMSTHRESHOLD= is valid only if THRESHOLD=HIGH/LOW is specified and only if SMSCONSTRUCT=YES is specified or defaulted.

Default: YES.

THRESHOLD=

Specifies whether ABR bypasses volumes because their current allocation (percentage of tracks allocated to data sets) is below a certain threshold. For non-SMS volumes, the thresholds may be stored in the ABR Model DSCB on the volume. For SMS-managed volumes, the threshold may be in the SMS storage group or may be taken from the ABR Model DSCB (see SMSTHRESHOLD=” in Section 51.5).

HIGH

The threshold used is the high threshold in the ABR Model DSCB or the SMS storage group.

LOW

The low threshold in the ABR Model DSCB or SMS storage group is used.

NO

Volumes are not to be bypassed because of allocation thresholds.

nnn

Is a number from 0 to 100 that are used as the threshold (values from the ABR Model DSCB and SMS are not used).

Default: NO.

Important

The MAXBTRKS= operand may affected threshold processing. If a large amount of data is being archived from a volume, MAXBTRKS= causes ABR to backup only a fraction of it at a time, making several passes on the volume. The threshold is evaluated at the start of each pass, so ABR may not select all of the eligible data sets. To avoid this, specify a large value for MAXBTRKS=. If you want this to occur, specify a smaller MAXBTRKS=.

VOLSORT=

NO

Volumes are processed in the order that they are found during a scan of the system UCBs, which is usually (but not always) in z/OS device address order.

YES

If you have more than one TAPEx DD Statement in this ABR step, ABR sorts the volumes to be backed up by the last digit of their z/OS device address, to attempt to balance channel and control unit utilization during concurrent backups. In other words, all volumes whose z/OS address are xxx0 are processed first, then xxx1, and so on.

Default: YES, except that NO is forced if you have only one TAPEx DD Statement.

VOLSORT= only applies to volumes selected by the ONLINE or ONLVOL operands or MOUNT statements. It does not apply to volumes selected by DISKxxxx DD Statements that are always processed first, in the order the DD statements appear in the JCL.

ZEDC=

Invoke zEDC (zEnterprise Data Compression) for both compression and decompression if the CPU and the operating system support it.

YES

Use the zEDC hardware compression/decompression feature:

NO

Do not use the zEDC hardware compression/decompression feature.

Default: NO.

Tip

If you have z/OS 2.1 or higher and have the zEDC support, we recommend that you use COMPRESS= and ZEDC=YES.

 

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