Setting up a JMS gateway

To create JMS gateways, use the following procedure.

  1. Click Account Admin > Profiles > Community Participant.
  2. Enter search criteria and click Search, or click Search without entering any search criteria to display a list of all participants.
  3. Click the View details icon to display the participant's profile.
  4. Click Gateways.
  5. Click Create.

Gateway Details

From the Gateway List page, perform the following steps:

  1. Type a name to identify the gateway. This is a required field.
  2. Optionally indicate the status of the gateway. Enabled is the default. A gateway that is enabled is ready to send documents. A gateway that is disabled cannot send documents.
  3. Optionally indicate whether the gateway is Online or Offline. The default is Online.
  4. Optionally enter a description of the gateway.

Gateway Configuration

In the Gateway Configuration section of the page, perform the following steps:

  1. Select JMS from the Transport list.
  2. In the Address field, enter the URI where the document will be delivered. This field is required.

    For WebSphere MQ JMS, the format of the target URI is as follows:

    file:///<user_defined_MQ_JNDI_bindings_path>

    For example:

    file:///opt/JNDI-Directory

    The directory contains the ".bindings" file for the file-based JNDI. This file indicates to WebSphere Partner Gateway how to route the document to its intended destination.

    This field is required.

  3. Optionally enter a user name and password, if a user name and password are required to access the JMS queue.
  4. In the Retry Count field, enter the number of times you want the gateway to attempt to send a document before it fails. The default is 3.
  5. In the Retry Interval field, enter the amount of time the gateway should wait before attempting to send the document again. The default is 300 seconds.
  6. In the Number of Threads field, enter the number of documents that can be processed simultaneously. The default is 3.
  7. In the Validate Client IP field, select Yes if you want the IP address of the sender to be validated before the document is processed. Select No otherwise. The default is No.
  8. In the Auto Queue field, select Yes if you want the gateway to be placed offline (automatically) if a delivery failure is about to occur because the number of retries has been exhausted. Select No otherwise. The default is No.

    When you select Auto Queue, all documents remain queued until the gateway is placed online manually.

  9. In the Authentication Required field, indicate whether a user name and password are supplied with the document. The default is No.
  10. In the JMS Factory Name field, enter the name of the Java class the JMS provider uses to connect to the JMS queue. This field is required.

    For internal JMS gateways, this name should match the one you specified with the define qcf command when you created the bindings file (step 4).

    If you entered the subfolder for the JMS context in step 2, enter only the factory name here (for example, Hub). If you did not enter the subfolder for the JMS context in the Address field, specify the subfolder before the factory name (for example, JMS/Hub).

  11. In the JMS Message Class field, enter the message class. The choices are any valid JMS Message class, such as TextMessage or BytesMessage. This field is required.
  12. In the JMS Message Type field, enter the type of message. This is an optional field.
  13. In the Provider URL Packages field, enter the name of the classes (or JAR file) that Java uses to understand the JMS context URL. This field is optional. If you do not specify a value, the file system path to the bindings file is used.
  14. In the JMS Queue Name field, enter the name of the JMS queue where documents are to be sent. This field is required.

    For internal JMS gateways, this name should match the one you specified with the define q command when you created the bindings file (step 4).

    If you entered the subfolder for the JMS context in step 2, enter only the queue name here (for example, outQ). If you did not enter the subfolder for the JMS context in the JMS provider URL, specify the subfolder before the factory name (for example, JMS/outQ).

  15. In the JMS JNDI Factory Name field, enter the factory name used to connect to the name service. This field is required. The value of com.sun.jndi.fscontext.RefFSContextFactory is the one you will probably use, if you set up your JMS configuration as described in Configuring the hub for the JMS transport protocol.
  16. If you want to configure the Preprocess or Postprocess step for the gateway, go to Configuring handlers. Otherwise, click Save.

Copyright IBM Corp. 2003, 2005