Components required for documents over JMS transport

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.

Table 51. Configuring WebSphere Partner Gateway and InterChange Server for JMS transport protocol
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.

Table 52. Components required to transfer documents to and from InterChange Server through JMS
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.

How documents are sent over the JMS transport

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.

Figure 22. Message flow from WebSphere Partner Gateway to a collaboration through the JMS transport protocol
This figure shows how a document is sent to WebSphere Partner Gateway, how WebSphere Partner Gateway sends the JMS message to the input queue of the Adapter for JMS, how the Adapter for JMS calls the payload data handler, and how the Adapter for JMS sends the resulting business object to a collaboration.

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:

  1. WebSphere Partner Gateway posts a message to its JMS outbound queue.

    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.

    Note: Within WebSphere Partner Gateway, you must configure a gateway that identifies the JMS queue to which WebSphere Partner Gateway sends the message and on which the Adapter for JMS is polling.
  2. When the Adapter for JMS sees a message on one of its input queues, it retrieves the message.

    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.

  3. The Adapter for JMS moves the message to its in-progress queue.
  4. The Adapter for JMS extracts the body of the JMS message and invokes a data handler with the body of the message. This data handler converts the body of the JMS message to a business object.
    Note: If your messages have attachments, you can install the Attachment data handler and then configure the Adapter for JMS to call it to convert the body of the JMS message to a business object. For more information, see Handling documents with attachments.

    When Backend Integration is the packaging type and the document contains attachments, the configured data handler is responsible for handling the payload and attachments.

  5. The data handler returns the business object to the Adapter for JMS.
    Note: If the Attachment data handler was used, this business object contains the payload as well as the attachments.
  6. If the Adapter for JMS finds a child dynamic meta-object (specified using cw_mo_conn in the business-object level application specific information), the adapter populates the user-defined JMS headers present in the business object with the headers present in the JMS message.
  7. The Adapter for JMS delivers the business object to the InterChange Server as part of a subscription delivery.

How documents are received over the JMS transport

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.

Figure 23. Message flow from a collaboration to WebSphere Partner Gateway through the JMS transport protocol
This figure shows how a business object is sent from a collaboration to the Adapter for JMS, how the Adapter for JMS calls the payload data handler, and how the Adapter for JMS sends the resulting JMS message to an output queue, from which WebSphere Partner Gateway retrieves it.

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:

  1. The collaboration within InterChange Server makes a service call to the Adapter for JMS, sending it the request business object.

    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.

  2. The Adapter for JMS uses a data handler to convert the business object that the collaboration has sent it into a JMS message.

    The adapter reads the DataHandlerMimeType and DataHandlerConfigMO properties to determine the data handler to use. For more information, see Specifying the payload data handler.

    Note: If your documents have attachments, install the Attachment data handler and then configure the Adapter for JMS to call it to convert the request business object to a document with attachments. For more information, see Handling documents with attachments.
  3. The data handler converts the business object to a string and returns it to the Adapter for JMS.
  4. The Adapter for JMS determines, from the request business object, the name of the dynamic meta-object for custom JMS properties.

    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.

  5. The Adapter for JMS searches the dynamic meta-object for the JMSProperties attribute.

    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.

  6. The Adapter for JMS creates a JMS message, using the string returned by the data handler. It also sets any custom properties, as defined in the dynamic meta-object.
  7. The Adapter for JMS sends the resulting request message to an output queue.

    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.

  8. WebSphere Partner Gateway receives the message from its JMS inbound queue, as configured in its target.

Note: WebSphere Partner Gateway supports only asynchronous interaction with InterChange Server over JMS. Therefore, you might not want to wait for the response. The response from the community participant or WebSphere Partner Gateway can come on a different queue. You can configure the Adapter for JMS to poll that queue. The response that comes on the queue can be delivered to InterChange Server as part of the event delivery.

Copyright IBM Corp. 2003, 2005