FPA keywords

The following topics explain the FPA keywords.

ACBCHK keyword
Use the ACBCHK keyword to specify whether to check the ACB during the reload job.
ACBLIB keyword
Use the ACBLIB keyword to specify the name of the data set that contains the DMB that describes the database configuration to simulate. Normally, use a test library and not IMSVS.ACBLIB.
ADXCFGRP keyword
Use the ADXCFGRP keyword to specify the Autonomics Director XCF group name. The name is used to send a sensor data notification to Autonomics Director when the sensor data is stored in the Sensor Data repository of IMS Tools KB.
ALLOCONLY keyword
Use the ALLOCONLY keyword to suppress the initialization of output area data sets.
AMSOPT keyword
Use the AMSOPT keyword to pass optional parameters to the Access Method Services (AMS) to define VSAM clusters.
AREADSN keyword
Use the AREADSN keyword to specify how to obtain area data set names.
AREASCAN keyword
Use the AREASCAN keyword to specify whether to scan the DEDB areas during the FPA job.
AREA_INFORMATION_RECORD keyword
Use the AREA_INFORMATION_RECORD keyword to specify how to handle the area information record.
ATASKCTL keyword
Use the ATASKCTL keyword to specify the maximum number of input areas to be analyzed concurrently.
ATTRIBUTE keyword
Use the ATTRIBUTE keyword to request optional processing related to allocation of a VSAM cluster that is used for the output of the ALLOCATE subcommand.
AVGREC keyword
Use the AVGREC keyword to identify the space requirements of the output data set that is created by dynamic allocation.
BREAK keyword
Use the BREAK keyword to specify the level and the timing for the trigger event for user-defined header and trailer of an extract or an unloaded file.
BUILDDSNMASK keyword
Use the BUILDDSNMASK keyword to specify the data set mask for dynamically allocating cataloged pre-existing build pointer segment record data sets.
BUILDMODE keyword
Use the BUILDMODE keyword to specify the mode for building secondary index databases.
CISIZE keyword
Use the CISIZE keyword to simulate the areas with a new CI size.
CISNAP keyword
Use the CISNAP keyword to specify whether to generate the CI Map/CI Dump report and the Pointer Chain Reconstruction report when an incorrect pointer is detected.
COMPRESS keyword
Use the COMPRESS keyword to specify whether the output record for the EXTRACT or the UNLOAD function should contain compressed segment if segment edit/compression routine is defined for the segment in DBDGEN.
DATACLAS keyword
Use the DATACLAS keyword to specify the SMS data class of an output data set that was created by dynamic allocation.
DBD keyword
Use the DBD keyword to identify the database description (DBD) that contains the areas to be processed.
DBRC keyword
Use the DBRC keyword to request or bypass the database recovery control (DBRC) facility process for the database that is specified by the DBD.
DBREC_DISCARD_MSGLVL keyword
Use the DBREC_DISCARD_MSGLVL keyword to specify the severity level of the message that is issued when a randomized database record is discarded due to a USR file not being specified.
DBRLDIST keyword
Use the DBRLDIST keyword to specify whether to generate the DB Record Length Distribution report.
DDNAME keyword
Use the DDNAME keyword to specify the ddnames for the data sets to be processed by the subcommand.
DISP keyword
Use the DISP keyword to specify the status and disposition of the data set that is accessed by dynamic allocation.
DOVFFS_PCT keyword
Use the DOVFFS_PCT keyword to specify a threshold setting for the percentage of free space in DOVF.
DOVFNULLPTR_MSGLVL keyword
Use the DOVFNULLPTR_MSGLVL keyword to specify that FPA issues a warning message if the first DOVF CI in any UOW contains a null pointer for the current overflow CI.
DSNAME keyword
Use the DSNAME keyword to specify the data set name or the data set mask for the BLDMFILECTL, the FILECTL, or the IRENAME subcommand.
DUPKEYACT keyword
Use the DUPKEYACT keyword to save duplicate pointer segment records in duplicate pointer segment record data sets.
DUPKEYDSNMASK keyword
Use the DUPKEYDSNMASK keyword to specify the data set name or the mask to be used when you want the duplicate pointer segment record data set allocated dynamically.
DUPKEYMAX keyword
Use the DUPKEYMAX keyword to specify the threshold for the number of duplicate keys per secondary index database. When the threshold is reached, FPA stops processing that secondary index database. Whether FPA continues processing the remaining secondary index databases or stops the job is controlled by the PROC_AFT_DUPKEY keyword.
EDITCOMP_CHANGE keyword
Use the EDITCOMP_CHANGE keyword to simulate changes in segment edit/compression routines.
EDITCOMP_SKIP keyword
Use the EDITCOMP_SKIP keyword to specify whether to skip the segment edit/compression exit routine process. This option is effective only for the Unload function and the Change function that is processed in non-REORG mode.
EFORMAT keyword
Use the EFORMAT keyword to specify the format of the output file for the EXTRACT command.
EMODLIB keyword
Use the EMODLIB keyword to specify the name of the data set that contains the segment edit/compression routines to simulate.
EVERY keyword
Use the EVERY keyword to select every Nth occurrence of a segment starting from the first segment.
EXITRTN keyword
Use the EXITRTN keyword to specify the name of the user exit routine to be invoked prior to the write process of an Unload or a Reload function.
EXPDT keyword
Use the EXPDT keyword to specify the expiration date of an output data set that was created by dynamic allocation.
FIELDS keyword
Use the FIELDS keyword to specify the content of the segment data records, user-defined header records, or user-defined trailer records that are written to the output file.
FORMAT keyword
Use the FORMAT keyword to specify the format of the unloaded file.
FS_DOVFIOVF keyword
Use the FS_DOVFIOVF keyword to specify a threshold setting for the free space in DOVF and in IOVF.
FS_RAADOVF keyword
Use the FS_RAADOVF keyword to specify a threshold setting for the free space in RAA BASE and in DOVF.
FS_RAADOVFIOVF keyword
Use the FS_RAADOVFIOVF keyword to specify a threshold setting for the free space in RAA BASE, DOVF, and IOVF.
FS_RAAIOVF keyword
Use the FS_RAAIOVF keyword to specify a threshold setting for the free space in RAA BASE and in IOVF.
FS_RECLAIM_REPORT keyword
Use the FS_RECLAIM_REPORT keyword to specify whether to generate the Secondary Index Freespace Reclaim report and the Result of Access Method Services report.
HISTORYDD keyword
Use the HISTORYDD keyword to specify the ddname of the DD statement for the output History file data sets that are specified in the JCL.
IAREA keyword
Use the IAREA keyword to specify one or more input areas for the process that is specified by the command.
ICACHE keyword
Use the ICACHE keyword to specify the type of control intervals that are to be preloaded into a data space storage for processing.
ICHECK keyword
Use the ICHECK keyword to control the input devices.
ICINCOMP keyword
Use the ICINCOMP keyword to specify, when an image copy is used as an input data set, whether the image copy records for the root addressable part are to be compressed by using the CSRCESRV MVS macro when they are stored into a data space storage.
ICNOTIFY keyword
Use the ICNOTIFY keyword to issue NOTIFY.IC command to DBRC.
ICOUT keyword
Use the ICOUT keyword to generate one or more image copies.
IDSNMASK keyword
Use the IDSNMASK keyword to specify the data set name or the mask for dynamically allocating cataloged pre-existing input data sets.
IDXDUMP keyword
Use the IDXDUMP keyword to specify whether to generate the Pointer Segment Dump report when incorrect pointers are detected.
IDXMAXERROR keyword
Use the IDXMAXERROR keyword to specify the maximum allowable number of pointer segment errors for the index database. When the maximum number is reached, the ANALYZE process ends abnormally.
IDXPROC keyword
Use the IDXPROC keyword to specify the function that the Build Index process starts.
IDXTASKCTL keyword
Use the IDXTASKCTL keyword to specify the maximum number of input secondary index databases that are to be processed concurrently.
IEXITRTN keyword
Use the IEXITRTN keyword to specify the name of the user exit routine that will be invoked after the area data set that is specified by the Change function is unloaded.
IMSCATACB_INPUT keyword
Use the IMSCATACB_INPUT keyword to specify whether to retrieve the currently active ACB definition or the pending ACB definition from the IMS directory. IMSCATACB_INPUT keyword is effective only when the IMSCATHLQ=bsdshlq option is specified on the GLOBAL command.
IMSCATACB_OUTPUT keyword
Use the IMSCATACB_OUTPUT keyword to specify 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 an ACB definition change is requested. IMSCATACB_OUTPUT keyword is effective only when the IMSCATHLQ=bsdshlq option is specified on the GLOBAL command.
IMSCATHLQ keyword
Use the IMSCATHLQ keyword to specify the high-level qualifier of the bootstrap data set of the IMS directory, which is an extension of the IMS catalog.
IMSID keyword
Use the IMSID keyword to specify the IMS system ID. The FPA process runs on the IMS system that is identified by this ID.
INDEXDBD keyword
Use the INDEXDBD keyword to specify the database description (DBD) for processing secondary index databases.
INSERT_LIMIT_COUNT keyword
Use the INSERT_LIMIT_COUNT keyword to specify the maximum number of segname segments that can be inserted close to their root segment.
IOVFCI_RBA_REPORT keyword
Use the IOVFCI_RBA_REPORT keyword to specify whether to generate the RBA of Used IOVF CI report.
IOVFFS_PCT keyword
Use the IOVFFS_PCT keyword to specify to a threshold setting for the percentage of free space in IOVF.
IOVFUSED_PCT keyword
Use the IOVFUSED_PCT keyword to specify a threshold setting for the percentage of IOVF CIs that are used.
ITASKCTL keyword
Use the ITASKCTL keyword to specify the maximum number of input areas to be processed concurrently.
ITKBDATA keyword
Use the ITKBDATA keyword to specify the type of additional data to store in the IMS Tools Base IMS Tools Knowledge Base repository.
ITKBLOAD keyword
Use the ITKBLOAD keyword to specify the name of the load module library for IMS Tools KB.
ITKBSRVR keyword
Use the ITKBSRVR keyword to specify the name of the IMS Tools KB server XCF group.
KEYCHGCHK keyword
Use the KEYCHGCHK keyword to specify whether the key sequence field was not changed by a user exit routine that is specified with EXITRTN, IEXITRTN, or OEXITRTN keyword.
KEYLABEL keyword
Use the KEYLABEL keyword to specify the key label for encrypting a new VSAM cluster. When encryption is requested for the base cluster, any alternate indexes associated with the base cluster will also be encrypted and use the same key label as specified for the cluster.
KEYSEQCHK keyword
Use the KEYSEQCHK keyword to specify what to do if a key sequence error is detected.
LARGEREC_COUNT keyword
Use the LARGEREC_COUNT keyword to specify the number of reporting entries in the Largest Database Records report and the Consolidated Largest Database Records report.
LARGEREC_REPORT keyword
Use the LARGEREC_REPORT keyword to specify whether to generate the Largest Database Records report and the Consolidated Largest Database Records report.
LIKE keyword
Use the LIKE keyword to specify the SMS allocation attributes of an output data set that was created by dynamic allocation.
LIUGOPT keyword
Use the LIUGOPT keyword to specify the LIU global option module that is to be used by IMS Library Integrity Utilities. The Integrity Checker utility of IMS Library Integrity Utilities requires that DBRC be active.
LOCATION keyword
Use the LOCATION keyword to specify the location to insert dependent segments that are specified by the SEGMENT keyword, which is either DOVF or IOVF.
LRECL keyword
Use the LRECL keyword to specify how to determine the LRECL of an unloaded segment records file when it is not specified in the DD control statement explicitly.
MAXERROR keyword
Use the MAXERROR keyword to specify the maximum number of pointer errors that might be encountered before the Analyzer process ends with an error.
MAXFAILS keyword
Use the MAXFAILS keyword to specify the maximum allowable number of UOWs that fail to be reorganized in an area, before the utility ends abnormally.
MGMTCLAS keyword
Use the MGMTCLAS keyword to specify the SMS management class of an output data set that was created by dynamic allocation.
MSTIMESTAMP keyword
Use the MSTIMESTAMP keyword to specify whether to include a timestamp in the messages.
OAREA keyword
Use the OAREA keyword to specify one or more output areas for the process.
OCACHE keyword
Use the OCACHE keyword to specify the types of control intervals that are held in a data space storage until all processing has completed.
OCHECK keyword
Use the OCHECK keyword to control the concurrent number of output devices to access.
ODSNMASK keyword
Use the ODSNMASK keyword to specify the data set name or mask for dynamically allocating cataloged pre-existing output data sets.
OEXITRTN keyword
Use the OEXITRTN keyword to specify the name of the user exit routine to be invoked prior to the write process of a Change function.
OTASKCTL keyword
Use the OTASKCTL keyword to specify the number of resources to be processed concurrently.
PAD keyword
Use the PAD keyword to specify the padding character to be used when the segment minimum length is increased due to DBD definition change. The PAD keyword is effective for fixed-length segments and variable-length segments.
PROC_AFT_DUPKEY keyword
Use the PROC_AFT_DUPKEY keyword to specify whether to end the job step when the number of duplicate keys reaches the threshold defined by the DUPKEYMAX keyword.
PTRCHK keyword
Use the PTRCHK keyword to specify what to do when a pointer error is detected.
PTRCHKLVL keyword
Use the PTRCHKLVL keyword to select the method that is used to run integrity verification in RAA BASE, DOVF and IOVF.
RAAFS_PCT keyword
Use the RAAFS_PCT keyword to specify a threshold setting for the percentage of free space in RAA BASE.
RAP_LONGSYN_PCT keyword
Use the RAP_LONGSYN_PCT keyword to specify a threshold setting for the percentage of RAPs that have a long synonym chain among all the RAPs that are used. With this keyword, you specify a threshold value and the lower bound for synonym chain length.
RAPOVFL_PCT keyword
Use the RAPOVFL_PCT keyword to specify a threshold setting for the percentage of RAA BASE CIs that use either DOVF or IOVF.
RBASEFS keyword
Use the RBASEFS keyword to specify a criterion to select UOWs to reorganize.
RDOVFFS keyword
Use the RDOVFFS keyword to specify a criterion to select UOWs to reorganize.
RECIOVF_PCT keyword
Use the RECIOVF_PCT keyword to specify to a threshold setting for the percentage of records that use IOVF CIs.
RECIO_AVG keyword
Use the RECIO_AVG keyword to specify a threshold setting for the average number of I/Os that can be done to access a database record.
RECIO_MAX keyword
Use the RECIO_MAX keyword to specify to a threshold setting for the maximum number of I/Os that can be done to access a database record.
RECOVOPT keyword
Use the RECOVOPT keyword to specify the method for recovering an area when the process ends abnormally.
RELOCATE_SDEP keyword
Use the RELOCATE_SDEP keyword to relocate the SDEP information.
REORGLIM keyword
Use the REORGLIM keyword to specify the reorganization limit for the amount of UOWs that can be reorganized in the area.
REPORTDD keyword
Use the REPORTDD keyword to specify the destination ddname for specific reports.
RESTART keyword
Use the RESTART keyword to enable the checkpoint restart option for reprocessing failed areas.
RESTART_COUNT keyword
Use the RESTART_COUNT keyword to specify the maximum number of restart processing runs for the checkpoint restart option.
RESYNCDSNMASK keyword
Use the RESYNCDSNMASK keyword to specify the data set mask for dynamically allocating cataloged pre-existing resync pointer segment record data sets or unverified resync pointer segment record data sets.
RESYNCDUMP keyword
Use the RESYNCDUMP keyword to specify whether to generate the Resync Pointer Segment Dump report. The index pointer segments that were or that will be updated to synchronize the secondary index databases with the primary DEDB database are written to the report.
RESYNCDUMPMAX keyword
Use the RESYNCDUMPMAX keyword to specify the maximum number of index pointer segments to be printed for each index database in the Resync Pointer Segment Dump report.
RESYNCMODE keyword
Use the RESYNCMODE keyword to specify the synchronization mode for synchronizing secondary index databases with their primary DEDB database.
RETPD keyword
Use the RETPD keyword to specify the retention period of an output data set that was created by dynamic allocation.
RFSSCAN keyword
Use the RFSSCAN keyword to specify whether to gather the statistics before and after reorganization.
RFSSTAT keyword
Use the RFSSTAT keyword to specify whether to generate the UOW Space Statistics report before and after reorganization.
RMOD keyword
Use the RMOD keyword to simulate replacement of the randomizer module.
RMODLIB keyword
Use the RMODLIB keyword to specify the name of the data set that contains the randomizer module to simulate.
ROOT keyword
Use the ROOT keyword to simulate the areas with a new ROOT parameter. The ROOT parameter controls the number of UOWs in the area.
ROOTIO_AVG keyword
Use the ROOTIO_AVG keyword to specify a threshold setting for the average number of I/Os to access a root segment.
ROOTIO_MAX keyword
Use the ROOTIO_MAX keyword to specify a threshold setting for the maximum number of I/Os that can be done to access a root segment.
SCAN keyword
Use the SCAN keyword to verify the syntax of command, keywords, and parameters in command sets without running FPA.
SDEP keyword
Use the SDEP keyword to specify how SDEP segment data is to be processed.
SDEP_BYPASS_MSGLVL keyword
Use the SDEP_BYPASS_MSGLVL keyword to specify the severity level of the message that FPA issues when the SDEP is defined but SDEP segment data is not unloaded because SDEP=NO is specified.
SDEPCHKLVL keyword
Use the SDEPCHKLVL keyword to select the method that is used to run an integrity verification in the SDEP part.
SDEP_ORPHAN_MSGLVL keyword
Use the SDEP_ORPHAN_MSGLVL keyword to specify the error message level for an orphan SDEP segment.
SDEP_PTRIOVF_MSGLVL keyword
Use the SDEP_PTRIOVF_MSGLVL keyword to specify the severity level of the message that is issued when detecting an SDEP pointer that points to the IOVF portion. If you specify SDEPCHKLVL=NONE, this keyword is ignored.
SEGLDIST keyword
Use the SEGLDIST keyword to specify whether to generate the Segment Length Distribution report.
SEGLSTAT keyword
Use the SEGLSTAT keyword to specify the format of the DB Record Profile Analysis report, which is one of the DEDB Area Analysis reports.
SEGMENT keyword
Use the SEGMENT keyword to specify the segment name for processing by its associated subcommand.
SEGREC_PREFIX keyword
Use the SEGREC_PREFIX keyword to specify the contents of the fields within the prefix portion of the segment records, which are to be written to an extract or an unload file.
SEGREC_SUFFIX keyword
Use the SEGREC_SUFFIX keyword to specify the contents of the fields within the suffix portion of the segment records, which are written to an extract or an unload file.
SENSOR keyword
Use the SENSOR keyword to specify whether to store the sensor data in the Sensor Data repository of IMS Tools KB.
SENSOR_DBREC keyword
Use the SENSOR_DBREC keyword to specify 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_PTRERR keyword
Use the SENSOR_PTRERR keyword to store the sensor data in the Sensor Data repository of IMS Tools KB even when pointer errors are detected in the area.
SENSOR_UOW keyword
Use the SENSOR_UOW keyword to specify whether to store the data elements that are related to UOW in the Sensor Data repository of IMS Tools KB.
SENSOR_UOW_REPORT keyword
Use the SENSOR_UOW_REPORT keyword to specify whether to print the data elements that are related to UOW in the Sensor Data Statistics report.
SITE_DSNAME keyword
Use the SITE_DSNAME keyword to specify the name of the data set that has the members of the site default tables.
SITE_MEMBER keyword
Use the SITE_MEMBER keyword to specify the member name of the site default table.
SKIP keyword
Use the SKIP keyword to skip a number of segment occurrences under a parent.
SORT keyword
Use the SORT keyword to sort the records in unloaded segment record data sets or build pointer segment record data sets.
SORTOPT_FILSZ keyword
Use the SORTOPT_FILSZ keyword to specify that FPA adds the FILSZ parameter to the SORT control statement.
SORTOPT_FILSZ_PCT keyword
Use the SORTOPT_FILSZ_PCT keyword to specify a percentage value to adjust the FILSZ parameter value of the SORT control statement.
SPACE keyword
Use the SPACE keyword to specify the space requirements of the output data set that is created by dynamic allocation.
SSP keyword
Use the SSP keyword to specify whether subset pointers should be retained or cleared.
STARTRBA keyword
Use the STARTRBA keyword to specify the relative byte address (RBA) where the extraction of SDEP segments should start.
STARTUOW keyword
Use the STARTUOW keyword to specify the number that defines the first UOW to be reported in the UOW report and the UOW Exception report.
STOPAFT keyword
Use the STOPAFT keyword to specify the end of the selection of segments after a specific number of segment occurrences under a parent segment.
STOPRBA keyword
Use the STOPRBA keyword to specify the relative byte address (RBA) where the extraction of SDEP segments should end.
STOPUOW keyword
Use the STOPUOW keyword to specify the number that defines the last UOW to be reported in the UOW report and the UOW Exception report.
STORCLAS keyword
Use the STORCLAS keyword to specify the SMS storage class of the output data set that is created by dynamic allocation.
SYNC keyword
Use the SYNC keyword to specify the interval between the synchronization points for updating secondary index databases with DL/I calls.
SYN_LEN_AVG keyword
Use the SYN_LEN_AVG keyword to specify a threshold setting for the average synonym chain length.
SYN_MAX keyword
Use the SYN_MAX keyword to specify a threshold setting for the maximum synonym chain length.
SYN_PCT_LEN keyword
Use the SYN_PCT_LEN keyword to specify a threshold setting for the percentage of RAPs that have a long synonym chain among all the RAPs that have synonyms. With this keyword, you specify a threshold value and the lower bound for synonym chain length.
TARDSNMASK keyword
Use the TARDSNMASK keyword to specify the data set name or the mask for dynamically allocating cataloged pre-existing tuning aid record data sets.
TOICTL keyword
Use the TOICTL keyword to temporarily stop the secondary index databases by using IMS Tools Online System Interface while the secondary index databases are being synchronized with the primary DEDB database.
TOINUM keyword
Use the TOINUM keyword to specify the number of retries for issuing the command to obtain a response from the IMS Tools Online System Interface.
TOITIME keyword
Use the TOITIME keyword to specify the time limit for obtaining a response from the IMS Tools Online System Interface.
TOIXCFGRP keyword
Use the TOIXCFGRP keyword to identify the XCF group that the IMS Tools Online System Interface uses to interface with FPA.
UNIT keyword
Use the UNIT keyword to specify 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.
UOW keyword
Use the UOW keyword to simulate the areas with a new number of CIs for each unit of work (UOW).
UOWDOVF_PCT keyword
Use the UOWDOVF_PCT keyword to specify a threshold setting for the percentage of UOWs that use DOVF.
UOWIOVF_AVG keyword
Use the UOWIOVF_AVG keyword to specify a threshold setting for the average number of IOVF CIs that are used by a UOW.
UOWIOVF_MAX keyword
Use the UOWIOVF_MAX keyword to specify a threshold setting for the maximum number of IOVF CIs that are used by a UOW.
UOWIOVF_PCT keyword
Use the UOWIOVF_PCT keyword to specify a threshold setting for the percentage of UOWs that use IOVF.
UOW_REPORT keyword
Use the UOW_REPORT keyword to specify whether to generate the UOW report.
VOLCNT keyword
Use the VOLCNT keyword to specify the maximum number of volumes that will be required by an output data set that is created by dynamic allocation that uses nonspecific volumes.
VOLSER keyword
Use the VOLSER keyword to specify one or more volume-serial identifiers for the data set that is accessed by dynamic allocation.
WHERE keyword
Use the WHERE keyword to specify the criteria that is used to select segments for extraction.
WKDS_SIZE_PCT keyword
Use the WKDS_SIZE_PCT keyword to specify a percentage value to adjust the allocation size of intermediate work data sets HFPSnnnn, HFPInnnn, and HFPZnnnn.

Parent topic: Command reference for FPA