Setting up a JMS gateway
To create
JMS gateways, use the following procedure.
- Click Account Admin > Profiles > Gateways.
- Click Create.
Gateway Details
From the Gateway List page, perform the following steps:
- Type a name to identify the gateway. This is a required field.
- 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.
- Optionally indicate whether the gateway is Online or Offline.
The default is Online.
- Optionally enter a description of the gateway.
Gateway Configuration
In the Gateway Configuration section
of the page, perform the following steps:
- Select JMS from the Transport list.
- 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.
- Optionally enter a user name and password, if a user name and
password are required to access the JMS queue.
- 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.
- 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.
- In the Number of Threads field, enter
the number of documents that can be processed simultaneously. The
default is 3.
- 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.
- 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.
- In the Authentication Required field,
indicate whether a user name and password are supplied with the
document. The default is No.
- 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.
- 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.
- In the JMS Message Type field, enter the
type of message. This is an optional field.
- 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.
- In the JMS Queue Name field, enter the
name of the JMS queue where documents are to be sent. This field
is required.
- In the JMS JNDI Factory Name field, enter
the factory name used to connect to the name service. This field
is required.
- If you want to configure the Preprocess or Postprocess step
for the gateway, go to Configuring handlers.
Otherwise, click Save.
