The OrderStatus collaboration synchronizes order status data from an Enterprise Resource Planning (ERP) application to a Customer Interaction Management (CIM) application. As status information on orders changes in an order-management system, the collaboration sends the change in state to a collaborating destination application.
To synchronize the status of an order between the ERP and CIM applications, the orders must already exist. The collaboration verifies that the order exists in the destination application before it sends the request to update its status. Because each status change is made to an existing sales order, the collaboration sends business objects with the Update verb only.
Every status business object reflects the format of the order whose status it tracks. For example, if the order contains three line items, the status business object contains the order header and the three line items from the order. The header information provides a summary view of the entire sales order's delivery status.
Typically the sales order process originates in the CIM application when the Telesales Representative or the Customer Service Representative (CSR) takes an order or makes a quote while talking with a customer. After the order is saved in the front-office application, the Telesales rep or CSR sends the order to the ERP application, where it is processed and booked. ERP processes include order generation, delivery of the products, billing to the customer, product returns, and any service or repairs.
Future requests or changes made by the front-office representative are also sent to the ERP system, where the changes are processed. Any change of status that occurs to the order in the ERP system is immediately pushed back to the CIM system by the OrderStatus collaboration.
The OrderStatus collaboration uses the generic OrderStatus business object to provide status data on sales orders.
The order life cycle can vary from a simple process to a complex one.
The OrderStatus collaboration uses a generic OrderStatus business object to report a change to an order's state during the sales order lifecycle. For example, if the ordered quantity of an item is updated in the ERP, this update is subscribed to by the OrderStatus collaboration. Similarly, if an item is removed from and order in the ERP, this will be processed as a status update by the collaboration.
As long as the sales order in the ERP application exists as an order in the CIM, the order in the CIM application can be of any type; that is, the ERP sales order can synchronize with a quote, a contract, a return, or a sales order in the CIM application. However, the orders must exist in both the ERP and CIM applications because the OrderStatus collaboration does not synchronize the order. Before the collaboration updates a status value, it verifies that the order referenced in the ERP application exists in some form in the CIM application. If it does not, the collaboration logs an error and stops.
An ERP application always serves as the source, because updates to the sales order are always made in the back office application. Whenever the ERP application notes a change in state of an order, the collaboration sends the specific status change of the order to the CIM application. Changes to the status of subsequent documents will be processed by other collaborations, if implemented.
These collaborations include the following:
Although the synchronizations performed by the OrderStatus collaboration are intended primarily for a CSR or Telesales Rep who responds to customers' queries through a front-office application, the collaboration is not triggered by a customer's phone call to the front office. Instead, status changes are pushed to the CIM application at the time they are made in the ERP application. Because the status of orders is synchronized in the CIM application as soon as they are changed in the ERP application, the CSR or Telesales Rep has access to the current status of an order when a customer requests it.
This section includes information on port bindings and required steps for setting up collaboration objects based on OrderStatus. 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 ports of OrderStatus as they are displayed in System Manager. The tables that follow the figure provide information about each port.
Figure 1. OrderStatus collaboration 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 |
---|---|---|---|
OrderStatus | The destination application's connector | Sends a reference-valued business object to retrieve the full-valued business object. The result determines the verb to use when synchronizing the Order. |
Retrieve |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
OrderStatus | Source application's connector or calling collaboration. | 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 |
---|---|---|---|
OrderStatus | The destination application's connector |
Sends the triggering business object out of the collaboration |
Create Update Delete |
OrderStatus is designed to be used as a stand-alone collaboration. To set up OrderStatus as a stand-alone collaboration object, follow these steps:
This section illustrates the process logic for this collaboration template:
Figure 2 illustrates the OrderStatus process logic.
Figure 2. OrderStatus collaboration process logic
This collaboration template uses the following standard collaboration business processes:
For information on these processes, see the Collaboration Development Guide.
InterChange Server Express can roll back a transaction when any step in a transactional collaboration fails. For example, when OrderStatus 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 must roll back the processing of every collaboration in the group.
When an OrderStatus 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 modifying 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:
Note: OrderStatus does not have unique configuration properties. All of its properties are standard. Standard properties
This collaboration template uses the following standard configuration properties for collaboration templates:
For information on these configuration properties, see the Collaboration Development Guide..
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:
To upgrade to newer version of the collaboration template, perform the following steps: