DD statements for the Unload function
DD statements of the FPA Unload function determine the input and output data sets and specify how to run the Unload function.
Subsections:
List of DD statements
The following table summarizes the DD statements for the Unload function.
DDNAME | Use | Format | Can be dynamically allocated? | Required or optional |
---|---|---|---|---|
JOBLIB or STEPLIB | Input | PDS | No | Required |
IMSACB, IMSACBA, or IMSACBB | Input | PDS | No | Required when IMSCATHLQ=*NO |
IMSDALIB | Input | PDS | No | Optional |
MODSTAT | Input | PS | Yes | Optional |
MODSTAT2 | Input | PS | Yes | Optional |
OLCSTAT | Input | PS | Yes | Optional |
EXITLIB | Input | PDS | No | Optional |
IMSRESLB | Input | PDS | No | Optional |
NEWACB | Input | PDS | Yes | Optional |
NEWRESLB | Input | PDS | No | Optional |
addnname or areaname | Input | VSAM ESDS cluster or PS (Note) | Yes | Required under certain conditions (for details, see addnname/areaname DD) |
OAREAnnn or OARnnnnn | Output | PS | Yes | Required when neither the ODSNMASK keyword nor the FILECTL subcommand is specified |
HFPSYSIN | Input | LRECL=80 | No | Required |
HFPCSITE | Input | PDS | Yes | Optional |
HFPPRINT | Output | SYSOUT | Yes | Optional |
HFPRPTS | Output | LRECL=133 | Yes | Optional |
HFPASNAP | Output | LRECL=133 | No | Required when CISNAP=YES |
HFPSEQER | Output | PS | No | Required when KEYSEQCHK=BYPASS or KEYSEQCHK=WARNING |
HFPTOTAL | Output | PS | No | Optional |
HFPABEND | Output | LRECL=125 | Yes | Optional |
HFPCHKPT | Input and output | PS | No | Required when RESTART=YES |
RECONn | Input and output | KSDS | Yes | Required when both of the following conditions are met:
|
ctttWKnn | Input and output | Yes | Optional | |
itttWKnn | Input and output | Yes | Optional | |
ctttSMSG | Output | LRECL=133 | Yes | Optional |
itttSMSG | Output | LRECL=133 | Yes | Optional |
DFSPRINT | Output | LRECL=122 | Yes | Optional |
ICEIN | Input | LRECL=80 | No | Optional |
ICEPRINT | Output | LRECL=133 | Yes | Optional |
ICERPRT | Output | LRECL=133 | No | Optional |
dataout1 | Output | PS | Yes | Optional |
dataout2 | Output | PS | Yes | Optional |
Note: If image copy is used as an input data set.
|
Input DD statements
The following input DD statements are used for the Unload 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 randomizer/edit compression members that were specified in the NEWACB data set if NEWRESLB DD statement is not specified.
- The library that contains a user exit routine member that was specified in 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.
- 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.
- 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.
- 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.
- 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 EXITRTN keyword is specified for the UNLOAD 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.
- NEWACB DD
- This DD statement is an optional DD statement. This statement defines the library that contains the new ACB library for the database.
- NEWRESLB DD
- This DD statement is an optional DD statement. This statement is effective when the NEWACB DD statement is specified in JCL statement or the IMSCATACB_OUTPUT keyword is specified. This statement defines the libraries in which randomizer routines and compression routines for NEWACB DD statements or the IMSCATACB_OUTPUT keyword are contained.
- addnname/areaname DD
- This DD statement is a required DD statement. This statement defines an input data set, which is the VSAM ESDS or image copy for an area to be unloaded. The ddname used must be the ddname for the area that is defined in the input ACB library (IMSACB DD). There can be multiple addnname DD statements for each area included in the unload request.
- HFPSYSIN DD
- This DD statement is a required DD statement that defines the input control statement that specifies the FPA functions.
- 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 Unload function.
- OAREAnnn/OARnnnnn DD
- This DD statement is a required DD statement when neither the ODSNMASK keyword nor the FILECTL subcommand is specified.
- 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.
- 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
- 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 PTRCHK=DETAIL and CISNAP=YES are specified.
- 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.
- HFPTOTAL DD
- This DD statement is an optional DD statement. This statement defines an output data set that contains the total number of unloaded segments in an area. When this DD statement is present, the Unload process writes the total number of unloaded segments of each segment type in an area.
- 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.
- 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.
- 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.
- 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 Unload function.
- HFPCHKPT DD
- This DD statement is a function-unique DD statement for the checkpoint restart option. The DD statement is required when RESTART=YES is specified. This statement defines the checkpoint file. It must be the same file used both for a particular checkpoint and for the associated attempted subsequent restarts.
- 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
- 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 Unload function, the input file is the unloaded segment record file. 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.
- itttWKnn DD
- These DD statements 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 the 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 unload step, the size of each input file is as follows:
- PTRCHK=DETAIL
- 30 × the number of pointers in the area
- CISNAP=YES
- 112 × the number of pointers in which pointer errors are detected