Utility control statements for the Tune function

The utility control statements for the Tune function define the user description of the GLOBAL command, the TUNE command, and five optional subcommands, SIMULATE, AREADEF, FILECTL, REPORT, and THRESHOLD, all of which control the Tune 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 is a sample showing how to code the HFPSYSIN data set.

Figure 1. TUNE HFPSYSIN data set
//HFPSYSIN DD *
  GLOBAL
    DBRC=YES
  TUNE
    DBD=dbdname
  SIMULATE
    ACBLIB=IMSVS.TEST.ACBLIB,
    RMODLIB=USER.RMODLIB
/*

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.

Table 1. GLOBAL command keywords
Keyword Required or optional Description Topic
AREADSN

Optional

Specifies how to obtain area data set names. AREADSN keyword
CISNAP

Optional

Specifies to request the CI Map/CI Dump report and the Pointer Chain Reconstruction report. CISNAP keyword
DBRC

Optional

Specifies to request or bypass the processing of database recovery control (DBRC) facility for the database that is specified by the DBD. DBRC 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
MSTIMESTAMP

Optional

Specifies whether to include a time stamp in the messages. MSTIMESTAMP keyword
SCAN

Optional

Specifies to verify 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
SITE_DSNAME

Optional

Specifies the data set name for the site default table. SITE_DSNAME keyword
SITE_MEMBER

Optional

Specifies the member name for the site default table. SITE_MEMBER keyword

TUNE command keywords

For the TUNE command, you can specify the keywords that are listed in the following table. For the format of the TUNE command, see TUNE command.

Table 2. TUNE command keywords
Keyword Required or optional Description Topic
AREASCAN

Optional

Requests to scan the areas and generate tuning aid record before simulating the database. AREASCAN keyword
CISNAP

Optional

Specifies to request the CI Map/CI Dump report and the Pointer Chain Reconstruction report. CISNAP keyword
DBD

Required

Specifies the database description (DBD) that contains the areas to be processed. DBD keyword
EDITCOMP_CHANGE

Optional

Specifies to simulate changes in segment edit/compression routines. EDITCOMP_CHANGE keyword
IAREA

Optional

Specifies one or more input areas for the Tune process. IAREA keyword
ICACHE

Optional

Specifies the type of control intervals that are to be preloaded into a data space storage for processing. ICACHE keyword
ICHECK

Optional

Controls the concurrent number of input devices to access by using the ITASKCTL keyword. ICHECK 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
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 analyzed concurrently. ITASKCTL keyword
MAXERROR

Optional

Specifies the maximum number of pointer errors that might be encountered before processing ends with an error. MAXERROR keyword
OTASKCTL

Optional

Specifies the maximum number of input areas to be simulated concurrently. OTASKCTL 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
TARDSNMASK

Optional

Specifies the data set name or the mask for dynamically allocating cataloged pre-existing tuning aid record data sets. TARDSNMASK keyword
WKDS_SIZE_PCT

Optional

Specifies a percentage value to adjust the allocation size of intermediate work data sets. WKDS_SIZE_PCT keyword

SIMULATE subcommand keywords

The SIMULATE subcommand provides resources for simulating databases.

For the SIMULATE subcommand, you can specify the keywords that are listed in the following table. For the format of the SIMULATE subcommand, see SIMULATE subcommand.

Table 3. SIMULATE subcommand keywords
Keyword Required or optional Description Topic
ACBLIB

Optional

Specifies the name of the data set that contains the DMB that describes the database configuration to simulate. ACBLIB keyword
EMODLIB

Optional

Specifies the name of the data set that contains the segment edit/compression routines to simulate. EMODLIB keyword
IMSCATACB_OUTPUT

Optional

Specifies whether to retrieve the currently active ACB definition or the pending ACB definition from the IMS directory. This keyword specifies the new ACB definition, which is used when simulating changes in ACB definitions. IMSCATACB_OUTPUT keyword
OAREA

Optional

Specifies one or more areas to be simulated. OAREA keyword
REPORTDD

Optional

Specifies the destination ddname for generating simulated analysis reports. REPORTDD keyword
RMOD

Optional

Specifies the new randomizer name to replace. RMOD keyword
RMODLIB

Optional

Specifies the name of the data set that contains the randomizer module to simulate. RMODLIB keyword

AREADEF subcommand keywords

The AREADEF subcommand defines the new area definitions to simulate.

For the AREADEF subcommand, you can specify the keywords that are listed in the following table. For the format of the AREADEF subcommand, see AREADEF subcommand.

Table 4. AREADEF subcommand keywords
Keyword Required or optional Description Topic
CISIZE

Optional

Specifies to simulate the areas with a new CI size. CISIZE keyword
OAREA

Optional

Specifies one or more areas to apply the definitions specified by this AREADEF subcommand. OAREA keyword
ROOT

Optional

Specifies to simulate the areas with a new ROOT parameter. The ROOT parameter affects the total number of UOWs and the number of UOWs in the overflow area. ROOT keyword
UOW

Optional

Specifies to simulate the areas with a new number of CIs for each unit of work (UOW). UOW keyword

FILECTL subcommand keywords

The FILECTL subcommand defines the output files to be created during the Tune process. One or more tuning aid record data sets are produced by each FILECTL subcommand that is specified.

For the FILECTL subcommand, you can specify the keywords that are listed in the following table. For the format of the FILECTL subcommand, see FILECTL subcommand.

Table 5. FILECTL subcommand keywords
Keyword Required or optional Description Topic
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
DDNAME

Optional

Specifies the ddnames for the data sets to be processed by the subcommand. DDNAME keyword
DISP

Optional

Specifies the status and the disposition of the data set that is accessed by dynamic allocation. DISP keyword
DSNAME

Optional

Specifies the mask for the data set name that is used for dynamic allocation of the data set to be processed by the subcommand. DSNAME keyword
EXPDT

Optional

Specifies the expiration date of an output data set that is created by dynamic allocation. Do not specify both the EXPDT keyword and the RETPD keyword because they are mutually exclusive. EXPDT keyword
IAREA

Optional

Specifies the areas for which you want a tuning aid record data set to be created. IAREA keyword
LIKE

Optional

Specifies the SMS allocation attributes of an output data set that is created by dynamic allocation. The model data set specified must be an existing SMS data set. LIKE keyword
MGMTCLAS

Optional

Specifies the SMS management class of an output data set that is created by dynamic allocation. MGMTCLAS keyword
RETPD

Optional

Specifies the retention period of an output data set that is created by dynamic allocation. Do not specify both the EXPDT keyword and the RETPD keyword because they are mutually exclusive. RETPD keyword
SPACE

Optional

Specifies the space requirements of the output data set that is created by dynamic allocation. SPACE keyword
STORCLAS

Optional

Specifies the SMS storage class of the output data set that is created by dynamic allocation. STORCLAS keyword
UNIT

Optional

Specifies the physical device type to be used for a data set that is accessed by dynamic allocation. Use this keyword also to specify the number of physical devices to be allocated. UNIT keyword
VOLCNT

Optional

Specifies the maximum number of volumes that will be required by an output data set that is created by dynamic allocation that uses nonspecific volumes. VOLCNT 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

REPORT subcommand keywords

The REPORT subcommand requests the analysis reports.

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.

Table 6. REPORT subcommand keywords
Keyword Required or optional Description Topic
DBRLDIST

Optional

Specifies whether to generate the DB Record Length Distribution report. DBRLDIST 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.

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.

Table 7. THRESHOLD subcommand keywords
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
RAP_LONGSYN_PCT

Optional

Specifies a threshold setting for the percentage of RAPs that have a long synonym chain among all the RAPs that are used. If the percentage of the RAPS that have a long synonym chain is greater than the threshold value, a warning message is issued. RAP_LONGSYN_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