Unloading messages command set


This example shows how to build and execute an UNLOAD command set that unloads 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.

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 unload a message command set

  1. On the Message Advisor Primary Menu panel, 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. Select the UNLOAD command set by performing the following steps:
    1. Type 3 in the choice entry field of the Insert Command Set pop-up panel.
    2. Press Enter.The UNLOAD Command Set pop-up panel  is displayed.

       File  Options  Samples  Session  Display  Help                               
       ------------------------------------------------------------------------------
         .-------------------------------------------------------------------------.  
       C |                          UNLOAD Command Set                             |  
         | Command ===> _________________________________________________________  |  
       T |                                                                         |  
         | Description ___________________________________________________________ |  
         |                                                                         |  
         | Select one of the following.  Then press Enter.                         |  
      Ac |                                                                         |  
       _ | _  1. Processing options  - Specify what this unload 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                  |

      The UNLOAD 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.

      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.

  5. Type 1 in the choice entry field, and press Enter.The UNLOAD Processing Options, Page 1 of 5 pop-up panel is displayed.

    This example shows how to unload messages for a specified destination.

    .----------------------------------------------------------------------------.
    |                        UNLOAD Processing Options                           |
    | Command ===> ___________________________________________ Scroll ===> PAGE  |
    |                                                                            |
    | Type options.  Then press Enter.                            Page  1 of 5   |
    |                                                                            |
    |   IMSID . . . . . . . . ?___ +                                             |
    |                                                                            |
    |   Conversational message unload option                                     |
    |     2 1. ALL  - Both conversational and non-conversational messages        |
    |                 may be unloaded                                            |
    |       2. NONE - No conversational messages may be unloaded                 |
    |       3. ONLY - Only conversational messages may be unloaded               |
    |                                                                            |
    |                                                                            |
    |                                                                            |
    |                                                                            |
    '----------------------------------------------------------------------------'
  6. Type the IMSID in the IMSID field, and press Enter.The UNLOAD Misc. Options, Page 2 of 5 pop-up panel is displayed.

    .-------------------------------------------------------------------------.   
      |                         UNLOAD Misc. Options                            | -
      | Command ===> _________________________________________________________  |  
      |                                                          Page  2 of 5   |  
      |                                                                         |  
      | Select (type a '/') one or more reports to print.                       |  
      |   / Summary report                                                      |  
      |   / Destination report of messages unloaded                             |  
      |   _ DRRN detail report (overrides destination report)                   |  
    A |                                                                         |  
      | Force option. Specify how to force unloading from active CNTs.          |  
      |   2 1. NO    - Do not unload if LTERM is active                         |  
      |     2. YES   - Attempt unload even if LTERM is active                   |  
      |     3. STOP  - Stop before unload                                       |  
      |     4. RESET - Stop before unload and restart after unload              |  
      |                                                                         |  
      | Maximum unload activity rate  ________ per minute                       |  
      '-------------------------------------------------------------------------'
  7. Type the option number in the Conversational message unload option field that indicates whether any active or held conversational messages should be unloaded. Possible values are:

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

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

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

  8. Select the appropriate options on the UNLOAD Misc. Options pop-up panel by performing the following steps:
    1. Select to print the Summary report and Destination report of messages unloaded.
    2. Type 2 in the Force option field.

      Note

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

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

      .-----------------------------------------------------------------------------.
      |                         UNLOAD 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   |
      |  _                                                                          |
      |  _  _______ _______ _____ _______ _______ _____       ___         ___       |
      |  _  _______ _______ _____ _______ _______ _____       ___         ___       |
      |  _  _______ _______ _____ _______ _______ _____       ___         ___       |
      |  _  _______ _______ _____ _______ _______ _____       ___         ___       |
      |  _  _______ _______ _____ _______ _______ _____       ___         ___       |
      |  _  _______ _______ _____ _______ _______ _____       ___         ___       |
      |  _  _______ _______ _____ _______ _______ _____       ___         ___       |
      |  _  _______ _______ _____ _______ _______ _____       ___         ___       |
  9. Determine whether to define time intervals to restrict message selection.For this example, leave this pop-up panel blank.
  10. Press Enter.The UNLOAD Message Selection, Page 4 of 5 pop-up panel is displayed.

    .-------------------------------------------------------------------------.    
    |                       UNLOAD 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*____   ___________    ________                | |  
    |  _  REJECT   ________ ________   ___________    ________                | |  
    |  _  ______   ________ ________   ___________    ________                | |  
    |  _  ______   ________ ________   ___________    ________                | |  
    |  _  ______   ________ ________   ___________    ________                | |  
    |  _  ______   ________ ________   ___________    ________                | |  
    |  _  ______   ________ ________   ___________    ________                | |  
    |  _  ______   ________ ________   ___________    ________                | |  
    |  _  ______   ________ ________   ___________    ________                | |

    On this panel, you can specify multiple destinations, origins, queues, and destination types by using the SELECT and REJECT subcommands.

  11. Define the UNLOAD message selection criteria by performing the following steps:
    1. Type S or I in the Act field.
    2. In the Function field, type SELECT or REJECT.
    3. In the Label field, type a user-defined name or label (up to eight characters) for the statement.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. In the Destination field, type a destination valid for your site.
    5. In the Destination type field, type a valid destination type.

      Note

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

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

      .-----------------------------------------------------------------------------.
      |                      UNLOAD 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 actions:
      • To access a 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. To exit the pop-up panel, press END.
      • 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 UNLOAD Message Selection, Page 4 of 5 panel is displayed.
    9. Press Enter.The UNLOAD Output Data Set Options, Page 5 of 5 pop-up panel is displayed.

      .-----------------------------------------------------------------------------.
      |                      UNLOAD 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              |
      |                                                                             |
  12. Define the UNLOAD output data set options, if necessary, by performing the following steps:
    1. Type a slash (/) in the Output file field, and press Enter.The UNLOAD Data Set Allocation Options pop-up panel is displayed.

      .-- .-------------------------------------------------------------------------.
      |   |                  UNLOAD 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 being allocated. If you are specifying a DDname, leave this field blank.

      or DDname

      Type the DDname which indicates a pre-allocated output data set 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:

      • New—A new output data set will be allocated.
      • Mod—If the named output data set exists, it will be used. If it does not exist, a new output data set will be allocated.
      • Old—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 UNLOAD 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 UNLOAD Output Data Set Options, Page 5 of 5 pop-up panel (UNLOAD Output Data Set Options panel, Page 5 of 5) is displayed.
    4. Press Enter.The Confirm Changes pop-up panel is displayed.
  13. 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.

     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 *****************************
       _     UNLOAD
  14. (optional) Name the command set and add a description.
    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 panels are populated.
    2. (optional) Type a description in the Title field, and press END.The Confirm Save pop-up panel is displayed.
  15. Confirm that you want to create and save a new member by performing the following steps:
    1. If you did not type 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 0022 of 0024
        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
       _ SAMPUL   ________            3   2001/08/23   2001/08/23 14:59:12    USERID1
       _ UNL0003  ________            7   2001/05/30   2001/05/30 12:27:52    USERID2
       _ UNL0015  ________            4   2001/06/04   2001/06/04 11:45:36    USERID2
        **End**
  16. View the command set and, if necessary, edit it 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.

       File  Edit  Edit_Settings  Menu  Utilities  Compilers  Test  Help            
      -------------------------------------------------------------------------------
      EDIT       bmcnode.MAQ.REQUEST(SAMPUL) - 01.00                     Columns 00001 00072
      000010 UNLOAD         IMSID=R61P,FORCE=YES                                     
      000020    SELECT      DESTINATION=CAT*,DESTYPE=ALL                             
      000030 END                                                                     
      ****** **************************** Bottom of Data ****************************

      This panel shows you the command set built with the preceding panels and 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.

  17. Review the command set and edit it, if needed.
  18. Press END.The Member List panel is displayed again.
  19. Use the IMS /STOP command to stop all nodes and transactions to be unloaded.

    Note

    You can issue the IMS /STOP command by using the Message Advisor and IMS Commands panel (option 6 on the Message Advisor Primary Menu).

  20. 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.
  21. 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 UNLOAD 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.

    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 unload 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 when the unload is completed.

    This pop-up panel shows the status of the unload process by displaying any significant messages. You can scroll up and down through the messages with the scroll keys.

     File  Options  Samples  Session  Display  Help                               
     ------------------------------------------------------------------------------
       .-------------------------------------------------------------------------.  
     C |                             Request Status                              |  
       | Command ===> ________________________________________ Scroll ===> CSR_  |  
     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  |  
     _ |   11:50:51 bmcnode.MAQ.REQUEST(SAMPUL)                                  |  
     _ |                                                        Line 001 of 003  |  
     _ | Significant messages:                                                   |  
     _ | BMC43077I UNLOAD IN PROGRESS FOR ROHPXM (TASK 3)                        |  
     _ | BMC43227I USING UNLOAD DDN=SYS00003 DSN=bmcnode.MAQ.OUTPUT IMSID=R61P   |  
     _ | BMC43076I UNLOAD FOR ROHPXM (TASK 3) IMS(R61P) ENDED, RC=00             |  
     _ |                                                                         |  
     _ |                                                                         |  
     _ |                                                                         |  
     _ |                                                                         |  
     _ |                                                                         |  
     _ |                                                                         |  
     Q '-------------------------------------------------------------------------'
  22. 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 pressing PF4 (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 to determine the problem.

  23. Press Enter.The Request Results pop-up panel is displayed.
  24. To view the UNLOAD report, type 1 in the choice entry field of the Browse Results pop-up panel, and press Enter.The Browse Results report is displayed.

    .-----------------------------------------------------------------------------.
    |                               Browse Results                                |
    | Command ===> ____________________________________________ Scroll ===> CSR_  |
    |                                        Line 000000 of 000029 Cols 001 075   |
    |                                                              More:     + >  |
    | ****************************** Top of Data ******************************** |
    | BMC43077I UNLOAD IN PROGRESS FOR ROHPXM (TASK 3)                            |
    | >>>>UNLOAD         IMSID=R61P,FORCE=YES                                     |
    | >>>>   OUTPUT      DSNAME=bmcnode.MAQ.OUTPUT,DISP=NEW,CYLS_PRIM=5           |
    | >>>>   SELECT      DESTINATION=CAT*,DESTYPE=ALL                             |
    | >>>>END                                                                     |
    | BMC43227I USING UNLOAD DDN=SYS00003 DSN=bmcnode.MAQ.OUTPUT IMSID=R61P       |
    |                                                                             |
    |  Message Advisor for IMS V1.0.02  - Server ID QJER       09/05/2001.248 11. |
    |  Unload  Statistics Summary for IMSID R61P                                  |
    |                                                                             |
    |  Total Number of Destinations Selected             5                        |
    |  Total Number of Messages Unloaded....            37                        |
    |  Total Number of Destinations in Error             0                        |
    |                                                                             |
    |   DESTINATION    TYPE  #MSG UNL.  Q# FIRST/LAST DRRN   LU/TPIPE   STATUS    |
    |  --------------- ----- ---------  -- --------/-------- -------- ----------- |
    |  CATTLE          CNT-V        10   4 040009A5/040009AE          00-UNLOAD O |
    |  CAT             CNT-V         8   4 040009B0/040009B7          00-UNLOAD O |
    |  CATALOG         CNT-V         2   4 080004F4/080004F5          00-UNLOAD O |
    |  CATFOOD         CNT-V        11   4 040009B8/040009C2          00-UNLOAD O |
    |  CATLITTR        CNT-V         6   4 080004EE/080004F3          00-UNLOAD O |
    |                                                                             |
    |                                                                             |
    | BMC43076I UNLOAD FOR ROHPXM (TASK 3) IMS(R61P) ENDED, RC=00                 |
    | ***************************** Bottom of Data ****************************** |
  25. Review all the messages and ensure that the UNLOAD 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.
  26. Press END until the Primary Menu is displayed.This step completes the sample task of unloading selected messages from multiple destinations.


 

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