Welcome
CICS VR Exits
Implementing exits for forward recovery and backout
Description of intended Programming Interfaces that allow you to write exits for CICS® VR forward recovery and backout.
Preapply exit: pass Log Records and VSAM Records
You can use the preapply exit to modify an after-image that is applied to a VSAM data set.
Parameter List
The parameter list that is passed to the preapply exit.

What's new in CICS VR 6.3
CICS® VR 6.3 contains these changes.
Operating environment
CICS® VR uses logs to recover your VSAM data.
CICS VR Overview
Getting Started
CICS® VR and CICS® TS
CICS VR Exits
- Using the CICS® VR archive exits
  Documentation of intended Programming Interfaces that assist you to write exits for CICS® VR archive and log stream copy utilities.
- Implementing exits for forward recovery and backout
  Description of intended Programming Interfaces that allow you to write exits for CICS® VR forward recovery and backout.
  - What you can use the exits for
    The special processing that the CICS® VR exits allow you to perform at four different exit points.
  - How the exits work
    Before you start using an exit, you must know how it works with CICS® VR.
  - Error exit: pass I/O error information
    You can use the error exit to make CICS® VR continue processing after an I/O error.
  - Batch backout ESDS delete exit: pass ESDS deletion records
    You must use a CICS® VR batch backout ESDS delete exit when you request CICS VR batch backout to back out one or more records that were added to a VSAM ESDS by a batch job.
  - Preapply exit: pass Log Records and VSAM Records
    You can use the preapply exit to modify an after-image that is applied to a VSAM data set.
    - When the Exit Is Called
      The preapply exit is called before CICS® VR updates a VSAM data set with the after-image for forward recovery for data sets that are being recovered in this CICS VR run.
    - Parameter List
      The parameter list that is passed to the preapply exit.
    - Parameters passed to the exit program
      The parameters that are passed to the exit program.
    - Parameters returned from the exit program
      The parameters that are returned from the exit program.
    - Sample CICS® VR preapply exit
      In the CICS® VR library SDWWSORC, member DWWPREEX contains a sample CICS VR preapply exit program.
  - Termination exit: pass CICS® VR return code
    You can use the termination exit to modify the CICS® VR return code.
Running CICS® VR forward recovery
CICS® VR forward recovery consists of a restore and then forward recovery.
Running CICS® VR backup
The information in the following topics describe how to take a backup using CICS® VR. The panels and secondary windows are in the sequence that they are displayed during a backup job generation.
Running CICS® VR reorganization
You can reorganize a VSAM sphere using CICS® VR. VSAM sphere reorganization can increase the space of a sphere and its alternate indexes. It can also change the control interval sizes for a sphere's components.
Working with other VSAM sphere list pull-down menus
The CICS® VR recovery and backup functions are typically accessed using the Utilities pull-down menu after selecting VSAM spheres.
Working with CICS® Backout Failed spheres
The CICS® Backout Failed sphere list shows the CICS spheres registered for manual recovery or reorganization after CICS notification of a backout failure.
Working with logs
Using ISMF data set lists with CICS® VR
CICS® VR is integrated with ISMF so that you can create a CICS VR recovery job for the data sets in an ISMF data set list by entering the VSAMREC line operator or list command. When you enter the VSAMREC line operator or list command, the necessary CICS VR panels are called and you can create a recovery job for the VSAM sphere.
Running CICS® VR manually
IBM® recommends that you use the CICS® VR panel interface to create recovery jobs for your VSAM spheres. Using the CICS VR panel interface eliminates the need for you to manually keep track of daily update activity, logs, backups, etc. Also, the CICS VR panel interface automatically creates the recovery JCL for you.
Running CICS® VR batch backout
The CICS® VR batch backout utility allows you to remove updates that were made to KSDS, ESDS, RRDS, and VRRDS VSAM spheres by steps in a batch job. This section describes how to run the CICS VR batch backout utility.
Understanding CICS® VR reports
The CICS® VR forward recovery and batch backout utilities produce a set of reports upon successful completion. The reports are written to the data set allocated to the DWWPRINT ddname. However, the set of reports written for the forward recovery backout utilities differ from the set of reports written for the batch backout utilities.
Understanding IBM® program support
The IBM® Customer Engineering Program Support structure helps you resolve problems with IBM products, and ensures that you can make the best use of your IBM computing systems.
Problem determination procedures
If you have to contact IBM® personnel about a CICS® VR problem, you must classify and describe the problem.
Diagnosing the causes of abends
You can determine the cause of a CICS® VR abend in a number of ways.
Reference information
The reference sections of the information contain reference information that you need when you use CICS® VR.
Glossary
The terms in this glossary are defined as they pertain to the CICS VSAM Recovery documentation.
Edition notice
This is the information for CICS VSAM Recovery for z/OS. It applies to CICS VSAM Recovery for z/OS Version 6.3, and to all subsequent versions, releases, and modifications until otherwise indicated in new editions. Make sure you are using the correct edition for the level of the product.
Download PDF
Download the PDF format documentation for CICS VSAM Recovery for z/OS 6.3

Parameter List

The parameter list that is passed to the preapply exit.

Base cluster name, log record, VSAM record length, VSAM record,
work area, action code, format

This figure shows how you find the parameters from the contents of register 1.

This figure lists the contents of the registers passed to the preapply exit used with the CICS VR recovery and CICS/ESA V4R1 backout utilities. Register 1 contains the address of the parameter list. The first fullword in the parameter list contains the address of the base cluster name. The second fullword in the parameter list contains the address of the log record. The third fullword in the parameter list contains the address of the VSAM record length. The fourth fullword in the parameter list contains the address of the VSAM record. The fifth fullword in the parameter list contains the address of the work area. The sixth fullword in the parameter list contains the address of the action code. Register 13 contains the address of the register save area. Register 14 contains the return address. Register 15 contains the exit program start address. — Figure 1. Preapply Exit Parameters