Utility control statements for the Reload function
The utility control statements for the Reload function define the user description of the GLOBAL command, the RELOAD command, and the optional ALLOCATE, LOADCTL, REPORT, and THRESHOLD subcommands, all of which control the Reload process.
The utility control statements must be specified in the HFPSYSIN data set. This control statement data set 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.
The following figure shows a sample of how to code the HFPSYSIN data set.
//HFPSYSIN DD *
GLOBAL
DBRC=YES
RELOAD
DBD=dbdname
/*Subsections:
GLOBAL command keywords
For the GLOBAL command, you can specify the keywords that are listed in the following table. For the format of the GLOBAL command, see GLOBAL command.
| Keyword | Required or optional | Description | Topic |
|---|---|---|---|
| ADXCFGRP |
Optional |
Specifies the name of the Autonomics Director XCF group. |
ADXCFGRP keyword |
| CISNAP |
Optional |
Requests the CI Map/CI Dump report and the Pointer Chain Reconstruction report. |
CISNAP keyword |
| DBRC |
Optional |
Specifies to request or bypass the database recovery control (DBRC) facility process for the database that is specified by the DBD. |
DBRC keyword |
| HISTORYDD |
Optional |
Specifies the DD statement for the output History file data set that is specified in the JCL. |
HISTORYDD keyword |
| ICINCOMP |
Optional |
Specifies, when an image copy is used as an input data set, whether the image copy records are to be compressed by using the CSRCESRV MVS™ macro when they are stored into a data space storage. |
ICINCOMP keyword |
| ICNOTIFY |
Optional |
Specifies whether to issue the NOTIFY.IC command to DBRC. |
ICNOTIFY keyword |
| ICOUT |
Optional |
Specifies whether to generate one or more image copies. |
ICOUT keyword |
| IMSCATACB_INPUT |
Optional |
Specifies whether to retrieve the currently active ACB definition or the pending ACB definition from the IMS directory. |
IMSCATACB_INPUT keyword |
| IMSCATHLQ |
Optional |
Specifies the high-level qualifier of the bootstrap data set of the IMS directory. |
IMSCATHLQ keyword |
| ITKBDATA |
Optional |
Specifies the type of additional data to store in the IMS Tools Base IMS Tools Knowledge Base repository. |
ITKBDATA keyword |
| ITKBLOAD |
Optional |
Specifies the library name of IMS Tools KB. |
ITKBLOAD keyword |
| ITKBSRVR |
Optional |
Specifies the name of the IMS Tools KB server XCF group. |
ITKBSRVR keyword |
| LIUGOPT |
Optional |
Specifies the LIU global option module that is to be used by IMS Library Integrity Utilities. |
LIUGOPT keyword |
| MSTIMESTAMP |
Optional |
Specifies whether to include a time stamp in the messages. |
MSTIMESTAMP keyword |
| PTRCHKLVL |
Optional |
Specifies the method that is used to run integrity verification in the root addressable part and in the independent overflow part. |
PTRCHKLVL keyword |
| RESTART |
Optional |
Enables the checkpoint restart option for reprocessing failed areas. |
RESTART keyword |
| RESTART_COUNT |
Optional |
Specifies the maximum number of restart processing runs for the checkpoint restart option. |
RESTART_COUNT keyword |
| SCAN |
Optional |
Verifies the syntax of command, keywords, and parameters in command sets without running FPA. The Scan function also allocates some (but not all) internal resources for running the process function. |
SCAN keyword |
| SDEPCHKLVL |
Optional |
Specifies the method that is used to run integrity verification in the sequential dependent part. |
SDEPCHKLVL keyword |
| SDEP_ORPHAN_MSGLVL |
Optional |
Specifies the error message severity level to be set when an orphan SDEP segment is detected. |
SDEP_ORPHAN_MSGLVL keyword |
| SITE_DSNAME |
Optional |
Specifies the data set name of the site default table. |
SITE_DSNAME keyword |
| SITE_MEMBER |
Optional |
Specifies the member name of the site default table. |
SITE_MEMBER keyword |
RELOAD command keywords
For the RELOAD command, you can specify the keywords that are listed in the following table. For the format of the RELOAD command, see RELOAD command.
| Keyword | Required or optional | Description | Topic |
|---|---|---|---|
| ACBCHK | Optional |
Specifies whether to check the DBD information in the library that is specified on the IMSACB DD statement with the DBD information in the USR files. | ACBCHK keyword |
| AREA_INFORMATION_RECORD |
Optional |
Specifies how to handle the area information record. AIR is an alias of this keyword. | AREA_INFORMATION_RECORD keyword |
| ATASKCTL | Optional |
Specifies the maximum number of output areas to be analyzed concurrently. | ATASKCTL keyword |
| CISNAP | Optional |
Requests the CI Map/CI Dump report and the Pointer Chain Reconstruction report when the reloaded area is analyzed concurrently. | CISNAP keyword |
| DBD | Required |
Specifies the database description (DBD) that contains the areas to be processed. | DBD keyword |
| EXITRTN | Optional |
Specifies the name of the user exit routine to be invoked prior to the write process of the Reload function. | EXITRTN keyword |
| FORMAT | Optional |
Specifies the format of the unloaded file. | FORMAT keyword |
| HISTORYDD | Optional |
Specifies the DD statement for the output History file data set that is specified in the JCL when the reloaded area is analyzed concurrently. | HISTORYDD keyword |
| IAREA | Optional |
Specifies one or more input areas for the Reload process. | IAREA keyword |
| ICHECK | Optional |
Controls the concurrent number of input devices to access by using the ITASKCTL keyword. | ICHECK keyword |
| ICNOTIFY | Optional |
Specifies whether to issue the NOTIFY.IC command to DBRC. | ICNOTIFY keyword |
| ICOUT | Optional |
Specifies whether to generate one or more image copies. | ICOUT keyword |
| IDSNMASK | Optional |
Specifies the data set name or the mask for dynamically allocating cataloged pre-existing input data sets. | IDSNMASK keyword |
| ITASKCTL | Optional |
Specifies the maximum number of input areas to be processed concurrently. | ITASKCTL keyword |
| KEYCHGCHK | Optional |
Specifies whether to check if the key sequence field was not changed by a user exit routine. | KEYCHGCHK keyword |
| KEYSEQCHK | Optional |
Specifies what to do if a key sequence error is detected. | KEYSEQCHK keyword |
| MAXERROR |
Optional |
Specifies the maximum number of pointer errors that might be encountered before processing ends with an error. | MAXERROR keyword |
| OAREA | Optional |
Specifies one or more output areas to the process. | OAREA keyword |
| OCACHE | Optional |
Specifies the type of control intervals that are held in a data space storage until all processing has completed. | OCACHE keyword |
| OCHECK |
Optional |
Controls the concurrent number of output devices to access. | OCHECK keyword |
| ODSNMASK | Optional |
Specifies the data set name or mask for dynamically allocating cataloged pre-existing output data sets. | ODSNMASK keyword |
| PTRCHKLVL | Optional |
Specifies the method that is used to run integrity verification in the root addressable part and in the independent overflow part. | PTRCHKLVL keyword |
| SDEP |
Optional |
Specifies how the SDEP segment data is to be processed. | SDEP keyword |
| SDEPCHKLVL | Optional |
Specifies the method that is used to run integrity verification in the sequential dependent part. | SDEPCHKLVL keyword |
| SDEP_ORPHAN_MSGLVL | Optional |
Specifies the error message severity level to be set when the reloaded area is analyzed concurrently and an orphan SDEP segment is detected. | SDEP_ORPHAN_MSGLVL keyword |
| SEGREC_PREFIX | Optional |
Specifies the contents of the fields within the prefix portion of the segment records. | SEGREC_PREFIX keyword |
| SEGREC_SUFFIX | Optional |
Specifies the contents of the fields within the suffix portion of the segment records. | SEGREC_SUFFIX keyword |
| SENSOR | Optional |
Specifies whether to store the sensor data in the Sensor Data repository of IMS Tools KB. | SENSOR keyword |
| SENSOR_DBREC | Optional |
Specifies whether to store the data elements that are related to database records and root segment distribution in the Sensor Data repository of IMS Tools KB. | SENSOR_DBREC keyword |
| SENSOR_PTRERR | Optional |
Specifies to store the sensor data in the Sensor Data repository of IMS Tools KB even when pointer errors are detected in the area. | SENSOR_PTRERR keyword |
| SENSOR_UOW | Optional |
Specifies whether to store the data elements that are related to UOW in the Sensor Data repository of IMS Tools KB. | SENSOR_UOW keyword |
| SENSOR_UOW_REPORT | Optional |
Specifies whether to print the data elements that are related to UOW in the Sensor Data Statistics report. | SENSOR_UOW_REPORT keyword |
| SORT | Optional |
Loads in sequence based on RAP (root anchor point). | SORT keyword |
| SORTOPT_FILSZ | Optional |
Specifies that FPA adds the FILSZ parameter to the SORT control statement. | SORTOPT_FILSZ keyword |
| SORTOPT_FILSZ_PCT |
Optional |
Specifies a percentage value to adjust the FILSZ parameter value of the SORT control statement. | SORTOPT_FILSZ_PCT keyword |
| SSP | Optional |
Specifies whether subset pointers should be retained or cleared. | SSP keyword |
| WKDS_SIZE_PCT |
Optional |
Specifies a percentage value to adjust the allocation size of intermediate work data sets. | WKDS_SIZE_PCT keyword |
ALLOCATE subcommand keywords
The ALLOCATE subcommand dynamically defines a VSAM cluster that is used for the processing of the RELOAD command.
For the ALLOCATE subcommand, you can specify the keywords that are listed in the following table. For the format of the ALLOCATE subcommand, see ALLOCATE subcommand.
| Keyword | Required or optional | Description | Topic |
|---|---|---|---|
| AMSOPT |
Optional |
Passes optional parameters to the Access Method Services (AMS) to define VSAM clusters. | AMSOPT keyword |
| ATTRIBUTE |
Optional |
Requests optional processing related to allocation of a VSAM cluster. | ATTRIBUTE keyword |
| AVGREC |
Optional |
Identifies the space requirements of the output data set that is created by dynamic allocation. | AVGREC keyword |
| DATACLAS |
Optional |
Specifies the SMS data class of an output data set that is created by dynamic allocation. | DATACLAS keyword |
| KEYLABEL |
Optional |
Specifies the key label for encrypting a new VSAM cluster. | KEYLABEL keyword |
| MGMTCLAS |
Optional |
Specifies the SMS management class of an output data set that is created by dynamic allocation. | MGMTCLAS keyword |
| OAREA |
Required |
Specifies one or more output areas for the process. | OAREA keyword |
| SPACE |
Optional |
Specifies the space requirements of an output data set that is created by dynamic allocation. | SPACE keyword |
| STORCLAS |
Optional |
Specifies the SMS storage class of an output data set that is created by dynamic allocation. | STORCLAS keyword |
| VOLSER |
Optional |
Specifies one or more volume-serial identifiers for the data set that is accessed by dynamic allocation. If this keyword is omitted for an output data set, nonspecific (private) volumes are required. | VOLSER keyword |
LOADCTL subcommand keywords
The LOADCTL subcommand specifies the load control information for a segment. You can specify an Insert Limit Count (ILC) and a place to insert dependent segments (either DOVF or IOVF). ILC is the maximum number of occurrences of segments that are inserted close to their root.
If the LOADCTL subcommand is specified multiple times for the same segment, they will be checked from the first to the last, and the first LOADCTL statement that matches the condition will be used for segment insertion.
For the LOADCTL subcommand, you can specify the keywords that are listed in the following table. For the format of the LOADCTL subcommand, see LOADCTL subcommand.
| Keyword | Required or optional | Description | Topic |
|---|---|---|---|
| INSERT_LIMIT_COUNT |
Optional |
Specifies the maximum number of segments that are selected by the SEGMENT keyword, that can be inserted close to their root segment. The maximum value is 32767 and the minimum value is 0. The minimum value 0 specifies that all specified segments are stored far from their root segment. | INSERT_LIMIT_COUNT keyword |
| LOCATION |
Optional |
Specifies the location to insert dependent segments, either DOVF or IOVF. You can specify the location where segments that were selected by the SEGMENT keyword are loaded. | LOCATION keyword |
| SEGMENT |
Required |
Specifies the segment name to be inserted at the specified location. The segment name must be a name that is coded on the SEGM statement in your DBD. | SEGMENT keyword |
REPORT subcommand keywords
The REPORT subcommand requests the analysis reports. If you do not specify PTRCHKLVL=FULL or PTRCHKLVL=QUICK, this subcommand is ignored.
For the REPORT subcommand, you can specify the keywords that are listed in the following table. For the format of the REPORT subcommand, see REPORT subcommand.
| Keyword | Required or optional | Description | Topic |
|---|---|---|---|
| DBRLDIST |
Optional |
Specifies whether to generate the DB Record Length Distribution report. | DBRLDIST keyword |
| IOVFCI_RBA_REPORT |
Optional |
Specifies whether to generate the RBA of Used IOVF CI report. | IOVFCI_RBA_REPORT keyword |
| LARGEREC_COUNT |
Optional |
Specifies the number of reporting entries in the Largest Database Records report and the Consolidated Largest Database Records report. This keyword is effective only when PTRCHKLVL=FULL is specified. | LARGEREC_COUNT keyword |
| LARGEREC_REPORT |
Optional |
Specifies whether to generate the Largest Database Records report. This keyword is effective only when PTRCHKLVL=FULL is specified. | LARGEREC_REPORT keyword |
| REPORTDD |
Optional |
Specifies the destination ddname for the analysis reports. | REPORTDD keyword |
| SEGLDIST |
Optional |
Specifies whether to generate the Segment Length Distribution report. | SEGLDIST keyword |
| SEGLSTAT |
Optional |
Specifies the format of the DB Record Profile Analysis report, which is one of the DEDB Area Analysis reports. | SEGLSTAT keyword |
| STARTUOW |
Optional |
Specifies the number that defines the first UOW to be reported in the UOW report and the UOW Exception report. | STARTUOW keyword |
| STOPUOW |
Optional |
Specifies the number that defines the last UOW to be reported in the UOW report and the UOW Exception report. | STOPUOW keyword |
| UOW_REPORT |
Optional |
Specifies whether to generate the UOW report. | UOW_REPORT keyword |
THRESHOLD subcommand keywords
The THRESHOLD subcommand specifies the threshold parameter values, which cause warning messages to be generated when the actual values do not meet the specified criteria. If you do not specify the REPORT subcommand, this subcommand is ignored.
For the THRESHOLD subcommand, you can specify the keywords that are listed in the following table. For the format of the THRESHOLD subcommand, see THRESHOLD subcommand.
| Keyword | Required or optional | Description | Topic |
|---|---|---|---|
| DOVFFS_PCT |
Optional |
Specifies a threshold setting for the percentage of free space in DOVF. If the percentage of free space in DOVF is less than the value that you specified, a warning message is issued. | DOVFFS_PCT keyword |
| FS_DOVFIOVF |
Optional |
Specifies a threshold setting for the free space in DOVF and in IOVF. If the free space in DOVF is greater than the value that you specified, and if the free space in IOVF is less than the value that you specified, a warning message is issued. | FS_DOVFIOVF keyword |
| FS_RAADOVF |
Optional |
Specifies a threshold setting for the free space in RAA BASE and in DOVF. If the free space in RAA BASE is greater than the value that you specified, and if the free space in DOVF is less than the value that you specified, a warning message is issued. | FS_RAADOVF keyword |
| FS_RAADOVFIOVF |
Optional |
Specifies a threshold setting for the free space in RAA BASE, DOVF, and IOVF. If the free space in RAA BASE is greater than the value that you specified, and if the free space in either DOVF or IOVF is less than the value that you specified, a warning message is issued. | FS_RAADOVFIOVF keyword |
| FS_RAAIOVF |
Optional |
Specifies a threshold setting for the free space in RAA BASE and in IOVF. If the free space in RAA BASE is greater than the value that you specified, and if the free space in IOVF is less than the value that you specified, a warning message is issued. | FS_RAAIOVF keyword |
| IOVFFS_PCT |
Optional |
Specifies a threshold setting for the percentage of free space in IOVF. If the percentage is less than value that you specified, a warning message is issued. | IOVFFS_PCT keyword |
| IOVFUSED_PCT |
Optional |
Specifies a threshold setting for the percentage of IOVF CIs used. If the percentage is greater than the value that you specified, a warning message is issued. | IOVFUSED_PCT keyword |
| RAAFS_PCT |
Optional |
Specifies a threshold setting for the percentage of free space in RAA BASE. If the percentage is less than the value that you specified, a warning message is issued. | RAAFS_PCT keyword |
| RAPOVFL_PCT |
Optional |
Specifies a threshold setting for the percentage of RAA BASE CIs that use either DOVF or IOVF. If the percentage is greater than the value that you specified, a warning message is issued. | RAPOVFL_PCT keyword |
| RECIO_AVG |
Optional |
Specifies a threshold setting for the average number of I/Os that can be done to access a database record. If the number is greater than the value that you specified, a warning message is issued. | RECIO_AVG keyword |
| RECIO_MAX |
Optional |
Specifies a threshold setting for the maximum number of I/Os that can be done to access a database record. If the number is greater than the value that you specified, a warning message is issued. | RECIO_MAX keyword |
| RECIOVF_PCT |
Optional |
Specifies a threshold setting for the percentage of records using IOVF CIs. If the percentage is greater than the value that you specified, a warning message is issued. | RECIOVF_PCT keyword |
| ROOTIO_AVG |
Optional |
Specifies a threshold setting for the average number of I/Os to access a root segment. If the number is greater than the value that you specified, a warning message is issued. | ROOTIO_AVG keyword |
| ROOTIO_MAX |
Optional |
Specifies a threshold setting for the maximum number of I/Os that can be done to access a root segment. If the number is greater than the value that you specified, a warning message is issued. | ROOTIO_MAX keyword |
| SYN_LEN_AVG |
Optional |
Specifies a threshold setting for the average synonym chain length. If the length is greater than the value that you specified, a warning message is issued. | SYN_LEN_AVG keyword |
| SYN_MAX |
Optional |
Specifies a threshold setting for the maximum synonym chain length. If the length is greater than the value that you specified, a warning message is issued. | SYN_MAX keyword |
| SYN_PCT_LEN |
Optional |
Specifies a threshold setting for the percentage of RAPs that have a long synonym chain among all the RAPs that have synonyms. If the percentage of the RAPS that have a long synonym chain is greater than the threshold value, a warning message is issued. | SYN_PCT_LEN keyword |
| UOWDOVF_PCT |
Optional |
Specifies a threshold setting for the percentage of UOWs that use DOVF. If the percentage is greater than the value that you specified, a warning message is issued. | UOWDOVF_PCT keyword |
| UOWIOVF_AVG |
Optional |
Specifies a threshold setting for the average number of IOVF CIs that are used by a UOW. If the number is greater than the value that you specified, a warning message is issued. | UOWIOVF_AVG keyword |
| UOWIOVF_MAX |
Optional |
Specifies a threshold setting for the maximum number of IOVF CIs that are used by a UOW. If the number is greater than the value that you specified, a warning message is issued. | UOWIOVF_MAX keyword |
| UOWIOVF_PCT |
Optional |
Specifies a threshold setting for the percentage of UOWs that use IOVF. If the percentage is greater than the value that you specified, a warning message is issued. | UOWIOVF_PCT keyword |