Dequeueing messages - command set


This example shows you how to build and execute a DEQUEUE command set to dequeue messages from multiple destinations.

For information about building the command set request library and creating command set members, see Building-and-executing-a-command-set-in-your-request-library.

The Message Advisor ISPF interface provides online help for all panels, pop-up panels, and fields. For information about accessing the online help system, see Online-help.

To dequeue a command set

  1. From the Message Advisor Primary Menu, perform the following steps:
    1. Type 1 in the choice entry field.
    2. Type a valid library name in the Request library field, and press Enter.The Member List panel is displayed.
  2. Add a new member by typing A in the Command area of the Member List panel.The Member List panel lets you add a new member or to select an existing member for update. After the command set is built and saved, you can also execute the command set from this panel.
  3. Press Enter.The Insert Command Set pop-up panel is displayed. This pop-up panel lets you select one of the Message Advisor base command sets.
  4. To select the DEQUEUE command set, type 2 in the choice entry field and press Enter.The DEQUEUE Command Set pop-up panel  is displayed.

    The DEQUEUE Command Set pop-up panel lets you access the options listed on the pop-up panel.This example goes through the pop-up panels sequentially. To go directly to a pop-up panel, type the number of the selection and press Enter.

    Warning

    Note

    Each pop-up panel tells you where you are in the series by displaying Page x of y in the upper right corner of the panel.

     File  Options  Samples  Session  Display  Help                               
     ------------------------------------------------------------------------------
       .-------------------------------------------------------------------------.  
     C |                          DEQUEUE Command Set                            |  
       | Command ===> _________________________________________________________  |  
     T |                                                                         |  
       | Description ___________________________________________________________ |  
       |                                                                         |  
       | Select one of the following.  Then press Enter.                         |  
    Ac |                                                                         |  
     _ | _  1. Processing options  - Specify what this dequeue should do         |  
     _ |    2. Misc. options       - Report, rate, force, exit options           |  
     _ |    3. Interval selection  - Restrict search based on time               |  
     _ |    4. Message selection   - Select or reject by dest, queue, etc.       |  
     _ |    5. Alternate output    - Output file specifications                  |  
     _ |                                                                         |  
     _ |    6. Exit                                                              |  
     _ |                                                                         |  
     _ |                                                                         |  
     _ |                                                                         |  
     _ |                                                                         |  
     _ |                                                                         |  
     _ |                                                                         |  
     _ '-------------------------------------------------------------------------'
  5. Type 1 in the choice entry field, and press Enter.The DEQUEUE Processing Options, Page 1 of 5 pop-up panel is displayed.

    This example shows how to dequeue all messages.

    .----------------------------------------------------------------------------.
    |                        DEQUEUE Processing Options                          |
    | Command ===> _____________________________________________________________ |
    |                                                                            |
    | Type options.  Then press Enter.                            Page  1 of 5   |
    |                                                                            |
    |   IMSID . . . . . . . . ?___ +                                             |
    |                                                                            |
    |   Processing mode . . . 1  1. Dequeue (delete) selected messages           |
    |                            2. Validate selected messages                   |
    |                            3. Dequeue and Unload messages                  |
    |                                                                            |
    |   Conversational message dequeue option (for Processing mode 1 only).      |
    |     2 1. ALL  - Both conversational and non-conversational messages        |
    |                 may be dequeued                                            |
    |       2. NONE - No conversational messages may be dequeued                 |
    |       3. ONLY - Only conversational messages may be dequeued               |
    |                                                                            |
    |   Rewrite type (for Processing mode 3 only).                               |
    |     _ 1. Rewrite by block   (faster)                                       |
    |       2. Rewrite by message (more precise)                                 |
    |                                                                            |
    |                                                                            |
    '----------------------------------------------------------------------------'
  6. Define the DEQUEUE processing options by performing the following steps:
    1. Verify that the IMSID in the IMSID field is accurate.
    2. If it is not already displayed, type 1 in the Processing mode field.
    3. To indicate whether any active or held conversational messages should be dequeued, type the option number in the Conversational message dequeue option field. Possible values are:

      • ALLBoth conversational and non-conversational messages may be dequeued.
      • NONE—Conversational messages will not be dequeued . This value is the default value.
      • ONLYOnly conversational messages may be dequeued (non-conversational messages are not dequeued).

      Regardless of the option chosen for this field, only messages which match the other selection criteria will be dequeued.

    4. Press Enter.The DEQUEUE Misc. Options, Page 2 of 5 pop-up panel is displayed.

      The Summary and Detail reports provide a summary of the messages dequeued and details of the messages dequeued by destination. For more information about reports, see Message-Advisor-reports.

        .-------------------------------------------------------------------------.   
        |                         DEQUEUE Misc. Options                           | -
        | Command ===> _________________________________________________________  |  
        |                                                          Page  2 of 5   |  
        |                                                                         |  
        | Select (type a '/') one or more reports to print.                       |  
        |   / Summary report                                                      |  
        |   / Destination report of messages dequeued                             |  
        |   _ DRRN detail report (overrides destination report)                   |  
      A |                                                                         |  
        | Force option. Specify how to force dequeuing from active CNTs.          |  
        |   2 1. NO    - Do not dequeue if LTERM is active                        |  
        |     2. YES   - Attempt dequeue even if LTERM is active                  |  
        |     3. RESET - Stop inactive LTERMs before dequeue and restart after    |  
        |     4. STOP  - Stop before dequeue                                      |  
        |     5. RESET ACTIVE - Stop active LTERMs before dequeue and restart     |  
        |     6. RESET ALL - Stop and restart all LTERMs matching selection       |  
        |     7. STOP ALL  - Stop all LTERMs matching selection                   |  
        |                                                                         |  
        | Maximum dequeue activity rate  ________ per minute                      |  
        |                                                                         |
  7. Select the appropriate options on the DEQUEUE Misc. Options pop-up panel by performing the following steps:
    1. Select to print the Summary report and Destination report of messages dequeued.
    2. Type 2 in the Force option field.

      Warning

      Note

      To dequeue an active destination, you must specify the Force option as 2. For a list of destinations that must be stopped before they can be dequeued and for a list of restricted destinations that are not valid with the Force option, see Restrictions.

    3. Press Enter.The DEQUEUE Interval Selection, Page 3 of 5 pop-up panel is displayed.

      .-----------------------------------------------------------------------------.
      |                         DEQUEUE Interval Selection                          |
      | Command ===> ____________________________________________ Scroll ===> PAGE  |
      |                                                                             |
      | Type one or more action codes, if desired.                   Page  3 of 5   |
      |   I=Insert   D=Delete                                        Line 00 of 00  |
      |                                                                             |
      |   Type time intervals to restrict which messages are to be selected.        |
      |                                                                             |
      |     -----Start Time------ ------Stop Time------  OR  Newer Than  Older Than |
      | Act YYYYDDD HHMMSST SHHMM YYYYDDD HHMMSST SHHMM      nnn Days    nnn Days   |
      |  _                                                                          |
      |  _ _______ _______ _____ _______ _______ _____        ___         ___       |
      |  _ _______ _______ _____ _______ _______ _____        ___         ___       |
      |  _ _______ _______ _____ _______ _______ _____        ___         ___       |
      |  _ _______ _______ _____ _______ _______ _____        ___         ___       |
      |  _ _______ _______ _____ _______ _______ _____        ___         ___       |
      |  _ _______ _______ _____ _______ _______ _____        ___         ___       |
      |  _ _______ _______ _____ _______ _______ _____        ___         ___       |
      |  _ _______ _______ _____ _______ _______ _____        ___         ___       |
  8. Determine whether to define time intervals to restrict message selection.For this example, leave this pop-up panel blank.

    Time intervals may be specified only if you selected a processing mode of dequeue and unload messages, option 3, on the DEQUEUE Processing Options, Page 1 of 5 pop-up panel (Figure 2). Additionally, specifying time intervals is optional, even if you specified option 3 as the display type.

  9. Press Enter.The DEQUEUE Message Selection, Page 4 of 5 pop-up panel is displayed.

    .-------------------------------------------------------------------------.    
    |                       DEQUEUE Message Selection                         | --
    | Command ===> ________________________________________ Scroll ===> PAGE  | .  
    |                                                                         | |  
    | Type one or more action codes, if desired.               Page  4 of 5   | |  
    |   I=Insert   D=Delete   S=Edit keyword values            Line 00 of 02  | |  
    |                                                                         | |  
    |   Type values on one line to 'AND'.  Use separate lines to 'OR'.        | |  
    |                                  Destination               More         | |  
    | Act Function  Label  Destination    Type         Origin  Keywords?      | |  
    |  _                                                                      | |  
    |  _  SELECT ________   CAT*____   ALL________    ________                | |  
    |  _  REJECT ________   ________   ___________    ________                | |  
    |  _  ______ ________   ________   ___________    ________                | |  
    |  _  ______ ________   ________   ___________    ________                | |  
    |  _  ______ ________   ________   ___________    ________                | |  
    |  _  ______ ________   ________   ___________    ________                | |  
    |  _  ______ ________   ________   ___________    ________                | |  
    |  _  ______ ________   ________   ___________    ________                | |  
    |  _  ______ ________   ________   ___________    ________                | |
  10. Define the DEQUEUE message selection criteria by performing the following steps:

    Warning

    Note

    You can specify as many SELECT and REJECT subcommands as you need to dequeue from multiple destinations, queues, and destination types.

    The Origin field should not be used when the processing mode is dequeue and unload messages.

    1. Type S or I in the Act field.
    2. In the Function field, type SELECT or REJECT.
    3. Type a user-defined name or label (up to eight characters) for the statement in the Label field.The default labels will be SEL00001 and REJ00001 for the first SELECT and REJECT statements with the number incrementing for each type of statement.
    4. Type a destination valid for your site in the Destination field.
    5. Type a valid destination type in the Destination type field.

      Warning

      Note

      Masking is allowed in several fields: ? replaces one character in a multi-character string; * replaces the rest of the string.

    6. Press Enter.The DEQUEUE Message Keyword Selection pop-up panel is displayed.

      .-----------------------------------------------------------------------------.
      |                      DEQUEUE Message Keyword Selection                      |
      | Command ===> ______________________________________________________________ |
      |                                                                             |
      | Label ________ Subcommand SELECT                                            |
      |                                                                             |
      | Type one or more action codes, if desired.                                  |
      |   S=Edit value       D=Set default value                                    |
      | Act Keyword      Value                                                      |
      |                                                                More:     +  |
      |  _ DESTination=                   Destinations or masks                     |
      |  _ DRRN=                          Device relative record number             |
      |  _ DESTYpe=     ALL               Destination type                          |
      |  _ RCNT=                          Remote CNTs or masks                      |
      |  _ PSB=                           Transactions associated with PSBs         |
      |  _ DBD=                           Transactions associated with DBDs         |
      |  _ NODENAME=                      VTAM nodenames or masks                   |
      |  _ LUname=                        LU names or masks                         |
      |  _ USERID=                        Userids or masks                          |
      |  _ MFSNAME=                       MFS names or masks                        |
      |  _ ORIGin=                        Origins or masks                          |
      |  _ PIMS=                          IMSIDs or masks                           |
      |  _ OIMS=                          IMSIDs or masks                           |
      '-----------------------------------------------------------------------------'
    7. Perform one of the following steps:
      • To access the pop-up panel so you can edit the value for each keyword that you want to specify on the SELECT or REJECT statement, type S in the Act field. Press END to exit each pop-up panel.
      • To clear the value for each keyword that you want to specify on the SELECT or REJECT statement, type D in the Act field.
      • To scroll through the list of available keywords, press F8.
    8. Press END.The DEQUEUE Message Selection panel, Page 4 of 5 menu is displayed.
    9. Press Enter.The DEQUEUE Output Data Set Options, Page 5 of 5 pop-up panel is displayed.

      .-----------------------------------------------------------------------------.
      |                      DEQUEUE Output Data Set Options                        |
      | Command ===> _____________________________________________________________  |
      |                                                                             |
      | Select (type a '/') to see more allocation options.           Page  5 of 5  |
      |                                                                             |
      | _ Output file.                                                              |
      |     Data set name ______________________________________________________    |
      |       or DDname . ________                                                  |
      |     Disposition . _ 1.New  2.Mod  3.Old                                     |
      |     Generic unit  ________ Primary quantity ________ cylinders              |
      |                                                                             |
      |                                                                             |
      |                                                                             |
      |                                                                             |
      |                                                                             |
      |                                                                             |
      |                                                                             |
      |                                                                             |
      |                                                                             |
      |                                                                             |
  11. Define the DEQUEUE output data set options by performing the following steps.
    1. Type a slash (/) in the Output file field, and press Enter.The DEQUEUE Data Set Allocation Options pop-up panel is displayed.

      .-- .-------------------------------------------------------------------------.
      |   |                  DEQUEUE Data Set Allocation Options                    |
      | C | Command ===> _________________________________________________________  |
      |   |                                                                         |
      | S | Data set information.                                                   |
      |   |   Data set name  ______________________________________________________ |
      | / |       or DDname  ________                                               |
      |   |   Disposition  . _ 1.New  2.Mod  3.Old                                  |
      |   |   Append . . . . ___ (YES or NO)                                        |
      |   |   Model after  . ____________________________________________           |
      |   |   Volume serial  ______      _ Specify multiple volumes                 |
      |   |   Generic unit . ________                                               |
      |   |                                                                         |
      |   | Space information.                                                      |
      |   |   Primary qty  . ________ cylinders                                     |
      |   |   Secondary qty  ________ cylinders                                     |
      |   |   Block size . . _____                                                  |
      |   |                                                                         |
      |   | SMS information (for SMS managed data set).                             |
      |   |   SMS Mgmt class ________                                               |
      |   |   SMS Stg class  ________                                               |
      |   |   SMS Data class ________                                               |
      |   |                                                                         |
      '-- '-------------------------------------------------------------------------'
    2. Edit the fields, described in the following table, as necessary:

      Field Name

      Description

      Data set name

      Type the name of the output data set that is being allocated. If you are specifying a DDname, leave the Data set name blank.

      or DDname

      Type the DDname which indicates a pre-allocated output data set that is to be used. If you are specifying a DDname, leave all other fields blank.

      Disposition

      Type the option number in the selection field to indicate the disposition of the output data set being allocated. Possible values are:

      • A new output data set will be allocated.
      • If the named output data set exists, it will be used. If it does not exist, a new output data set will be allocated.
      • The named output data set already exists.

      The default value for this field is 3.

      Append

      Type the appropriate value to indicate whether data is to be appended to the output data set or not. Possible values are:

      • YES—Append new data to the output data set.
      • NO—Replace, or overwrite, the old data with the new data in the output data set.

      If the Disposition field value is 2. Mod, the default value for this field is YES. If the Disposition field value is 3. Old, the default value for this field is NO.

      Model after

      Specify the name of the existing data set whose attributes you want to copy for the output data set being allocated.

      Volume serial

      Specify the DASD volume serial (VOLSER) where this output data set will be allocated.

      Specify multiple volumes

      Type a slash (/) in this field and press Enter to access the Volume List pop-up panel where you specify multiple DASD volume serials (VOLSERs) for the data set. Press END to return to the DEQUEUE Data Set Allocation Options pop-up panel.

      Generic unit

      Type the generic unit name to be used for data set allocation. Generic names (also referred to as esoteric) are given to groups, or pools of DASD volumes. Some common generic/esoteric names are SYSDA, SYSALLDA, and SCRATCH.

      Primary quantity

      Specify the number of cylinders to be used for the output data set allocation.

      Secondary quantity

      Specify the number of cylinders to be used for the output data set allocation.

      Block size

      Specify the DASD block size to be used for the output data set allocation.

      SMS Mgmt class

      Specify the SMS Management class to be used for this output data set allocation. This field is not required unless your installation requires SMS to be used.

      SMS Stg class

      Specify the SMS Storage class to be used for this output data set allocation. This field is not required unless your installation requires SMS to be used.

      SMS Data class

      Specify the SMS Data class to be used for this output data set allocation. This field is not required unless your installation requires SMS to be used.

    3. Press END.The DEQUEUE Output Data Set Options, Page 5 of 5 pop-up panel (DEQUEUE Output Data Set Options panel, Page 5 of 5) is displayed.
    4. Press Enter.The Confirm Changes pop-up panel is displayed.
  12. In the choice entry field of the Confirm Changes pop-up panel, type 1, Accept changes, and press Enter.The Command Sets panel is displayed. This panel lets you name the command set and enter title information describing the command set.

     File  Options  Session  Display  Help                                        
    ------------------------------------------------------------------------------
                       Command Sets - bmcnode.MAQ.REQUEST
    Command ===> ________________________________________________ Scroll ===> PAGE
                                                                                  
    Member   ________                                                              
    Title. . ______________________________________________________________________
                                                                                  
    Type one or more action codes.  Then press Enter.                              
      S=Select for update   I=Insert   D=Delete                    Line 000 of 001
                                                                                 
    Action  Command Set Description                                                
       _     ***************************** TOP OF DATA *****************************
       _     DEQUEUE
  13. (optional) Name the command set and add a description by performing the following steps:
    1. (optional) Type the name of the command set in the Member field.If you name the command set, fields on the following pop-up panel are populated.
    2. (optional) Type a description in the Title field, and press END.The Confirm Save pop-up panel is displayed.
  14. Confirm that you want to create and save a new member by performing the following steps:
    1. If you did not specify the name on the previous pop-up panel, type a member name in the Create new member field.
    2. If it is not already displayed, type 2 in the choice entry field.If you named the command set on the command sets pop-up panel, a 2 is displayed in the choice entry field and the member name is carried forward to this pop-up panel.
    3. Press Enter.The Member List panel  is displayed.

       File  Options  Samples  Session  Display  Help                               
      ------------------------------------------------------------------------------
                          Member List - bmcnode.MAQ.REQUEST
      Command ===> ________________________________________________ Scroll ===> PAGE
                                                                                    
      Type one or more action codes.  Then press Enter.             Row 0021 of 0022
        S=Update member   Q=Execute interactively  D=Delete  B=Browse                
        A=Add new member  X=Execute in batch       R=Rename  E=Edit                  
                                                                           More: -  
      Act Name     Prompt          Size    Created           Changed            ID    
       _ SAMPDQ   ________            3   2001/08/22   2001/08/22 15:33:58    USERID
       _ UNL0003  ________            7   2001/05/30   2001/05/30 12:27:52    USERID
      **End**
  15. View the command set and edit it, if necessary, by performing the following steps:
    1. Type E in the Act field.From the Member List panel, you can edit and/or execute the member that you just created. You can also select the member for update from the Member List panel and change the options and defaults on the respective pop-up panels by using the Message Advisor ISPF interface.
    2. Press Enter.The new command set is displayed.

      This panel shows you the command set built with the preceding panels and pop-up panels selecting a single destination on the DEQUEUE Processing Options pop-up panel. You can edit this command set on this panel and save the changes. You can also select the command set from the Member List panel and change the command set by using the Message Advisor ISPF interface.

       File  Edit  Edit_Settings  Menu  Utilities  Compilers  Test  Help            
      -------------------------------------------------------------------------------
      EDIT       bmcnode.MAQ.REQUEST(SAMPDQ) - 01.00                     Columns 00001 00072
      ****** ***************************** Top of Data ******************************
       000010 DEQUEUE        IMSID=R61P,FORCE=YES
       000020    SELECT      DESTINATION=CAT*,QUEUE=ALL,DESTYPE=ALL
       000030 END
      ****** **************************** Bottom of Data ****************************
  16. Review the command set and edit as needed.
  17. Press END.The Member List panel is displayed.
  18. To execute the command set, type Q in the Act field of the Member List panel and press Enter.The Confirm Execute pop-up panel is displayed.
  19. If 1 is not already displayed in this field, confirm execution by typing 1 in the choice entry field of the Confirm Execute pop-up panel and pressing Enter.Message Advisor executes the request and then displays several status panels that indicate the status of the DEQUEUE request that you just executed. The Waiting pop-up panel, which is the first in a series of status and selection list panels, is displayed.

    Warning

    Note

    When the Waiting pop-up panel is first displayed and how often it is displayed are determined by the Session Control option settings. For more information about setting these options, see Session-Control.

    The Waiting pop-up panel remains displayed while the dequeue runs. You do not have to press any keys or type any commands while this pop-up panel is displayed; it automatically scrolls to the Request Status pop-up panel, shown below.

     File  Options  Samples  Session  Display  Help                               
     ------------------------------------------------------------------------------
       .-------------------------------------------------------------------------.  
     C |                             Request Status                              |  
       | Command ===> ________________________________________ Scroll ===> PAGE  |  
     T | BMC43868 Request complete.  Press Enter for report options.             |  
       | Use the scroll actions/keys to view the messages.                       |  
       | Then press Enter to continue.                                           |  
       |                                                                         |  
    Ac | Request for Server QJER:                    Highest condition code: 00  |  
     _ |   16:26:34 bmcnode.MAQ.REQUEST(SAMPDQ)                                  |  
     _ |                                                        Line 001 of 004  |  
     _ | Significant messages:                                                   |  
     _ | BMC43077I DEQUEUE IN PROGRESS FOR USERID (TASK 9)                       |  
     Q | BMC43076I DEQUEUE FOR USERID (TASK 9) IMS(R61P) ENDED, RC=00            |  
     _ |                                                                         |  
     _ |                                                                         |  
       |                                                                         |  
       |                                                                         |  
       |                                                                         |  
       |                                                                         |  
       '-------------------------------------------------------------------------'
  20. Review the messages on the Request Status pop-up panel.This pop-up panel displays the status of the requested process by showing any significant messages. You can view an explanation about any message on the panel by placing the cursor on the message and by pressing F4 (PROMPT).

    If this pop-up panel shows a condition code other than 00, review the messages and reports from the Browse Results pop-up panel (see the following figure) to determine the problem.

  21. Press Enter.The Request Results pop-up panel is displayed.
  22. To view the DEQUEUE report, type 1 in the choice entry field on the Browse Results pop-up panel and press Enter.The Browse Results pop-up panel is displayed.

    .-----------------------------------------------------------------------------.
    |                               Browse Results                                |
    | Command ===> ____________________________________________ Scroll ===> PAGE  |
    |                                        Line 000000 of 000027  Cols 001 075  |
    |                                                              More:     + >  |
    | ****************************** Top of Data ******************************** |
    | BMC43077I DEQUEUE IN PROGRESS FOR USERID (TASK 9)                           |
    | >>>>DEQUEUE        IMSID=R61P                                               |
    | >>>>   SELECT      DESTINATION=CAT*,DESTYPE=ALL                             |
    | >>>>END                                                                     |
    |                                                                             |
    |  Message Advisor for IMS V1.0.02  - Server ID QJER       08/22/2001.234 16. |
    |  Dequeue Statistics Summary for IMSID R61P                                  |
    |                                                                             |
    |  Total Number of Destinations Selected             3                        |
    |  Total Number of Messages Dequeued....           140                        |
    |  Total Number of Destinations in Error             0                        |
    |                                                                             |
    |                                                                             |
    |                                                                             |
    |  Message Advisor for IMS V1.0.02  - Server ID QJER                          |
    |  Dequeue Destination Report for IMSID R61P                                  |
    |                                                                             |
    |   DESTINATION    TYPE  #MSG DEQ.  Q# FIRST/LAST DRRN   LU/TPIPE   STATUS    |
    |  --------------- ----- ---------  -- --------/-------- -------- ----------- |
    |  CATTLE          CNT-V        10   4 08000705/0800070E          00-DEQUEUE  |
    |  CATLIKE         CNT-V         1   3 040009A5                   00-DEQUEUE  |
    |                              109   4 040009BB/04000A27                      |
    |  CATS0001        CNT-V        20   4 040009A7/040009BA          00-DEQUEUE  |
    |                                                                             |
    | BMC43076I DEQUEUE FOR USERID (TASK 9) IMS(R61P) ENDED, RC=00                |
    | ***************************** Bottom of Data ****************************** |
    '-----------------------------------------------------------------------------'
  23. Review the messages by performing the following steps:
    1. Ensure that the DEQUEUE status code is 00.If this pop-up panel shows a status code other than 00, see the BMC Documentation Center for an explanation about the error codes.
    2. Press END.The Primary Menu is displayed.

      This step completes the sample task of dequeueing all messages from one destination.


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

Message Advisor for IMS 1.7