Operating System Exit Options for FDRABR and FDRREORG
The FDR system includes several Operating System exits for FDRABR and FDRREORG. Although these exits are not required for ABR and FDRREORG to function, they provide important additional functions. Additional information on the exits is found in Dynamic-Installation-of-the-FDR-Exits.
Panel A.I.4.11 – Set Operating System Exit Options
This panel takes you to other panels to set the exits to install and set options for the various exits.
Operating System Exit Options – Panel A.I.4.11
OPTION ===>
1 - DYNAMIC INSTALLATION EXITS
2 - ABR CATALOG LOCATE EXIT ARCHIVE AUTO-RECALL OPTIONS
3 - ABR CATALOG LOCATE EXIT FDRCLONE AUTO-RECALL OPTIONS
4 - ABR DATA SET NOT FOUND EXIT OPTIONS
5 - ABR DADSM PRE-PROCESSING EXIT OPTIONS
6 - ABR OPEN EXIT OPTIONS
Panel A.I.4.11.1 – Set Dynamic Installation Exits
This panel sets options for the dynamic installation of the ABR exits. The options control the operation of FDRSTART, the FDR utility that controls installation of the exits (see Dynamic-Installation-of-the-FDR-Exits).
Dynamic Installation – Panel A.I.4.11.1
COMMAND ===>
ABRLOC DYNAMICALLY INSTALL THE ABR CATALOG LOCATE EXIT............ NO
ABRDSNF DYNAMICALLY INSTALL THE ABR DATASET NOT FOUND EXIT......... NO
ABRPRE DYNAMICALLY INSTALL THE ABR DADSM PRE-EXIT................. NO
ABROPEN DYNAMICALLY INSTALL THE ABR OPEN EXIT...................... NO
CADISKSVC CA-DISK SVC NUMBER TO INTERCEPT FOR CO-EXISTENCE WITH ABR.. NONE
IEBCOPY DYNAMICALLY INSTALL FDRREORG TO PROCESS IEBCOPY COMPRESS... NO
CLOUDEXIT DYNAMICALLY INSTALL THE FDRCLOUD EXIT...................... NO
CONFINST CONFIRM INSTALLATION OF THE FDR SYSTEM EXITS AT IPL TIME... NO
ABRLOC
If set to “YES”, the ABR Catalog Locate exit is dynamically installed. The Catalog Locate exit is required to automatically recall (auto-recall) archived data sets cataloged for auto-recall.
ABRDSNF
If set to “YES”, the ABR Data Set Not Found (DSNF) exit is dynamically installed. The DSNF exit is recommended to enable auto-recall of archived data sets not referenced through the catalog.
ABRPRE
If set to “YES”, the ABR DADSM Preprocessing exit is dynamically installed. The DADSM Preprocessing exit performs several functions for ABR, including the recording of scratched and renamed data sets. Its use is recommend for all ABR installations.
ABROPEN
Specifies whether the ABR OPEN exit is dynamically installed (or activated) by FDRSTART.
CADISKSVC
Specifies the CA Disk SVC number that is intercepted for coexistence with ABR. The number may be from 201 to 255. Complete information on using CA Disk with ABR is documented in section FDRABR-Coexistence-with-CA-Disk.
IEBCOPY
If set to “YES”, the FDRREORG IEBCOPY intercept is dynamically installed. The IEBCOPY intercept routes IEBCOPY compress requests to FDRREORG. This option should be used only if the FDRREORG product is installed.
CLOUDEXIT
Specifies whether the FDRCLOUD exit is to be dynamically installed (or activated) by FDRSTART.
CONFINST
If set to “YES”, FDRSTART asks the operator to confirm the dynamic installation of the exits via a console message (WTOR).
Panel A.I.4.11.2 – Set ABR Auto-Recall Options
The following options affect only the ABR Catalog Locate exit, except for LXBYPSEC that also applies to the Data Set Not Found (DSNF) exit.
ABR Auto-Recall Options – Panel A.I.4.11.2
COMMAND ===>
LXFOREST USER IS ASKED TO CONFIRM RESTORE.......................... YES
LXDFREST RESTORE TYPE(S) FOR TSO AUTO-RECALL....................... FG,BG,RQ
( NO NONE FG FOREGROUND BG BACKGROUND RQ REMOTE QUEUE )
LXFGSYNBG CONVERT TSO FG RESTORE TO SYNCHRONOUS BACKGROUND RESTORE.. NO
LXFGERR RETRY AUTO-RECALL REQUEST IF FG FAILS ( NO, BG OR RQ )... NO
LXNOMSG SUPPRESS AUTO-RECALL MESSAGES IF TSO RECALL IS DISABLED... NO
LXNEWVOL USER MAY SPECIFY A NEW VOLUME SERIAL WHERE TO RESTORE..... YES
LXREISSU PROMPT TO CONFIRM THE SPECIFIED NEW VOLUME SERIAL......... NO
LXSYNPROC CATALOGED PROCEDURE NAME USED FOR BACKGROUND RESTORES..... SYNRECAL
LXCHKSEC CHECK SECURITY BEFORE THE AUTO-RECALL RESTORE OPERATION... NO
LXBYPSEC BYPASS SECURITY DURING AUTO-RECALL RESTORE OPERATION...... NO
LXEXIT RECALL SECURITY EXIT ACTIVE..... NO .......EXIT NAME..... NONE
LXXRPROC JOB-LEVEL EXTERNAL RECALL ACTIVE NO RECALL PROCEDURE NAME NONE
LXNCDENY FAIL LOCATE WITH 'NOT CATALOGED' IF TSO USER DENIES RECALL YES
LXCONUSE USE CONSTANT NEW VOLUME FOR ALL DATA SET RECALLS.......... NO
LXCONVOL CONSTANT NEW VOLUME FOR ALL DATA SET RECALLS.............. NEWVOL
LXALTMSG ISSUE ALTERNATE FDRW71 (CONFIRM RESTORE) MESSAGE FORMAT... NO
LXUNCAT ASK USER WHETHER TO UNCATALOG INSTEAD OF RECALLING DATASET NO
LXMAXSTC MAXIMUM NUMBER OF RECALL STARTED TASKS ACTIVE AT ONE TIME. 100
LXMAXREC LIMIT OF TOTAL RECALLS (INCLUDING STC) ACTIVE AT ONE TIME. NONE
LXDIRVOL DIRECTED VOLUME SERIAL NUMBER TO BE RETURNED TO JES3...... NONE
LXDIRTYP DIRECTED DEVICE TYPE TO BE RETURNED TO JES3............... NONE
LXSPFMIG DISPLAY VOLSER MIGRAT FOR MULTIVOL DATASETS UNDER ISPF 3.4 NO
LXHRCANRQ PLACE CANCELLED TSO ASYNCHRONOUS HRECALL REQUEST IN RQ.... NO
LXASTPMRQ PLACE THRUPUT MANAGER ASYNCH OR WAIT HRECALL REQUEST IN RQ NO
LXFOREST
Specifies that when the TSO user references a data set archived for auto-recall:
YES
Issue the FDRW71 message asking the TSO user to confirm or deny the restore of the referenced data set.
NO
Do not issue the FDRW71 message (the TSO user is not asked to confirm nor deny the restore); force the restore of the referenced data set.
This option has no effect if options LXDFREST and LXUNCAT are both set to “NO”.
LXDFREST
Specifies the restore options that are available to do automatic recalls for TSO users. The values that may be specified are NO or any combination of FG, BG, and RQ. If more than one restore type is specified, the TSO user is prompted to choose which restore type to use. If only one restore type is specified, that restore type is used automatically, and the TSO user is not prompted. The restore types are described in section FDRABR-Archiving-and-Superscratch.
NO
automatic recall is not available for TSO users.
FG
foreground recalls (immediately under TSO or as a synchronous external task) are available.
BG
background recalls (asynchronous external task) are available.
RQ
remote queue recalls (added to remote queue for later processing) are available.
LXFGSYNBG
Specifies that the TSO restore type FG (Foreground) should be converted to a synchronous background restore. That is, the restore is to be done synchronously in the background (batch) via a started task. Requires use of the procedure name specified by the LXSYNPROC operand. This may be useful when TSO users do not have tape mount privileges but it may mean that TSO users may have their sessions locked up longer while the recall takes place.
LXFGERR
If “BG” or “RQ”, a recall is retried in the background (BG) or via the remote queue (RQ), if a TSO foreground recall fails. This option has no effect unless option LXDFREST includes “FG” as an available restore type.
LXFGERR is an important option in the environment where data sets are archived to DASD with a short retention and to tape with a longer retention, and the TSO users do not have the authority to mount tapes (MOUNT). As long as an archived data set is available on DASD, it can be quickly recalled in the foreground. After the DASD copy expires, ABR automatically tries to restore from the tape copy, but the dynamic allocation fails because the user does not have MOUNT privileges. If LXFGERR is set to “BG” or “RQ”, the recall is automatically sent to the background or the remote queue, where the tape can be mounted.
LXNOMSG
If “YES”, messages FDRW70 and FDRW79 are suppressed when a TSO user references a data set that is archived for recall, but the installation does not allow automatic recalls for TSO users (LXDFREST and LXUNCAT both set to “NO”).
LXNEWVOL
If “YES”, the TSO user is prompted to designate a target output volume to which to restore an archived data set with messages FDRW76 (original volume serial) and FDRW77 (specify new output volume serial). If NO, the user is not prompted and the original volume serial is used as a target.
If the selection of output volumes has been automated by the ABR Restore Allocate List, SMS, or other products, you will probably want to change this to “NO”. The topic “Target Volume for Recall” at the end of this section discusses the interaction among the various options that may affect the output volume choice.
LXREISSU
If “YES”, after a TSO user replies to FDRW77 with a new volume serial number, the volume serial number is re-displayed and the user has another chance to change it; this continues until the user accepts the last entry by pressing ENTER. This option has no effect if either option LXDFREST or option LXNEWVOL is set to “NO”.
LXSYNPROC
Specifies the name of the cataloged procedure that is executed as a started task to perform external recalls. External recalls are used under TSO for asynchronous background recalls (recall type BG) and synchronous background recalls (see LXFGSYNBG in Operating System Exit Options for FDRABR and FDRREORG). They are also used for recalls for batch jobs in special circumstances when a recall in the batch address space is not possible.
When installing the ABR Catalog Locate exit, you must copy the SYNRECAL cataloged procedure from the Installation Control Library (ICL) to a cataloged procedure library that is available to JES for START commands. If you change the LXSYNPROC name, rename the SYNRECAL proc to that name. Further details are in Step 3: SYNRECAL Procedure in Dynamic-Exit-Installation-Procedure and Cataloged Procedures in Testing-the-FDR-z-OS-Exits.
Any procedure name assigned to this keyword must have this content:
//NAME PROC PTR= //RESTR EXEC PGM=FDRECALL,REGION=0K,PARM='&PTR' //STEPLIB DD … * IF REQUIRED //SYSPRINT DD SYSOUT=X //SYSUDUMP DD SUSOUT=X * REQUIRED IF ABEND //ABRDEBUG DD DUMMY * PRINT DIAGNOSTICS //ABNLDUMP DD DUMMY Print normal IBM dump in addition to the Abend-AID Report
This procedure is always initiated with the START command.
Default: SYNRECAL.
LXCHKSEC
If “YES”, data set security checking for at least READ authority is done before attempting to recall an archived data set. Users with no authority to a data set will not be able to recall it. Security Considerations in ABR-Auto-Recall-Security gives further details. This option has no effect if global option ALLCALL is set to “NO” (this option does not yet support the FDR.NOALLCALL security profile).
LXBYPSEC
If “YES”, security checking normally done by FDRABR or FDRABRUT during the actual recall is bypassed. This option is separate from the LXCHKSEC and LXEXIT options, which control security checking that may be done before FDRABR or FDRABRUT is invoked. The bypass applies both to security checking that FDRABR and FDRABRUT perform explicitly (see Security), and to security checking performed by Operating System routines that FDRABR and FDRABRUT invoke. If “NO”, users may require ALTER or CREATE authority to allocate and recall an archived data set; “YES” allows users with READ authority or with no authority if LXCHKSEC=NO, to recall the data set, although normal security is in place again when they attempt to open it. LXCHKSEC=YES requires at least READ authority to recall a data set, even with LXBYPSEC=YES. Special-Considerations gives further details.
The FDR.NOALLCALL security profile does not affect the LXBYPSEC option. LXBYPSEC is recommended as a usability option; it does not create a security exposure because it does not enable the user to access the data set after the recall if he does not have authority.
LXEXIT
If “YES”, a user-supplied security exit is invoked for each data set to be recalled before invoking FDRABR to do the recall. EXIT NAME specifies the name of the exit load module. The exit may also specify a new target volume for the recalled data set. The topic Target Volume for Recall in Operating System Exit Options for FDRABR and FDRREORG discusses the interaction among the various options that may affect the output volume choice. If you wish to write a security exit, please contact BMC Support for details.
LXXRPROC
Activate job-level external recalls and specify the name of the cataloged procedure to perform recalls of all archived data sets requested by the DD statements for an entire job. It is used if the BATCH_RCLMIGDS option in PARMLIB member ALLOCxx is set to PARALLEL rather than SERIAL, or the batch job being executed has this DD statement present in the first job step:
This procedure name is started in a separate address space during step initiation when the first DD statement for an archived data set is processed.
When installing the ABR Catalog Locate exit, you must copy this cataloged procedure from member FDREXRCL in the Installation Control Library (ICL) to a cataloged procedure library that is available to JES for START commands. The suggested name for this procedure in your PROCLIB is FDREXRCL. Specify this name (FDREXRCL or other) in option LXXRPROC. Further details are in Step 4: FDREXRCL Procedure in Dynamic-Exit-Installation-Procedure and Cataloged Procedures in Testing-the-FDR-z-OS-Exits.
Default: None
LXNCDENY
If “YES”, a “not cataloged” return code is returned to LOCATE when a TSO user references a data set that has been archived for recall, and the user specifies that the data set should not be recalled (by the reply to message FDRW71). This option has no effect if options LXDFREST and LXUNCAT are both set to NO. If NO, when the user bypasses the recall, a normal (zero) return code is passed to LOCATE, along with the volume serial currently in the catalog (which may be MIGRAT); since the data set has not been recalled. TSO may try to open the data set and get an error saying it could not be found, or the volume could not be mounted.
LXCONUSE
LXCONVOL
If LXCONUSE=YES, a constant new volume serial specified by the LXCONVOL option is passed as the target volume for every auto-recall. If NO, the volume to which the data set is currently cataloged is passed as the target output volume. The usual use of the LXCONUSE/LXCONVOL options is to designate a non-existent volume in order to force ABR to select a volume using the ABR Restore Allocate List (see Define-the-ABR-Protect-Lists-and-Restore-Allocation-List).
LXALTMSG
If “YES”, an alternate format for message FDRW71 is used when asking a TSO user whether an archived data set should be recalled. This alternate format requires a positive action (keying in “YES”) to cause an archived data set to be recalled. If “NO”, the standard format for FDRW71 is used, where pressing ENTER recalls the data set, and a response of “NO” is required to bypass the recall. This option has no effect if options LXDFREST and LXUNCAT are both set to “NO”, or if option LXFOREST is set to “NO”.
LXUNCAT
If “YES”, the ABR Catalog Locate exit offers a TSO user the choice of uncataloging an archived data set instead of recalling; this allows the user to create a new data set if the data in the archived version is not required. If option LXFOREST is set to “NO”, then option LXUNCAT is ignored and the TSO user is not offered the choice of uncataloging the data set
LXMAXSTC
Specifies the maximum number of recall started tasks that are allowed to be running in the system at one time. The number may be from 1 to 255. If LXMAXSTC and LXMAXREC are both specified, then LXMAXSTC must be less than or equal to LXMAXREC. If set to “NONE”, the number of recall tasks is not limited. If the limit is exceeded, additional requests are pended; batch jobs wait and TSO users are given the option to wait or cancel the recall.
LXMAXREC
Specifies the maximum total number of recalls that are allowed to be running in the system at one time. This is the sum of recalls done by started tasks (which may be limited separately by the LXMAXSTC option) and recalls performed in the address space issuing the LOCATE. (Remote queue recalls do not count.) The number may be from 1 to 255. If LXMAXSTC and LXMAXREC are both specified, then LXMAXSTC must be less than or equal to LXMAXREC. If exceeded, the result is the same as described for LXMAXSTC above. If set to “NONE”, the total number of recalls is not limited.
LXDIRVOL (JES3 only)
To meet the requirements of JES3 job scheduling, this specifies a special DASD volume serial that is returned to JES3 during setup for all data sets archived for auto-recall. This “directed” volume serial must be online and available to all systems in the complex so that JES3 is able to schedule the job on any system (subject to other constraints). Once the job begins running and the data set is recalled, the actual volume serial to which it was recalled is used.
LXDIRTYP (JES3 only)
Specifies the device type of the “directed” volume serial in LXDIRVOL above, specified as “3380”, “3390”, and so on. This must be the actual device type on which that volume is mounted.
LXSPFMIG
Specifies that under ISPF option 3.4 (data set list utility), the volume serial of data sets archived for auto-recall are displayed as “MIGRAT”, even if they were not archived with the MIGRAT option or they are multi-volume VSAM.
LXHRCANRQ
If “YES”, a TSO recall request initiated by an HRECALL command that is canceled because the LXMAXSTC or LXMAXREC values are exceeded is placed on the remote queue.
LXASTPMRQ
If “YES”, asynchronous HRECALL requests issued by Thruput Manager (a product of MVS Solutions) are redirected to the remote queue.
Target volume for recall
Whenever the ABR Catalog Locate exit initiates a restore for an archived data set, using any restore type, the exit designates a target output volume to which the data set should be restored. The default is that the designated volume is the volume where the data set is cataloged (that is either the volume from which the data set was archived, or “MIGRAT” if the MIGRAT option was in effect when the data set was archived). The following paragraphs explain the interaction among the various options that may change the designated volume. These options are LXCONUSE, LXCONVOL, LXCHKSEC, LXEXIT, LXNEWVOL, and LXREISSU.
If the LXCONUSE option is set to “YES”, the ABR Catalog Locate exit initially sets the output volume to the value specified by the LXCONVOL option. If not, it is set to the volume to which the data set is cataloged (which is either the volume from which the data set was archived, or “MIGRAT”, if the MIGRAT option was in effect when the data set was archived).
Next, if the LXEXIT option is set to “YES”, the ABR Catalog Locate exit calls the user-written recall security exit named by the EXIT NAME option. The LXEXIT exit may designate a new output volume. If the LXCHKSEC is set to “YES”, the ABR Catalog Locate exit may call a user-written FDR Data Set Security exit that may also designate a new output volume.
If the recall is on behalf of a TSO user, and the LXNEWVOL option is set to YES, the ABR Catalog Locate exit issues messages FDRW76 and FDRW77, telling the TSO user the output volume that is currently selected, and allowing entry of a new volume. If a new volume was entered, and the LXREISSU option is set to “YES”, the FDRW76 and FDRW77 messages are issued again, allowing the user to change the volume again (this continues until ENTER is pressed to accept the last choice).
After all this, the output volume chosen by the CATALOG LOCATE is not necessarily the volume to which the data set is actually restored. If the designated volume is “MIGRAT”, ABR substitutes the original volume from which the data set was archived, as recorded in the Archive Control File. If the designated or original volume is not online, or has no room for the data set, ABR uses the Restore Allocate List (Define-the-ABR-Protect-Lists-and-Restore-Allocation-List), if any, to select a different volume. LXCONUSE and LXCONVOL, in particular, are often used to designate a non-existent volume in order to force ABR to select a volume using the Restore Allocation List. In addition, if SMS is active, SMS may assign the data set to a different volume (see System-Managed-Storage-SMS) or other storage management software may direct the data set to particular volumes.
Panel A.I.4.11.5 – Set ABR DADSM Pre-Exit Options
These options affect the ABR DADSM Preprocessing exit.
ABR DADSM Preprocessing Exit Options – Panel A.I.4.11.5
COMMAND ===>
PXNOGDG NUMBER OF GDG GENERATIONS TO KEEP IN THE SCRATCH CATALOG... 4
PXERRLEN ISSUE WTO MESSAGE IF SCRATCHED DSNAME EXCEEDS 42 CHARACTERS YES
PXNOGDG
Specifies the number of scratched generations of a Generation Data Group (GDG) that are kept in the ABR Scratch Catalog. PXNOGDG may be specified as an absolute number (1 to 255), or alternatively as a relative number, when prefixed by a plus or minus sign, for example, –5, +12, +0. The first time that a generation of a given GDG is scratched, a GDG base is built in the ABR scratch catalog with a name of “#.gdgbase” where “#” is the scratch catalog prefix specified on panel A.I.4.5 and “gdgbase” is the name of the actual GDG base. It is assigned a limit value assigned by PXNOGDG so the records of that many scratched generations are retained in the scratch catalog.
When PXNOGDG is a relative number, the limit value is calculated by taking the limit currently associated with the real GDG base and adding or subtracting the PXNOGDG value. For example, if PXNOGDG is +3, and a generation is scratched from a GDG having a limit of 5, the “#.gdgbase” in the scratch catalog is built with a limit of 8, so the GDG may have 5 live generations and 8 scratched generations.
PXERRLEN
If set to “YES”, the DADSM Preprocessing exit issues the WTO message (FDRW90 REASON=O) when it is unable to create an entry in the ABR Scratch Catalog for a data set being scratched or renamed because the combined lengths of the ABR Scratch index “#.” and of the data set name exceed 44 characters (when the data set name is 43 or 44 characters in length). If set to “NO”, no message is generated for this condition.
Default: YES.
Panel A.I.4.11.6 - Set ABR Open Exit Options