DD statements

DD statements are used to identify the source of input and the placement of output information. The DD statements that are listed in this section are supported by IMS Index Builder.

STEPLIB DD statement

This DD statement can contain the following libraries:
  • IMS Index Builder load library (Required). It must be at the top of the STEPLIB DD concatenation.
  • IMS RESLIB (Required).
  • IMS Tools Online System Interface load library, if you want the IMS commands issued automatically.
  • IMS Tools Knowledge Base load library, if storing reports to the knowledge base is enabled.
  • IMS Tools Catalog Interface load library, if you want to enable the IMS management of ACBs.
  • The SGLXLOAD library of IMS Tools Base, if you want to offload eligible workloads to zIIP processors.
  • Libraries that contain exit routines and IMS dynamic allocation modules (MDAs). These libraries must be present if there are any exits or dynamic allocation modules.

    If the MDA library is not APF-authorized, specify the library on the IMSDALIB DD statement.

All the libraries that are specified by this statement must be authorized through the Authorized Program Facility (APF). For more information, see Enabling inter-region communication (APF authorization).

This statement is required.

DDEFPDS DD statement

This DD statement provides IMS Index Builder delete and define statements for the indexes it processes. It is optional. You might want to use it to change the allocation parameters (such as the volume or space allocations) of the new index. IMS Index Builder looks for the delete and define statements for each index data set in a member with the same name as the index DD name. The member contents must be only delete and define statements.

Members for PSINDEX partitions are ignored if the UPDATE option is specified on the PROC control statement.

Define this data set as a PDS, fixed blocked with LRECL=80 and fixed-block format.

In parallel IMS Index Builder job runs, the DDEFPDS functionality might result in concurrent IDCAMS delete and define operations, and one operation typically fails.

This statement is optional.

DFSACBPD DD statement

This DD statement points to the control statement data set that defines the type of the IMS catalog that IMS Index Builder refers to in an IMS managed ACBs environment. This DD statement is optional. STAGING is the only valid keyword.

When the IMS management of ACBs is enabled, by default, IMS Index Builder obtains the active database from the IMS catalog directory. To override the default behavior and obtain pending ACBs from the staging data sets in the IMS catalog, specify the keyword STAGING on this DD statement.

When the IMS management of ACBs is not enabled, this DD statement is ignored.

DFSCTL DD statement

This DD statement defines a file that is used by IMS OSAM sequential buffering to define its environment.

If IMS Index Builder plans a DL/I hierarchical scan for an OSAM database and a DFSCTL DD statement is not specified, the statement is generated by IMS Index Builder.

DFSPARM DD statement

The DFSPARM DD statement provides sort control options. Because you can use any compatible sort product with IMS Index Builder, you must refer to the sort product documentation to understand the sort control options that are provided by the DFSPARM DD statement.

This statement is optional.

DFSURIDX DD statement

This DD statement contains output from the prefix resolution process. IMS Index Builder uses the content of the file to build one or more secondary index databases. When this file is empty or has the DUMMY attribute, all of the selected data sets that are being built will be initialized.

If the INPUT control statement specifies DFSURIDX, this statement is required.

DFSURWF1 DD statement

This DD statement contains the output from the reorganization process. This file is used as input by IMS Index Builder to build one or more secondary index databases.

To use two or more files as input to the same job step, concatenate the work files that are generated by each of the reload utility job steps.

If the INPUT control statement specifies DFSURWF1, this statement is required.

DFSVSAMP DD statement

This DD statement is used by IMS. If this DD statement is specified, it defines the file that contains definitions for the database I/O buffer subpools for VSAM and, if required, for OSAM. If you do not specify this DD statement, IMS Index Builder dynamically generates sufficient subpool definitions for the hierarchical scan process.

This statement is optional.

HPSRSIDX DD statement

This DD statement contains the output from IMS High Performance Load that is needed to build one or more secondary indexes. It has the same format at DFSURWF1.

This statement is required if the control statement specifies HPSRSIDX.

HSSROPT DD statement

Specify this statement to use IMS High Performance Unload for hierarchical scan. IMS High Performance Unload commands are supplied by the user. For more information about HSSROPT options and control statements, see the IMS High Performance Unload User's Guide.

This statement is optional.

IIUCABP DD statement

This DD statement defines the file that is created by IMS Index Builder to specify the CAB buffering parameters that are used during the scan. IMS Index Builder creates the appropriate control statement options for CAB buffering parameters; however, you can change them by using this DD statement.

This statement is optional.

Important: Explicitly specifying CAB buffering parameters can impact the optimal performance of the scan, so taking the program-generated values is strongly recommended

IIUCAPT DD statement

This DD statement contains the combined WTO messages from all of the address spaces that are involved in the process.

This statement replaces SYSPRINT.

This statement is optional. If not specified, this file is dynamically allocated as //IIUCAPT DD SYSOUT=*.

IIUDUMP DD statement

This DD statement contains a dump that is generated as the result of an error. You can use this dump to diagnose the error.

This statement is optional. If not specified, this file is allocated dynamically as //IIUDUMP DD SYSOUT=*.

IIUIN DD statement

This DD statement defines the main IMS Index Builder input file. It contains the control statements that specify which actions will occur and which options to use.

This statement is required.

IIUOPT DD statement

This DD statement authorizes IMS Index Builder to select appropriate options for the IMS HP Unload feature available for hierarchical scans. The options are identical to the options for the HSSROPT DD statement, which is used in IMS HP Unload.

This DD is reserved for system use.

IIUSTAT DD statement

This file contains the performance statistics resulting from the hierarchical HPU scan.

This statement is optional. If not specified, this file is dynamically allocated by IMS Index Builder as //IIUSTAT DD SYSOUT=*.

IIUPRINT DD statement

This DD statement defines the main IMS Index Builder output file. It contains the index build report and error messages, if any.

This statement is optional. If not specified, this file is allocated dynamically as //IIUPRINT DD SYSOUT=*.

IIUSNAP DD statement

This DD statement contains the critical events report and the following output:
  • IMS High Performance Image Copy
  • IMS High Performance Unload
  • DBRC notify commands

This statement is optional. If not specified, this file is dynamically allocated as //IIUSNAP DD SYSOUT=*.

IIUSOUT DD statement

This DD statement defines a file for the sort messages and the IDCAMS messages for the delete and define statements.

This statement is optional. If not specified, this file is dynamically allocated as //IIUSOUT DD SYSOUT=*.

IIUWFPnn DD statement

This DD statement is allocated by IMS Index Builder dynamically when the INPUT HPSRWFP statement is specified.

nn is in the range of 00 - 99. Do not specify the DD statements in JCL.

IMS DD statement

This DD statement is used to access the involved databases. The file points to one or more libraries that contain the DBDs of the physical database and its indexes.

This statement is required unless the IMS management of ACBs is enabled..

IMSALT DD statement

This DD statement should be used only when creating new secondary indexes without a full reorganization of the physical database. The file must point to a library that contains the new DBDs for the physical database and the new secondary indexes. If specified, this library is used only to load the new DBDs for its mapping function.

This statement is required if a new index is built.

IMSDALIB DD statement

This DD statement contains the IMS dynamic allocation modules (MDAs).

OUTPUT DD statement

If you defined an OUTPUT statement as one of your input control statements, you must specify this DD statement. The DD name that you use must match the name that you specify in the OUTPUT statement.

Use the following guidelines when you specify the OUTPUT DD statement:
  • When you use the split function to read records from DFSURWF1, this DD statement points to a flat file that contains only those records in DFSURWF1 that are needed for prefix resolution. The output file must be defined with DCB=(RECFM=VB,LRECL=900).
  • When you build the HIDAM primary index of a non-HALDB database, this DD statement points to the new primary index database. The output DD name must be different from the DD name that is defined in the DBD for the primary index.
Important: Do not use the OUTPUT DD statement when building a HALDB primary index database. Partitioned primary index databases are built by using the original index databases.

PROCLIB DD statement

This DD statement points to the IMS.PROCLIB data set that contains the DFSDFxxx member to enable the IMS management of ACBs. The DFSDFxxx member must contain the ACBMGMT=CATALOG parameter in the <CATALOG> section. You must also specify the DFSDF control statement in the IIUIN data set so that IMS Index Builder refers to the DFSDFxxx member.

This DD statement is required only when IMS Index Builder uses IMS managed ACBs through the DFSDFxxx member. This DD statement is not required if IMS Index Builder refers to DBD libraries or if you enable the IMS management of ACBs with the IMS Catalog Definition exit routine (DFS3CDX0).

RECON1, RECON2, RECON3 DD statements

These DD statements point to the RECON1, RECON2, and RECON3 data sets.

If you want to allocate RECON data sets dynamically, do not specify these DD statements. If no RECONx DD statement is specified, RECONx data sets are dynamically allocated from the MDA members in STEPLIB or IMSDALIB.