Managing Order Status with the Orders Receive Adapter

The Orders receive adapter includes the following two properties that you can use to help manage the status of orders that are exported using that adapter:

• Status From

• Status To

Both of these properties are strings, and valid values are comma-separated lists of one or more purchase order status values such as NewOrder, Submitted, Shipped, and so on. The Status From property may have zero (0) or more comma-separated values, and the Status To property must have either zero (0), one (1), or exactly the same number of values specified as the Status From property.

Note

All values that you include in the comma-separated lists for the Status From and Status To properties must be defined as valid values for the status of orders within the Orders System. For more information about the Orders System status values, including the default order status values, see How to Coordinate Updates to Orders.

The values in the Status From property, if any, are used as a filter for the export operation. In other words, if you set the Status From property to the value "NewOrder, InProcess"", then only orders with a status of "NewOrder" or "InProcess" will be included in export messages generated for the Orders receive adapter endpoint for which you configured these values.

The values in the Status To property, if any, are used to modify the status of the corresponding order within the Orders System according to the behaviors defined in the following table.

Status From property	Status To property	Behaviors and example
Zero (0) values	Zero (0) values	Behaviors: No filtering of exported orders based on the Status From property occurs. Note: Other filtering, based on different property settings, may still occur. No changing of order status within the Orders System is performed. Example: Status From: <no value> Status To: <no value>
One (1) or more values	Zero (0) values	Behaviors: Exported orders are filtered according to the value(s) specified in the Status From property. No changing of order status within the Orders System is performed. Example: Status From: NewOrder, Cancelled Status To: <no value> New and cancelled orders are exported, but no status values are changed within the Orders System.
One (1) or more values	One (1) value	Behaviors: Exported orders are filtered according to the value(s) specified in the Status From property. Every exported order has its status in the Orders System updated to the value provided in the Status To property. Example: Status From: NewOrder, Cancelled Status To: Submitted New and cancelled orders are exported, and the status of all exported orders is changed to "Submitted" within the Orders System.
One (1) or more values	Exactly the same number of values	Behaviors: Exported orders are filtered according to the value(s) specified in the Status From property. Every exported order has its status in the Orders System updated to the value within the Status To property that is in the same relative position as its pre-updated status within the Status From property. Example: Status From: NewOrder, Cancelled Status To: Submitted, InProcess New and cancelled orders are exported, and with the Orders System, new orders are updated to a status of "Submitted" and cancelled orders are updated to a status of "InProcess".
One (1) or more values	Some number of values other than exactly the same number	Behaviors: These settings will generate an error when you attempt to apply the property changes or click OK to exit the dialog box. Example: Status From: New, Cancelled, Rejected Status To: Submitted, InProcess
Zero (0) values	One (1) or more values	Behaviors: These settings will generate an error when you attempt to apply the property changes or click OK to exit the dialog box. Example: Status From: <no value> Status To: Submitted, InProcess

Important Note:

The Orders receive adapter does not ever change the status value of the one or more orders within the CommerceServerOrdersExport messages that it generates and delivers to BizTalk Server. These values are always exactly as they were within the Orders System before any changes made by the Orders receive adapter based on the values provided in the Status From and Status To properties. It is up to order processing code implemented within BizTalk Server, or order processing code implemented in another application beyond BizTalk Server, such as a line-of-business (LOB) application, to recognize and account for the fact that the order status within the Orders System and the order status in the CommerceServerOrdersExport message may be different.

See Also

Other Resources

How to Configure the Orders Transport Properties for a Receive Endpoint

BizTalk Adapter Concepts