Configuring Business Integration Connect for InterChange Server

A general overview of how to configure Business Integration Connect to communicate with a back-end system is provided in Configuring Business Integration Connect. This section summarizes the steps needed to configure Business Integration Connect to communicate with InterChange Server. To perform this configuration, use an instance of Business Integration Connect Enterprise or Advanced Edition that functions as the Community Manager in your hub community.

Configuration of Business Integration Connect involves the following steps:

Providing support for outgoing documents

For Business Integration Connect 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 Business Integration Connect and InterChange Server. When the Community Manager 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:

Configuring for outgoing documents over HTTP transport protocol

When the Community Manager sends a document to InterChange Server over the HTTP protocol, the Community Manager 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 ICS-compatible component receives the document at the appropriate URL, where it can then send it to InterChange Server.

For the Community Manager to be able to send documents through a gateway over the HTTP transport protocol, you must create a gateway from the Gateway Details screen 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 ICS-compatible component is listening. As Table 30 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 30. HTTP values for Gateway Details screen for communication with InterChange Server

InterChange Server version Value of Target URI field Notes and restrictions
4.1.1, 4.2.0, 4.2.1 The URL should be the same as the one configured for the WebSphere Business Integration Connect Servlet. Obtain this URL from the configuration of the Connect Servlet in the WebSphere InterChange Server integration.
4.2.2 The URL should be the same as the the one that the protocol listener of the WebSphere Business Integration Adapter for HTTP uses to receive requests. Obtain this URL from the configuration of the Adapter for HTTP in the WebSphere InterChange Server integration.

Configuring for outgoing documents over JMS transport protocol

When the Community Manager sends documents to InterChange Server over the JMS protocol, the Community Manager routes the document to the appropriate JMS queue, where it can be retrieved by InterChange Server. For the Community Manager to obtain this JMS location, you must create a gateway in Business Integration Connect, 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 Community Manager to be able to send documents through a gateway over the JMS transport protocol, create a gateway from the Gateway Details screen of the Community Console. If you are using WebSphere MQ version 5.3 as your JMS provider, use the information in Table 116 to set the gateway fields. In addition, specify the information specified in Table 31 for the JMS protocol in the Gateway Details screen.

Table 31. JMS values for the Gateway Details screen for communication with ICS

Gateway Details field Value Notes and restrictions
JMS Message Class TextMessage, BytesMessage, or StreamMessage

Versions of the Adapter for JMS before 2.4.1 supports JMS text messages only. If you are using a pre-2.4.1 version of this adapter, make sure that the gateway is configured to write only JMS text messages (TextMessage)

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

This queue must be included the 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 Business Integration Connect 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 Community Manager:

  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 Business Integration Connect and InterChange Server.

    For Community Manager 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.

Configuring for incoming documents over HTTP transport protocol

When the Community Manager 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 Community Manager.

For the Community Manager to receive documents through a target over the HTTP transport protocol, you must create a target from the Target List screen of the Community Console. This target must use the HTTP 1.1 transport protocol. The Community Manager 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 ICS-compatible component must be configured to send documents to this URL. Therefore, you must ensure that this target URL is available for the InterChange Server configuration.

Configuring for incoming documents over JMS transport protocol

When the Community Manager receives documents from InterChange Server over the JMS protocol, the Community Manager obtains the document from the appropriate JMS queue, where InterChange Server has sent it. For the Community Manager to be able to obtain this JMS location, you must create a target in Business Integration Connect, one that uses the JMS transport protocol. Through the target, the Community Manager 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 Community Manager to receive documents through a target over the JMS transport, you must create a target from the Target List screen of the Community Console. If you are using WebSphere MQ version 5.3 as your JMS provider, use the information in Table 115 to set the target fields. In addition, specify the information specified in Table 32 for the JMS protocol in the Target Details screen.

Table 32. JMS values for the Target Details screen for communication with ICS

Target Details field Value Notes and restrictions
JMS Message Class TextMessage

Versions of the Adapter for JMS before 2.4.1 support JMS text messages only. If you are using one of these versions of the adapter, make sure that the target is configured to write only JMS text messages.

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, 2004