Configuring WebSphere Partner Gateway for Message Broker

A general overview of how to configure WebSphere Partner Gateway to communicate with a back-end system is provided in Configuring WebSphere Partner Gateway. This section summarizes the steps needed to configure WebSphere Partner Gateway to communicate with Message Broker.

Configuration of WebSphere Partner Gateway involves the following steps:

Providing support for outgoing documents

For WebSphere Partner Gateway to send documents to any back-end system, you must perform the steps described in Defining where to send the participant document. When your back-end system is Message Broker, you need to create a gateway whose transport type matches the transport protocol used for messages between WebSphere Partner Gateway and Message Broker. When the hub sends a document to Message Broker, it must know where to route the document. This location must conform with the transport protocol being used. The transport protocol must be one that Message Broker supports (see Message transports that Message Broker supports).

The following sections summarize how to create gateways for the following transport protocols, which Message Broker supports:

Configuration for sending documents over the HTTP transport protocol

When the hub sends a document to Message Broker over the HTTP protocol, it routes the message through the defined gateway. This gateway identifies the URL where the document can be received by Message Broker. When Message Broker uses the HTTP protocol, it routes the document to the HTTPInput node of the message flow associated with the specified URL.

For the hub to be able to send documents through a gateway over the HTTP transport protocol, you must create a gateway from the Gateway Details page of the Community Console. This gateway must be configured to use the HTTP 1.1. transport protocol and to write to the URL on which the appropriate HTTPInput node is listening. As Table 61 shows, you provide this URL in the Target URI field of the gateway definition.

Note: An overview of how to create a gateway is provided in Defining where to send the participant document.

Table 61. HTTP values for Gateway Details page for communication with Message Broker
Target Details field Value Notes and restrictions
Target URI The URL should be the same as the one configured for the HTTPInput node in the Message Broker message flow Obtain this URL from the configuration of the message flow in the WebSphere Business Integration Message Broker integration.

Configuration for receiving documents over the JMS transport protocol

When the hub sends documents to Message Broker over the JMS protocol, it routes the document to the appropriate JMS queue, where it can be transferred to the JMS queue from which Message Broker can retrieve it. For the hub to obtain this JMS location, you must create a gateway in WebSphere Partner Gateway, one that uses the JMS transport protocol. This gateway must be configured to write to the queue whose contents are transferred to the queue on which Message Broker receives messages.

Note: For an overview of how to create a gateway, see Defining where to send the participant document.

For the hub to be able to send documents through a gateway over the JMS transport protocol, create a gateway from the Gateway Details page of the Community Console. When using WebSphere MQ, version 5.3 as your JMS provider, refer to the Hub Configuration Guide for the detailed steps. In addition, use the information specified in Table 62 for the JMS protocol in the Gateway Details page.

Table 62. JMS values for the Gateway Details page for communication with Message Broker
Gateway Details field Value Notes and restrictions
JMS Queue Name Name of the JMS queue, on the computer where WebSphere Partner Gateway resides

Documents received on this queue are transferred to the JMS queue on the computer where Message Broker resides.

Providing support for incoming documents

For WebSphere Partner Gateway to receive messages from any back-end system, you must perform the steps described in Defining where to retrieve the back-end document. When your back-end system is Message Broker, you need to take the following steps:

  1. As part of the participant profile for the Community Manager, define the gateway type and provide the associated IP address on which the Receiver will listen.
  2. Create a target whose transport type matches the transport protocol used for documents between WebSphere Partner Gateway and Message Broker.

    For the hub to receive a document from Message Broker, it must know the location at which to retrieve the messages. This location must conform with the transport protocol to be used.

The following sections summarize how to create targets for transport protocols that Message Broker supports.

Configuring for incoming documents over HTTP transport protocol

When the hub receives a document over the HTTP transport protocol, its Receiver retrieves the document from the defined target. This target identifies the URL at which the Receiver listens for documents from Message Broker. When Message Broker uses the HTTP transport protocol, the HTTPRequest node sends the document to the appropriate URL, where it can be received by the hub.

For the hub to receive documents through a target over the HTTP transport protocol, you must create a target from the Target List page of the Community Console. This target must use the HTTP 1.1 transport protocol. The hub determines this URL as a combination of the following information:

Note: An overview of how to create a target is provided in Defining where to retrieve the back-end document.

For Message Broker to be able to send documents to this target, the HTTPRequest node of the message flow must be configured to send documents to this URL. Therefore, you must ensure that this target URL is available to the Message Broker configuration.

Configuring for incoming documents over JMS transport protocol

When the hub receives documents from Message Broker over the JMS protocol, it obtains the document from the appropriate JMS input queue, where it has been transferred from the JMS output queue where Message Broker has sent it. For the hub to be able to obtain this JMS location, you must create a target in WebSphere Partner Gateway, one that uses the JMS transport protocol. Through the target, the hub listens for any documents on its input queue and retrieves them.

Note: For an overview of how to create a target, see Defining where to retrieve the back-end document.

For the hub to receive documents through a target over the JMS transport, you must create a target from the Target List page of the Community Console. When using WebSphere MQ, version 5.3 as your JMS provider, refer to the Hub Configuration Guide for the detailed steps. In addition, use the information specified in Table 63 for the JMS protocol in the Target Details page.

Table 63. JMS values for the Target Details page for communication with Message Broker
Target Details field Value Notes and restrictions
JMS Queue Name Name of the JMS input queue that receives documents from the output queue of Message Broker

Documents in this input queue are transferred from the JMS output queue on the computer where Message Broker resides

Copyright IBM Corp. 2003, 2005