Configuring WebSphere Partner Gateway for InterChange Server

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 InterChange Server.

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 InterChange Server, you need to create a gateway whose transport type matches the transport protocol used for messages between WebSphere Partner Gateway and InterChange Server. When the hub sends a document to InterChange Server, 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 InterChange Server supports (see Message transports that InterChange Server supports).

The following sections summarize how to create gateways for following transport protocols, which InterChange Server supports:

Configuration for sending documents to ICS over the HTTP transport protocol

When the hub sends a document to InterChange Server over the HTTP protocol, the hub routes the message through the defined gateway. This gateway identifies the URL where the document can be received by InterChange Server. When InterChange Server uses the HTTP protocol, an adapter receives the document at the appropriate URL, where it can then send it to InterChange Server.

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 adapter is listening.

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

Configuration for sending documents to ICS over the JMS transport protocol

When the hub sends documents to InterChange Server over the JMS protocol, the hub routes the document to the appropriate JMS queue, where it can be retrieved by InterChange Server. 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 on which the Adapter for JMS polls.

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. If you are using WebSphere MQ, version 5.3 as your JMS provider, refer to the Hub Configuration Guide for detailed steps. In addition, provide the information specified in Table 28 for the JMS protocol in the Gateway Details page.

Table 28. JMS values for the Gateway Details page for communication with ICS
Gateway Details field Value Notes and restrictions
JMS Message Class TextMessage, BytesMessage, or StreamMessage
JMS Queue Name Same JMS queue name as the input queue for the Adapter for JMS

This queue must be included in the list of input queues of the Adapter for JMS; that is, the adapter must poll this queue for incoming events. For more information, see Identifying the JMS queues.

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 InterChange Server, you need to take the following steps in your hub:

  1. As part of your 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 InterChange Server.

    For the hub to receive a document from InterChange Server, it must know the location at which to retrieve the messages. This location must conform with the transport protocol to be used. The transport protocol must be one that InterChange Server supports (see Message transports that InterChange Server supports).

The following sections summarize how to create targets for transport protocols that InterChange Server supports.

Configuration for receiving documents from ICS over the 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 InterChange Server. When InterChange Server uses the HTTP transport protocol, an adapter 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 InterChange Server to be able to send documents to this target, its adapter must be configured to send documents to this URL. Therefore, you must ensure that this target URL is available for the InterChange Server configuration.

Configuration for receiving documents from ICS over the JMS transport protocol

When the hub receives documents from InterChange Server over the JMS protocol, the hub obtains the document from the appropriate JMS queue, where InterChange Server 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. If you are using WebSphere MQ, version 5.3 as your JMS provider, refer to the Hub Configuration Guide for the detailed steps. In addition, provide the information specified in Table 29 for the JMS protocol in the Target Details page.

Table 29. JMS values for the Target Details page for communication with ICS
Target Details field Value Notes and restrictions
JMS Message Class TextMessage

JMS Queue Name Same JMS queue name as the output queue for the Adapter for JMS

This queue must be listed as the output queue of the Adapter for JMS; that is, the adapter must send documents to this queue. For more information, see Identifying the JMS queues.

Copyright IBM Corp. 2003, 2005