DD statements for the Online Pointer Checking function (for full-function databases)

DD statements are used to identify the source of input and the placement of output information. The following DD statements are supported for the Online Pointer Checking function that is run with the FABJMAIN program.

Table 1. DD statements for the Online Pointer Checking function
DDNAME Use Format Required or optional
STEPLIB Input PDS Optional
DFSRESLB Input PDS Optional
IMSDALIB Input PDS Optional
RECON1
RECON2
RECON3
Input/Output KSDS Required if DBRC=Y (See Note 1)
IMS Input PDS Required
ICEIN Input LRECL=80 Required
ICEPRINT Output LRECL=133 Required
DFSPRINT Output LRECL=122 Required
ICERPRT Output LRECL=133 Optional
ICEDLIST Output LRECL=133 Optional
FABJSTAT Output LRECL=133 Optional
datain Input VSAM or OSAM Required (See Note 2)
dataout1 Output RECFM=FB or VBS Required (See Note 2)
dataout2 Output RECFM=FB or VBS Optional (See Note 2)
stack1 Output RECFM=FB or VBS Required (See Note 2)
stack2 Output RECFM=FB or VBS Optional (See Note 2)
DSSPRINT Output LRECL=133 Optional
DSSSTATS Output LRECL=133 Optional
CHKPTDD Input/Output LRECL=4096 or greater, RECFM=VB Optional
HPSRETCD Input LRECL=80 Optional
FABJDRSN Input LRECL=80 Optional
FABJHRDD Input/Output RECFM=VB Optional
FABJRDMP Output LRECL=(RECON CI size)+4, RECFM=VBA Optional
SYSABEND or SYSUDUMP Output LRECL=133 Optional
DBDEFCTL Output LRECL=133 Required if run in multiple steps (See Note 3)
IMS2 Input PDS Required if you use FABPZWTO
FSESTAT Input/Output LRECL=134 Required if run in multiple steps (See Note 4)
HISTORY Input/Output KSDS Required if run with the HISTORY option
PRIMAPRT Output LRECL=133 Required
STATIPRT Output LRECL=133 Required (See Note 4)
VALIDPRT Output LRECL=133 Required (See Note 4)
EVALUPRT Output LRECL=133 Required if run in single step
SUMMARY Output LRECL=133 Required if run in single step
SNAPPIT Output LRECL=133 Required (See Note 4)
SORTEX Output LRECL=40 Required if run in multiple steps (See Note 5)
SPMNIN Input LRECL=80 Optional
SPMNSPDT Input/Output Fixed record length Optional
Notes:
  1. Do not specify these DD statements if you want the RECON data sets dynamically allocated.
  2. IMS HP Image Copy supports dynamic allocation for these data sets. To have these data sets dynamically allocated, do not specify the DD statements.
  3. If you want to invoke the HD Pointer Checker HASH Check option in single step, do not supply this statement or specify DUMMY.
  4. Besides the data sets in this table, the following data sets are allocated dynamically as temporary data sets. You do not need to specify them in the JCL, but you must not use these names in your JCL statements because they will be used by HD Pointer Checker:
    • STATIPnn DD (nn=01, 02, 03, ...99)
    • VALIDPnn DD (nn=01, 02, 03, ...99)
    • SNAPPInn DD (nn=01, 02, 03, ...99)
    • FSESTAnn DD (nn=01, 02, 03, ...99)
  5. If you want to invoke the HD Pointer Checker HASH Check option in single step, delete this statement. Do not specify DUMMY for the SORTEX DD statement.
  6. DD names that start with the following prefixes are reserved for IBM® use: FABJ, ICE#, and HKT.
STEPLIB DD
This statement points to the load module library data sets. They must be in the following sequence:
//STEPLIB  DD   DISP=SHR,DSN=HPS.SHPSLMD0
//         DD   DISP=SHR,DSN=HPPC.SHPSLMD0
//         DD   DISP=SHR,DSN=TOSI.SGLXLOAD
//         DD   DISP=SHR,DSN=TOSI.SFOILOAD
//         DD   DISP=SHR,DSN=IMS.SDFSRESL 

where:

HPS.SHPSLMD0
The name of the library that contains the load modules of IMS HP Image Copy.
HPPC.SHPSLMD0
The name of the library that contains the load modules of IMS HP Pointer Checker.
TOSI.SGLXLOAD
TOSI.SFOILOAD
The names of the libraries that contain the load modules of IMS Tools Generic exit and IMS Tools Online System Interface, which are provided by IMS Tools Base.
IMS.SDFSRESL
The name of the library that contains the IMS nucleus and required action modules.

To use the IMS HP Image Copy site default table, you must specify the library that contains the IMS HP Image Copy site default table.

If STEPLIB is unauthorized because it specifies libraries concatenated to IMS.SDFSRESL, you must include a DFSRESLB DD statement.

DFSRESLB DD
This statement points to an authorized library that contains the IMS SVC modules.
IMSDALIB DD
This statement specifies the dynamic allocation members for the database, the index, and the RECON data sets. Allocation of these data sets is attempted in the following order:
  1. DD statements found in the JCL stream
  2. Dynamic allocation members in the IMSDALIB concatenation
  3. Dynamic allocation members in the JOBLIB or STEPLIB concatenation
For dynamic allocation of HALDB databases, RECON data sets are used instead of this DD statement.
RECON1 DD
RECON2 DD
RECON3 DD
These statements specify the DBRC RECON data sets. These statements are required if HALDB exists in the databases and the RECON data sets are not allocated dynamically, or if DBRC parameter is Y and the RECON data sets are not allocated dynamically. Do not specify these RECON data set DD statements if you want RECON data sets allocated dynamically using the DFSMDA macro.
IMS DD
This statement defines the library that contains the DBD describing the database to dump, generally DSNAME=IMS.DBDLIB. The data set must reside on a direct-access volume.
ICEIN DD
This statement is required. It specifies the input control statement data set. The data set can reside on a tape or a direct-access volume, or it can be routed through the input stream (DD * or DD DATA).

For details, see ICEIN control statements.

ICEPRINT DD
This statement is required. It specifies the output messages data set. The IMS HP Image Copy main module generates messages in this data set. The data set can reside on a tape, a direct-access volume, or a printer, or it can be routed through the output stream (SYSOUT).
DFSPRINT DD
This statement specifies the required output message data set. The data set contains messages from the IMS HP Image Copy module that has alias name DFSUDMP0 or DFSURDB0. The data set can reside on a tape, a direct-access volume, or a printer, or it can be routed through the output stream (SYSOUT).
If this DD statement is not specified, IMS HP Image Copy ends abnormally with U3905.
ICERPRT DD
This statement specifies the optional report data set. This data set contains the Image Copy Dump Process report. It can reside on a tape, a direct-access volume, or a printer, or it can be routed through the output stream (SYSOUT).
ICEDLIST DD
This statement specifies the optional output message data set. This data set contains the DBRC report for DBRC commands, such as the NOTIFY.IC, the NOTIFY.UIC, and the CHANGE.IC commands. It can reside on a tape, a direct-access volume, or a printer, or it can be routed through the output stream (SYSOUT).
FABJSTAT
This statement specifies the optional report data set. This data set contains the Data Set Statistics report. It can reside on a tape, a direct-access volume, or a printer, or it can be routed through the output stream (SYSOUT).
datain
This statement defines the input data set to be dumped. The ddname on this statement must be the same as the one in the DBD that describes this data set. You can request the Image Copy function to dynamically allocate the input data set using the DFSMDA member. To dynamically allocate the data set, omit this DD statement and specify the DBDALLOC=YES parameter in the ICEIN data set. IMS HP Image Copy determines the optimal buffer size for each data set.
dataout1 DD or stack1 DD
This statement defines the first copy of the dumped output data set. One DD statement is required for each data set to be dumped unless the output data set is dynamically allocated. The ddname can be any 1- to 8-character string, but the ddname must appear in the associated utility control statement. The output device must be either a direct-access device or a tape. Standard labels must be used. If the output is a direct-access device, BLKSIZE is determined by the system to optimize output DASD BLKSIZE. If BLKSIZE is specified in the JCL, that BLKSIZE is used.
You can request the Image Copy function to allocate the output data set dynamically by omitting this DD statement and specifying the ICDALLOC=YES parameter and its associated allocation parameters in the ICEIN data set.
For details, see ICOUT keyword and STACK keyword.
dataout2 DD or stack2 DD
This statement is required only if the associated utility control statement requests two copies of the dump. The name must appear in the control statement. The name must be that of either the tape or the direct-access device. Standard labels must be used. If the output is a direct-access device, BLKSIZE is determined by the system to optimize output DASD BLKSIZE. If BLKSIZE is specified in the JCL, that BLKSIZE is used. If either of the two output copies has an "open" problem (message DFS301A) or fails the first PUT operation to either output data set (message DFS319A), the current control statement is terminated and the next control statement is processed.
Once the utility has proceeded beyond the first PUT, all I/O errors caused by output data set result in RC=08, but the utility continues to copy to the remaining output data set. Each image copy control statement is treated as an independent copy; the last return code is the highest received for the job.
You can request the Image Copy function to allocate the output data set dynamically by omitting this DD statement and specifying the ICDALLOC=YES parameter and its associated allocation parameters in the ICEIN data set.
For details, see ICOUT keyword and STACK keyword.
DSSPRINT DD
This statement specifies the output messages data set for the messages that DFSMSdss generates when the Advanced Image Copy Services is used. If this statement is present, DFSMSdss issues messages that are prefixed with ADR to the data set. These messages provide processing information and any errors that occurred during processing.
DSSSTATS DD
This statement specifies the optional output message data set for messages on statistics of DFSMSdss User Interaction module (UIM) processing when Advanced Image Copy Services is used. If this statement is present, IMS HP Image Copy creates the DFSMSDSS User Interaction Module (UIM) Statistics report, which includes information on UIM processing, such as the start and the end time, task ID, and target database name.
CHKPTDD DD
A function-unique DD statement for the Checkpoint Restart option. The DD statement is valid when RESTART=Y|N|C is specified. This statement defines the checkpoint file. It must be the same file used for a both a particular checkpoint and for the associated attempted subsequent restarts. Additionally, the file must be preallocated and cataloged before the requested checkpoint or restart. If the checkpoint file (CHKPTDD) is not defined in the job step or is DD DUMMY, then the Checkpoint Restart function is bypassed. However, the requested functions are attempted. For details, see RESTART keyword.
HPSRETCD DD
This statement is a function-unique DD statement for the Return Code Handling option. This optional input data set contains the user-specified control statements that define the return codes of the IMS HP Image Copy process.
For details, see HPSRETCD control statement.
FABJDRSN DD
This statement specifies the input data set that contains the user-specified control statements for defining the error reason code (S99ERROR) and the SMS reason code (S99ERSN) for dynamic allocation.
For details, see FABJDRSN control statement.
FABJHRDD DD
A function-unique DD statement for Checkpoint Restart, which is used with the HASH option of the RESTART keyword. The DD statement is valid when RESTART=(Y,HASH) and HDPC=Y are specified. The file must be preallocated and cataloged before running the requested checkpoint or restart. If the HASH record file (FABJHRDD) is not defined in the job step or is DD DUMMY, the HASH record validation that uses FABJHRDD is bypassed.
This DD defines the validation of the HASH record file, which is used at restart time. It must be the same file that is used for both a particular checkpoint and for the associated attempted subsequent restarts. If HASH Check finds, at the restart time, the same hash error as in the previous run, IMS HP Image Copy regards it as the database having fatal error, and does not restart the next run.
FABJRDMP DD
An optional output data set in which the RECON REPRO output is stored for diagnosis use in the QSAM format. IMS HP Image Copy runs REPRO and stores the RECON data set into the data set of FABJRDMP DD, when the DD is defined under the following conditions:
  • DBDS record is found in RECON, but its corresponding database record is not found in the Online Pointer Checking function.
  • IC record is found in RECON, but its corresponding DBDS record is not found in the Recovery function.

Tape drives are not supported.

This DD is optional.

The specification is as follows:

//FABJRDMP DD  DISP=OLD,DSN=dataset_name

where dataset_name is the data set name where REPRO output is stored.

SYSABEND DD
SYSUDUMP DD
These statements define a dump data set. If both statements are present, the last occurrence is used for the dump.
IMS2 DD
This statement defines the library that contains the FABPZWTO user exit, the partition selection exit module, or both. The data set must reside on a direct-access volume. It is required if you want to use FABPZWTO, the partition selection exit, or both.
FSESTAT DD
This statement defines the work data set used by the HDAM, HIDAM, HDAM, and PHIDAM scan processes. If BLKSIZE is coded on the DD statement, it must be a multiple of 134.
HISTORY DD
This optional data set defines the HISTORY data set (VSAM KSDS) that is used as input to the DB Historical Data Analyzer and Space Monitor of IMS HP Pointer Checker. When the HISTORY option is specified, this data set is required, and must be allocated and initialized by the DB Historical Data Analyzer utility before you run IMS HP Image Copy. DISP=SHR must be used. For more information, see the IMS High Performance Pointer Checker User's Guide.
PRIMAPRT DD
This statement defines the output data set that contains the primary reports produced by the HISAM, INDEX, HDAM, HIDAM, PHDAM, and PHIDAM HASH Check option processes. If BLKSIZE is coded on the DD statement, it must be a multiple of 133.
STATIPRT DD
This statement defines the output data set that contains the statistics reports generated by HISAM, HDAM, HIDAM, PHDAM, and PHIDAM. If BLKSIZE is coded on the DD statement, it must be a multiple of 133.
VALIDPRT DD
This statement defines the output data set that contains the legend and the validation reports produced by the HISAM, INDEX, HDAM, HIDAM, PHDAM, and PHIDAM HASH Check option processes. If BLKSIZE is coded on the DD statement, it must be a multiple of 133.
EVALUPRT DD
This statement defines the output data set containing the evaluation reports. This DD statement is required. If BLKSIZE is coded on the DD statement, it must be a multiple of 133.
SUMMARY DD
This statement defines the output data set containing the summary reports. It is optional. If BLOCKSIZE is coded on the DD statement, it must be a multiple of 133.
SNAPPIT DD
This statement defines the output data set that contains the block maps and block dumps that the HDAM, HIDAM, HDAM, and PHIDAM scan processes produce. The block maps and block dumps are produced when the HDAM HIDAM, HDAM, and PHIDAM scan process detects pointer errors, incorrect FSEAPs or FSEs, or T2 errors. The statement is required. If BLKSIZE is coded on the DD statement, it must be a multiple of 133.
SORTEX DD
This statement defines the output data set that contains 40 byte sort records written by the HISAM, INDEX, HDAM, HIDAM, PHDAM, and PHIDAM processes. It contains pointer type records for both each segment type and each segment type records. This data set is used as the input data set for the subsequent EVALUATE process. The statement is required. LRECL must be 40, and BLKSIZE must be a multiple of 40. If you want to invoke the HD Pointer Checker HASH Check option in single step, delete this statement. Do not specify "DUMMY" for the SORTEX DD.
SPMNIN DD
This optional input data set contains the control statements for Space Monitor of IMS HP Pointer Checker. For more information, see the IMS High Performance Pointer Checker User's Guide.
SPMNSPDT DD
This optional input/output sequential data set is the graph record data set for Space Monitor. For more information, see the IMS High Performance Pointer Checker User's Guide.