HPSRETCD control statement

The HPSRETCD data set contains user-specified control statements that define the return codes of IMS HP Image Copy processes.

HPSRETCD is an optional input data set. If you specify the name of the HPSRETCD data set for the RETCDDSN keyword of the GLOBAL statement, IMS HP Image Copy allocates HPSRETCD DD dynamically and uses it. For more information about the RETCDDSN keyword, see RETCDDSN keyword.

Note: If you specify HPSRETCD control statements for FASTIC=(,COPY) processing, the specification of the return code is ignored.

Subtopics:

Format

This control data set usually resides in the input stream. However, it can also be defined as a sequential data set or as a member of a partitioned data set. It must contain 80-byte, fixed-length records. BLKSIZE, if coded, must be a multiple of 80. This data set must contain (HPIC) statements.

The following figure shows an example of the control statement in the HPSRETCD data set:

//HPSRETCD  DD  *  
   (HPIC)  
   T2ERROR=12,DBERROR=16,  
   IOERROR=24,EMPTYIDX=28
Note: On the control statement, you can code uppercase alphabetic characters, numeric characters, and the following special characters:
  • Asterisk (*)
  • Comma (,)
  • Equal sign (=)
  • Parenthesis ( )

Control statement syntax

The following describes the coding conventions that you must follow in writing control statements in the HPSRETCD data set:

  • An (HPIC) control statement must be coded in the first line of the HPSRETCD data set, and optional parameters must be coded in the second or later lines.
  • The (HPIC) control statement and option parameters must be coded within column 1 and column 72.
  • When more than one option parameter is coded, they must be separated by commas. No blanks are allowed between the option parameters and the commas, or within the option parameters.
  • Option parameters can be continued onto one or more following control statement records.
  • Option parameters are not positional parameters; they can be specified in any order of sequence. A null value is not allowed for any option parameter.
  • Comments can follow the last option parameter on each control statement record separated by at least one blank.
  • A comment line must begin with an asterisk in column 1.
  • The only control statement name that can be used within round brackets is HPIC, as in (HPIC).

(HPIC) Statement

The (HPIC) statement specifies the options for return codes. There must be only one (HPIC) statement, and it must be the first statement in the HPSRETCD data set.

If multiple conditions for nonzero return code occur, IMS HP Image Copy returns the highest return code.

The (HPIC) statement supports the following optional keywords:

  • CATLGERROR=nn|0
  • COMPWARN=nn|0
  • DBERROR=nn|4
  • DEDBPCER=nn|2
  • EMPTYIDX=nn|8
  • ICDSNOTF=nn|8
  • INDEXCIC=nn|0
  • IOERROR=nn|8
  • PCLOADER=nn|4
  • SPMNERROR=nn|8
  • SPMNWARN=nn|4
  • STACMDFAIL=nn|4
  • T2ERROR=nn|2
  • TMSERROR=nn|8
CATLGERROR
If IMS HP Image Copy detects a failure in the CATALOG macro for the stack data set, IMS HP Image Copy returns the return code specified by this parameter. nn is 0 - 99. The default value is 0.
Note: This parameter is effective only for the Image Copy function.
If you specify a value higher than 8 for this parameter:
  • IMS HP Image Copy will not register the IC record that has been detected as a catalog failure to RECON.
  • IMS HP Image Copy will not process the remaining DBDSs, which are not yet processed.
COMPWARN
If a warning of compression routine is detected, IMS HP Image Copy returns the return code specified by this parameter. nn is 0 - 99. The default value is 0.
DBERROR
Specify the return code that is to be issued when a database error is detected. nn is 0 - 99. The default value is 4. This option is effective when HASH Check of HD Pointer Checker is requested.
DEDBPCER
If IMS HP Image Copy detects a DEDB Pointer Checker error return, IMS HP Image Copy returns the return code specified by this parameter. nn is 0 - 99. The default value is 2.
EMPTYIDX
If IMS HP Image Copy finds empty index databases when processing an Image Copy function, IMS HP Image Copy returns the return code specified by this parameter. nn is 0 - 99. The default value is 0.
ICDSNOTF
If IMS HP Image Copy cannot find a valid input image copy data set in processing Recovery function and Create Image Copy function, IMS HP Image Copy returns the return code specified by this parameter. nn is 0 - 99. The default value is 8.
INDEXCIC
If IMS HP Image Copy attempts to process concurrent image copy of index databases, IMS HP Image Copy returns the return code specified by this parameter. nn is 0 - 99. The default value is 0.
IOERROR
If an I/O error is detected in either the primary or the secondary image copy process, and IMS HP Image Copy can continue that process, IMS HP Image Copy returns the return code specified by this parameter. nn is 0 - 99. The default value is 8.
PCLOADER
If IMS HP Image Copy fails in loading the IMS HP Pointer Checker module, IMS HP Image Copy returns the return code specified by this parameter. nn is 0 - 99. The default value is 4.
SPMNWARN
If space monitor detects a warning of return code 4, IMS HP Image Copy returns the return code specified by this parameter. nn is 0 - 99. The default value is 4. This option is effective when HASH Check of HD Pointer Checker is requested.
SPMNERROR
If space monitor detects a warning of return code 8, IMS HP Image Copy returns the return code specified by this parameter. nn is 0 - 99. The default value is 8. This option is effective when HASH Check of HD Pointer Checker is requested.
STACMDFAIL
If IMS HP Image Copy detects a failure in starting or releasing the quiesce state of the database, partition, or area for which the /START command or the UPDATE DB STOP(QUIESCE) command was issued by IMS Tools Online System Interface, IMS HP Image Copy returns the return code that is specified by this parameter. nn is 0 - 99. The default value is 4.
T2ERROR
Specify the return code that is to be issued when a T2 (unknown data) error is detected. nn is 0 - 99. The default value is 2. This option is effective when HASH Check of HD Pointer Checker is requested.
TMSERROR
When processing the Recovery function and the Create Image Copy function, if time stamp of input image copy data set is different from that of the DBRC record, IMS HP Image Copy returns the return code specified by this parameter. nn is 0 - 99. The default value is 8. This option is effective when HASH Check of HD Pointer Checker is requested.