Previous Topic

Next Topic

Book Contents

Book Index

Automated Console Action Parameters: DO Statement

Automated Console Action parameters (DO statements) specify actions to be performed by Control-O. These actions are performed only after conditions specified in the Message/Event Selection parameters have been fulfilled.

DESCRIPTION                                                               

      ===========================================================================

      DO

At least one DO statement must be specified in a rule. Note that the DO IF, DO ELSE and DO ENDIF statements provide Boolean "IF" logic capability, allowing for alternative actions to be performed. Repetition logic is provided using the DO WHILE and DO ENDWHILE statements.

To insert an "empty" DO between two existing DO lines, type the > character over the first letter in the DO field of the first line (for example, DO >OMMAND), and press Enter.

To delete a DO statement, place the cursor on the first letter in the DO field and press the EOF key on your keyboard or blank the field.

A list of allowable DO options is displayed under the Automated Console Action parameters section of the Rule Definition screen. The OPTLIST command can be used to alternately hide or display this list. For more information, see "OPTLIST" in Commands of the Rule Definition Screen.

DOM Options

The following are a description and example of each of the DO statement options.

DO ASKOPER – Issue a WTOR (Write to Operator with Reply) message.

DESCRIPTION

==========================================================================

DO ASKOPER  = HAVE YOU NOTIFIED SHIFT SUPERVISOR ? REPLY 'YES' OR 'NO'

ROUTE       CONSOLEID 01 CONSOLE                           TIMEOUT 0030

DO

DO COMMAND – Issue a specified MVS, VTAM or MVS subsystem operator command.

DESCRIPTION

       ===========================================================================

DO COMMAND  = D A,CICSPROD

   WAIT        CONSOLEID    CONSOLE          SYSTEM

   WAITMODE   Y             WAITRESP Y            TIMEOUT

   RESPMSG

DO

DO COND – Add or delete a prerequisite condition. Prerequisite conditions are used to trigger events in Control-O or other INCONTROL products.

DESCRIPTION SIGNAL CONTROL-M THAT DB2 IS ACTIVE (AND NOT DOWN)

DESCRIPTION

===========================================================================

DO COND     = DB2-IS-ACTIVE        STAT +   DB2-IS-DOWN           STAT -

DO CTD REQ – Order or Force Control-D mission request.

DESCRIPTION

       ===========================================================================

DO CTD REQ  = MISSION MIS1     CAT                      DATE ODAT   FORCE Y

                LIBRARY LIB1                                              

DO CTOPCMSG – Specify a message to be sent to Control-M/Links for Windows NT.

DESCRIPTION

       ===========================================================================

DO SHOUT    = TO OPER2             URGENCY  R          SYSTEM CTO282I82I

   MESSAGE NON-CORRECTABLE I/O ERR ON MVSRES (UNIT=230). PAGE TECH-SUPPORT

DO CTOPCMSG = PAGE SYSPROG DATA-CHECK ON MVSRES (UNIT=230)

DO

DO DISPLAY – Control the display of the message on the console, or control the execution of a command.

DESCRIPTION

       =========================================================================== 

DO DISPLAY  = SUPPRESS Y ROUTE     DESC    CONSOLEID 01 CONSOLE

   SYSTEM                                                                  

   NEWTEXT

DO

DO DOM – Delete a highlighted, unrollable message from the display.

DO DISPLAY  = SUPPRESS N ROUTE     DESC    CONSOLEID    CONSOLE         

   SYSTEM                                                               

   NEWTEXT PLEASE MOUNT TAPE S89542 ON UNIT 480

DO SET      = %%NEWDOMID=%%$LDOMID                                 GLOBAL  N

DO WAIT     = REPLY                DOM Y             TIMEOUT 9999

   MESSAGE

DO DOM      = %%NEWDOMID

DO

DO ENDMSG – Delimit DO statements which are processed during message interception in command-response mode or for multi-line messages.

DESCRIPTION ===========================================================================

DO SET      = %%JSTAT = INACTIVE                                  GLOBAL  N

DO COMMAND  = D A,CICSPROD                                            

   WAIT        CONSOLEID    CONSOLE          SYSTEM                

   WAITMODE   Y             WAITRESP Y            TIMEOUT          

   RESPMSG                                                         

IF       %%$W2 %%$M* EQ CICSPROD

DO SET      = %%JSTAT = ACTIVE                                    GLOBAL  N

ENDIF

DO DISPLAY  = SUPPRESS A ROUTE     DESC    CONSOLEID    CONSOLE         

   SYSTEM                                                               

   NEWTEXT

ENDMSG

DO SHOUT    = TO OPER              URGENCY R SYSTEMCTO282I

   MESSAGE JOB CICSPROD IS %%JSTAT

DO

DO EXIT – Exit from a multi-line message block or a DO WHILE block.

===========================================================================

DO SET      = %%$MLLEND=NO                                        GLOBAL  N

DO COMMAND  = $DA                                              

   WAIT        CONSOLEID    CONSOLE          SYSTEM                       

   WAITMODE   Y             WAITRESP Y            TIMEOUT                 

   RESPMSG $HASP890     $HASP612                                          

IF       %%$MSGID EQ $HASP612                                             

DO SHOUT    = TO OPER              URGENCY R SYSTEM          CTO282I      

   MESSAGE SYSTEM IS IDLE                                                 

EXIT     MESSAGE                                                          

DO                                                                        

ENDIF                                                                     

ENDMSG                                                                    

DO                                                                        

===========================================================================

DO FORCEJOB – Force a job under Control-M.

=========================================================================== 

      DO FORCEJOB = TABLE   SMF      JOB CLEANSMF  UFLOW N    DATE ODAT

                    LIBRARY CTM.PROD.SCHEDULE                               

      DO

DO IF / DO ELSE / DO ENDIF – Provide Boolean "IF" logic capability allowing for alternative actions to be performed. Nesting levels can be displayed or hidden using the SHOWNEST command, described in SHOWNEST Command.

===========================================================================

DO DISPLAY  = SUPPRESS Y ROUTE     DESC    CONSOLEID    CONSOLE   

   SYSTEM                                                         

DO SHOUT    = TO OPER              URGENCY R SYSTEMCTO282I

   MESSAGE TSO IS BEING SHUT DOWN. SHIFT SUPERVISOR MUST BE NOTIFIED.

DO SET      = %%RC = 4                                            GLOBAL  N

   WHILE    %%RC NE# 0

DO ASKOPER  = HAVE YOU NOTIFIED SHIFT SUPERVISOR?  REPLY 'YES' OR 'CANCEL'

   ROUTE       CONSOLEID    CONSOLE                          TIMEOUT 0030

IF       (%%$ASKRC EQ# 4) AND ((%%$RPLYTXT EQ YES) OR (%%$RPLYTXT EQ CANCEL))

DO SET      = %%RC = 0                                            GLOBAL  N

   ENDIF

   ENDWHILE

   IF       %%$RPLYTXT EQ YES

DO COMMAND  = P TSO                                         

   WAIT        CONSOLEID    CONSOLE          SYSTEM       

   WAITMODE   N

ELSE

DO SHOUT    = TO OPER              URGENCY R SYSTEMCTO282I

   MESSAGE ACTION CANCELED

ENDIF

DO

DO KSL – Execute a KeyStroke OpenAccess (KOA) script.

DESCRIPTION

       ===========================================================================

DO SET      = %%FILENAME = FILE01                                 GLOBAL  N

DO SET      = %%FILESTAT = UNKNOWN                                GLOBAL  N

DO KSL      = CICSINQ %%FILENAME

   WAITMODE   Y                                      TIMEOUT         STOP Y

   INITPROC   CICSP          SHARELOC Y              IMMEDIATE Y

DO RESOURCE – Change the quantity of a Quantitative resource.

DESCRIPTION                                                                 

=========================================================================== 

DO RESOURCE = TAPE                 0001 +                                   

DO                                                                          

===========================================================================  

DO RETURN – Exit from the rule and return to the caller.

=========================================================================== 

IF       %%$V2 EQ  ''AAUTCNMI''                                           

DO SET      = %%STATUS_NLDM = UP                                  GLOBAL  Y

RETURN                                                                    

ENDIF                                                                     

IF       %%$V2 EQ  ''BNJDSERV''                                           

DO SET      = %%STATUS_NPDA = UP                                  GLOBAL  Y

ENDIF                                                                     

DO                                                                        

=========================================================================== 

DO RULE – Invoke another rule from within the current rule.

DESCRIPTION

===========================================================================

DO RULE     = GENALERT %%$JOBNAME %%ABEND                    OWNER  IOAADMIN

   TABLE               LIBRARY

DO

===========================================================================

DO SET – Assign a value to an AutoEdit variable.

DESCRIPTION

=========================================================================== 

DO SET      = %%IMS1_REPLY_ID = %%$REPLY                           GLOBAL  Y 

DO                                                                          

=========================================================================== 

DO SHELL – Run a z/OS shell script

DESCRIPTION

=========================================================================== 

DO SHELL    = /u/m66/myscript.ch                                            

   WAITMODE   N                                      TIMEOUT         STOP Y

   SHARELOC   N                                      IMMEDIATE N            

DO SHOUT   = TO OPER                    URGENCY R SYSTEM          CTO282I 

   MESSAGE Z/OS SCRIPT myscript.ch ENDED WITH RC=%%$SHELLRC  

DO

===========================================================================

DO SHOUT – Issue a message to a console, TSO user, ROSCOE user, IOA Log or Info/Management using the notification facility.

DESCRIPTION

=========================================================================== 

DO SHOUT    = TO TSO-DBA           URGENCY U SYSTEM                       CTO282I

   MESSAGE DB2 MASTER ABENDED - PLEASE CHECK!                              

DO                                                                          

===========================================================================

DO SMSCLASS – Assign an SMS class name to a new data set.

=========================================================================== 

DO SMSCLASS = ID 01 CLASS SMS_CLASS_01                                      

DO                                                                          

=========================================================================== 

DO SMSMSG – Define a message to be displayed in the job log for a new data set.

=========================================================================== 

DO SMSMSG   = ID 1  MESSAGE SMS MESSAGE                                     

DO                                                                          

=========================================================================== 

DO STOPJOB – Stop the execution of the next steps of the job under which the rule is executing.

DESCRIPTION

=========================================================================== 

DO STOPJOB

DO

===========================================================================

DO SYSREQ – Execute system programmer requests.

DESCRIPTION

===============================================================================

DO SYSREQ   = ENQINFO    STATUS OWNER      SCOPE ALL       JOBNAME

   QNAME      SYSDSN     RNAME %%DSNAME

DO

DO TERMINAT – Terminate the process of the triggering rule, and all called rules (if any), and continue to the next rule.

ON EVENT    = TERMINAT                                                     

OWNER N18A     GROUP                         MODE LOG     RUNTSEC          

THRESHOLD                                                                  

DESCRIPTION                                                                

===========================================================================

DO SET      = %%A=BEFORE CALL                                     GLOBAL  N

DO RULE     = TERMINAT                                      OWNER          

   TABLE               LIBRARY                                             

   SYSTEM              SHARELOC       TIMEOUT                              

DO SET      = %%A=AFTER CALL                                      GLOBAL  N

DO    

ON RULE     = TERMINAT                                                     

OWNER N18A     GROUP                         MODE LOG     RUNTSEC          

THRESHOLD                                                                  

DESCRIPTION                                                                

===========================================================================

DO SET      = %%A=CALLED RULE                                     GLOBAL  N

TERMINAT                                                                   

DO SET      = %%A=AFTER TERMINAT                                  GLOBAL  N

DO

DO TSO – Perform a TSO command, CLIST, or REXX procedure.

DESCRIPTION

===========================================================================

DO TSO      = LISTALC

   WAITMODE   Y                                      TIMEOUT         STOP Y

   INITPROC                  SHARELOC                IMMEDIATE N

DO SHOUT    = TO OPER              URGENCY R SYSTEMCTO282I

   MESSAGE CLIST LISTALC ENDED WITH RC=%%$TSORC    DESCRIPTION

DO

DO WAIT – Delay subsequent action until any of the specified events is completed.

DESCRIPTION

===========================================================================

DO DISPLAY  = SUPPRESS N ROUTE     DESC    CONSOLEID    CONSOLE      

   SYSTEM                                                            

   NEWTEXT PLEASE MOUNT TAPE S89542 ON UNIT 480

DO SET      = %%NEWDOMID=%%$LDOMID                                GLOBAL  N

DO WAIT     = REPLY                DOM Y             TIMEOUT 9999

   MESSAGE

DO DOM      = %%NEWDOMID

DO

DO WHILE / DO ENDWHILE – Provide repetition (loop) logic capability so that other DO actions can be performed repeatedly.

Nesting levels can be displayed or hidden using command SHOWNEST described in SHOWNEST Command.

DESCRIPTION

       ===========================================================================

  DO DISPLAY  = SUPPRESS Y ROUTE     DESC    CONSOLEID    CONSOLE      

     SYSTEM                                                            

  DO SHOUT    = TO OPER              URGENCY R SYSTEMCTO282I

     MESSAGE TSO IS BEING SHUT DOWN. SHIFT SUPERVISOR MUST BE NOTIFIED.

  DO SET      = %%RC = 4                                            GLOBAL  N

 WHILE    %%RC NE# 0

  DO ASKOPER  = HAVE YOU NOTIFIED SHIFT SUPERVISOR?  REPLY 'YES' OR 'CANCEL'

     ROUTE       CONSOLEID    CONSOLE                          TIMEOUT 0030

 IF       (%%$ASKRC EQ# 4) AND ((%%$RPLYTXT EQ YES) OR (%%$RPLYTXT EQ CANCEL))

  DO SET      = %%RC = 0                                            GLOBAL  N

 ENDIF

 ENDWHILE

 IF       %%$RPLYTXT EQ YES

  DO COMMAND  = P TSO                                         

     WAIT        CONSOLEID    CONSOLE          SYSTEM       

     WAITMODE   N

 ELSE

  DO SHOUT    = TO OPER              URGENCY R SYSTEMCTO282I

     MESSAGE ACTION CANCELED

 ENDIF

  DO

Parent Topic

Rule Definition Screen