The TradingPartnerOrderManagement collaboration template is used to create and update Sales Orders in the supplier's order management application. The process is initiated by the creation or modification of a Purchase Order in the buyer's procurement application. The following list describes in detail this collaboration's various features:
TradingPartnerOrderManagement uses the generic TradingPartnerOrder business object to synchronize Purchase Order and Sales Order data.
Although it synchronizes only TradingPartnerOrder business object data, TradingPartnerOrderManagement can be implemented in parallel with the appropriate collaboration to synchronize order status data using the following related business object:
Business object | Related collaboration properties | Called collaborations |
---|---|---|
OrderDeliveryStatus | FromTradingPartnerURL ToTradingPartnerURL | OrderDeliveryStatus |
This section includes information on port bindings and required steps for setting up collaboration objects based on TradingPartnerOrderManagement. For information on standard features, ports, and configuration properties for collaboration templates, see the Collaboration Development Guide. For general information on creating collaboration objects, see the System Implementation Guide.
Figure 1 illustrates TradingPartnerOrderManagement's ports, as they are displayed in System Manager.
Figure 1. TradingPartnerOrderManagement collaboration's ports
Note: To prevent the collaboration object from using a port, bind that port to the Port connector. Binding the port indicates that the port is unused without causing the collaboration object to provide additional functionality.
Business object | Bound to | Function | Verbs used |
---|---|---|---|
TradingPartnerOrder | Destination (supplier's) application connector | Sends a reference-valued business object to retrieve the full-valued business object. |
Retrieve |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
TradingPartnerOrder | The source (buyer's) application connector | Receives the triggering business object. At the end of a synchronous call, this port also returns the triggering business object to the source application when the collaboration ends successfully. |
Create Retrieve Update Delete |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
TradingPartnerOrder | The destination (supplier's) application connector, a custom collaboration, or the SalesOrderProcessingWrapper collaboration |
Sends the triggering business object out of the collaboration. Normally this is bound to the destination application, but it can be bound to a wrapper collaboration. |
Create Update Delete |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
TradingPartnerOrder | Source (buyer's) application connector | Returns the object to the buyer's application if the Sales Order creation fails in the destination application. |
Update |
This section illustrates the process logic for this collaboration template:
Figure 2 illustrates TradingPartnerOrderManagement's process logic.
Figure 2. TradingPartnerOrderManagement collaboration's process logic
This collaboration template uses the following standard collaboration business processes:
For information on these processes, see the Collaboration Development Guide.
Figure 3 illustrates TradingPartnerOrderManagement's additional process for updates.
Figure 3. Additional processing for updates
InterChange Server Express can roll back a transaction when any step in a transactional collaboration fails. For example, when TradingPartnerOrderManagement is a member of a collaboration-object group that participates in a transactional collaboration, its actions are one subtransactional step of a larger transaction. If any step in the collaboration-object group's business process fails, the transactional collaboration details how InterChange Server Express rolls back the processing of every collaboration in the group.
When a TradingPartnerOrderManagement collaboration object is used independently of other collaboration objects or the collaboration object's From port is bound to a source application rather than to another collaboration, its process comprises a single transactional step. In such a situation, it is not necessary to perform rollback.
To cause a collaboration object or a collaboration-object group to perform rollback requires modification of the collaboration template. To understand transaction processing in the IBM WebSphere Business Integration Server Express Plus system, see the System Implementation Guide. For information about adding transaction processing to the collaboration template, see the Collaboration Development Guide.
To extend the collaboration object to handle transaction processing, complete the following steps:
This section describes the standard properties and collaboration template-specific properties for this collaboration template:
This collaboration template uses the following standard configuration properties for collaboration templates:
For information on these configuration properties, see the Collaboration Development Guide.
In addition to its standard configuration properties, this collaboration template has the configuration properties described below.
Property name and explanation | Possible values | Default value |
---|---|---|
ALLOW_UPDATES Specifies whether or not Purchase Order updates will be processed by the collaboration. Set to "true" to allow updates. |
true, false | true |
RETRIEVE_ORDER_STATUS This property is only evaluated if the ALLOW_UPDATES property is set to "true". If set to "true", when the collaboration receives a TradingPartnerOrder.update event, it retrieves the full object from the destination application and evaluates the value of the ORD_STATUS_ERROR_ATTRIBUTE property. If it evaluates to ORD_STATUS_ERROR_COND, the event fails and an email is sent to the buyer application's administrator. If set to "false", when the collaboration receives a TradingPartnerOrder.update event, no retrieval occurs. |
true, false | true |
RETURN_ERROR_OBJECT If set to "true", when the Sales Order creation or update fails in the supplier's application, or when the value of the ORD_STATUS_ERR_ATTRIBUTE property evaluates to ORD_STATUS_ERR_COND, the collaboration will send the TradingPartnerOrder generic business object back to the buyer through the ToFailure port. If set to "false", no object will be sent back to the buyer. This configuration option has no effect on the SEND_EMAIL configuration. |
true, false | false |
ORD_STATUS_ERR_COND This property is only evaluated if RETRIEVE_ORDER_STATUS evaluates to "true". Specify values for the collaboration to use as a filter to prevent synchronization of the triggering business object. The collaboration excludes a business object from synchronization if the value of the attribute specified by ORD_STATUS_ERR_ATTRIBUTE matches one of the values listed in this property. The collaboration is not sensitive to the case of the specified values or to extra spaces in the list of values. |
Comma-delimited list of values | shipped |
ORD_STATUS_ERR_ATTRIBUTE The collaboration evaluates this property only if ORD_STATUS_ERR_COND evaluates to a value other than "none". Specify the business object attribute for the collaboration to use when comparing values in the ORD_STATUS_ERR_COND property. The collaboration compares the value in the specified attribute against the values specified for exclusion by the ORD_STATUS_ERR_COND property to prevent synchronization of business objects with specific values. For example, assume that a top-level business object named BusObjA contains a child business object named BusObjB. To filter on an attribute named Type in the BusObjB business object, set the value of ORD_STATUS_ERR_ATTRIBUTE to BusObjA.BusObjB.Type. |
AttributeName | status |
To view an explanation of the messages of this collaboration template, launch the Log Viewer and open the collaboration template's message file. To launch the Log Viewer and open the collaboration template's message file: