Maintaining Input Queue (IQUEUE) Definitions

An IQUEUE definition defines the input queue on which Event Replicator for Adabas should listen for requests from webMethods EntireX (or, EntireX Broker) and WebSphere MQ targets. At least one definition is required for every webMethods EntireX or WebSphere MQ target you intend to use.

This document covers the following topics:


Listing IQUEUE Definitions

Start of instruction setTo use the Adabas Event Replicator Subsystem to list the IQUEUE definitions stored in the Replicator system file:

  • Select option Q from the Adabas Event Replicator Subsystem Main Menu.

    The List of IQUEUE Definitions screen appears showing all of the IQUEUE definitions in the Adabas Event Replicator Subsystem.

    19:57:51      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2013-03-12
                            List of Input Queue Definitions              M-RP1300  
                                                                                   
     Sel   Name   Typ   Sel   Name   Typ   Sel   Name   Typ   Sel   Name   Typ     
     -----------------  -----------------  -----------------  ----------------     
      _  ABCDEF1  MQ     _                  _                  _                   
      _  ETBIN1   ETB    _                  _                  _                   
      _  ETBQUEUE ETB    _                  _                  _                   
      _  E2       ETB    _                  _                  _                   
      _                  _                  _                  _                   
      _                  _                  _                  _                   
      _                  _                  _                  _                   
      _                  _                  _                  _                   
      _                  _                  _                  _                   
      _                  _                  _                  _                   
      _                  _                  _                  _                   
      _                  _                  _                  _                   
      _                  _                  _                  _                   
      _                  _                  _                  _                   
                                                                                   
    Command ==>                                                                    
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Help  Repos Exit  Add                -     +                      Menu   

The function keys on this screen perform the following functions:

Function Key Description
PF1/F1 (Help) Provides you with help for this screen.
PF2/F2 (Repos) Provides you with a pop-up panel that allows you to specify the name of the definition you want to locate in the list. Once you have specified a name on the pop-up panel and pressed Enter, the list is repositioned so the name you selected appears first. You can use an asterisk as a wild card character at the end of the definition name or partial definition name you specify on the pop-up panel. Or, you can simply enter the first few characters of the name to reposition the list to the first occurrence in the list of a name starting with those characters.
PF3/F3 (Exit) Returns you to the previous screen.
PF4/F4 (Add) Allows you to add a new definition. A new screen appears.
PF7/F7 (-) Allows you to scroll backwards through the list of definitions.
PF8/F8 (+) Allows you to scroll forwards through the list of definitions.
PF12/F12 (Menu) Returns you to the main menu.

Creating an EntireX Broker IQUEUE Definition

Be sure to read Using webMethods EntireX as the Messaging System prior to webMethods EntireX as the messaging subsystem.

Start of instruction setTo use the Adabas Event Replicator Subsystem to add an EntireX Broker IQUEUE definition to the Replicator system file:

  1. Select option Q from the Adabas Event Replicator Subsystem Main Menu.

    The List of IQUEUE Definitions screen appears.

  2. Press PF4 on the List of IQUEUE Definitions screen.

    The Create New IQUEUE Definition screen appears.

    18:26:36      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2013-02-28
                             Create New IQUEUE Definition                M-RP1390  
                                                                                   
                                                                                   
                     Code    Function                                              
                     ----    -------------------------------------                 
                       M     Create MQ Input Queue Definition                      
                       E     Create Broker Input Queue Definition                  
                       ?     Help                                                  
                       .     Exit                                                  
                      ----   -------------------------------------                 
                                                                                   
                                                                                   
              Code ... _                                                           
                                                                                   
                                                                                   
                                                                                   
                                                                                   
                                                                                   
                                                                                   
    Command ==>                                                                    
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Help        Exit                                                  Menu   
  3. Select option E on the Create New IQUEUE Definition screen.

    The EntireX Broker Input Queue Definition screen appears.

    18:27:14      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2013-02-28
                                    EntireX Broker                       M-RP1320  
                                Input Queue Definition                             
                                                                                   
                                                                                   
                                                                                   
            Input Queue Name ............ ________                                 
            Broker ID ................... ________________________________         
            Broker Service .............. ________________________________         
            Service Name ................ ________________________________         
            Service Class ............... ________________________________         
            Input Queue Buffer Length ... ______2048                               
            Retry Interval .............. GLOBAL____                               
            Retry Count ................. GLOBAL____                               
            Open Queue at start ......... GLOBAL     
            Single Conversation mode .... NO_        
                                                                                   
                                                                                   
                                                                                   
                                                                                   
                                                                                   
    Command ==>                                                                    
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Help        Exit        Save                                      Menu   
  4. Update the fields on this screen as described in the following table.

    Parameter Name Specify Default
    Broker ID The EntireX Broker ID you want used for this IQUEUE definition. For the valid values of this parameter, check with your webMethods EntireX Broker development staff and the webMethods EntireX Broker documentation. A maximum of 32 characters can be specified.

    Broker IDs come in two formats: one for TCP/IP communications and one for Adabas SVC communication. For TCP/IP communications, the format is:

    ip-address:port-number:TCP

    In this case, the ip-address setting is the TCP/IP IP address and the port-number setting should match the EntireX Broker PORT parameter.

    For Adabas SVC communications, the format is:

    'broker-id:SVCnnn:NET'

    In this case, the broker-id setting should match the EntireX Broker BROKER-ID parameter in the Broker ETBFILE DD. The nnn setting should match either the EntireX Broker ADASVC or ADA5SVC parameters in the Broker PARMS DD statement.

    This is the equivalent of specifying the IQETBBROKERID parameter in the Event Replicator Server startup job.

    ETBBROKERID value
    Broker Service The EntireX Broker service you want used for this IQUEUE definition. This should be the same as the value specified for the SERVICE parameter in EntireX Broker. The ID can be up to 32 characters long. For the valid values of this parameter, check with your webMethods EntireX Broker development staff and the webMethods EntireX Broker documentation.

    This is the equivalent of specifying the IQETBSERVICE parameter in the Event Replicator Server startup job.

    ---
    Input Queue Buffer Length The length, in bytes, of the input buffer associated with this input queue. Valid values range from "2048" through "2,147,483,647". However, the practical maximum value is restricted by the amount of virtual storage available in the Event Replicator Server address space. If you enter a value less than "2048", "2048" is used.

    This is the equivalent of specifying the IQBUFLEN parameter in the Event Replicator Server startup job.

    This value should be set to a value greater than or equal to the largest message that will be received by the input queue. When the input queue will receive data as a part of node-to-node replication, the largest message will be limited by the minimum of the following Event Replicator Server settings: MAXOUTPUTSIZE parameter, DMAXOUTPUTSIZE parameter (if specified for the destination), or the message limit imposed by the messaging system.

    2048
    Input Queue Name A unique name for the IQUEUE definition. The name must use alphanumeric characters and be between one and 8 characters long.

    This is the equivalent of specifying the IQUEUE NAME parameter in the Event Replicator Server startup job.

    ---
    Open Queue at Start Whether the input queue should be opened automatically when the Event Replicator Server starts up or when an RPLREFRESH command is run. Valid values are GLOBAL, NO, or YES:
    • GLOBAL (the default): This setting indicates that the decision about automatically opening the input queue should be based on the setting of the GOPEN global parameter. If the GOPEN global parameter is set to "YES", the input queue is opened; if GOPEN is set to NO, the input queue is not opened.

    • NO: This setting indicates that the input queue should never be opened automatically when the Event Replicator Server starts up or when an RPLREFRESH command is run.

    • YES: This setting indicates that the input queue should always be opened automatically when the Event Replicator Server starts up or when an RPLREFRESH command is run.

    This is the equivalent of specifying the IQOPEN parameter in the Event Replicator Server startup job.

    GLOBAL
    Retry Count The number of times that an attempt to open the input queue will be retried at the interval specified by the Retry Interval parameter. This is the equivalent of specifying the IQRETRYCOUNT parameter directly in the Event Replicator Server startup job.

    Valid values range from 0 through 2,147,483,647 or the literal "GLOBAL".

    If the value "GLOBAL" is specified for this parameter, the specification for the Retry Count global variable will be used. Any retry attempts will occur at the interval specified by the Retry Interval parameter. A value of zero indicates that no retry attempt to open this input queue should occur.

    The value of the Retry Count global variable
    Retry Interval The default number of seconds between retry attempts to open the input queue identified by this definition. This is the equivalent of specifying the IQRETRYINTERVAL parameter directly in the Event Replicator Server startup job.

    Valid values are 0, 5 through 2,147,483,647, or the literal "GLOBAL".

    If the value "GLOBAL" is specified for this parameter, the specification for the Retry Interval global variable will be used. A value of zero indicates that no retry attempt to open this input queue should occur. Except for a specification of zero, the minimum value that can be specified for this parameter is 5 seconds.

    The value of the Retry Interval global variable
    Service Class The EntireX Broker service class you want used for this IQUEUE definition. This should be the same as the value specified for the CLASS parameter in EntireX Broker. The name can be up to 32 characters long. For the valid values of this parameter, check with your webMethods EntireX Broker development staff and the webMethods EntireX Broker documentation.

    This is the equivalent of specifying the IQETBSERVICECLASS parameter in the Event Replicator Server startup job.

    ---
    Service Name The name of the EntireX Broker service you want used for this IQUEUE definition. This should be the same as the value specified for the SERVER parameter in EntireX Broker. The name can be up to 32 characters long. For the valid values of this parameter, check with your webMethods EntireX Broker development staff and the webMethods EntireX Broker documentation.

    This is the equivalent of specifying the IQETBSERVICENAME parameter in the Event Replicator Server startup job.

    ---
  5. Press PF5 to save the IQUEUE definition.

Creating a WebSphere MQ IQUEUE Definition

Be sure to read Using WebSphere MQ as the Messaging System prior to using WebSphere MQ as the messaging subsystem.

Note:
If you are running on z/OS using IBM WebSphere MQ Series definitions for your Event Replicator DESTINATION or IQUEUE definitions, a S0D3 abend can occur if you run it as a started task and specify the parameter REUSASID=YES. This is a documented IBM WebSphere MQ Series issue.

Start of instruction setTo use the Adabas Event Replicator Subsystem to add a WebSphere MQ IQUEUE definition to the Replicator system file:

  1. Select option Q from the Adabas Event Replicator Subsystem Main Menu.

    The List of IQUEUE Definitions screen appears.

  2. Press PF4 on the List of IQUEUE Definitions screen.

    The Create New IQUEUE Definition screen appears.

    18:26:36      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2013-02-28
                             Create New IQUEUE Definition                M-RP1390  
                                                                                   
                                                                                   
                     Code    Function                                              
                     ----    -------------------------------------                 
                       M     Create MQ Input Queue Definition                      
                       E     Create Broker Input Queue Definition                  
                       ?     Help                                                  
                       .     Exit                                                  
                      ----   -------------------------------------                 
                                                                                   
                                                                                   
              Code ... _                                                           
                                                                                   
                                                                                   
                                                                                   
                                                                                   
                                                                                   
                                                                                   
    Command ==>                                                                    
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Help        Exit                                                  Menu   
  3. Select option M on the Create New IQUEUE Definition screen.

    The MQSeries Input Queue Definition screen appears.

    18:27:53      ***** A D A B A S  EVENT REPLICATOR SUBSYSTEM *****    2013-02-28
                                       MQSeries                          M-RP1310  
                                Input Queue Definition                             
                                                                                   
                                                                                   
                                                                                   
    Input Queue Name ........... ________                                          
    Queue Manager Name.......... ________________________________________________  
    MQ Queue Name .............. ________________________________________________  
    Input Queue Buffer Length .. ______2048                                        
    Retry Interval ............. GLOBAL____                                        
    Retry Count ................ GLOBAL____                                        
    Open Queue at start ........ GLOBAL                                            
                                                                                   
                                                                                   
                                                                                   
                                                                                   
                                                                                   
                                                                                   
                                                                                   
    Command ==>                                                                    
    Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
          Help        Exit        Save                                      Menu   
  4. Update the fields on this screen as described in the following table.

    Parameter Name Specify Default
    Input Queue Buffer Length The length, in bytes, of the input buffer associated with this input queue. Valid values range from "2048" through "2,147,483,647". However, the practical maximum value is restricted by the amount of virtual storage available in the Event Replicator Server address space. If you enter a value less than "2048", "2048" is used.

    This is the equivalent of specifying the IQBUFLEN parameter in the Event Replicator Server startup job.

    This value should be set to a value greater than or equal to the largest message that will be received by the input queue. When the input queue will receive data as a part of node-to-node replication, the largest message will be limited by the minimum of the following Event Replicator Server settings: MAXOUTPUTSIZE parameter, DMAXOUTPUTSIZE parameter (if specified for the destination), or the message limit imposed by the messaging system.

    2048
    Input Queue Name A unique name for the IQUEUE definition. The name must use alphanumeric characters and be between one and 8 characters long.

    This is the equivalent of specifying the IQUEUE NAME parameter in the Event Replicator Server startup job.

    ---
    MQ Queue name The name of the WebSphere MQ queue you want used for this IQUEUE definition. The name can be up to 48 characters long. For the valid values of this parameter, check with your WebSphere MQ development staff and the WebSphere MQ documentation.

    This is the equivalent of specifying the IQMQQNAME parameter in the Event Replicator Server startup job.

    ---
    Open Queue at Start Whether the input queue should be opened automatically when the Event Replicator Server starts up or when an RPLREFRESH command is run. Valid values are GLOBAL, NO, or YES:
    • GLOBAL (the default): This setting indicates that the decision about automatically opening the input queue should be based on the setting of the GOPEN global parameter. If the GOPEN global parameter is set to "YES", the input queue is opened; if GOPEN is set to NO, the input queue is not opened.

    • NO: This setting indicates that the input queue should never be opened automatically when the Event Replicator Server starts up or when an RPLREFRESH command is run.

    • YES: This setting indicates that the input queue should always be opened automatically when the Event Replicator Server starts up or when an RPLREFRESH command is run.

    This is the equivalent of specifying the IQOPEN parameter in the Event Replicator Server startup job.

    GLOBAL
    Queue Manager Name The name of the WebSphere MQ queue manager you want used for this IQUEUE definition. The name can be up to 48 characters long. For the valid values of this parameter, check with your WebSphere MQ development staff and the WebSphere MQ documentation.

    This is the equivalent of specifying the IQMQQMGRNAME parameter in the Event Replicator Server startup job.

    ---
    Retry Count The number of times that an attempt to open the input queue will be retried at the interval specified by the Retry Interval parameter. This is the equivalent of specifying the IQRETRYCOUNT parameter directly in the Event Replicator Server startup job.

    Valid values range from 0 through 2,147,483,647 or the literal "GLOBAL".

    If the value "GLOBAL" is specified for this parameter, the specification for the Retry Count global variable will be used. Any retry attempts will occur at the interval specified by the Retry Interval parameter. A value of zero indicates that no retry attempt to open this input queue should occur.

    The value of the Retry Count global variable
    Retry Interval The default number of seconds between retry attempts to open the input queue identified by this definition. This is the equivalent of specifying the IQRETRYINTERVAL parameter directly in the Event Replicator Server startup job.

    Valid values are 0, 5 through 2,147,483,647, or the literal "GLOBAL".

    If the value "GLOBAL" is specified for this parameter, the specification for the Retry Interval global variable will be used. A value of zero indicates that no retry attempt to open this input queue should occur. Except for a specification of zero, the minimum value that can be specified for this parameter is 5 seconds.

    The value of the Retry Interval global variable
  5. Press PF5 to save the IQUEUE definition.

Modifying IQUEUE Definitions

Start of instruction setTo use the Adabas Event Replicator Subsystem to modify an IQUEUE definition in the Replicator system file:

  1. List the IQUEUE definitions in the Adabas Event Replicator Subsystem, as described in Listing IQUEUE Definitions.

    The IQUEUE definitions are listed on the List of IQUEUE Definitions screen.

  2. Locate the definition you want to modify on the screen and enter an M in the Sel column for that definition.

    You can locate the definition you want in the list by pressing the PF7 (F7) or PF8 (F8) keys to scroll through the list. You can also press PF2 (F2) to specify the name of the definition to which the list should be repositioned.

    An appropriate IQUEUE definition screen appears for the IQUEUE type you selected. For information on modifying this screen, read the description of adding that type of IQUEUE definition, elsewhere in this section.

  3. When all modifications have been made, press PF5 to save the changes.

Copying IQUEUE Definitions

Start of instruction setTo use the Adabas Event Replicator Subsystem to copy an IQUEUE definition in the Replicator system file:

  1. List the IQUEUE definitions in the Adabas Event Replicator Subsystem, as described in Listing IQUEUE Definitions.

    The IQUEUE definitions are listed on the List of IQUEUE Definitions screen.

  2. Locate the definition you want to copy on the screen and enter a C in the Sel column for that definition.

    You can locate the definition you want in the list by pressing the PF7 (F7) or PF8 (F8) keys to scroll through the list. You can also press PF2 (F2) to specify the name of the definition to which the list should be repositioned.

    A dialog appears requesting a name for the copy of the IQUEUE definition.

                                 
     Enter new name: ________    
     or press PF3 to cancel      
                                 
  3. Specify a new, unique name for the copy of the IQUEUE definition and press Enter.

    The IQUEUE definition is copied and the copy appears on the List of IQUEUE Definitions screen.

Deleting IQUEUE Definitions

Start of instruction setTo use the Adabas Event Replicator Subsystem to delete an IQUEUE definition in the Replicator system file:

  1. List the IQUEUE definitions in the Adabas Event Replicator Subsystem, as described in Listing IQUEUE Definitions.

    The IQUEUE definitions are listed on the List of IQUEUE Definitions screen.

  2. Locate the definition you want to delete on the screen and enter a D in the Sel column for that definition.

    You can locate the definition you want in the list by pressing the PF7 (F7) or PF8 (F8) keys to scroll through the list. You can also press PF2 (F2) to specify the name of the definition to which the list should be repositioned.

    The IQUEUE definition is deleted.