DD statements for OPC

The following table summarizes the DD statements for OPC. The optional output data sets that are used by OPC are determined by the combination of the TYPRUN keyword and the FULLSTEP keyword of the ANALYZE control statement.

STEPLIB DD

Defines the library that contains the OPC utility.

• The load library of IMS HP Image Copy must be concatenated if you specify the comprtn parameter on the IC keyword or the IC=(YES,ICEIN) keyword.
• The IMS Tools Base library (SHKTLOAD) is required if you specify the ADXCFGRP keyword, the ITKBSRVR keyword, or the SENSOR=YES option.
• The library that contains DFSMDA dynamic allocation members for the RECON data sets.

The data set that contains the DBRC SCI registration exit routine (DSPSCIX0) must be concatenated when using the RECON data set in which an IMSplex name is set.

FPXOPTS DD

Defines the input data set that contains the option control statements for the process. FPXOPTS 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. Block size, if coded, must be a multiple of 80. It can be specified as DUMMY, NULLFILE, or an empty file.

For details of the option control statements, see Option control statement for OPC.

FPXIN DD

Defines the control statements for OPC. FPXIN describes the area to be processed, and it can contain optional user requests that further define the operating mode. FPXIN DD and SYSIN DD are mutually exclusive. FPXIN 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. Block size, if coded, must be a multiple of 80. It cannot be specified as DUMMY, NULLFILE, or an empty file. When both FPXIN DD and DASYSIN DD are specified, DASYSIN DD is ignored.

For details of the control statements, see Utility control statements for OPC.

SYSIN DD

Defines the input control data set that contains the IMS IFP utility control statements. A minimum of four statements is required, as shown below:

   TYPE TOOL
   AREA areaname
   EXIT ANALYZE
   GO 

where areaname is the name of an area to be processed. Only one area per job step can be specified.

For additional information about these IMS IFP utility control statements, see IMS Database Utilities for the version of IMS that you are using.

DASYSIN DD

Defines the control statement file that contains the data collection options, image copy specifications and reporting options. This data set can reside on a direct-access device or be routed through the input stream.

For details of the control statements, see Utility control statements for OPC.

FPXMFILE DD

Defines the default message output. The output can go to a data set or to a printer, routed through the output stream. If the DD statement is specified explicitly or implicitly by the MFILE keyword of the ANALYZE control statement, and if the DD statement for the specified DD name is not coded in the JCL stream, the DD is allocated dynamically to the system output stream with SYSOUT=*. If the DD name is overridden by the MFILE keyword with a different DD name, the DD statement for the specified DD name must be coded in the JCL stream.

FPXRPTS DD

Defines the default report output. The output can go to a data set or to a printer, routed through the output stream. If the DD statement is specified explicitly or implicitly by the RFILE keyword of the ANALYZE control statement and if the DD statement for the specified DD name is not coded in the JCL stream, the DD is allocated dynamically to the system output stream with SYSOUT=*. If the DD statement is overridden by the RFILE keyword with a different DD name, and the DD statement for the specified DD name is not coded in the JCL stream, the DD is allocated dynamically to the system output stream with SYSOUT=*.

FPXSPRT DD

Defines the report output data set when SENSOR=YES is specified. This output data set contains the Sensor Data Statistics report that can be used to verify which sensor data is stored in the Sensor Data repository of IMS Tools KB. The following DCB attributes of the file are set by FPO:

• RECFM=FBA
• LRECL=133
• BLKSIZE=1330

Do not code the DCB information in your JCL statement. The output data set must be a standard SYSOUT or a sequential data set. You can specify NULLFILE or DUMMY for this data set.

The FPXSPRT data set contains 133-byte, fixed-length records. It is recommended that you code your DD statement as follows:

//FPXSPRT DD SYSOUT=A

Note on dynamic allocation:

When this statement is not specified in the JCL statements, FPO dynamically allocates the data set by using SYSOUT=*.

HFPPRINT DD

Defines the message output data set when FULLSTEP=YES is specified. This output data set contains the HFP messages, which are the processing messages issued by FPA. The following DCB attributes of the file are set by FPA:

• RECFM=FBA
• LRECL=133
• BLKSIZE=1330

Do not code the DCB information in your JCL statement. The output data set must be a standard SYSOUT or a sequential data set. Do not specify DUMMY for this data set.

The HFPPRINT data set contains 133-byte, fixed-length records. It is recommended that you code your DD statement as follows:

//HFPPRINT DD SYSOUT=A

Note on dynamic allocation:

When this statement is not specified in the JCL statements, FPA dynamically allocates the data set by using SYSOUT=*.

reportdd DD

Defines the output for the following reports:

• DEDB Area Analysis reports
• UOW report
• UOW Exception report
• Largest Database Records report
• Consolidated Largest Database Records report
• Segment Length Distribution report
• DB Record Length Distribution report
• RBA of Used IOVF CI report

The output can go to a data set or to a printer, routed through the output stream. FPXRPTS is the default DD name, however, the DD name can be overridden by the REPORTDD keyword specification of the REPORT control statement.

This statement is used only when you specify the TYPRUN=RPT and the FULLSTEP=YES keywords, or the TYPRUN=FS and the FULLSTEP=YES keywords.

reportdd DD is similar to the reportdd DD of the Analyze function of FPA.

SYSPRINT DD

Defines the system message output. For OPC with SYSIN DD, SYSPRINT is used by OPC as the default message data set until it is (optionally) overridden by the MFILE= keyword of the ANALYZE control statement.

Warning: You cannot allocate the OPC SYSPRINT DD output stream to a data set because SYSPRINT DD is also used by IMS. If you specify SYSPRINT DD as a data set, some output might become overridden or unpredictable open or close errors might occur. Therefore, you must specify SYSPRINT DD as SYSOUT.

DFSUDUMP DD

Defines the default output image copy data set. DFSUDUMP is used by OPC as the default primary image copy data set until it is (optionally) overridden by the IC1OUTDD keyword of the ANALYZE control statement. The output can reside on a tape or on a direct-access device. If the DD statement is overridden by the IC1OUTDD keyword with a different DD name, the DD statement for the specified DD name must be coded in the JCL stream.

Do not specify DISP=MOD for this DD statement.

The secondary image copy data set is (optionally) specified by the IC2OUTDD keyword of the ANALYZE control statement, the specified DD name must be coded in the JCL stream.

SNAPPIT DD

Defines the output for the CI SNAP dump produced by OPC.

The CI SNAP dump option is ignored if the DD statement is not provided.

The output can go to a data set or to a printer, routed through the output stream.

FPXAUOWC DD

Each record in this data set specifies a range of UOW numbers of an area, which defines a UOW group of the area. The information about the UOW group is recorded in the FPXAHST2 data set or in a sensor data record set in the order that is specified in the FPXAUOWC data set, even if the UOW ranges overlap or are in reverse order.

The data set can reside in the JCL input stream. The data set can also be defined as a sequential data set or as a member of a partitioned data set. If a data set is specified, the data set must have the following attributes:

• DSORG=PS
• RECFM=FB
• LRECL=80
• BLKSIZE=a multiple of 80

If the data set is empty, all UOWs of the area are regarded as the target UOW range.

When you specify the FPXAHST2 DD statement, you must also specify the FPXAUOWC DD statement. If an FPXAUOWC DD statement is not specified, the FPXAHST2 DD statement is ignored.

When SENSOR_UOW=YES is specified, the data elements that will be stored differ by the FPXAUOWC DD specification as follows:

• If you specify the FPXAUOWC DD statement, data elements are collected at the UOW group level.
• If you do not specify the FPXAUOWC DD statement, data elements are collected at the UOW level.

The FPXAUOWC DD is similar to the HFPAUOWC DD of the Analyze function of FPA.

For information about defining a UOW group, see UOW group definition record layout.

FPXAHST DD

Defines an output data set that contains historical records. The analysis report generation process adds one record for each DEDB area that it processes. The record contains the key space utilization and performance information for that area. This statement is used only when you specify the TYPRUN=RPT keyword and the FULLSTEP=YES keyword.

If this feature is used, the FPXAHST data set must be preallocated with the following attributes:

• DSORG=PS
• RECFM=FB
• LRECL=100
• BLKSIZE=user-specified

The DD statement in the JOB stream is specified as:

//FPXAHST DD DSN=HPFP.HISTORY,DISP=(MOD,KEEP,KEEP) 

The DD name can be (optionally) overridden by the HISTORYDD keyword with a different DD name of the ANALYZE control statement.

The FPXAHST DD is similar to the HFPAHST DD of the Analyze function of FPA.

FPXAHST2 DD

Defines an output data set that contains historical records. The analysis report generation process adds one record for each UOW group that is specified by FPXAUOWC DD. The record contains the key space utilization and performance information for the area, which is based on the information obtained from the specified UOW range. This statement is used only when you specify the FPXAUOWC DD statement, the TYPRUN=RPT keyword, and the FULLSTEP=YES keyword. If FPXAUOWC DD statement is not specified, this statement is ignored.

If this feature is used, the FPXAHST2 data set must be preallocated with the following attributes:

• DSORG=PS
• RECFM=FB
• LRECL=200
• BLKSIZE=user-specified

The DD statement in the JOB stream is specified as:

//FPXAHST2 DD DSN=HPFP.HISTORY2,DISP=(MOD,KEEP,KEEP)

The FPXAHST2 DD is similar to the HFPAHST2 DD of the Analyze function of FPA.

FPXARERG DD

Defines an output data set that contains the reorganization control statements for the High-Speed DEDB Direct Reorganization utility (DBFUHDR0).

This statement is used only when you specify the TYPRUN=RPT and the FULLSTEP=YES keywords, or the TYPRUN=FS and the FULLSTEP=YES keywords.

The following DCB attributes of the file are set by the Analyze process:

• RECFM=PS
• LRECL=80
• BLKSIZE=800

Do not code the DCB information in your JCL statement. Do not specify DISP=MOD for this DD statement.

The FPXARERG DD is similar to the HFPARERG DD of the Analyze function of FPA.

TARnnnnn DD

Defines the tuning aid record data set. A TARnnnnn DD statement specifies the tuning aid record data set for one area.

When TARECGEN=YES is specified, TARnnnnn DD statements define the output data sets for generating tuning aid records. If this statement is not specified for an area, the tuning aid record for that area is not generated.

A TARnnnnn DD statement is for areas in the range of 1 - 9999. The value of nnnnn must be right-aligned, with leading zeros if necessary. When you code multiple TARnnnnn DD statements, do not specify the same data set more than once; each TARnnnnn DD statement must point to a different data set.

This data set can be allocated dynamically by specifying the TARDSNMASK keyword of the ANALYZE statement.

For a description and space requirement of the tuning aid records, see Tuning aid records.

DAR12O DD

Defines the output data set containing the free space and area information records. The data set can reside on either a direct-access device or a tape. When FULLSTEP=YES is specified, this DD statement is not used.

Space requirements vary depending on the size of the areas and the number of free space elements. (Approximation: number of CIs in area × 1.5 × 20 bytes.) Do not specify DISP=MOD for this DD statement.

When DAR12O is so big that the allocated space is not adequate, a B37 abend occurs.

DAR13SO DD

Defines the output data set containing the segment information records for all segments that reside in the root addressable part of the database. The data set can reside on either a direct-access device or a tape. When FULLSTEP=YES is specified, this DD statement is not used.

Space requirements vary depending on the size of the areas and the number of segments in the areas. (Approximation: number of segments × 40 bytes.) Do not specify DISP=MOD for this DD statement.

When DAR13SO is so big that the allocated space is not adequate, a B37 abend occurs.

SORT12 DD

Defines the output data set for the SORT control statements for the SORT12 step. The data set must reside on a direct-access device. When FULLSTEP=YES is specified, this DD statement is not used.

Space requirements are very small (1 track suffices). Do not specify DISP=MOD for this DD statement.

DCB information is hard-coded in OPC. Do not code DCB information in your JCL.

SORT3CS DD

Defines the output data set for the SORT control statements for the sort before pointer resolution. The data set must reside on a direct-access device. When FULLSTEP=YES is specified, this DD statement is not used.

Space requirements are very small (1 track suffices). Do not specify DISP=MOD for this DD statement.

DCB information is hard-coded in OPC. Do not code DCB information in your JCL.

DAR3CSO DD

Defines the output data set containing all pointer information records and the segment information records for all segments that reside in IOVF and SDEP. The data set can reside on either a direct-access device or a tape. When FULLSTEP=YES is specified, this DD statement is not used.

Space requirements vary depending on the size of the areas and the number of segments in the areas. (Approximation: number of segments × 1.5 × 26 bytes.) Do not specify DISP=MOD for this DD statement.

When DAR3CSO is so big that the allocated space is not adequate, a B37 abend occurs.

IMSDALIB DD

An optional DD statement that defines the library that contains DFSMDA dynamic allocation members for the RECON data sets.

RECON1/RECON2/RECON3 DD

Defines the DBRC RECON data sets. You must specify these DD statements when you specify both IC=YES and ICNOTIFY=YES keywords, or both ITKBSRVR=servername and DBRC=YES keywords. RECONn data sets must be the same data sets that are used in the IMS control region.

When you specify IC=YES and ICNOTIFY=YES, OPC updates RECONn data sets because OPC registers the image copy data set to DBRC. When you specify ITKBSRVR=servername and DBRC=YES, OPC retrieves the RECON ID from RECON data sets.

If these statements are omitted when the data sets are necessary and if DFSMDA members are available, the utility uses the DFSMDA members and dynamically allocates the data sets.

TOOLSNP1

Defines a snap dump output data set used for diagnostic purposes. All you need to provide is the DSN and space allocation. OPC assigns the correct DCB parameters internally. Usually, //TOOLSNP1 DD SYSOUT=* is sufficient.

TOOLSNP2

Defines a secondary diagnostic output file subject to the same restrictions as TOOLSNP1.

HFPABEND DD

Defines a snap dump output data set used for diagnostic purposes. This data set might be used when FULLSTEP=YES is specified and the FPO job ends abnormally. Do not code the DCB information in your JCL statement. The output data set must be a standard SYSOUT or a sequential data set.

Note on dynamic allocation:

When this statement is not specified in the JCL statements, FPO dynamically allocates the data set by using SYSOUT=*.

SYSOUT DD

Defines the output data set that is used by both OPC and DFSORT for message functions. OPC writes images of its control statements that are specified in DASYSIN DD. When the FULLSTEP=YES keyword is specified, this output data set also contains the message that is produced by DFSORT.

Note on dynamic allocation:

When DFSORT is needed and this statement is not specified in the JCL statement, OPC dynamically allocates the data set by using SYSOUT=*.

i001WKnn DD

An optional DD statement. These are intermediate storage data sets that are used by DFSORT. For more information about coding the SORTWKnn DD statements, see the DFSORT Application Programming Guide. The adequate size of storage data sets is 1.5 to 2.5 times the input file size. This statement is used only when you specify the FULLSTEP=YES keyword.

Allocating twice the space used by the SORTIN data set is usually adequate for each work data set.

Do not specify DISP=MOD for these DD statements.

In the analyze step, the size of each input file is as follows:

i:

A: Always used

30 × the number of pointers in the area

D: If SDEP=YES is specified

30 × the number of SDEP segments in the area

G: If SNAPPIT DD is specified

112 × the number of pointers in which pointer errors are detected

J: If TYPRUN=RPT is specified

X × (the number of non-SDEP segments in the areas + the number of free space elements in the areas + the number of references to other CIs)

Where X is:

• When LARGEREC_REPORT=NO is specified, X is calculated as follows:
  • 34 + (the maximum segment level × 4)
  However, if X is smaller than 48, 48 is used for X.
• When LARGEREC_REPORT=YES is specified, X is calculated as follows:
  • 34 + (the maximum segment level × 4) + root key length
  However, if X is smaller than 48, 48 is used for X.

J: If TYPRUN=FS is specified

23 × (the number of free space elements in the area + the number of references to other CIs)

K: If TYPRUN=RPT is specified

X × the number of segments in the area

Where X is:

• When TYPRUN=MODEL, LARGEREC=Y, or TARECGEN=Y is specified, X is calculated as follows:
  • 34 + (the maximum segment level × 4) + root key length
• In other cases, X is calculated as follows:
  • 34 + (the maximum segment level × 4)

M: If TYPRUN=RPT or TYPRUN=PTRALL is specified

X × the number of IOVF segments in the area

Where X is:

• When TYPRUN=MODEL, LARGEREC=Y, or TARECGEN=Y is specified, X is calculated as follows:
  • 34 + root key length
• In other cases, X is 34.

Q: Always used

34 × the number of segments in the area

Note on dynamic allocation:

If this statement is not specified in the JCL statement when these data sets are necessary, FPO allocates them dynamically.

i001SMSG DD

This DD statement is an optional DD statement. However, this DD statement is required when DFSORT is used. This statement defines an output data set for storing DFSORT messages. For the condition for running DFSORT and the naming rules for the DD names, see the description of i001WKnn DD.

Note on dynamic allocation:

When this statement is not specified in the JCL statements, OPC dynamically allocates the data set by using SYSOUT=*.

ICEIN DD

This DD statement is an optional DD statement. This statement specifies the input data set that contains the control statements for IMS HP Image Copy. The data set can reside on a tape, a direct-access volume, or it can be routed through the input stream (DD * or DD DATA). This data set is used only when you specify IC=(YES,ICEIN). If the DD statement is not coded and if IC=(YES,ICEIN) is specified, the default control statements are used. For details about the ICEIN control statements, see the IMS High Performance Image Copy User's Guide.

ICEPRINT DD

This DD statement is an optional DD statement. This statement specifies the output data set that contains the reports that are produced by IMS HP Image Copy. 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). This data set is used only when you specify IC=(YES,ICEIN). If the DD statement is not coded and IC=(YES,ICEIN) is specified, a SYSOUT stream is dynamically allocated for the DD.

ICERPRT DD

This DD statement is an optional DD statement. This statement specifies the output data set that contains the Image Copy Dump Process report, which is produced by IMS HP Image Copy. It can reside on a tape, a direct-access volume, or a printer, or it can be routed through the output stream (SYSOUT). This data set is used only when you specify IC=(YES,ICEIN).

dataout1 DD

This DD statement is an optional DD statement. This statement defines the primary image copy data set. One DD statement is required for each data set that is to be dumped. The DD name can be any 1- to 8-character string. The data set specified by the DD statement must be on either a direct-access device or a tape device. This data set is used only when you specify IC=(YES,ICEIN).

For details of the format and the characteristics of the image copy data set, see the IMS High Performance Image Copy User's Guide. You can request IMS HP Image Copy to allocate the image copy data set dynamically by omitting this DD statement and specifying the allocation parameters that are associated with the data set in the ICEIN data set.

dataout2 DD

This DD statement is an optional DD statement. This statement defines the secondary image copy data set. This statement is required only if the associated ICEIN control statement requests the secondary image copy. The data set specified by the DD statement must be on either a direct-access device or a tape device. This data set is used only when you specify IC=(YES,ICEIN).

For details of the format and the characteristics of the image copy data set, see the IMS High Performance Image Copy User's Guide.

D2Xnnnn DD

D3Cnnnn DD

D3SRnnnn DD

D3SInnnn DD

D4Pnnnn DD

D4Snnnn DD

WPRNnnn DD

Define the intermediate work data sets. FPO uses up to three sets of intermediate work data sets, one set for processing one area. For each set, the same nnnn value is used. nnnn must be right-aligned with leading zeros. These statements are used only when you specify the FULLSTEP=YES keyword.

• D2Xnnnn data sets contain the free space and area information records.
• D3Cnnnn data sets contain all non-SDEP pointer information records.
• D3SRnnnn data sets contain the segment information records for all segments that reside in the RAP part of the database.
• D3SInnnn data sets contain the segment information records for all segments that reside in the IOVF part of the database.
• D4Pnnnn data sets contain all SDEP pointer information records.
• D4Snnnn data sets contain the segment information records for all segments that reside in the SDEP part of the database.
• WPRNnnn data sets contain analysis reports.

Do not specify DISP=MOD for these DD statements. DCB information is hard-coded in OPC. Do not code DCB information in your JCL.

Note on dynamic allocation:

If these statements are not specified in the JCL statements when these data sets are necessary, FPO allocates them dynamically.

WSNAP DD

This DD statement is an optional DD statement. It defines the intermediate work data set for snap dumps. This statement is used only when you specify the FULLSTEP=YES keyword.

Do not specify DISP=MOD for this DD statement. DCB information is hard-coded in OPC. Do not code DCB information in your JCL.

Note on dynamic allocation:

If this statement is not specified in the JCL statements when this data set is necessary, FPO allocates it dynamically.