ZFCRU SETUP-Parameter Table Maintenance and Setup

Use this command to update an existing parameter table that has been locked.

Requirements and Restrictions

You must lock the parameter table before you can use the ZFCRU SETUP command.
The ADR and WID parameters are not supported with CRUISE restore processing when the database is captured using multiple reference check (MRC) support. Using the STATISTICS parameter with MRC support can result in incomplete statistics because not all paths are chain chased during MRC processing.

Format

                 .----------------------------------.
                 V                                  |
>>-ZFCRU SETUP- ---+-| Function Parameters |------+-+----------><
                   +-| Chain Chasing Parameters |-+
                   '-| Other Parameters |---------'
 
Function Parameters:
 
|--+-FUNCTION-+---+-+-CAPTURE-+-+-------------------------------|
   '-FUN------'   | '-CAP-----' |
                  +-+-RESTORE-+-+
                  | '-RST-----' |
                  +-+-VERIFY-+--+
                  | '-VER----'  |
                  '-+-PACK-+----'
                    '-PAC--'
 
Chain Chasing Parameters:
 
           .-/---------.
           V           |
|--+-REF- ---+-id----+-+-+- -+-----------------------------+----|
   |         '-id-id-'   |   +-PARTITION-pp----------------+
   |      .-/--------.   |   +-INTERLEAVE-ii---------------+
   |      V          |   |   +-FVN-vv----------------------+
   '-FAD ---fileaddr-+---'   |          .-/--------------. |
                             |          V                | |
                             '-ORDINAL----+-FIRST------+-+-'
                                          +-LAST-------+
                                          +-o----------+
                                          +-FIRST-o----+
                                          +-o-LAST-----+
                                          +-o-o--------+
                                          '-FIRST-LAST-'

Other Parameters:
 
         .- NO--.
|--+-MRC-+------+--------------------------------------------+--|
   |     '- YES-'                                            |
   |       .- ALL-----.                                      |
   +-MRCID-+----------+--------------------------------------+
   |       |   .-/--. |                                      |
   |       |   V    | |                                      |
   |       '- ---id-+-'                                      |
   |       .-/---------.                                     |
   |       V           |                                     |
   +-WID- ---+-id----+-+-- --+-----------------------------+-+
   |         '-id-id-'       +-PARTITION-pp----------------+ |
   |                         +-INTERLEAVE-ii---------------+ |
   |                         +-FVN-vv----------------------+ |
   |                         |          .-/--------------. | |
   |                         |          V                | | |
   |                         '-ORDINAL----+-FIRST------+-+-' |
   |                                      +-LAST-------+     |
   |                                      +-o----------+     |
   |                                      +-FIRST-o----+     |
   |                                      +-o-LAST-----+     |
   |                                      +-o-o--------+     |
   |                                      '-FIRST-LAST-'     |
   |         .-/--------.                                    |
   |         V          |                                    |
   +-ADR-- ----fileaddr-+------------------------------------+
   +-ECB-ecb-------------------------------------------------+
   +-APL-a---------------------------------------------------+
   +-UEX-text------------------------------------------------+
   +-+-TAPE-+--ttt-------------------------------------------+
   | '-TAP--'                                                |
   +-+-TARGET-+---+-TPF-+------------------------------------+
   | '-TAR----'   '-MVS-'                                    |
   +-+-+-SETINUSE-+---+---+-YES-+----------------------------+
   | | '-SET------'   |   '-NO--'                            |
   | +-+-STATISTICS-+-+                                      |
   | | '-STA--------' |                                      |
   | '-IMB------------'                                      |
   |              .-/-------.                                |
   |              V         |                                |
   +-+-OUTPUT-+-----address-+--------------------------------+
   | '-OUT----'                                              |
   +-+-PRINT-+---+-prt-+-------------------------------------+
   | '-PRT---'   '-ALL-'                                     |
   +-+-LOGGING-+---+-log-+-----------------------------------+
   | '-LOG-----'   '-ALL-'                                   |
   '-+-RESTORE-+-----+-OLD-------------------------------+---'
     '-RST-----'     +-NEW-------------------------------+
                     +-+-NOREB-----+---------------------+
                     | '-NOREBUILD-'                     |
                     |                 .-+-NOREL-----+-. |
                     |                 | '-NORELEASE-' | |
                     '-+-REB-----+--/--+-+---------+---+-'
                       '-REBUILD-'       +-REL-----+
                                         '-RELEASE-'

FUNCTION

specifies the function to be performed.

CAPTURE

specifies the data to be captured to tape.

RESTORE

specifies the data to be restored from tape.

VERIFY

verifies data structures, and reports broken chains and references that are not valid.

PACK

specifies data structures to pack according to the database definition (DBDEF) macro.

Notes:

Because packing large database structures requires a significant amount of system resources, commit scope processing is not available with the pack function, regardless of what the DBDEF macro has set as the default.
When processing a CRUISE operation that specifies the PACK function, the system must be in CRAS state or above.

Note:

You must specify a chain chasing parameter when you use the capture, verify, or pack functions.

REF

specifies as many as 30 hexadecimal fixed file identifiers (IDs) to chain chase.

Notes:

The subparameters associated with the REF parameter (PARTITION, INTERLEAVE, FVN, and ORDINAL) are used to selectively chain chase ordinals in capture, verify, and pack operations related to a single REF ID. You cannot use these subparameters with a file ID range.
Do not use the REF parameter when completely restoring a database structure. For selective restore operations, use the REF parameter to chain chase index subfiles that were not restored. CRUISE will replace each index reference to an old file address with the corresponding new file address.
Use the WID parameter to selectively process a subset of the reference IDs and ordinals that are chain chased with the REF parameter. If you do not specify a WID parameter, all embedded file structures are processed.

id

is a record ID in 2-character alphanumeric or 4-character hexadecimal format.

id-id

is a range of IDs in 2-character or 4-character hexadecimal format.

id-id/id/id

is a list of IDs. You can specify single IDs and ID ranges in mixed format.

PARTITION-pp

specifies a fixed file partition to be processed, where pp is the partition for TPFDF files.

Note:

This parameter works for TPFDF files only.

INTERLEAVE-ii

specifies a fixed file interleave to be processed, where ii is the interleave number for TPFDF files.

Note:

This parameter works for TPFDF files only.

FVN-vv

specifies the file version (if applicable), where vv is the file version number.

ORDINAL

specifies an ordinal number or range of ordinal numbers to be processed.


FIRST: specifies the first relative ordinal number.
LAST: specifies the last relative ordinal number.
o: is a relative ordinal number. You can specify a relative ordinal number with a maximum size of 8 digits.
FIRST-o: specifies a range of relative ordinal numbers starting with the first ordinal number.
o-LAST: specifies a range of relative ordinal numbers ending with the last ordinal number.
o-o: is a range of relative ordinal numbers.
FIRST/LAST: specifies a list of relative ordinal numbers beginning with the first and ending with the last ordinal number.

Note:

You can specify a maximum of 10 relative ordinal number ranges.

FAD

specifies as many as fifty 8- or 16-character hexadecimal file addresses to be chain chased.

Note:

The file addresses specified with this parameter are started when you use the RESTORE parameter with the REBUILD option.

fileaddr

is an 8- or 16-character hexadecimal file address.

fileaddr/fileaddr

is a list of 8- or 16-character hexadecimal file addresses.

MRC

specifies multiple reference check (MRC) support during CRUISE capture processing, where:

NO: specifies that MRC support is not used during CRUISE capture processing.
YES: specifies that MRC support is used during CRUISE capture processing.
MRC support is a method that modifies CRUISE capture processing so that detailed files referenced from more than one index file are chain chased only once.

MRCID

specifies the file IDs to be included with MRC processing, where:

ALL: specifies that all file IDs are to be included with MRC processing.
id: is the file ID to be included with MRC processing. You can specify as many as 10 file IDs.

Notes:

Because the MRC parameter with the NO value specified ignores the MRCID parameter, they can be used together.
If you use the MRCID parameter, the MRC parameter with the YES value is automatically specified by the TPFDF product.

WID

sets up as many as 30 wanted file IDs (WIDs) to be chain chased.

Notes:

The WID parameter can be a fixed or pool file.
The WID parameter limits processing to the specified file IDs while chain chasing the structure referenced by the REF or FAD parameter. If you specify the IMB parameter with the NO option, only the reference IDs specified by the WID parameter and associated subparameters are processed. If you specify the IMB parameter with the YES option, the reference IDs and all references embedded in them are processed.
When you use the RESTORE parameter, the WID parameter specifies the first file ID to be restored. Additionally, all forward chain blocks (if any) will be restored. If you use the IMB parameter, all referenced subfiles will also be processed.
The subparameters associated with the WID parameter (PARTITION, INTERLEAVE, FVN, and ORDINAL) are related to a single wanted file ID. You cannot specify them using an ID range.
The WID parameter is not supported with CRUISE restore processing when the database is captured using MRC support.
The WID parameter is not supported with CRUISE verify processing.

ADR

specifies a search of as many as fifty 8- or 16-character hexadecimal file addresses. CRUISE will report all references of the specified file addresses during chain chasing as specified by the REF or FAD parameter.

The RESTORE parameter processes this file address and all of its forward chains. When you use the IMB parameter, it also processes all referenced subfiles.

Note:

The ADR parameter is not supported with CRUISE tape restore processing when the database is captured by using MRC support.

ECB-ecb

specifies the percentage of total entry control blocks (ECBs) to be distributed, where ecb is a value in the range 1-100%. One hundred percent is the total number of ECBs allocated on the TPF system.

Notes:

At run time, the ECB percentage that is specified with the ECB parameter is ignored if it is too low for a specific ID (for example, there are not enough ECBs for all structure levels of that database). The predefined default number of ECBs is used, and an informational message is written to the specified output address and the parameter table logging file. You can specify a higher ECB percentage to avoid using the default.
At run time, the ECB percentage that is specified with the ECB parameter is always ignored if a CRUISE function cannot determine the number of structure levels in a database. The predefined default number of ECBs is then used to process that database.

APL-a

specifies the application ID of the files that the CRUISE function will process, where a is the application code.

Note:

This parameter applies to the fixed files specified with the REF parameter.

UEX-text

specifies a text string, where text is user-specific text up to 103 bytes that will be available to the user exit segment. The text is contained in the CRUISE workblock (IRCHDF) at assembler label IRCHUTX. The CRUISE workblock is contained in global CINFC, CMMCRU label. You can use the vertical bar (|) to switch between hexadecimal and character input.

TAPE-ttt

specifies the requested output medium, where ttt is any user-defined tape. In the Airline Control System (ALCS) environment, ttt can also be a 3 character sequential data set name.

TARGET

specifies the target system where the data will be processed. For example, it specifies whether the tape format is for the CRUISE restore function or for processing by applications other than TPFDF applications. This parameter is used for CRUISE capture only.

TPF: specifies that the data will be restored on a TPF or ALCS system by a CRUISE restore function. Since the capture tape is created using multiple-ECB processing for increased performance, the file blocks are not in any specific order on the tape. Every data block is preceded by a control block with CRUISE-specific information. The tape can only be used for a restore function.
MVS: specifies that the data can be used by an offline batch job on an MVS system. The file blocks for subfiles are written to tape in sequential order so that the tape can be processed by an offline batch job on an MVS system.
The tape can also be used for a restore operation on a TPF or ALCS system by using the DBTRD and DBTLD macros, if the tape contains only TPFDF-type data.

Note:

If you do not use ZFCRU DEFAULT to define a default value for the TARGET parameter, the default value is TPF.

SETINUSE

specifies pool file use, where:

YES: calls case 3 of user exit macro DFUEX during the processing of the RESTORE and VERIFY parameters when pool files are used. The RESTORE parameter must have the REF and FAD parameters specified when you use this option.

Note:

You can use this parameter only in NORM state.
NO: does not call case 3 of user exit macro DFUEX during the processing of the RESTORE and VERIFY parameters when pool files are used.

STATISTICS

specifies statistics from the parameter table, where:

YES: specifies that file statistics are built for all record IDs that were chain chased following successful parameter table processing.

Note:

If you specify the YES option, the system must be in CRAS state or higher when the CRUISE operation is started.

NO: specifies that file statistics are not built following successful parameter table processing.

Note:

Using this parameter with MRC support can result in incomplete statistics because not all paths are chain chased during MRC processing.

IMB

specifies that embedded references are included in processing, where:

YES: specifies that references embedded in files indicated with the WID parameter are included in CRUISE processing.

NO: specifies that references embedded in files indicated with the WID parameter are not included in CRUISE capture, restore, or pack processing. When you use this parameter, only files indicated with the WID parameter are included in processing.

Note:

The IMB parameter is valid only if the WID parameter was specified.

OUTPUT-address

specifies the output device, where address is a 6-digit hexadecimal printer or terminal address. You can specify as many as three output addresses.

Note:

If you start a CRUISE function from a terminal that is not specified as an output terminal, only start and end messages are displayed. However, a prime CRAS receives messages regardless of where a CRUISE function was started.

PRINT

specifies the number of messages to be printed to the output device selected with the ZFCRU OUTPUT command, where

prt: is a number in the range 0-100.

ALL: specifies all the messages are to be printed.

Notes:

Printing will stop when the number you specified is reached.
If the number of messages you specify is less than the number of messages printed, printing will end.
The specified number of messages is in effect only when the CRUISE function is in running state.

LOGGING

specifies messages to be logged to the parameter table, where:

log: is a number in the range 0-100.

ALL: specifies that all the messages are to be logged to the parameter table logging file.

Notes:

Logging ends when the specified number of logged messages is reached.
Logging will run until available pool space is used if you use the ALL parameter with the ZFCRU LOG command.
If the number of logged messages you specify is less than the number of messages logged, logging will complete and no messages are deleted.
The number of messages you specified to be logged is in effect only when the CRUISE function is in running state.

RESTORE

specifies the method in which CRUISE restores data, where:

OLD

specifies that the database is restored to the same fixed and pool file addresses that were captured.

NEW

specifies that the captured fixed and pool files are restored to new pool file addresses where the data structure is rebuilt.

Note:

You can use this parameter only in CRAS state or above.

NOREBUILD

specifies that the captured fixed and pool files are restored to new pool file addresses and the data structure is not rebuilt.

Note:

You can use this parameter only in CRAS state or above.

REBUILD

specifies that the captured fixed files are restored to the same ordinals that were captured. The captured pool files are restored to new pool file addresses and the database structure is rebuilt.

Notes:

You can use this parameter only in CRAS state or above.
To improve system performance, pack a subfile using the pack operation after restore processing on B⁺Tree and block index files.

NORELEASE

specifies that old pool file addresses are not released when the structure is rebuilt.

Note:

You can use this parameter only in NORM state.

RELEASE

specifies that old pool file addresses are released when the data structure is rebuilt.

Notes:

You can use this parameter only in NORM state.
You cannot use the RELEASE parameter when restoring TPFDF files that reference non-TPFDF files.

Note:

You can also specify the optional parameter names in their abbreviated form as shown in the syntax diagram.

Additional Information

If your database contains a large amount of data with subfiles referenced by index files, MRC support improves the performance of CRUISE capture processing by chain chasing each subfile once. By eliminating redundant chain chasing, MRC support reduces the amount of tape required and increases the performance of CRUISE capture processing. The performance of CRUISE restore and verify processing is also improved. Additionally, MRC support enhances the management of your system resources with improved CPU and input/output (I/O) time.
The ADR and WID parameters are not supported with CRUISE restore processing when the database is captured using MRC support. Using the STATISTICS parameter with MRC support can result in incomplete statistics because not all paths are chain chased during MRC processing.
You must pack a B⁺Tree and block index file to validate the file references after CRUISE capture and restore processing because CRUISE capture and restore processing nullifies the validation of block index technical LRECs (TLRs) and releases B⁺Tree files.
You must make sure that the system is in CRAS state or above when processing a CRUISE RESTORE operation that includes the NEW, NOREBUILD, or REBUILD option.

Examples

In the following example, a parameter table (TABLE1) is updated to verify reference ID range FD00-FDFF.

User:    ZFCRU SETUP FUN-VERIFY REF-FD00-FDFF

System:  FCRU0000I 10.51.11 MODIFIED
         FCRU0000I 10.51.11 PARAMETER TABLE DISPLAY FOR TABLE1
         FUNCTION                   VER
         USABLE ECB START VALUE     33 PCT
         SET POOL ADDRESSES IN USE  NO
         BUILD STATISTICS           YES
         NUMBER OF PRINT MESSAGES   100
         OUTPUT ADDRESSES           306919  000000  000000
         NUMBER OF LOG MESSAGES     ALL
         REFERENCE ID               FD00 - FDFF
         FCRU0000I 10.51.11 END OF DISPLAY

In the following example, a parameter table (TABLE3) is updated to capture two ranges of relative ordinal numbers for reference ID FDED. Statistcs are built for the entire ordinal range of referenced IDs, including embedded files.

User:    zfcru setup fun-cap ref-fded wid-fded ord-0-4/20-24 imb-yes

System:  CSMP0097I 11.12.27 CPU-B SS-BSS  SSU-HPN  IS-01
         FCRU0042I 11.12.27 MODIFIED
         FCRU0000I 11.12.27 PARAMETER TABLE DISPLAY FOR TABLE3
           FUNCTION                   CAP
           USABLE ECB START VALUE     15 PCT
           TAPE NAME                  BFA
           TARGET SYSTEM NAME         TPF
           BUILD STATISTICS           YES
           NUMBER OF PRINT MESSAGES   50
           NUMBER OF LOG MESSAGES     ALL
           RESTORE OPTION             REBUILD/NORELEASE
           REFERENCE ID               FDED
           WANTED ID                  FDED
            ORDINALS                  0000000-0000004 0000020-0000024
            IMBEDDED ADDRESSES        YES
         FCRU0000I 11.12.27 END OF DISPLAY

In the following example, a parameter table (TABLE4) is updated to restore a range of relative ordinal numbers for reference ID FDED.

User:    zfcru setup fun-rst wid-fded ord-0-4 imb-yes

System:  CSMP0097I 11.12.27 CPU-B SS-BSS  SSU-HPN  IS-01
         FCRU0042I 11.12.27 MODIFIED
         FCRU0000I 11.12.27 PARAMETER TABLE DISPLAY FOR TABLE4
           FUNCTION                   RST
           USABLE ECB START VALUE     15 PCT
           TAPE NAME                  BFA
           TARGET SYSTEM NAME         TPF
           BUILD STATISTICS           NO
           NUMBER OF PRINT MESSAGES   50
           NUMBER OF LOG MESSAGES     ALL
           RESTORE OPTION             REBUILD/NORELEASE
           WANTED ID                  FDED
            ORDINALS                  0000000-0000004
            IMBEDDED ADDRESSES        YES
         FCRU0000I 11.12.27 END OF DISPLAY

In the following example, a parameter table (FADADR) is updated to verify the file address specified with the FAD parameter and to report all references of the file address specified with the ADR parameter.

User:   ZFCRU SETUP FUN-VER STA-YES FAD-28110003 ADR-18DBCF6D

System: CSMP0097I 13.05.07 CPU-2 SS-PNR SSU-PR IS-01
        FCRU0000I 13.05.07 PARAMETER TABLE DISPLAY FOR FADADR
          FUNCTION                   VER
          USABLE ECB START VALUE     40 PCT
          SET POOL ADDRESSES IN USE  NO
          BUILD STATISTICS           YES
          NUMBER OF PRINT MESSAGES   ALL
          NUMBER OF LOG MESSAGES     ALL
          REFERENCE FILE ADDRESS     0000000028110003
          SEARCH FILE ADDRESS        0000000018DBCF6D
        FCRU0000I 13.05.07 END OF DISPLAY

In the following example, a parameter table (CR0VER28110000) is updated to verify the file ID specified with the REF parameter and the file addresses specified with the FAD parameter.

User:   ZFCRU SETUP FUN-VER STA-YES REF-C098 FAD-0000000028110000/0000000028110100
        ZFCRU DISPLAY-CR0VER28110000
System: CSMP0097I 12.54.09 CPU-2 SS-PNR SSU-PR IS-01
        FCRU0000I 12.54.09 PARAMETER TABLE DISPLAY FOR CR0VER28110000
          FUNCTION                   VER
          USABLE ECB START VALUE     40 PCT
          SET POOL ADDRESSES IN USE  NO
          BUILD STATISTICS           YES
          NUMBER OF PRINT MESSAGES   ALL
          NUMBER OF LOG MESSAGES     ALL
          REFERENCE ID               C098
          SEARCH FILE ADDRESS        0000000028110000 0000000028110100
        FCRU0000I 12.54.09 END OF DISPLAY

Related Information

See the following commands for information about overriding parameter table default values while the CRUISE function is in running state.
See TPFDF Programming Concepts and Reference for more information about commit scopes, and the DBTRD and DBTLD macros.
See TPFDF Utilities for more information about CRUISE.