Customizing senders

When a WebSphere Partner Gateway receiver component receives a business document from a trading partner, the sequence of steps is as follows:

  1. The document processor component unpackages the business document in accordance with the business protocol for that document type.
  2. The participant connection determines how the document will be processed and routed.
  3. The document is processed and packaged according to the business protocol requirements of the "To" protocol and the "To" packaging specified by the participant connection.
  4. The Delivery Manager picks up the business document and sends it to the trading partner. The "To" gateway determined from the participant connection gives the configuration to use for sending the packaged business document to the recipient trading partner.
  5. The Delivery Manager invokes the Receiver Framework to send the document. The Receiver Framework manages the senders and sending of the document.
  6. The sender performs the actual sending of the packaged business document to the target trading partner.

The sender is responsible for sending the packaged business documents to the target trading partner. If the business protocol requires such action, the sender can synchronously receive the response business document for the document it is sending. The sequence is as follows:

  1. The sender receives the response business document according to the business protocol semantics.
  2. If the sender obtains the response business document, the sender introduces the document into the system.
  3. After the response document is introduced into the system, the WebSphere Partner Gateway document processor processes the document like any other business document.
  4. The document processor unpackages the response document, using the participant connection to look up information for the document.
  5. The response business document is processed and packaged according to the business protocol requirements of the "To" protocol and the "To" packaging given by the participant connection.
  6. The Delivery Manager picks up the business document and sends it to the trading partner.
  7. If the response document is in response to a request document that was synchronously received by the receiver, the Delivery Manager gives this document to the receiver. In this case, the receiver sends the response to the waiting trading partner.

    If the request document was not synchronously received, the Delivery Manager processes the response document the same way that it processed the request document.

The sender handles the final stage in the data flow of WebSphere Partner Gateway. It picks up documents from the BPE, packages them, and sends them to their destinations, based on information in the Community Console-configured gateway. In the case of a synchronous request, it can also process the response document.

This chapter describes sender customization and the processing done by senders. You can customize the sending of documents in either of two ways:

The chapter describes both ways of customizing senders:

An additional section describes development and deployment issues:

The API list and example code follows in the next chapter.

Copyright IBM Corp. 2003, 2005