Generic OrderStatus business object

The generic OrderStatus business object, which is one of the generic objects used by the Order Status collaboration template, is independent of the other status objects. It is used to capture the state of a sales order whenever that state changes.

For example, the creation of a sales order triggers the creation of a corresponding OrderStatus business object with a status of "Open". Scheduling a delivery for one of the line items in the sales order triggers creation of a new OrderStatus business object, this time with a status of "Partially Scheduled". Reserving inventory for all line items in the sales order triggers creation of an OrderStatus business object with a status of "Fully Reserved".

Business object structure

The OrderStatus business object is hierarchical. One of its attributes references the OrderStatusLine child business object, which contains status information about a line item in the associated sales order.

Each OrderStatus business object matches the structure of its associated sales order. If the sales order has two line items, OrderStatus has a header and two OrderStatusLine business objects. Even if the triggering event affects only one line item of the sales order, OrderStatus references separate child business objects for each line item in the sales order.

For example, assume a sales order has two line items, one of which has just been scheduled for delivery. Scheduling the line item's delivery triggers creation of an OrderStatus business object with two OrderStatusLine business objects. Only one of the child business objects contains the change in scheduling status. The other child business object contains no information specific to the current triggering event. A summary of the scheduling status for the entire order is stored in the OrderStatus header object.

OrderStatus: Reporting summary status changes

OrderStatus contains such information as the identifiers of the order and its associated customer and purchase order, the reason for the order, delivery and billing block data, and the person who last changed the order as well as the date of the change. In addition, it uses six attributes to summarize the status of all line items in the order.

Table 1: Status attributes in the OrderStatus business object

Attribute Value reported
ProcessingStatusHeader The physical state of the entire order; for example, values might include "Incomplete", "Open", and "Partially Complete"
InventoryResStatusHeader Whether the inventory has been reserved; for example, values might include "Not reserved", "Partially reserved", and "Fully reserved"
ApprovalStatusHeader The stage of the order's approvals; for example, values might include "Not approved", "Level 1 approved", and "Level 2 approved"
CreditStatus The result of the customer's credit standing or credit check; for example, values might include "Not checked", "Approved", and "Not approved"
RejectionStatusHeader The order's rejection status if its fulfillment was rejected for any reason; for example, values might include "Not rejected", "Rejected customer", and "Rejected part"
DeliverySchHeader Whether the deliveries for the sales order have been scheduled in the shipping application; that is, whether deliveries have been created. It does not indicate that deliveries have been shipped; for example, values might include "Not schedule", "Partially scheduled", and "Fully Scheduled".

OrderStatusLine: Reporting line item status changes

OrderStatusLine contains such information as the identifiers of the sales order line item and its associated item, the reason for the rejection of the line item, the billing block assigned to the line item, and the person who last changed the line item as well as the date of the change. In addition, it uses five attributes to contain the status of the line item.

Table 2 explains the five status attributes used by the OrderStatusLine business object.

Table 2: Status attributes in the OrderStatusLine business object

Attribute Value reported
ProcessingStatusLine The physical state of the line item
InventoryResStatusLine Whether the inventory for the line item has been reserved
ApprovalStatusLine The stage of the line item's approvals
RejectionStatusLine The line item's rejection status if its fulfillment was rejected for any reason
DeliverySchLineStatus Whether the deliveries for the line item have been scheduled

For information on the business object's capability to handle complex sales orders, such as a single sales order with multiple sales documents, see the generic OrderDeliveryStatus business object.

Supported verbs

OrderStatus supports the following verbs:

Examining the object

To examine the attributes of the generic OrderStatus business object, use System Manager or Process Designer Express.

Related References

Copyright IBM Corp. 1997, 2004