Entity-Type Syntax › Considerations for Syntax Presentation

Considerations for Syntax Presentation

Order of Presentation

This order of presentation is followed for each entity type:

1. Syntax for ADD/MODIFY/REPLACE/DELETE

   Note: Where it is necessary to expand a parameter, the location of the expansion is noted in the diagram.

2. Syntax for DISPLAY/PUNCH

   (for listing a single entity occurrence)

3. Syntax for DISPLAY/PUNCH ALL

   (for listing multiple entity occurrences)

4. Parameter descriptions for all syntax
5. Usage tips
6. Examples

Repetition of Parameter Descriptions

All parameters for the WITH/ALSO WITH/WITHOUT clause of DISPLAY/PUNCH are described in detail under SET OPTIONS Syntax; these parameters are not repeated for each entity. An exception to this is when there are special considerations that apply to a specific entity type.

Descriptions of parameters presented in Chapter 4: are not repeated unless special considerations apply.

Verb Synonyms

Where the verbs ADD, MODIFY, and DELETE are used, their respective synonyms (CREATE, ALTER, and DROP) are assumed.

Default Values

Default values shown are for ADD and REPLACE statements.

MODIFY statements assume as defaults the parameters used in the ADD or most recent MODIFY statement.

Relationships between Clauses and Verbs

Note the following points about the relationships between specific clauses and specific verbs:

• Optional clauses can appear in ADD, MODIFY, and REPLACE statements, unless otherwise noted.
• Clauses that apply to only one verb are noted in the parameter description.
• Clauses that are required with ADD statements appear as optional in the syntax, but are noted as mandatory in the parameter description.

Entity Types Used Only with CA IDMS Products

Four of the entity types described in this chapter are used only with specific CA IDMS data management products; the entity types and products are as follows:

Security

After securing the product through the SECURITY clause of the SET OPTIONS statement (see SET OPTIONS Statement), the database administrator can control entity-type security by verb, using the AUTHORITY clause in the USER statement.

If the SET OPTIONS statement specifies that security for a certain product is enabled (ON), the user must be assigned the proper authority to issue verbs and statements for related entities.