Setting up the environment for JMS transport
Because the sending and receiving of documents to and
from InterChange Server involves JMS queues and the Adapter for
JMS, you must perform the setup and configuration tasks described
in Table 53. For information on
how to configure WebSphere Partner Gateway for use with InterChange
Server over JMS, see Configuring WebSphere Partner Gateway for InterChange Server.
Configuring the JMS queues
To use the JMS transport protocol with InterChange Server,
you must set up the JMS system that WebSphere MQ provides. Supported
versions of InterChange Server use version 5.3 of WebSphere MQ as
a JMS provider. You can use the steps in the Hub Configuration Guide to
set up the JMS transport-protocol mechanism.
Important: The steps in the Hub Configuration Guide must
be performed on the computer on which WebSphere Partner Gateway
resides. This guide assumes that the JMS transport-mechanism required
by the Adapter for JMS and InterChange Server has already been set
up as part of the InterChange Server installation.
When you create your JMS queues for use between WebSphere Partner
Gateway and InterChange Server, consider the following points:
- Part of the InterChange Server installation process involves
the creation of a WebSphere MQ queue manager. You can use this queue
manager with WebSphere Partner Gateway.
- When you create your JMS queue aliases, you might want to name
them to indicate the direction of flow between WebSphere Partner
Gateway and InterChange Server. For example, if you create the queues
listed in the Original queue name column of Table 54, you
could rename these queues to indicate the InterChange Server directional
flow, as shown in the Directional queue name column of Table 54.
Table 54. Naming JMS queues for InterChange Server directionality
Original queue name |
Directional queue name |
inQ |
ICS2HUB |
outQ |
HUB2ICS |
Configuring the Adapter for JMS
The Adapter for JMS allows WebSphere Partner Gateway to
exchange documents with InterChange Server in the form of JMS messages.
It supports the following interactions with InterChange Server:
- For request processing, it receives the request business object
from InterChange Server, converts it to a JMS
message (using a data handler), and puts the JMS message on a JMS
queue (see Figure 23), where it
can be picked up by WebSphere Partner Gateway.
- For event notification, it polls a JMS queue
for JMS messages from WebSphere Partner Gateway. When it finds a
JMS message, it converts it to an event business object (using a
data handler) and sends it to InterChange Server.
Important: WebSphere Partner Gateway does not include
the WebSphere Business Integration Adapter
for JMS. You must obtain this product separately and install it according
to the instructions in its Adapter for JMS User Guide.
It is important that you read the steps described in this guide
to correctly install and configure your Adapter for JMS.
When you have configured the Adapter for JMS to communicate with
InterChange Server, follow the steps in this section to configure
this adapter to accept JMS messages from WebSphere Partner Gateway:
Specifying the payload data handler
As Figure 23 shows,
the Adapter for JMS uses a data handler to convert the business
objects it receives from InterChange Server into the appropriate
JMS messages.
Note: The data handler that the Adapter for JMS calls
converts the payload of the document. If your document is wrapped
in an XML transport envelope (it contains attachments or the Envelope
Flag is Yes), configure the Attachment data handler as the payload
data handler. For more information, see Handling documents with attachments.
To indicate which data handler to use to convert the payload,
you must take the steps listed in Business object conversion. In
addition, you must configure the Adapter for JMS to use this payload
data handler. In Connector Configurator, take the following steps:
- Set the following connector configuration properties to identify
the payload data handler:
- Set the DataHandlerConfigMO and DataHandlerMimeType properties with the name of the top-level data-handler meta-object
and the supported MIME type, respectively.
- Set the DataHandlerClassName property with the name of the data-handler class to instantiate.
Note: You set either the DataHandlerConfigMO and DataHandlerMimeType properties or the DataHandlerClassName property.
- Include the top-level data-handler meta-object in the list of
supported business objects.
You can also specify the data handler to use in the static or
dynamic meta-object. The same properties (DataHandlerMimeType, DataHandlerConfigMO, and DataHandlerClassName) are available as attributes in these meta-objects. For a complete
description, refer to the Adapter for JMS User Guide.
Identifying the JMS queues
When the Adapter for JMS receives a document from InterChange
Server, it puts the message in its outbound queue, which is the
one that the WebSphere Partner Gateway Receiver is polling. Similarly,
when WebSphere Partner Gateway sends a document to InterChange Server,
it puts the document in its outbound queue, which is the one that the
Adapter for JMS is polling.
Table 55 summarizes how to configure
the JMS queues that the Adapter for JMS uses to receive and send
documents.
Note: For a complete description of how to configure JMS
queues, refer to the Adapter for JMS User Guide.
Table 55. JMS queues
JMS queue |
Configuration set |
Input queue |
Set the InputDestination connector configuration property to the name of the JMS queue
that the Adapter for JMS will poll for incoming messages.
Make sure that the name of this queue is the same as the one
WebSphere Partner Gateway is using as its JMS outbound queue. If
this queue is not specified in InputDestination, the Adapter for JMS will not poll
the queue.
Note: The InputDestination property contains a comma-separated list of input queues.
If the Adapter for JMS polls multiple queues, make sure that this
list includes the name of the JMS queue that WebSphere Partner Gateway
is using as its JMS outbound queue. |
Output queue |
At run-time, the collaboration can dynamically
set the OutputQueue attribute in the dynamic meta-object to the name of the JMS
queue that the Adapter for JMS will use to send its outgoing message. |
You must make sure that the static or dynamic meta-objects are
configured so that they can write to the queue on which the WebSphere
Partner Gateway target is listening.
