This time-triggered transaction sets the order's ORDER_CLOSED flag to ‘Y' and raises the ON_SUCCESS event. These actions are only performed when the entire ORDER_QTY for all the order lines reaches the configured pickup status. If an order has ORDER_CLOSED set to ‘Y', it is not picked up for monitoring.
The Close Order agent must be configured along with the Purge transaction in the pipeline.
Many of this transaction's elements and attributes are template-driven. Refer to the XML for element level details.
The Close Order agent must be run before running the Monitor agent in order to avoid alerts getting raised for cancelled orders.
The following are the attributes for this time-triggered transaction:
Attribute | Value |
---|---|
Base Transaction ID | CLOSE_ORDER |
Base Document Type | Order |
Base Process Type | Order Fulfillment |
Abstract Transaction | No |
APIs Called | None |
The following are the criteria parameters for this transaction:
Parameter | Description |
---|---|
Action | Required. Triggers the transaction. If left blank, it defaults to Get, the only valid value. |
Number of Records To Buffer | Optional. Number of records to retrieve and process at one time. If left blank or specified as 0 (zero), it defaults to 5000. |
Next Task Queue Interval | Optional. Specifies in hours how long a failed task should be suspended before it is considered for reprocessing. Defaults to 5 hours. |
ColonyID | Required in a multischema deployment where a table may exist in multiple schemas. Runs the agent for the colony. |
The following statistics are tracked for this transaction:
Statistic Name | Description |
---|---|
NumOrdersProcessed | Number of orders processed. |
NumOrdersClosed | Number of orders closed. |
For this transaction the pending job count is the number of records available to be processed by the transaction with the AVAILABLE_DATE value less than or equal to (<=) the current date value in the YFS_Task_Q table, if tasks on hold are not ready to be processed.
The following events are raised by this time-triggered transaction:
Transaction/Event | Data Published | Template Support? |
---|---|---|
ON_SUCCESS | YFS_CLOSE_ORDER.ON_ |
Yes |