CA IDMS Reference 19.0

PDF
English

LOGICAL TERMINAL

LOGICAL-TERMINAL statements are used to document the logical terminals used in an online environment and to relate those logical terminals to established systems and users, as well as to physical terminals. Logical terminals allow application programs to communicate with DC/UCF systems without specifying physical device identifiers. At runtime, the terminal user's signon information, the executing task, and dynamic storage are associated with the logical terminal.
idmscu19
LOGICAL-TERMINAL statements are used to document the logical terminals used in an online environment and to relate those logical terminals to established systems and users, as well as to physical terminals. Logical terminals allow application programs to communicate with DC/UCF systems without specifying physical device identifiers. At runtime, the terminal user's signon information, the executing task, and dynamic storage are associated with the logical terminal.
It is recommended that you maintain LOGICAL TERMINAL definitions using the system generation compiler,
not
 the DDDL compiler. If a system generation component is processed by the DDDL compiler, only dictionary security is checked,
not
 system generation security. For more information on using the system generation compiler, refer to
CA IDMS Administrating section
.
If the SET OPTIONS statement specifies SECURITY FOR IDMS-DC IS ON, the user must be assigned the proper authority to issue LOGICAL-TERMINAL statements.
Syntax
LOGICAL-TERMINAL Statement
 

 
►►─┬─ ADD ─────┬─┬─ LOGical-terminal ─┬─ name is 
logical-terminal-name
 ───────►
   ├─ MODify ──┤ └─ LTErm ────────────┘
   ├─ REPlace ─┤
   └─ DELete ──┘

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

 ►─┬────────────────────────────────────────────────────────┬─────────────────►
   └┬─ PREpared ─┬─ by 
user-id
 ──┬────────────────────────┬─┘
    └─ REVised ──┘               └─ PASsword is 
password
 ─┘
 
 ►─┬─────────────────────────────────────────────────────┬────────────────────►
   └─ logical-terminal DEScription is 
description-text
 ──┘

   ┌─────────────────────────────────────────────────────────────────┐
 ►─▼─┬─────────────────────────────────────────────────────────────┬─┴────────►
     └─┬─ 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 ◄ ┬ within SYStem 
system-name
 ┬──────────────────────────────┬──
    └ EXClude ──┘                           └ Version is ┬────────────────┬┘
                                                         ├ 
version-number
 ┤
                                                         ├ HIGhest ───────┤
                                                         └ LOWest ────────┘
 
─►────────────────────────────────────────────────────────────────────────────►─
  ─┬──────────────────────────────────────────────────────────────────────────
   └─┬─ PHYsical-terminal ─┬─ is 
physical-terminal-name
 ──────────────────────
     └─ PTErm ─────────────┘

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

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

  ──────────────────────────────────────────────────────────────────────────┐
─►─────────────────────────────────────────────────────────────────────────┬┴─►
  ─┬┬ PHYsical-terminal ┬ is 
terminal-name
 ─┬───────────────────────────┬┬─┘
   │└ PTErm ────────────┘                   └ Version is 
version-number
 ┘│
   ├─ AUTotask code is ─┬─ NULl ◄ ────┬──────────────────────────────────┤
   │                    └─ 
task-name
 ─┘                                  │
   ├┬ ENAbled ◄ ─┬───────────────────────────────────────────────────────┤
   │└ DISabled ──┘                          ┌─────────────────┐          │
   ├─ PRINter class is ─┬─ ADD ◄ ──┬──┬─ ( ─▼─ 
printer-class
 ─┴─ ) ─┬────┤
   │                    └─ DELete ─┘  └─ ALL ───────────────────────┘    │
   ├─ NOPrinter ◄ ───────────────────────────────────────────────────────┤
   └─ PRIority is ─┬─ 0 ◄ ──────────────────────┬────────────────────────┘
                   └─ 
terminal-priority-number
 ─┘                         
 
   ┌───────────────────────────────────────────────────────────────┐
 ►─▼─┬───────────────────────────────────────────────────────────┬─┴──────────►
     │                            ┌────────────────────┐         │
     └─ EDIt ─┬─ COMments ────┬───▼─ 
edit-instruction
 ─┴─ QUIT ──┘
              ├─ DEFinition ──┤
              └─ 
comment-key
 ─┘

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








DISPLAY/PUNCH LOGICAL-TERMINAL Statement (for a single terminal)








►►─┬─ DISplay ─┬─┬─ LOGical-terminal ─┬─ name is 
logical-terminal-name
 ───────►
   └─ PUNch ───┘ └─ LTErm ────────────┘

 ►─┬───────────────────────────────────┬──────────────────────────────────────►
   └─ 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 ──────────────────┤
                           ├─ NONe ─────────────────────┤
                           ├─ PHYsical-terminals ───────┤
                           ├─┬─ SYStems ────┬───────────┤
                           │ └─ SUBSYstems ─┘           │
                           ├─ 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 LOGICAL-TERMINAL Statement (for multiple terminals)








►►─── DISplay ──┬─ ALL ──────────────────────────┬─┬─ LOGical-terminals ─┬────►
                └─┬─ FIRst ─┬─┬─ 1 ◄ ──────────┬─┘ └─ LTErms ────────────┘
                  ├─ 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
  • LOGical-terminal name is
    logical-terminal-name
    Identifies a new logical terminal to be established in the dictionary or an existing logical terminal to be modified, replaced, deleted, displayed, or punched. LTErm is a synonym for LOGical-terminal.
    Logical-terminal-name
     must be a 1- through 8-character alphanumeric value.
  • within SYStem
    system-name
    Associates the named logical terminal with a system.
    System-name
     must be the 1- through 32-character name of an existing system. The WITHIN SYSTEM specification is documentation only, unless the system generation compiler COPY facility is to be used to copy logical-terminal definitions from an IDD-built system. When the COPY facility is not used, all logical-terminal/system relationships are established and maintained by the system generation compiler.
  • PHYsical-terminal is
    physical-terminal-name
    Associates a physical terminal with or disassociates it from the logical-terminal/system relationship. The named physical terminal must be defined within the named system. In the DC/UCF environment, this parameter is documentation only; the logical-to-physical terminal association is established by means of the DC OPTION clause (described below) or directly through the system generation compiler.
  • DC option is
    Assigns logical functions to the logical-terminal occurrence and, in DC/UCF environments, associates the logical terminal with a physical terminal.
  • PHYsical-terminal is
    physical-terminal-name
    Specifies the physical terminal with which the named logical terminal is to be associated. Note that the VERSION clause keywords HIGHEST and LOWEST are
    not
     valid.
    Although a logical terminal can be associated with only one physical terminal at a time, the specified association can be changed by means of an operator command during system execution.
  • AUTotask code is NULl/
    task-name
    Specifies whether a task is to be executed automatically when the logical terminal is enabled. NULL (the default) specifies that no task is initiated when the terminal is enabled.
    Task-name
     specifies that the named task will be initiated automatically when the terminal is enabled.
    Task-name
     must be a 1- through 8-character alphanumeric value.
    If the named task is defined with the INPUT option, task execution is deferred until the terminal operator enters the requested data (see TASK).
    Note that AUTOTASK CODE cannot be specified if PRINTER CLASS is specified.
  • ENAbled/DISabled
    Specifies whether the logical terminal is to be enabled or disabled automatically when the DC/UCF system starts up. ENABLED (the default) automatically enables the terminal at system startup. DISABLED disables the terminal until it is enabled explicitly by an operator command during system execution.
  • PRINter class is ADD/DELete
    printer-class-number
    /ALL
    Specifies one or more print classes.
    Printer-class-number
     must be an integer in the range 1 through 64. ALL assigns all printer classes (1 through 64) to the logical terminal.
    The optional ADD/DELETE parameter adds or deletes the specified printer classes; ADD is the default. Specify the PRINTER CLASS option only if the associated physical terminal is a 3280 or similar device that has print capabilities.
    PRINTER CLASS cannot be specified if AUTOTASK CODE is specified.
  • NOPrinter
    Specifies that the logical terminal is not associated with a physical print device.
  • PRIority is 0/
    terminal-priority-number
    Specifies the dispatching priority for the named logical terminal. The DC/UCF system uses the specified value in combination with task and user priorities to determine the dispatching priority of specific requests.
    Terminal-priority-number
     must be an integer in the range 0 through 255; the default for ADD is 0.
  • WITh/ALSo WITh/WITHOut (DISPLAY/PUNCH only)
    Includes or excludes the specified options when the named logical terminal 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 and DC OPTIONS specifications.
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
  • PUBLIC ACCESS
  • COMMENTS/DEFINITION/
    comment-key
  • WITHIN SYSTEM
  • DC OPTION
  • Related attributes
Logical-terminal/system relationships established by the system generation compiler are not affected.
Example
In the following example, the ADD statement registers logical terminal LTM26 within the system INVENTORY and associates LTM26 with physical terminal TM026. The MODIFY statement removes the logical terminal from the INVENTORY system and defines it as a component of a DC/UCF system.

add logical-terminal ltm26
    prepared by dba password is 'ice 9'
    within system inventory
        physical-terminal tm026.
 
modify logical-terminal ltm26
    revised by dba password is 'ice 9'
    exclude within system inventory
    dc option is physical-terminal tm026
    dc option is autotask code is reser9
    dc option is enabled
    dc option is priority is 15.