CLIST System Task

The CLIST (command list) task executes a module of task statements. The module is called a command list module. Command list modules are often used to perform the following functions:
idmscu19
The CLIST (command list) task executes a module of task statements. The module is called a
command list module
. Command list modules are often used to perform the following functions:
  • Set up session defaults
    -- System administrators can define these command lists so that they are executed automatically when users sign on. Command lists invoked in this manner are identified in a profile associated with the user.
  • Perform commonly used operations
    -- Application developers, for example, can execute command list modules to vary areas offline or online, set up a test environment, or define programs for execution.
This article describes the following information:
Syntax
►►─── CLIST 
module-name
 ──────────────────────────────────────────────────────►  ►─┬──────────────────────────┬───────────────────────────────────────────────►    └─ VERsion 
version-number
 ─┘  ►─┬──────────────────────┬───────────────────────────────────────────────────►    └─ DICTNOde 
node-name
 ─┘  ►─┬────────────────────────────┬─────────────────────────────────────────────►    └─ DICTNAme 
dictionary-name
 ─┘  ►─┬──────────────┬───────────────────────────────────────────────────────────►◄    ├─ PROmpt ─────┤    └─ NOPrompt ◄──┘
Parameters
  • CLIST
    Specifies the command list module that contains the task statements to be executed.
    • module-name
      The name of the module.
  • VERsion
    Specifies the version number of the named command list module.
    • version-number
      The version number.
      By default, if you do not specify a version number, the highest existing version of the named module is used.
  • DICTNOde
    Specifies the node that controls the dictionary in which the requested module resides.
    • node-name
      The name of the node.
      By default, if you do not specify a node name, the default dictionary node established for your session is accessed. If a default node has not been established, the local node is accessed.
  • DICTNAME
    Specifies the data dictionary in which the requested module resides.
    • dictionary-name
      The name of the dictionary.
      By default, if you do not specify a dictionary, the default dictionary established for your session is accessed. If a default dictionary has not been established for your session, the default dictionary for the system is accessed.
  • PROmpt
    Stops system execution after each task is executed and displays the following prompt:
    PRESS ENTER TO CONTINUE, ANYTHING ELSE TO CANCEL
    In this case, you press Enter by itself to resume execution of the command list module. You press Clear or enter any character to cancel execution of the command list module.
  • NOPrompt
    Executes all the task statements in the command list module without stopping.
    This is the default.
Usage
Defining a command list module
To use the CLIST task, you must first define a command list module in the data dictionary by using the IDD MODULE statement.
To define the command list module
  1. Begin the module by specifying the module name and language (DC) as follows:
    add module 
    command-list-module-name
    language is dc
    Ensure that the module language is specified as DC.
  2. Code the module by specifying system and user task statements. The following rules apply to command list modules:
    • A command list module can contain any number of valid DC/UCF task statements, including another CLIST statement.
    • Command lists can be chained but not nested.
    • A CLIST command within a command list must be the last task statement in the module.
Invalid task statements
If an invalid task statement is encountered in the command list module at runtime, subsequent task statements are not executed.
Signon CLIST
To make the command list module a
signon CLIST
for a user, name the module as the value of the CLIST attribute in a user profile associated with the user.
The following sample CLIST task invokes the command list module named SETUP-LR1:
Vnnn ENTER NEXT TASK CODE:       CA IDMS release nn.n tape volser node nodename:   
clist setup-lrl1
The following is an example of the command list module, SETUP-LRL1:
add module name is setup-lrl1 language is dc module source follows dcuf set dictname devdict dcmt v d p dudxc1m qua . dcmt v d p cudx12mk qua . dcmt v d p cudxlimk pli qua . dcmt v d p cutest qua . dcmt v d t deptbye inv xxxdc5st inp . msend.
Invoking command list modules from programs
For more information about invoking command list modules from application programs, see Callable Services Reference.
Example
CLIST module-name
       APPLDICT-PROFILE       SET DBNAME EMPDB IDMS DC402009 V55 DBNAME EMPDB HAS BEEN SET       SET DICTNAME APPLDICT IDMS DC402009 V55 DICTNAME APPLDICT HAS BEEN SET       SET PRINT DESTINATION USWSWDP5 IDMS DC402009 V55 PRINT DESTINATION HAS BEEN SET
 
More Information
For more information about creating and storing command list modules, see the IDD DDDL Reference.