Previous Topic: SyntaxNext Topic: Usage


Parameters

LOGical RECord/LR name is logical-record-name

Names a logical record. For ADD operations, logical-record-name must uniquely identify a logical record in the current subschema.

Logical-record-name cannot duplicate the name of a database record described in the same subschema. Note that synonyms cannot be defined for logical records; logical records with different names (such as names for COBOL versus those for Assembler) must be defined in different subschemas.

Logical-record-name must be a 1- to 16- character name. Note that LOGICAL RECORD and LR are synonymous.

When naming logical records, be sure that the selected names do not conflict with the CA IDMS Data Manipulation Language precompiler with which the logical records will be used.

ELements are

Identifies either a subschema record described in the current subschema or a record described in the dictionary, but not in the schema that owns the current subschema. Multiple subschema and dictionary records can be defined as elements of a logical record.

All elements named in the ELEMENTS clause of the DDL RECORD statement or the DDDL RECORD statement are included in the logical record.

subschema-record-specification

Identifies a record described in the current subschema and optionally assigns a unique ID to a logical record element that occurs more than once in the logical record description.

subschema-record-name

Identifies the name of a subschema record described in the current subschema.

ROLe name is role-name

Assigns a unique ID to a logical-record element that occurs more than once in a single logical record; it can also be used for logical-record elements that occur only once in the logical record.

Role-name is a 1- to 16-character name. Role-name cannot be the name of a record or record synonym defined in the schema that owns the current subschema, or the name of a logical record used in the subschema.

Each role name can be assigned to only one record type per subschema; it can be assigned to that record type in any number of LOGICAL RECORD statements.

idd-record-specification

Identifies a record described in the dictionary, but cannot be the name of a record or record synonym defined in the schema that owns the current subschema. IDD records commonly are included in logical records to introduce work fields into the logical-record path logic.

idd-record-name

Names the dictionary record.

version-specification

Qualifies the dictionary record with a version number. This clause is required for dictionary records. The version number defaults to the current session option for existing versions.

Note: Expanded syntax for version-specification is presented in Chapter 13, “Parameter Expansions".

ROLe name is role-name

Assigns a unique ID to a logical-record element that occurs more than once is a single logical record. The syntax rules that appear above apply, with one exception: for dictionary records, role-name can be up to 32 characters long.

ON LR-ERROR CLEar

Indicates that variable-storage allocated to the logical record in the program gets set to low values if a program request for access to the named logical record results in the return of the LR-ERROR path status.

ON LR-ERROR NOClear

Indicates that variable-storage allocated to the logical record in the program does not get set to low values if a program request for access to the named logical record results in the return of the LR-ERROR path status. NOCLEAR is the default.

ON LR-NOT-FOUND CLEar

Indicates that variable-storage allocated to the logical record in the program gets set to low values if a program request for access to the named logical record results in the return of the LR-NOT-FOUND path status.

ON LR-NOT-FOUND NOClear

Indicates that variable-storage allocated to the logical record in the program does not get set to low values if a program request for access to the named logical record results in the return of the LR-NOT-FOUND path status. NOCLEAR is the default.

COMments comment-text

Permits documentational entries for the named logical record.

Note: For rules on coding comment-text, see 10.5.4, "Coding Comment Text".

COMments

Displays and punches all comment text included in the logical-record definition.

DETails

Displays and punches the following information about the logical record:

ALL

Displays and punches the entire logical-record description.

NONe

Displays and punches only the name of the logical record.