CA Culprit in the CA IDMS/DB Environment › KEY and KEYFILE Parameters › About the KEYFILE Parameter

About the KEYFILE Parameter

Purpose

The KEYFILE parameter is an optional parameter that specifies the characteristics of a sequential file that contains key values. The key file field contains the following types of values, depending on whether the entry record is a database record, logical record, or a table:

Database Record

If the entry record is a database record, the value of the key field must be a CALC key, an index key, or a db-key:

• If the entry record is accessed by using an index, the key values must be index keys.
• If the entry record is not accessed by using an index and has a CALC location mode, the key values can be CALC keys.
• If the entry record is not accessed by using an index and has any type of location mode, the key values can be db-keys.

The key file fields that contain CALC-key or index-key values must be defined with the same field length and data type as the field in the database; for example, if the database field contains a 2-byte binary value, the values in the key file must be 2-byte binary values.

Logical Record or Table

If the entry record is a logical record or a table, the following options can be used to select logical records or table rows:

• Key file values can be compared to the values of any logical record field or table column by using KEY-VALUE in the WHERE clause on the PATH or INPUT parameter. The KF= expression on the KEYFILE parameter designates the field in the key file. The LRFNAME= expression on the KEYFILE parameter designates the logical record field or table column. Both keyword expressions are described in the syntax rules below.
• If the KEYFILE parameter includes the FN= option, any key file field can be referenced in the WHERE clause on the PATH or INPUT parameter.

  Note: When a key file field is referenced in a WHERE clause, no KEY parameters can be specified.

Associated Parameters

Only one KEYFILE parameter can be specified for a CA Culprit run. Parameters that are associated with the KEYFILE parameter follow:

REC Parameters

User-supplied REC parameters define fields in the sequential file unless the file is defined to the data dictionary, in which case the file must be named in the FN= expression on the KEYFILE parameter. User-supplied REC parameters must be qualified by the keyword KEYFILE.

SELECT/BYPASS Parameters

SELECT/BYPASS parameters can be specified to define selection criteria to be applied to each record in the sequential file.

SELECT/BYPASS parameters associated with the KEYFILE parameter must appear in the input stream after the KEYFILE parameter and before any subsequent INPUT or PATH parameters. SELECT/BYPASS parameters associated with a KEYFILE parameter are coded in the same way as SELECT/BYPASS parameters associated with INPUT parameters.

More information:

REC Parameter

SELECT / BYPASS Parameters