ENTRY POINT

ENTRY POINT statements document program entry points. Optional clauses:

Associate documentation text with the entry point
Relate the entry point to users
Include the entry point in attribute/entity relationships

Entry points are associated with programs through the PROGRAM statement (see PROGRAM).

If the SET OPTIONS statement specifies SECURITY FOR IDD IS ON, the user must have the proper authority to issue ENTRY POINT statements.

Syntax

ENTRY POINT Statement

►►─┬─ ADD ─────┬─ ENTRy point name is entry-point-name ───────────────────────►
   ├─ MODify ──┤
   ├─ REPlace ─┤
   └─ DELete ──┘

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

 ►─┬────────────────────────────────────────────────┬─────────────────────────►
   └─ entry point DEScription is description-text ──┘

 ►─┬─────────────────────────────────────┬────────────────────────────────────►
   └─ NEW NAMe is new-entry-point-name ──┘

   ┌─────────────────────────────────────────────────────────────────┐
 ►─▼─┬─────────────────────────────────────────────────────────────┬─┴────────►
     └─┬─ 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 ENTRY POINT Statement (for a single entry point)

►►─┬─ DISplay ─┬─ ENTRy point name is entry-point-name ───────────────────────►
   └─ PUNch ───┘

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

   ┌────────────────────────────────────────────────────────────┐
 ►─▼─┬────────────────────────────────────────────────────────┬─┴─────────────►
     │                  ┌──────────────────────────────────┐  │
     └─┬─ WITh ──────┬──▼──┬─ ALL ───────────────────────┬─┴──┘
       ├─ ALSo WITh ─┤     ├─ ALL COMment TYPes ─────────┤
       └─ WITHOut ───┘     ├─ ATTributes ────────────────┤
                           ├─ COMments ──────────────────┤
                           ├─ DEFinitions ───────────────┤
                           ├─ DETails ───────────────────┤
                           ├─ HIStory ───────────────────┤
                           ├─ NONE ──────────────────────┤
                           ├─ PROgrams ──────────────────┤
                           ├─ 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 ENTRY POINT Statement (for multiple entry points)

►►─┬─ DISplay ─┬─┬─ ALL ──────────────────────────┬─ ENTRy points ────────────►
   └─ PUNch ───┘ └─┬─ FIRst ─┬─┬─ 1 ◄ ──────────┬─┘
                   ├─ 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

ENTRy point name is entry-point-name: Identifies a new entry point to be added to the dictionary, or an existing entry point to be modified, replaced, deleted, displayed, or punched. Entry-point-name must be a unique 1- through 8-character name.
NEW NAMe is new-entry-point-name: Specifies a new name for the requested entry point. This clause changes only the name of the entry point; it does not alter or delete previously defined relationships in which the entry point participates. Subsequent references to the requested entry point must specify the new name.
WITh/ALSo WITh/WITHOut: Includes or excludes the specified options when the named entry point 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.

Example

In the following example, the ADD statement defines entry point OREN5A and relates it to the attribute DEVELOPMENT within the class ENTITY-STATUS. The MODIFY statement excludes the DEVELOPMENT attribute and includes the attribute PRODUCTION.

add entry point name is oren5a
    description is
         'entry point in order-entry pgm: nxtordor'
    entity-status is development.

modify entry point name is oren5a
    exclude entity-status is development
    include entity-status is production.