PANEL (SCREEN)

PANEL statements associate documentation entries and users with maps that are used in the 3270-type terminal environment. The keywords PANEL and SCREEN are synonymous; all screens are reported as panels, regardless of the DDDL syntax used to establish and/or maintain the occurrences. Optional clauses relate panels to established users and accommodate attribute/entity relationships. The MAP statement is used to associate established panels with maps; see MAP earlier in this chapter for further details. When a panel is deleted, all maps associated with it are also deleted. Panel occurrences can document either existing panel definitions or anticipated panel requirements.

If the SET OPTIONS statement specifies SECURITY FOR IDMS-DC IS ON, the user must be assigned the proper authority to issue PANEL statements.

Syntax

PANEL (SCREEN) statement

►►─┬─ ADD ─────┬─┬─ PANel ──┬─ name is panel-name ────────────────────────────►
   ├─ MODify ──┤ └─ SCReen ─┘
   ├─ REPlace ─┤
   └─ DELete ──┘

 ►─┬────────────────────────────────────────────┬─────────────────────────────►
   └─ Version is ─┬─ version-number ──────────┬─┘
                  └─┬─────────┬─┬───────────┬─┘
                    └─ NEXt ──┘ ├─ HIGhest ─┤
                                └─ LOWest ──┘

 ►──┬────────────────────────────────────────────────────────┬────────────────►
    └┬─ PREpared ─┬─ by user-id ──┬────────────────────────┬─┘
     └─ REVised ──┘               └─ PASsword is password ─┘

 ►─┬───────────────────────────────────────────────────────────────────────┬──►
   └─ NEW NAMe is new-panel-name ─┬──────────────────────────────────────┬─┘
                                  └─ Version is ─┬─ version-number ─────┬┘
                                                 └─ NEXt ─┬───────────┬─┘
                                                          ├─ HIGhest ─┤
                                                          └─ LOWest ──┘

 ►─┬──────────────────────────────────────────┬───────────────────────────────►
   └─ NEW Version is ─┬─ version-number ─────┬┘
                      └─ NEXt ─┬───────────┬─┘
                               ├─ HIGhest ─┤
                               └─ LOWest ──┘

 ►─┬─────────────────────────────────────────────────┬────────────────────────►
   └─┬──────────┬─ DEScription is description-text ──┘
     ├─ panel ──┤
     └─ screen ─┘

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

(for complete user-specification syntax, see USER clause)

 ►─┬──────────────────────────────────────────────────────┬───────────────────►
   └─ PUBlic access is ─┬───────────┬─ for ─┬─ ALL ◄ ───┬─┘
                        └─ ALLOwed ─┘       ├─ NONe ────┤
                                            ├─ UPDate ──┤
                                            ├─ MODify ──┤
                                            ├─ REPlace ─┤
                                            ├─ DELete ──┤
                                            └─ DISplay ─┘

   ┌────────────────────────────────────────────────────────────────────────┐
 ►─▼┬─────────────────────────────────────────────────────────────────────┬─┴─►
    └┬─ INClude ◄ ┬─ class-name is attribute-name ─┬────────────────────┬─┘
     └─ EXClude ──┘                                └ TEXt is user-text ─┘

   ┌───────────────────────────────────────────────────────────────┐
 ►─▼─┬───────────────────────────────────────────────────────────┬─┴──────────►
     │                            ┌────────────────────┐         │
     └─ EDIt ─┬─ COMments ────┬───▼─ edit-instruction ─┴─ QUIT ──┘
              ├─ DEFinition ──┤
              └─ comment-key ─┘

   ┌──────────────────────────────────────────────────┐
 ►─▼─┬─────────────────────────────────────────────┬──┴───────────────────────►◄
     └─┬─ COMments ─────┬── is ─┬─ NULl ─────────┬─┘
       ├─ DEFinition ───┤       └─ comment-text ─┘
       └─ comment-key ──┘

DISPLAY/PUNCH PANEL (SCREEN) (for a single panel)

►►─┬─ DISplay ─┬─┬─ PANel ──┬─ name is panel-name ────────────────────────────►
   └─ PUNch ───┘ └─ SCReen ─┘

 ►─┬────────────────────────────────────┬─────────────────────────────────────►
   └─ Version is ─┬─ version-number ─┬──┘
                  ├─ HIGhest ────────┤
                  └─ LOWest ─────────┘

 ►─┬───────────────────────────────────────────────────┬──────────────────────►
   └─ PREpared by user-id ─┬─────────────────────────┬─┘
                           └─ PASsword is password ──┘

   ┌──────────────────────────────────────────────────────────┐
 ►─▼─┬──────────────────────────────────────────────────────┬─┴───────────────►
     │                  ┌─────────────────────────────────┐ │
     └─┬─ WITh ──────┬──▼──┬─ ALL ──────────────────────┬─┴─┘
       ├─ ALSo WITh ─┤     ├─ ALL COMment TYPes ────────┤
       └─ WITHOut ───┘     ├─ ATTributes ───────────────┤
                           ├─ COMments ─────────────────┤
                           ├─ DEFinitions ──────────────┤
                           ├─ DETails ──────────────────┤
                           ├─ HIStory ──────────────────┤
                           ├─ MAPs ─────────────────────┤
                           ├─ NONe ─────────────────────┤
                           ├─ USErs ────────────────────┤
                           └─┬─ USEr DEFINED COMments ─┬┘
                             └─ UDCs ──────────────────┘

 ►─┬──────────────────────────────────────────────────────────────────────────►─
   └─ TO ─┬─ SYSpch ──────────────────────────────────────────────────────────
          └─ MODule module-name ─┬───────────────────────────────────┬────────
                                 └─ Version is ─┬─ version-number ─┬─┘
                                                ├─ HIGhest ────────┤
                                                └─ LOWest ─────────┘

─►──────────────────────────────────────────────────────────────────────────┬─►
  ─────────────────────────────────────────────────────────────────────────┬┘
  ─┬──────────────────────┬┬──────────────────────────────────────────────┬┘
   └ LANguage is language ┘└ PREpared by user-id ┬───────────────────────┬┘
                                                 └ PASsword is password ─┘

 ►─┬──────────────────────┬──┬─────────────────────┬──────────────────────────►◄
   └─ VERB ─┬─ DISplay ─┬─┘  └─ AS ─┬─ SYNtax ───┬─┘
            ├─ PUNch ───┤           └─ COMments ─┘
            ├─ ADD ─────┤
            ├─ MODify ──┤
            ├─ REPlace ─┤
            └─ DELete ──┘

DISPLAY/PUNCH PANEL (SCREEN) (for multiple panels)

►►─── DISplay ──┬─ ALL ──────────────────────────┬─┬─ PANels ──┬──────────────►
                └─┬─ FIRst ─┬─┬─ 1 ◄ ──────────┬─┘ └─ SCReens ─┘
                  ├─ NEXt ──┤ └─ entity-count ─┘
                  ├─ LASt ──┤
                  └─ PRIor ─┘

 ►─┬──────────────────────────────────────────────────┬───────────────────────►
   └─ PREpared by user-id ─┬────────────────────────┬─┘
                           └─ PASsword is password ─┘

 ►─┬─────────────────────────────────┬────────────────────────────────────────►
   └─ WHEre conditional-expression ──┘

(for complete conditional-expression syntax, see WHERE clause)

 ►─┬──────────────────┬───────────────────────────────────────────────────────►
   └─ BY ─┬─ SET ◄ ─┬─┘
          └─ AREa ──┘

 ►─┬──────────────────────────────────────────────────────────────────────────►─
   └─ TO ─┬─ SYSpch ──────────────────────────────────────────────────────────
          └─ MODule module-name ─┬───────────────────────────────────┬────────
                                 └─ Version is ─┬─ version-number ─┬─┘
                                                ├─ HIGhest ────────┤
                                                └─ LOWest ─────────┘

─►──────────────────────────────────────────────────────────────────────────┬─►
  ─────────────────────────────────────────────────────────────────────────┬┘
  ─┬──────────────────────┬┬──────────────────────────────────────────────┬┘
   └ LANguage is language ┘└ PREpared by user-id ┬───────────────────────┬┘
                                                 └ PASsword is password ─┘

 ►─┬──────────────────────┬──┬──────────────────────────────────────┬─────────►◄
   └─ VERB ─┬─ DISplay ─┬─┘  └─ AS ─┬─ SYNtax ───┬──┬─────────────┬─┘
            ├─ PUNch ───┤           └─ COMments ─┘  └─ RECursive ─┘
            ├─ ADD ─────┤
            ├─ MODify ──┤
            ├─ REPlace ─┤
            └─ DELete ──┘

Parameters

PANel (SCReen) name is panel-name: Identifies a new panel to be established in the dictionary, or an existing panel to be modified, replaced, deleted, displayed, or punched. Panel-name must be a 1- through 32-character alphanumeric value.
NEW NAMe is new-panel-name: Specifies a new name for the requested panel. This clause changes only the name of the panel occurrence; it does not alter or delete any previously defined relationships in which the panel participates. Subsequent references to the panel must specify the new name. New-panel-name must be a 1- through 32-character value. The concatenation of the new panel name and version number must not duplicate that of an existing panel.
NEW Version is new-version-number/NEXt HIGhest/NEXt LOWest: Specifies a new version number for the named panel. The panel name and new version number must not duplicate that of an existing panel.
WITh/ALSo WITh/WITHOut: Includes or excludes the specified options when the panel is displayed or punched. Detailed information for each DISPLAY/PUNCH option is under SET OPTIONS Syntax. The option that is listed below presents special considerations for this entity type.
DETails: Includes the DESCRIPTION clause.

Usage

If you specify REPLACE

If you specify REPLACE, the DDDL compiler initializes to defaults and/or excludes the following options:

DESCRIPTION
USER REGISTERED FOR
COMMENTS/DEFINITION/comment-key
Related attributes
PUBLIC ACCESS

The following relationships are not affected:

Data fields to which the named panel is related
Maps to which the named panel is related

Example

In the following example, the ADD statement defines panel SH5.

add panel name is sh5
    panel description is 'common shipping queries'.