For your interactions between WebSphere Partner Gateway and InterChange Server, you must create an Integration Component Library (ICL) within the System Manager tool. This ICL will include the following artifacts:
You must also create a user product and select from the ICL those artifacts required for your particular interaction between InterChange Server and WebSphere Partner Gateway.
WebSphere Partner Gateway sends your message to an adapter, which routes the message to InterChange Server in the form of one or more business objects. For InterChange Server to recognize a business object, it must first locate a template, called a business object definition, to describe the structure of the information in the business object. Each piece of information in a business object definition is held in an attribute. Therefore, you must create business object definitions to represent the information in your message. To create business object definitions, use the Business Object Designer tool.
InterChange Server uses business objects for the following information:
To hold the payload of the WebSphere Partner Gateway document or message, you must define a business object definition to represent the payload business object. It is in the form of a payload business object that the adapter transfers the document into (or out of) InterChange Server. This section provides the following information on the payload business object:
Business object structureThe payload business object must be designed so that each piece of information in the document that you want to transfer has an attribute in its associated payload business object definition. As Table 30 shows, the contents of the payload business object depend on the structure of the document and the packaging type that the document uses.
Document structure | Packaging type | Payload business object definition |
---|---|---|
Payload only | None | Holds the payload information of the document. |
Payload only | Backend Integration |
Holds:
|
Payload and attachments | None | Not applicable. You must use Backend Integration packaging if your document contains attachments. |
Payload and attachments
The document contains an XML wrapper, called a transport envelope, in which both the payload and attachments are wrapped. |
Backend Integration |
Holds:
A WebSphere Partner Gateway-supplied data handler, called the Attachment data handler, is required to process the transport envelope. For more information, see Handling documents with attachments. |
The payload business object must also be designed according to the requirements of the particular adapter used for integration with WebSphere Partner Gateway. Table 31 provides information on where to find details of how to create the payload business object for transfer over a particular transport protocol.
Transport protocol | Notes and restrictions | For more information |
---|---|---|
HTTP | Creating business object definitions for ICS over HTTP | |
JMS | If document uses Backend Integration packaging | Creating business object definitions for JMS |
All | If document has attachments | Creating attachment-related business object definitions |
Usually, the adapter uses a data handler to convert between the format of the document and its business-object representation. This data handler is called the payload data handler. The adapter must be configured to call the appropriate data handler for the payload's content type. Usually, the WebSphere Business Integration Data Handler for XML is configured as the payload data handler because it converts between XML messages and business objects. However, you can create custom data handlers for any message formats that do not have a corresponding data handler provided by WebSphere Business Integration Server.
You must make sure the payload data handlers you are using can ignore the child meta-objects that are required by the transport protocol you are using. Before using a data handler (whether it is supplied by WebSphere Business Integration or whether it is a custom data handler), make sure it provides support for child meta-objects. Refer to the section on the cw_mo_label tag in the business object's application-specific information in the appropriate section for your transport protocol (see Table 31).
To indicate which data handler to use to convert the payload, you must take the following steps:
The Data Handler Guide in the WebSphere Business Integration Adapter documentation set describes the data handlers that IBM provides. If none of these data handlers can work, you can create a custom data handler.
For InterChange Server, the name of the payload business object depends on the direction of the communication, as follows:
In this case, the data business object is called the event business object (sometimes called just an event), which notifies InterChange Server of an event that occurred in some community participant.
In this case, the data business object is a request business object, which InterChange Server has sent to request information from some community participant. In response, InterChange Server might send a response business object back to the hub community.
For many of the adapters, you create business object definitions to hold configuration information. Such business objects are often called meta-objects.
Table 32 provides information on where to find details of how to create the data business object for transfer over a particular transport protocol.
Transport protocol | Related component | For more information |
---|---|---|
HTTP | Adapter for HTTP | Creating HTTP transport-level header information for ICS |
JMS | Adapter for JMS | Creating JMS header information |
All | Attachment data handler | Creating the Attachment child meta-object |
You must create a connector object for the adapter you will be using. This connector object represents an instance of the adapter at run-time. You create connector objects within InterChange Server's System Manager tool.
Table 33 summarizes where to find information about how to create connector objects, based on the transport protocol you are using.
Transport protocol | Adapter | For more information |
---|---|---|
HTTP | Adapter for HTTP | Creating the HTTP connector object |
JMS | Adapter for JMS | Creating the JMS connector object |
It is the collaboration, within InterChange Server, that performs the actual business process you need. Therefore, the appropriate collaboration must exist for InterChange Server to correctly process your WebSphere Partner Gateway documents. Make sure you take the following steps to make the appropriate collaboration available at run-time:
Table 34 summarizes where to find information about how to create connector objects, based on the transport protocol you are using.
Transport protocol | Adapter | For more information |
---|---|---|
HTTP | Adapter for HTTP | Binding collaborations to communicate with Adapter for HTTP |
JMS | Adapter for JMS | Binding collaborations to communicate with Adapter for JMS |
After your user project contains the artifacts that define the run-time components needed, you must deploy it to the InterChange Server repository. You deploy a user project within System Manager.