Return code handling

An optional input data set FRXRETCD allows you to specify the return code from auxiliary utilities run under IMS Database Recovery Facility.

The FRXRETCD data set can be used to override the return code values, nn = 0-16, from the following utilities:

  • IMS High Performance Pointer Checker (PCERROR=)
  • IMS Index Builder (IBERROR=)
  • IMS High Performance Pointer Checker (DEDB) (DPERROR=)
  • IMS High Performance Image Copy (ICERROR=)
  • DFSPREC0 (PRERROR=)

The return codes nn must be two-digit number between 0 and 16.

The functionality is similar to the HPSRETCD data set provided in IMS High Performance Image Copy and IMS High Performance Pointer Checker. The keywords used by FRXRETCD are unique to IMS Database Recovery Facility.

The IMS Database Recovery Facility final return code is based on two criteria:

  • Any recovery-related errors produce RC equal to or greater than 0.
  • If there are no recovery-related errors, the final return code is set to the larger value of either the IMS Database Recovery Facility return code or the integrated auxiliary utility return code.

    For example, if IMS Database Recovery Facility returns RC=8 and the IMS Index Builder auxiliary utility returns RC=12, the IMS Database Recovery Facility final return code becomes 12.

FRXRETCD data set format

The FRXRETCD data set contains your specifications for the return codes that are returned from the integrated auxiliary utilities.

The following conditions apply to the FRXRETCD data set:

  • The function is disabled if the FRXRETCD data set is not present in the JCL, or if the data set is specified as DD DUMMY.
  • The control data set can be specified as part of the input stream, a sequential data set, or a member of a partitioned data set.
  • The data set must contain 80 byte fixed length records. BLKSIZE is optional. If BLKSIZE is used, it must be specified as a multiple of 80.

The FRCRETCD data set contains (DRF) statements using the following format:

Figure 1. Control statement format for the FRCRETCD data set
//FRXRETCD  DD  *
(DRF)
PCERROR=nn
IBERROR=nn
DPERROR=nn
ICERROR=nn
PRERROR=nn
/*

These statements must be coded as shown in the following example:

Figure 2. Example control statement format for the FRCRETCD data set
//FRXRETCD   DD *
(DRF)
PCERROR=4,
IBERROR=8

Control statement format conventions

Follow these format conventions when you write control statements in the FRXRETCD data set:

  • You must code an (DRF) statement in the first line of the FRXRETCD data set, and you must code keywords and their values on the second or subsequent lines.
  • You must code the (DRF) statement, keywords, and their values within columns 1 and 72.
  • When you code multiple keywords, they can be separated by commas or a new line.
  • Keywords are not positional; you can specify them in any order of sequence. You cannot specify a null value for any keyword.
  • Comments can follow the last keyword value on each control statement record, separated by at least one blank.
  • A comment statement must begin with an asterisk in column 1.
  • Comments can follow the last keyword value on each control statement record, separated by at least one blank.
  • Comments can be located right after the value (without any blanks) or on a new line, but they should start with a forward slash and an asterisk, not just with an asterisk.

(DRF) statement syntax

The (DRF) statement must contain optional parameters that are specified by the keywords shown in the following syntax diagram.

Read syntax diagramSkip visual syntax diagram (DRF)
Optional keywords
Read syntax diagramSkip visual syntax diagram PCERROR=nn IBERROR=nn DPERROR=nn ICERROR=nn PRERROR=nn

Keyword reference

PCERROR=
Specify the return code when the PC (IMS High Performance Pointer Checker) error is detected.

The value nn is from 0 to 16.

IBERROR=
Specify the return code when the IB (IMS Index Builder) error is detected.

The value nn is from 0 to 16.

DPERROR=
Specify the return code when the DP (IMS High Performance Pointer Checker (DEDB)) error is detected.

The value nn is from 0 to 16.

ICERROR=
Specify the return code when the IC (IMS High Performance Image Copy) error is detected.

The value nn is from 0 to 16.

PRERROR=
Specify the return code when the PR (DFSPREC0 ) error is detected.

The value nn is from 0 to 16.