USER Clause

General DDDL Syntax Options › Securing the Dictionary › USER Clause

USER Clause

The USER clause is valid in all entity-type statements except CLASS, LOAD MODULE, MESSAGE, and USER. The USER clause:

Associates one or more existing users with the requested entity occurrence
Registers each user to perform operations (MODIFY, REPLACE, DELETE, DISPLAY/PUNCH) for the requested entity occurrence, or establishes a registration option of public access.
Assigns each user responsibility for the creation, update, and/or deletion of the requested entity occurrence.

Each iteration of the USER clause associates one user with the named entity, specifies a registration option and one or more responsibilities, and optionally supplies descriptive text.

Syntax: USER Clause

   ┌──────────────────────────────────────────────────────────────┐
►►─▼─┬─ INClude ◄ ─┬─ USEr is user-id ──┬───────────────────────┬─┴───────────►◄
     └─ EXClude ───┘                    └─ user-specification ──┘

Expansion of user-specification

►►─┬─────────────────────────────────────────┬────────────────────────────────►
   └─ REGistered for ─┬─ PUBlic access ◄ ──┬─┘
                      ├─ ALL ──────────────┤
                      ├─ UPDate ───────────┤
                      ├─ MODify ───────────┤
                      ├─ REPlace ──────────┤
                      ├─ DELete ───────────┤
                      └─ DISPlay ──────────┘

 ►─┬───────────────────────────────────────────────────────────────┬──────────►
   │                                   ┌────────────────────────┐  │
   └─ RESponsible for ─┬─ NONe ◄ ───┬──▼─┬────────────────────┬─┴──┘
                       ├─ CREation ─┤    └─ AND ─┬─ CREation ─┤
                       ├─ UPDate ───┤            ├─ UPDate ───┤
                       └─ DELetion ─┘            └─ DELetion ─┘

 ►─┬──────────────────────┬───────────────────────────────────────────────────►◄
   └─ TEXt is user-text ──┘

Parameters

USEr is user-id: Associates (INCLUDE) a user with or disassociates (EXCLUDE) a user from the requested entity occurrence. User-id must correspond to a 1- through 32-character user ID in the dictionary. If the specified ID includes embedded blanks or delimiters, it must be enclosed in site-standard quote characters.
user-specification: See the following descriptions for the REGISTERED FOR, RESPONSIBLE FOR, and TEXT parameters.
REGistered for: Registers the named user with the requested entity occurrence and specifies the functions the user can perform for the entity.
PUBlic access: Specifies that the PUBLIC ACCESS clause (described later in this chapter) controls the functions that the user can perform. This is the REGISTERED FOR default.
ALL: Specifies that the user is registered to perform all functions; the user can issue MODIFY, REPLACE, DELETE, and DISPLAY/PUNCH verbs, and can change the REGISTERED FOR options for other users and the PUBLIC ACCESS specification.
UPDate: Specifies that the user is registered to perform update functions; the user can issue MODIFY, REPLACE, DELETE, and DISPLAY/PUNCH verbs but cannot change the REGISTERED FOR and PUBLIC ACCESS specifications.
MODify: Specifies that the user is registered only to issue MODIFY and DISPLAY/PUNCH verbs.
REPlace: Specifies that the user is registered only to issue REPLACE and DISPLAY/PUNCH verbs.
DELete: Specifies that the user is registered only to issue DELETE and DISPLAY/PUNCH verbs.
DISPlay: Specifies that the user is registered only to issue DISPLAY/PUNCH verbs.
RESponsible for: Documents responsibility for the named user. The options named with RESPONSIBLE FOR do not have any impact on entity-occurrence security.
NONe: Specifies that no responsibility is documented for the named user. NONE is the default.
CREation: Documents creation responsibility for the named user.
UPDate: Documents update responsibility for the named user.
DELetion: Documents deletion responsibility for the named user.
AND CREation/UPDate/DELetion: Documents additional creation, update, or deletion responsibilities for the user. You can repeat this clause.
TEXt is user-text: Associates 1 through 40 characters of documentation text with the user/entity relationship. If the text includes special characters or embedded blanks, it must be enclosed in quotation marks. For more information about the TEXT clause, see Documenting Entity Occurrences, later in this chapter.

Examples

The following examples illustrate four forms of the USER clause.

In the following example, user WMC can perform all functions for the CUSTOMER record (issue MODIFY, REPLACE, DELETE, and DISPLAY verbs, change the REGISTERED FOR specification for other users, and change the PUBLIC ACCESS specification); user WMC is also assigned documentation responsibility for creating, updating, and deleting the record.

add record name is customer
   include user wmc
     registered for all
     responsible for creation
       and update and deletion.

In the following example, user WMC can modify, replace, delete, and display the requested entity occurrence but cannot change the REGISTERED FOR specifications for other users or the PUBLIC ACCESS specification of the requested entity occurrence.

include user wmc
     registered for update.

In the following example, user WMC can modify and display only the requested entity occurrence.

include user wmc
     registered for modify.

In the following example, user WMC can only display the requested entity occurrence.

include user wmc
     registered for display.

Usage

USER clause rules

The following rules apply to the USER clause:

The clause can be repeated as needed to define multiple users for each entity occurrence.
To assign a value other than ALL to the PUBLIC ACCESS clause (that is, to override the default), at least one user of the entity occurrence must be assigned the REGISTERED FOR ALL option; see PUBLIC ACCESS Clause for additional details.
An EXCLUDE request that names the last user assigned the REGISTERED FOR ALL option will not be processed unless PUBLIC ACCESS IS ALLOWED FOR ALL has been specified; see PUBLIC ACCESS Clause below for further details.
The REGISTERED FOR parameter overrides any previously specified registration options for the named user.