DD statements for the Change function

List of DD statements

The following table summarizes the DD statements for the Change function.

Input DD statements

The following input DD statements are used for the Change function.

JOBLIB/STEPLIB DD

This DD statement is a required DD statement. This DD statement defines the input data sets as follows:

• The FPA load module library (required).
• The library that contains DFSMDA dynamic allocation members for the RECON data set. When DBRC=YES is specified and the RECONn DD statement is omitted, this DD statement is required.
• The library that contains a user exit routine member that was specified for the EXITRTN= keyword, if EXITLIB DD statement is not specified.
• The library that contains a default site default member (HFPCSITE) to determine the data set name and the member of the site default table.
• The IMS load module library (required).
• The IMS Tools Base library (SHKTLOAD), if you specify the ITKBSRVR keyword.
• The IMS Tools Base library (SGLXLOAD), if you specify the IMSCATHLQ keyword.
• The IMS HP Image Copy library, if you specify the ICOUT=YES option.
• The IMS Library Integrity Utilities library, if you want to activate Integrity Checker.

FPA must be run as an APF-authorized program. All of the data sets that are listed within the JOBLIB or the STEPLIB concatenation must also be APF-authorized. If you use DFSMDA members and the DFSMDA members are in a non-APF authorized library, you can specify the DFSMDA library on the IMSDALIB DD statement.

IMSACB DD

This DD statement is an optional DD statement that defines the library that contains the DMB for the database. The IMSACB DD statements (IMSACB, IMSACBA, IMSACBB, MODSTAT, MODSTAT2, and OLCSTAT) can be used to identify the active ACB library. When both OLCSTAT or MODSTAT and MODSTAT2 are found, FPA checks the time stamp and determines the latest one.

The active IMSACB library is determined according to the following rules:

1. Check IMSACB DD statement in the JCL statement.
2. Check OLCSTAT DD statement in the JCL statement.
3. Check MODSTAT and MODSTAT2 DD statement in the JCL statement.
4. Allocate OLCSTAT dynamically and check the OLCSTAT member.
5. Allocate MODSTAT and MODSTAT2 dynamically and check the MODSTAT and MODSTAT2 members.

If you specify the IMSCATHLQ keyword, IMSACB DD statements are not used. The IMS directory is used instead of the ACB library.

IMSACBA DD

This DD statement is an optional DD statement that defines the library that contains the DMB for the database. This statement must be provided if MODSTAT and MODSTAT2, or the OLCSTAT DD statement is specified.

IMSACBB DD

This DD statement is an optional DD statement that defines the library that contains the DMB for the database. This statement must be provided if MODSTAT and MODSTAT2, or the OLCSTAT DD statement is specified.

IMSDALIB DD

This DD statement is an optional DD statement that defines the IMSDALIB data set. This DD statement is useful when the data set for dynamic allocation members is not APF-authorized.

MODSTAT DD

This DD statement is an optional DD statement that defines the MODSTAT data set. When this statement is specified, the IMSACBA and IMSACBB DD statements must be specified instead of the ACBLIB DD statement.

Note on dynamic allocation:

If this statement is not specified in the JCL statements when the data set is required, the data set is allocated dynamically by using a DFSMDA member. You can build the DFSMDA member for the MODSTAT library by using a TYPE=DATABASE statement of the DFSMDA macro.

MODSTAT2 DD

This DD statement is an optional DD statement that defines the MODSTAT2 data set. When this statement is specified, the IMSACBA and IMSACBB DD statements must be specified instead of the ACBLIB DD statement.

Note on dynamic allocation:

If this statement is not specified in the JCL statements when the data set is required, the data set is allocated dynamically by using a DFSMDA member. You can build the DFSMDA member for the MODSTAT2 library by using a TYPE=DATABASE statement of the DFSMDA macro.

OLCSTAT DD

This DD statement is an optional DD statement that defines the OLCSTAT data set. When this statement is specified, the IMSACBA and IMSACBB DD statements must be specified instead of the ACBLIB DD statement.

Note on dynamic allocation:

If this statement is not specified in the JCL statements when the data set is required, the data set is allocated dynamically by using a DFSMDA member. You can build the DFSMDA member for the OLCSTAT library by using a TYPE=DATABASE statement of the DFSMDA macro.

EXITLIB DD

This DD statement is an optional DD statement. This statement defines the user exit routine library. This DD statement is used when the IEXITRTN or OEXITRTN, or both keywords are specified for the CHANGE command. When the EXITLIB DD statement is specified in the JCL statement, user exit routines are loaded directly only from the EXITLIB DD statement. When the EXITLIB DD statement is not specified in the JCL statement, the routines are loaded from the JOBLIB or the STEPLIB DD statement.

All of the data sets that are listed within the EXITLIB concatenation must be APF-authorized.

IMSRESLB DD

This DD statement is an optional DD statement that defines the libraries that contain the randomizer routines and compression routines that are specified in the ACB member in the IMSACB DD statements. If the IMSRESLB DD statement is specified in the JCL statement, only the randomizer and compression routines are loaded directly from the IMSRESLB DD statement. If the IMSRESLB DD statement is not specified in the JCL statement, they are loaded from the JOBLIB or the STEPLIB DD statement.

The IMS version of IMSRESLB DD statement must be the same as those of IMSACB DD.

All the data sets that are listed within the IMSRESLB concatenation must be APF-authorized.

OLDACB DD

This DD statement is an optional DD statement. This statement defines the library that contains the original ACB library for the database. If this statement is specified, the CHANGE command is processed in the non-REORG mode (restructure). However, if the ACB member in the IMSACB DD library and the ACB member in the OLDACB DD library are the same, and the OLDRESLB DD statement is not specified in the JCL statement, the CHANGE command is processed in the REORG mode. If you want to reorganize the area data sets, do not specify this DD statement and do not allocate the data set dynamically.

If you specify the IMSCATHLQ keyword, OLDACB DD statement is not used. The IMS directory is used instead of the ACB library.

Note on dynamic allocation:

When this statement is not specified in the JCL statement, the data set is allocated dynamically by using a DFSMDA member. This DD library is allocated dynamically even if you do not specify in the JCL statement or a DFSMDA member. You can build the DFSMDA member for the OLDACB library by using a TYPE=DATABASE statement of the DFSMDA macro.

OLDRESLB DD

This DD statement is an optional DD statement. This statement is effective when the OLDACB DD statement is specified in JCL statement or the IMSCATACB_OUTPUT keyword is specified. This statement defines the libraries that contain the randomizer routines and compression routines that are specified in the ACB member pointed to from the OLDACB DD statements or the IMSCATACB_INPUT keyword.

If the OLDACB DD statement or the IMSCATACB_OUTPUT keyword is specified, the randomizer and compression routines are loaded from the OLDRESLB DD statement. If the OLDRESLB DD statement is not specified when the OLDACB DD statement or the IMSCATACB_OUTPUT keyword is specified, the randomizer and compression routines are loaded from the JOBLIB or the STEPLIB DD statement.

All of the data sets that are listed within the OLDRESLB concatenation must be APF-authorized.

IAREAnnn/IARnnnnn DD

This DD statement is a required DD statement when the IDSNMASK keyword is not specified. This statement defines the input area data set, which is the VSAM ESDS or an image copy data set for an area to be changed.

This data set can be allocated dynamically by using the IDSNMASK keyword parameter with the CHANGE command, or it can be specified with one of the following DD statements explicitly:

• //IAREAnnn DD JCL statement
• //IARnnnnn DD JCL statement

An IAREAnnn DD statement is for areas in the range of 1 - 999, and an IARnnnnn DD statement is for areas in the range of 1 - 9999. If the area number of the changed area is greater than 999, you must use the IARnnnnn DD statement. The value of nnn or nnnnn must be right-aligned, with leading zeros if necessary. The area number is the are number that is specified for the IAREA= parameter of the CHANGE command.

Note on dynamic allocation:

When this statement is not specified in the JCL statement, the data set is allocated dynamically by using the IDSNMASK keyword.

The following figure shows how FPA determines area data set names.

HFPSYSIN DD

This DD statement is a required DD statement that defines the input control statement that specifies the FPA functions.

The HFPSYSIN DD statement can be coded as a standard SYSIN file, a sequential data set, or a PDS member. LRECL=80 is required for the DCB of this data set. Only one command, besides the GLOBAL command, can be specified in HFPSYSIN. FPA analyzes the command syntax in columns 1 - 72. Columns 73 - 80 are regarded as comment.

For details about coding the HFPSYSIN DD statement, see Utility control statements for the Change function.

HFPAPARM DD

This DD statement is an optional DD statement. This statement defines the control parameters for generating the analysis reports.

When SENSOR=YES is specified, the values of RBASEFS and RDOVFFS keywords are stored in the Sensor Data repository as the values of data elements DB_THRESHOLD_RBASEFS and DB_THRESHOLD_RDOVFFS. These values are used by the Online Space Management utility as the values of RBASEFS and RDOVFFS keywords for the OER utility process (online reorganization process).

The HFPAPARM DD statement can be coded as a sequential data set or as a PDS member. LRECL=80 is required for the DCB of this data set. The HFPAPARM keywords must be written on one line. It can be coded as follows:

//HFPAPARM DD * 
  RDOVFFS=40 SYNTBL=20 UDOVFFS=35 RBASEFS=40 
/*

You can specify the keywords that are listed in the following table.

Table 2. HFPAPARM keywords

Keyword	Description
ARDIGIT	This keyword specifies the digit of the area number field for the UOW group definition records that are defined in the HFPAUOWC file. The value is 3 or 5. The default is 3. If the HFPAUOWC file is not specified in the JCL statement, this keyword is ignored.
RBASEFS	This keyword is an optional keyword. If a RAP CI contains free space that is greater than the percentage specified, and the RAP CI also uses overflow CIs, a reorganization control statement is generated for the UOW, and the UOW is included in the UOW Exception report. The default is 100%, which means that reorganization control statements are never generated. The maximum value is 99, and the minimum value is 0.
RDOVFFS	This keyword is an optional keyword. If the DOVF part of a UOW contains free space that is greater than the percentage specified, and the UOW also uses IOVF CIs, a reorganization control statement is generated for the UOW and the UOW is included in the UOW Exception report. The default is 100%, which means that reorganization control statements are never generated. The maximum value is 99, and the minimum value is 0.
RGROUP	This keyword sets the group identifier for the statistics that are collected and stored in the History2 file or in a sensor data record set. For the History2 file, the keyword value is set in the Repository Group field, and for a sensor data record set, the value is set for the DB_SENSOR_DATA_GROUP_ID data element. This keyword has no default value. If this keyword is not specified, FPA sets the group identifier as follows: The Repository Group field in the History2 file contains 4 bytes of blank characters. The DB_SENSOR_DATA_GROUP_ID data element is not included in the sensor data record set.
SYNTBL	This keyword is an optional keyword. It controls the number of reporting entries in the Synonym Chain Analysis table. The default value is 41 (that is, all synonym chains longer than 40 are grouped and reported together). The maximum value is 999, and the minimum value is 12.
UDOVFFS	This keyword is an optional keyword. If the DOVF UOW contains free space that is less than the percentage specified, the UOW is included in the UOW Exception report. The default is 0%, which means that the UOW is never included in the UOW Exception report. The maximum value is 99, and the minimum value is 0.
Note: The RBASEFS keyword and the RDOVFFS keyword that are used for the HFPAPARM data set are different from those used for the REORG command.

Requirement: Generating reorganization control statements for the High-Speed DEDB Direct Reorganization utility, you must specify the free space control percentages. You must also specify the HFPARERG DD statement in the JCL stream. For details, see the description of HFPARERG DD.

HFPAUOWC DD

This DD statement is a required DD statement when HFPAHST2 DD is specified. 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 range is recorded in the HISTORY2 data set or in a sensor data record set in the order that is specified in the HFPAUOWC data set, even if the UOW ranges overlap or are in reverse order. You can specify the UOW ranges for each area in any order. However, you must specify the area numbers in ascending 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 HFPAHST2 DD statement, you must also specify the HFPAUOWC DD statement. If an HFPAUOWC DD statement is not specified, the HFPAHST2 DD statement is ignored.

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

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

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

HFPCSITE DD

This DD statement is an optional DD statement. The HFPCSITE DD statement can be used to define the data set name of the site default table. When the SITE_DSNAME keyword is specified in the HFPSYSIN DD statement, the HFPCSITE DD statement is allocated dynamically. HFPCSITE DD in the JCL is mutually exclusive with the SITE_DSNAME keyword in the HFPSYSIN DD statement. The data set attribute of HFPCSITE DD is PDS.

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 ICOUT=YES. If the DD statement is not coded and if ICOUT=YES is specified, the default control statements are used. For details about the ICEIN control statements, see IMS High Performance Image Copy User's Guide.

Output DD statements

The following output DD statements are used for the Change function.

addnname/areaname DD

This DD statement is a required DD statement. This statement defines an output area data set, which is a VSAM ESDS that is generated by the Change process. The ddname used must be the ddname for the area that is defined in the output ACB library (IMSACB DD).

This data set can be allocated dynamically by one of following methods:

• The ODSNMASK keyword parameter of the CHANGE command
• When the GLOBAL DBRC=YES option is specified, the ADS information in the DBRC RECON data sets
• The area name member in the IMS DFSMDA library

Or it can be specified with one of the following DD statements explicitly:

• //addnname DD JCL statement
• //areaname DD JCL statement

The area data set can be also defined by the ALLOCATE subcommand with the CHANGE command.

For the CHANGE command output, if the area is registered with DBRC, it must be in the RECOV NEEDED status; that is, all ADSs of the area must be in the UNAVAILABLE status in DBRC.

The following figure shows how FPA determines area data set names.

HFPPRINT DD

This DD statement is an optional DD statement that defines the processing log output data set. The data set contains the processing messages that are issued by FPA.

The following DCB attributes of the file are set by the FPA main task:

• 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 cannot specify DUMMY.

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=*.

The following figure shows an example of the processing messages that are issued for the CHANGE command.

IMS HPFP UTILITIES                                        "Processing messages"                                        PAGE:       1
5698-FPP V2R1                                                                                                    2021-11-22 13:03:37
HFPC0001I COMMAND ANALYZE PROCESSING STARTED.
HFPC0005I DBRC=NO IS SPECIFIED.
          - EEQE DETECTION IS NOT PERFORMED.
HFPD0001I OLDACB DYNAMICALLY ALLOCATED TO
          - DSNAME: IMSVS.ACBLIB
HFPC0002I COMMAND ANALYZE PROCESSING COMPLETED.
HFPF0001I CHANGE PROCESSING STARTED FOR DATABASE: DEDBJN21
HFPJ0001I UNLOAD PROCESSING STARTED FOR AREA NO: 1, AREANAME: DB21AR0
HFPJ0002I UNLOAD PROCESSING COMPLETED FOR AREA NO: 1, AREANAME: DB21AR0
HFPK0001I RELOAD PROCESSING STARTED FOR AREA NO: 1, AREANAME: DB21AR0
HFPK0002I RELOAD PROCESSING COMPLETED FOR AREA NO: 1, AREANAME: DB21AR0
HFPF0002I CHANGE PROCESSING COMPLETED FOR DATABASE: DEDBJN21
HFPL0001I REPORT STARTED FOR COMMAND: CHANGE, DATABASE: DEDBJN21
HFPL0002I REPORT COMPLETED FOR COMMAND: CHANGE, DATABASE: DEDBJN21

HFPRPTS DD

This DD statement is an optional DD statement that defines the report output data set. The data set contains the reports that can be used to verify the process of the command. The following DCB attributes of the file are set by the FPA main task:

• 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.

The following reports are generated in this data set:

• Audit report
• Processing report
• DBD Definition report
• Unloaded report
• Reloaded report

When the REPORT subcommand and PTRCHKLVL=FULL are specified the following reports are generated:

• DEDB Area Analysis reports
• Process Summary of Analysis report
• Resolve Pointers report
• UOW report
• UOW Exception report
• Largest Database Records report (When LARGEREC_REPORT=YES is specified)
• Consolidated Largest Database Records report (When LARGEREC_REPORT=YES is specified and the second parameter of the LARGEREC_COUNT keyword specifies a value that is equal to or larger than 1)
• Segment Length Distribution report
• DB Record Length Distribution report
• RBA of Used IOVF CI report

When the REPORT subcommand and PTRCHKLVL=QUICK are specified, the following reports are generated:

• DEDB Area Analysis reports (FREESPACE ANALYSIS only)
• Process Summary of Analysis report
• UOW report (without DB record information)
• UOW Exception report (without DB record information)
• Pointer Checksum report
• RBA of Used IOVF CI report

You can generate reports related to the Analyze process in another DD data set that is specified by the REPORTDD=keyword parameter of the REPORT subcommand.

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

//HFPRPTS 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=*.

HFPSPRT DD

This DD statement is an optional DD statement that 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 the FPA main task:

• 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 HFPSPRT data set contains 133-byte, fixed-length records. It is recommended that you code your DD statement as follows:

//HFPSPRT 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=*.

HFPAHST DD

This DD statement is an optional DD statement. This statement 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 both the REPORT subcommand and the PTRCHKLVL=FULL keyword.

If this feature is used, the HFPAHST 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:

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

You can generate the records in another DD data set specified by the HISTORYDD= keyword parameter instead of HFPAHST DD.

HFPAHST2 DD

This DD statement is a required DD statement when HFPAUOWC DD is specified. This statement 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 HFPAUOWC DD. The record contains the key space utilization and performance information for that area, which is based on the information obtained from the specified UOW range. This statement is used only when you specify both the REPORT subcommand and the PTRCHKLVL=FULL keyword. If HFPAUOWC DD statement is not specified, this statement is ignored.

If this feature is used, the HFPAHST2 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:

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

HFPARERG DD

This DD statement is an optional DD statement. This statement 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 both the REPORT subcommand and the PTRCHKLVL=FULL or the PTRCHKLVL=QUICK keyword.

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

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

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

Requirement:

Generating reorganization control statements for the High-Speed DEDB Direct Reorganization utility, you must specify the HFPARERG DD statement in the JCL stream. You must also specify the free space control percentages. For details about specifying the free space control percentages, see the description of HFPAPARM DD.

HFPASNAP DD

This DD statement is a required DD statement when CISNAP=YES. This statement defines the output data set for the CI Map/CI Dump report and the Pointer Chain Reconstruction report. This DD statement is effective when the REPORT subcommand, PTRCHKLVL=FULL or PTRCHKLVL=QUICK, and CISNAP=YES are specified.

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

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

Do not code the DCB information in your JCL statement.

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

//HFPASNAP DD SYSOUT=A

HFPSEQER DD

This DD statement is a required DD statement when KEYSEQCHK=BYPASS or KEYSEQCHK=WARNING. This statement defines the output data set that contains the sequence error segment data records for one or more areas.

This statement defines an output data set for the sequence error segment data records that are produced for one or more of the areas defined in the "output" ACB library (NEWACB DD statement or IMSACB DD statement in Reorg mode).

The format of this record is specified in the HFPZSER macro, which is provided as a product-sensitive user interface. For details of the record format, see Sequence error segment records layout.

HFPTOTAL DD

This DD statement is an optional DD statement. This statement defines an output data set that contains the total number of reloaded segments in an area. When this DD statement is present, the Change process writes the total number of reloaded segments of each segment type in an area.

The following DCB attributes of the file are set by the FPA main task:

• DSORG=PS
• LRECL=60
• BLKSIZE=6000

Do not code the DCB information in your JCL statement.

The format of this record is specified in the HFPZTOT macro, which is provided as a product-sensitive user interface. For details of the record format, see Total segments records layout.

HFPABEND DD

This DD statement is an optional DD statement. It defines a snap dump output data set that is used for diagnostic purposes. This data set might be used when the FPA 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, FPA dynamically allocates the data set by using SYSOUT=*.

ctttSMSG 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 ctttWKnn DD.

Note on dynamic allocation:

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

itttSMSG 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 itttWKnn DD.

Note on dynamic allocation:

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

DFSPRINT DD

This DD statement is an optional DD statement. This statement specifies the output data set that contains the messages 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 ICOUT=YES. If the DD statement is not coded and ICOUT=YES is specified, a SYSOUT stream is dynamically allocated for the DD.

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 ICOUT=YES. If the DD statement is not coded and ICOUT=YES 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 ICOUT=YES.

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 ICOUT=YES. For details of the format and the characteristics of the image copy data set, see 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 ICOUT=YES. For details of the format and the characteristics of the image copy data set, see IMS High Performance Image Copy User's Guide.

Input/Output DD statements

The following input/output DD statements are used for the Change function.

RECON1/RECON2/RECON3 DD

These statements define the DBRC RECON data sets. These DD statements are required DD statements when both of the following conditions are met:

• DBRC=YES is specified for the GLOBAL command
• DFSMDA members for RECONn data sets are not used

The RECONn data set must be the same data set that is used in the IMS control region. Because FPA issues a signon, a signoff, an authorization call, and an unauthorization call to DBRC, it updates RECONn data sets.

Note on dynamic allocation:

If this statement is not specified in the JCL statements when the data set is necessary, the data set is allocated dynamically by using a DFSMDA member.

ctttWKnn DD

These DD statements are optional DD statements. These data sets are intermediate storage data sets that are used by DFSORT. For more information about coding the SORTWKnn DD statements, see DFSORT Application Programming Guide.

The adequate size of storage data sets is 1.5 to 2.5 times the input file size. In the Change function, the input file is the unloaded segment record file that is generated internally. The size of the file is computed by multiplying the average length of the unloaded segment record by the number of segments. Allocating twice the space used by the SORTIN data set is usually adequate for each work data set. This data set is allocated dynamically by OS. When the SORTIN is too large for sort, a B37 abend occurs. In this case, this DD is a required DD.

Do not specify DISP=MOD for these DD statements.

The naming rules of the ddnames are as follows:

c:

The thousands digit of n for n-th output thread subtask.

U:

If n is 999 or less, U must be specified.

V:

If n is 1000 - 1999, V must be specified.

W:

If n is 2000 - 2048, W must be specified.

Note: When a subtask ends processing an area, it starts processing the next area. For this reason, the n-th output thread subtask does not always process the n-th output data set.

ttt:

The hundredths, tenths, and units digits of the area number of the area to be processed, or the thread task number of the thread task that processes the area. If the area number is greater than 2048, only the thread task number is valid.

nn:

Specifies the number of the SORT work data sets. This value must be 01 - 03.

Note on dynamic allocation:

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

It is recommended that you specify the SORTOPT_FILSZ=AUTO keyword and not specify ctttWKnn DD statements to prevent DFSORT intermediate data sets causing insufficient storage.

itttWKnn DD

These are optional DD statements. These are intermediate storage data sets that are used by DFSORT. For more information about coding the SORTWKnn DD statements, see DFSORT Application Programming Guide.

Do not specify DISP=MOD for these DD statements.

The adequate size of storage data sets is 1.5 to 2.5 times the input file size. In the analyze step, the size of each input file is as follows:

PTRCHKLVL=FULL

30 × the number of pointers in the area

SDEPCHKLVL=FULL

30 × the number of SDEP segments in the area

CISNAP=YES

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

REPORT subcommand and PTRCHKLVL=FULL are 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.

REPORT subcommand and PTRCHKLVL=QUICK are specified

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

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

The naming rules of the ddnames are as follows:

i:

A, B, and C:

If PTRCHKLVL=FULL is specified.

D, E, and F:

If SDEPCHKLVL=FULL is specified.

G, H, and I:

If CISNAP=YES is specified.

J, K, and L:

If the REPORT subcommand is specified.

The thousands digit of the area number of the area to be analyzed, or the thousands digit of n for n-th input thread subtask.

A, D, G, and J:

If the number of areas to be analyzed or n is 999 or less.

B, E, H, and K:

If the number of areas to be analyzed or n is 1000 - 1999.

C, F, I, and L:

If the number of areas to be analyzed or n is 2000 - 2048.

Note: When a subtask ends processing an area, it starts processing the next area. For this reason, the n-th input thread subtask does not always process the n-th input data set.

ttt:

The hundredths, tenths, and units digits of the area number of the area to be processed, or the thread task number of the thread task that processes process the area. If the area number is greater than 2048, only the thread task number is valid.

nn:

The number of the SORT work data sets. This value must be 01 - 03.

Note on dynamic allocation:

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

It is recommended that you specify the SORTOPT_FILSZ=AUTO keyword and not specify itttWKnn DD statements to prevent DFSORT intermediate data sets causing insufficient storage.