For WebSphere Partner Gateway to communicate with InterChange Server over the JMS transport protocol, the components must be configured to work with JMS. Table 51 summarizes these configuration steps.
Component | Version | For more information |
---|---|---|
WebSphere Partner Gateway | 6.0 |
Configuration for sending documents to ICS over the JMS transport protocol Configuration for receiving documents from ICS over the JMS transport protocol |
WebSphere InterChange Server | 4.2.2, 4.3 | Creating ICS artifacts for JMS |
In addition, to send or receive a document between WebSphere Partner Gateway and InterChange Server over the JMS transport protocol, you also use the components listed in Table 52.
Component | Description | Notes and restrictions |
---|---|---|
WebSphere Business Integration Adapter for JMS (Adapter for JMS) |
This adapter allows InterChange Server to exchange business objects with applications that send or receive data in the form of JMS messages. The Adapter for JMS and WebSphere Partner Gateway communicate through JMS queues. |
Make sure you are using the Adapter for JMS, version 2.7.0 (or higher), which provides support for custom header properties. Refer to the adapter documentation to make sure that the version of the adapter is compatible with the version of InterChange Server you are using. |
A payload data handler | This data handler converts the payload between its document format and its business-object representation. | For more information, see Specifying the payload data handler. |
Attachment data handler |
This data handler converts documents with attachments into business objects. |
This data handler is required only if your documents include attachments. For more information, see Handling documents with attachments. |
The following sections describe how the components in Table 52 work together to send and receive documents between WebSphere Partner Gateway and InterChange Server over the JMS transport protocol.
For WebSphere Partner Gateway to send a document to InterChange Server using the JMS transport protocol, you use the Adapter for JMS to retrieve the message that WebSphere Partner Gateway has put on a JMS queue. The adapter then routes the message to InterChange Server. Figure 22 provides an overview of how WebSphere Partner Gateway sends documents to InterChange Server over the JMS transport protocol.
The following steps describe how WebSphere Partner Gateway participates in event notification by sending a document to a collaboration within InterChange Server over the JMS transport protocol:
If the packaging type of the document is Backend Integration, WebSphere Partner Gateway has provided custom properties in this message. The JMS message header, JMSType, is set with the content type of the payload.
The JMS queue that WebSphere Partner Gateway uses as its outbound queue is the same queue that the Adapter for JMS uses as its input queue. For information on how to set up this queue, see Configuring the JMS queues. For detailed information on the processing of the Adapter for JMS, see the Adapter for JMS User Guide.
When Backend Integration is the packaging type and the document contains attachments, the configured data handler is responsible for handling the payload and attachments.
For WebSphere Partner Gateway to receive a document from InterChange Server using the JMS transport protocol, you use the Adapter for JMS, which places the message it receives from InterChange Server on a JMS queue for WebSphere Partner Gateway to retrieve. Figure 23 provides an overview of how WebSphere Partner Gateway receives documents from InterChange Server over the JMS transport protocol.
The following steps describe how WebSphere Partner Gateway participates in request processing by receiving a document from a collaboration within InterChange Server over the JMS transport protocol:
The request business object contains application-specific information pointing to a dynamic meta-object that contains the JMS transport-level header information, which WebSphere Partner Gateway expects.
The adapter reads the DataHandlerMimeType and DataHandlerConfigMO properties to determine the data handler to use. For more information, see Specifying the payload data handler.
The adapter searches the application-specific information of the request business object for the cw_mo_conn tag, which identifies the attribute that contains the dynamic meta-object. If you are using Backend Integration packaging for your document, you can specify transport-level header information in this dynamic meta-object.
If this attribute is populated, the adapter sets the transport-level header fields in the request document. Within the JMSProperties attribute, you can also specify the content-type standard JMS header. For more information, see Creating JMS header information.
The queue can be specified in the static meta-object or the dynamic meta-object. For information on specifying queues, see Identifying the JMS queues. WebSphere Partner Gateway listens on this JMS queue, which is configured as its inbound queue in its target definition.