Utility control statements for OER
The utility control statements for OER define the user description of the GLOBAL control statement, the REORG control statement, the PTRCHK control statement, the REPORT control statement, and the THRESHOLD control statement, all of which control the OER process.
All control statements that can be specified to run an OER job are explained in this topic. The control statements that can be specified are:
- GLOBAL control statement
- The GLOBAL control statement defines the job step keyword values. If specified, GLOBAL must be the first command in the input stream. The GLOBAL control statement can be specified only in FPXIN DD.
- REORG control statement
- The REORG control statement specifies information that control how the OER run is to be processed.
- PTRCHK control statement
- The PTRCHK control statement specifies the options for OPC that runs after all selected UOWs have been reorganized.
- REPORT control statement
- The REPORT control statement defines the parameter value that is related to the analysis reports.
- THRESHOLD control statement
- The THRESHOLD control statement defines the threshold parameter values, which cause warning messages to be generated when the actual values do not meet the specified criteria.
OER allows you to specify site default options.
Subsections:
GLOBAL statement keywords
The GLOBAL control statement specifies the job step keyword values. This control statement is optional.
The keywords associated with the GLOBAL statement are available for site default options.
For the GLOBAL statement, you can specify the keywords that are listed in the following table. For the format of the GLOBAL statement, see GLOBAL control statement.
| Keyword | Required or optional | Description | Topic |
|---|---|---|---|
| ADXCFGRP |
Optional |
Specifies the name of the Autonomics Director XCF group. | ADXCFGRP keyword |
| DBRC |
Optional |
Specifies whether to store reports that are associated with a RECON in the IMS Tools KB repository. | DBRC keyword (for GLOBAL) |
| 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 name of the load module library for IMS Tools KB. | ITKBLOAD keyword |
| ITKBSRVR |
Optional |
Specifies the name of the IMS Tools KB server XCF group. | ITKBSRVR keyword |
| KEYWORD_DUPCHK |
Optional |
Specifies to end the job with an error message when a duplicate keyword is found. | KEYWORD_DUPCHK keyword |
REORG statement keywords
The REORG control statement specifies information that controls how the OER run is to be processed. This control statement is mandatory.
The keywords associated with the REORG statement are available for site default options except for the AREA keyword.
For the REORG statement, you can specify the keyword that is listed in the following table. For the format of the REORG statement, see REORG control statement.
| Keyword | Required or optional | Description | Topic |
|---|---|---|---|
| AREA |
Required |
Specifies the name of the area to be reorganized. | AREA keyword |
| ERRORACT |
Optional |
Specifies the action that OER takes when one of the following errors occurs:
|
ERRORACT keyword |
| FPBP64U |
Optional |
Specifies whether to enable the Fast Path 64-bit buffer manager for the IMS High-Speed DEDB Direct Reorganization utility (DBFUHDR0). | FPBP64U keyword |
| MAXBUFFS |
Optional |
Specifies the number of buffer sets that are used in the reorganization. | MAXBUFFS keyword |
| MAXFAILS |
Optional |
Specifies the maximum allowable number of UOWs that fail to be reorganized, before the utility is ends abnormally. | MAXFAILS keyword |
| MFILE |
Optional |
Specifies the DD name of the output data set or output stream to which OER messages and OPC messages are to be written. | MFILE keyword |
| PCHKONLY |
Optional |
Specifies whether to evaluate only the control statement keywords or also to reorganize a set of UOWs in an online DEDB area. | PCHKONLY keyword |
| PROC_AFT_ERROR |
Optional |
Specifies whether to end the job step when an area-specific error is encountered or to continue processing subsequent areas. | PROC_AFT_ERROR keyword |
| PTRCHK |
Optional |
Specifies whether to run OPC after the area is reorganized. | PTRCHK keyword |
| RBASEFS |
Optional |
Specifies a criterion to select UOWs to reorganize. | RBASEFS keyword |
| RCEXLOAD |
Optional |
Specifies whether to call the return code exit routine FPXRCEX0 from the STEPLIB or JOBLIB data set concatenation. | RCEXLOAD keyword |
| RDOVFFS |
Optional |
Specifies a criterion to select UOWs to reorganize. | RDOVFFS keyword |
| REORGLIM |
Optional |
Specifies the reorganization limit for the amount of UOWs that can be reorganized in the job. | REORGLIM keyword |
| REORGMSG |
Optional |
Specifies whether to generate detailed reorganization messages. | REORGMSG keyword |
| RFILE |
Optional |
Specifies the DD name of the output data set or output stream to which OER reports are to be written. | RFILE keyword |
| RFSSCAN |
Optional |
Specifies whether to gather the statistics before and after reorganization by using Area Sensor. | RFSSCAN keyword |
| RFSSTAT |
Optional |
Specifies whether to generate the UOW Space Statistics report before and after reorganization. | RFSSTAT keyword |
PTRCHK statement keywords
The PTRCHK control statement specifies the options for OPC that runs after all selected UOWs have been reorganized. The acceptable values and their meanings for the keyword parameter are the same as those for the stand-alone OPC except for the TYPRUN and CHKUOW keywords.
The PTRCHK control statement can be specified in FPXIN even if PTRCHK=YES is not specified in the REORG control statement. But in that case, PTRCHK control statement is ignored.
The keywords associated with the PTRCHK statement are available for site default options.
For the PTRCHK statement, you can specify the keyword that is listed in the following table. For the format of the PTRCHK statement, see PTRCHK control statement.
| Keyword | Required or optional | Description | Topic |
|---|---|---|---|
| ARDIGIT |
Optional |
Specifies the digit of the area number field for the UOW group definition records that are defined in the FPXAUOWC file. | ARDIGIT keyword |
| CHKUOW |
Optional |
Specifies whether to do the pointer checking for all UOWs in the area or for the UOWs that have been reorganized. | CHKUOW keyword |
| DBRC |
Optional |
Specifies that image copies be registered to DBRC. DBRC registration of the area is required in order to DBRC register an image copy. DBRC is alias keyword for ICNOTIFY. | DBRC keyword (for GLOBAL) |
| DOVFNULLPTR_MSGLVL |
Optional |
Specifies that the utility issues a warning message if the first DOVF CI in any UOW contains a null pointer for the current overflow CI. | DOVFNULLPTR_MSGLVL keyword |
| EDITCOMP_CHANGE |
Optional |
Specifies to include root segment and DDEP segment data in the tuning aid record data set so that changes in segment edit/compression routines can be simulated. | EDITCOMP_CHANGE keyword |
| EXC_RBASEFS |
Optional |
Specifies a criterion. 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 printed in the UOW Exception report. | EXC_RBASEFS keyword |
| EXC_RDOVFFS |
Optional |
Specifies a criterion. 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 printed in the UOW Exception report. | EXC_RDOVFFS keyword |
| EXC_UDOVFFS |
Optional |
Specifies a criterion. If the DOVF part of a UOW contains free space that is less than the percentage specified, the UOW is printed in the UOW Exception report. | EXC_UDOVFFS keyword |
| FULLSTEP |
Optional |
Specifies whether OPC continues to process the pointer verification data collected from an online DEDB area. | FULLSTEP keyword |
| HISTORYDD |
Optional |
Specifies the ddname of the DD statement for the output History file data sets that are specified in the JCL. | HISTORYDD keyword |
| IC |
Optional |
Specifies that an IMS standard image copy be taken while scanning the database area. | IC keyword |
| ICNOTIFY |
Optional |
Specifies that image copies be registered to DBRC. | ICNOTIFY keyword |
| IC1OUTDD |
Optional |
Specifies the DD name of the output file to which the primary image copy data set is to be written. | IC1OUTDD keyword |
| IC2OUTDD |
Optional |
Specifies the DD name of the output file to which the secondary image copy data set is to be written. | IC2OUTDD keyword |
| IOVFPOOL |
Optional |
Specifies the size of the IOVF buffer pool. To allow for overlapped read/extract I/O, twice this number of buffers are actually obtained. The keyword is optional and should be required only for severely disorganized areas. | IOVFPOOL keyword |
| MAXERROR |
Optional |
Specifies the maximum number of pointer errors that might be encountered before processing ends abnormally. | MAXERROR keyword |
| MAXTWINCTR |
Optional |
Specifies the threshold value for the number of twin segments. | MAXTWINCTR keyword |
| RGROUP |
Optional |
Specifies to fill the value in the Repository Group field in the FPXAHST2 file or in a sensor data record set. | RGROUP keyword |
| SDEP |
Optional |
Specifies whether or not run totals and SDEP pointer integrity is to be verified and any errors reported. | SDEP keyword |
| SDEP_ORPHAN_MSGLVL |
Optional |
Specifies the error message level for an orphan SDEP segment. | SDEP_ORPHAN_MSGLVL keyword |
| SDEP_PTRIOVF_MSGLVL |
Optional |
Specifies the severity level of the message that is issued when detecting an SDEP pointer that points to the IOVF portion. | SDEP_PTRIOVF_MSGLVL 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 to 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 to 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 |
| STAT |
Optional |
Specifies whether or not run totals and statistics are to be generated. | STAT keyword |
| SYNTBL |
Optional |
Specifies the number of reporting entries in the Synonym Chain Analysis table. | SYNTBL keyword |
| TARDSNMASK |
Optional |
Specifies the data set name or the mask to use when dynamically allocating cataloged pre-existing tuning aid record data sets. | TARDSNMASK keyword |
| TARECGEN |
Optional |
Specifies whether to generate the tuning aid records. | TARECGEN keyword |
| TYPRUN |
Optional |
Specifies the operating mode. | TYPRUN keyword |
REPORT statement keywords
The REPORT control statement specifies the parameter values related to the analysis
reports. This control statement is effective only when the PTRCHK=YES keyword is specified on the
REORG control statement and either of the following keyword combinations exists on the PTRCHK
control statement:
- FULLSTEP=YES and TYPRUN=RPT
- FULLSTEP=YES and TYPRUN=FS
The keywords associated with the REPORT statement are available for site default options.
The REPORT control statement is similar to that of the Analyze function of FPA.
For the REPORT statement, you can specify the keywords that are listed in the following table. For the format of the REPORT statement, see REPORT control statement.
| 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. | LARGEREC_COUNT keyword |
| LARGEREC_REPORT |
Optional |
Specifies whether to generate the Largest Database Records report. | LARGEREC_REPORT keyword |
| REPORTDD |
Optional |
Specifies the DD name of the output data set or output stream, to which OPC
writes the following 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 statement keyword
The THRESHOLD control statement 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 PTRCHK=YES keyword in the REORG control statement, and the TYPRUN=RPT keyword and the FULLSTEP=YES keyword in the PTRCHK control statement, this control statement is ignored.
The keywords associated with the THRESHOLD statement are not available for site default options.
The THRESHOLD control statement is similar to that of the Analyze function of FPA.
For the THRESHOLD statement, you can specify the keywords that are listed in the following table. For the format of the THRESHOLD statement, see THRESHOLD control statement.
| 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 the user-specified value, a warning message is issued. | IOVFFS_PCT keyword |
| IOVFUSED_PCT |
Optional |
Specifies a threshold setting for the percentage of IOVF CIs that are 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 that use 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 get access to 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 get access to 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 synonym chains and the synonym chain length. If the percentage of the exceeding synonym chain length that you specified is greater than the value that you specified, 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 |