CA IDMS Reference 19.0

PDF
English

QUEUE

QUEUE statements document the manner in which a teleprocessing system groups similar requests. In the DC/UCF environment, the QUEUE statement can specify the name of a task to be invoked when the queue contains a certain number of entries. When the specified number of entries is reached, the system initiates the required task and processes the queued records.
idmscu19
QUEUE statements document the manner in which a teleprocessing system groups similar requests. In the DC/UCF environment, the QUEUE statement can specify the name of a task to be invoked when the queue contains a certain number of entries. When the specified number of entries is reached, the system initiates the required task and processes the queued records.
It is recommended that you maintain QUEUE 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 QUEUE statements.
This article describes the following information:
2
2
Syntax
QUEUE Statement
 

 
►►─┬─ ADD ─────┬─ QUEue name is 
queue-name
 ───────────────────────────────────►
   ├─ MODify ──┤
   ├─ REPlace ─┤
   └─ DELete ──┘
 ►─┬────────────────────────────────────────────┬─────────────────────────────►
   └─ Version is ─┬─ 
version-number
 ──────────┬─┘
                  └─┬─────────┬─┬───────────┬─┘
                    └─ NEXt ──┘ ├─ HIGhest ─┤
                                └─ LOWest ──┘
 ►─┬────────────────────────────────────────────────────────┬─────────────────►
   └─┬─ PREpared ─┬─ by 
user-id
 ─┬────────────────────────┬─┘
     └─ REVised ──┘              └─ PASsword is 
password
 ─┘
 ►─┬──────────────────────────────────────────┬───────────────────────────────►
   └─ queue 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 ────────┘
   ──────────────────────────────────────────────────────────────────────────┐
 ─►─────────────────────────────────────────────────────────────────────────┬┴─►
─┬─────────────────────────────────────────────────────────────────────┬─┘
 └─ threshold TASk is 
task-name
 ─┬───────────────────────────────────┬─┘
                                 └─ Version is ─┬─ 
version-number
 ─┬─┘
                                                ├─ HIGhest ────────┤
                                                └─ LOWest ─────────┘
   ┌────────────────────────────────────────────────────────────────────────┐
 ►─▼─┬─────────────────────────────────────────────────────────────────────┬┴─►
     └┬─ INClude ◄ ┬─ 
class-name
 is 
attribute-name
 ─┬─────────────────────┬┘
      └─ EXClude ──┘                                └─ TEXt is 
user-text
 ─┘
   ┌──────────────────────────────────────────────────────────────────────────
 ►─▼─┬────────────────────────────────────────────────────────────────────────►─
     └─ DC option is ─────────────────────────────────────────────────────────
   ──────────────────────────────────────────────────────────────────────┐
 ─►────────────────────────────────────────────────────────────────────┬─┴─────►
   ─┬─ THReshold is ─┬─ 1 ◄ ───────────────┬────────────────────────┬──┘
    │                └─ 
queue-entry-count
 ─┘                        │
    ├─ UPPer limit is ─┬─ 0 ◄ ─────────────────┬────────────────────┤
    │                  └─ 
maximum-entry-count
 ─┘                    │
    ├─ threshold TASk is 
task-name
 ─┬─────────────────────────────┬─┤
    │                               └─ Version is 
version-number
 ─┘ │
    └─┬─ ENAbled ◄ ─┬───────────────────────────────────────────────┘
      └─ DISabled ──┘
   ┌───────────────────────────────────────────────────────────────┐
 ►─▼─┬───────────────────────────────────────────────────────────┬─┴──────────►
     │                            ┌────────────────────┐         │
     └─ EDIt ─┬─ COMments ────┬───▼─ edit-instruction ─┴─ QUIT ──┘
              ├─ DEFinition ──┤
              └─ 
comment-key
 ─┘
   ┌──────────────────────────────────────────────────┐
 ►─▼─┬─────────────────────────────────────────────┬──┴───────────────────────►◄
     └─┬─ COMments ─────┬── is ─┬─ NULl ─────────┬─┘
       ├─ DEFinition ───┤       └─ 
comment-text
 ─┘
       └─ 
comment-key
 ──┘
DISPLAY/PUNCH QUEUE Statement (for a single queue)
 

►►─┬─ DISplay ─┬─ QUEue name is 
queue-name
 ───────────────────────────────────►
   └─ PUNch ───┘
 ►─┬───────────────────────────────────┬──────────────────────────────────────►
   └─ 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 ──────────────────────┤
                          ├─┬─ SYStems ─────┬───────────┤
                          │ └─ SUBSYstems ──┘           │
                          ├─ TASks ─────────────────────┤
                          ├─ 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 QUEUE Statement (for multiple queues)
 

►►─── DISplay ──┬─ ALL ──────────────────────────┬─ QUEues ───────────────────►
                └─┬─ 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
  • QUEue name is
    queue-name
    Identifies a new queue to be established in the dictionary, or an existing queue to be modified, replaced, deleted, displayed, or punched.
    Queue-name
     must be a 1- through 16-character alphanumeric value.
  • within SYStem
    system-name
    Associates (INCLUDE) the queue with or disassociates (EXCLUDE) it from the named system.
    System-name
     must be a 1- through 32-character value. The WITHIN SYSTEM clause is documentation only, unless the system generation compiler COPY facility is to be used to copy all queues from an IDD-built system. When the COPY facility is not used, functional queue/system relationships are established and maintained by the system generation compiler.
    If INCLUDE is specified and the THRESHOLD TASK parameter is omitted, the DDDL compiler establishes a new queue/system relationship. If EXCLUDE is specified and the THRESHOLD TASK parameter is omitted, the DDDL compiler removes the queue/system relationship and any dependent task/queue relationships.
  • threshold TASk is
    task-name
    Associates an established task with the queue/system relationship.
    Task-name
     must reference a task that is associated with the named system. The teleprocessing monitor invokes the named task when the queue contains a specified number of entries. In DC/UCF environments, this specification is documentation only; use the THRESHOLD TASK parameter in the DC OPTION clause (described below), or define the threshold task directly via the system generation compiler.
  • DC option is
    Documents queue characteristics used by the system generation compiler.
  • THReshold is 1/
    queue-entry-count
    Specifies the number of queue entries required before a task is initiated to process the queue entries.
    Queue-entry-count
     must be an integer in the range 1 through 32,767; the default for ADD is 1.
  • UPPer limit is 0/
    maximum-entry-count
    Specifies the maximum number of records that can be directed to the queue. This specification is useful in a test environment to prevent looping programs from using all the space in the queue.
    Maximum-entry-count
     must be an integer in the range 0 through 32,767; the default for ADD is 0. If 0 is specified, no checking is performed.
  • threshold TASk is
    task-name
    Identifies the task to be invoked when the specified queue threshold is reached.
    Task-name
     must identify an existing task. If specified, the VERSION parameter must identify an explicit number associated with the task; a version of HIGHEST or LOWEST is not acceptable.
  • ENAbled
    Automatically enables the queue at system startup. ENABLED is the default.
  • DISabled
    Automatically disables the queue until it is enabled explicitly by an operator command during system execution.
  • WITh/ALSo WITh/WITHOut
    Includes or excludes the specified options when the named queue 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 OPTION 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
System/queue relationships established by the system generation compiler are not affected.
Example
In the following example, the ADD statement defines the queue REG-IN within the system REGIST and names RUPDT as the threshold task. The MODIFY statement removes REG-IN from the REGIST system in preparation for use by the DC/UCF system.

add queue reg-in
    description is 'registration input'
    within system regist
    threshold task is rupdt.
 
modify queue reg-in
    exclude within system regist
    dc option threshold task is rupdt
    dc option threshold is 3
    dc option upper limit is 9.