Orders¶
The processing of a recipe variation is known as running an order. Orders are specific to a kitchen-recipe-variation combination.
Each order is assigned an order ID, which is unique across all kitchens. From the Orders page, hover over any truncated order ID to view the full unique identifier.
Example order ID:
887d01ba-365e-11e9-8394-0242ac110002
View the Orders page¶
A list of past and present orders is available in Automation from the Orders page.
- In Automation, select your kitchen.
- Select Orders from the green menu.
The Orders page refreshes every 10 seconds. The system automatically polls an active order run for its status for the first 30 seconds of a run. Click Refresh Orders to refresh the page if an order run ID has not yet been displayed for an order.
Use the filters—Recipe, Variation, Order Status, Order Run Status, and Time Period—or the ID search field to refine the list of orders.
- Any filters or search applied to the Orders page automatically updates the URL, so you can share a pre-filtered page link with colleagues who have access to the kitchen.
- While you can filter by Order Status, only order run statuses are shown in the table, not the order status.
Warning
Filters save to the user account: Any filters you apply to the Orders page will persist until you change or clear them. Filters do not reset on logout. If you cannot find a new order listed, try clearing your filters.
Order Actions¶
Click Order Actions to open a drop-down menu with options to Delete All orders, Delete Completed orders, and Run Variation Once.
The Run Variation Once option opens a dialog where you can select the variation to run.
Columns¶
- Order ID: the unique identifier for the order.
- Recipe/Variation: shows the recipe and variation of the order. Click any link to open to the Variation Metrics page.
- Created By: who created the order.
- Schedule status: for scheduled orders, this column shows the schedule status. For orders run manually, the status is N/A.
- Active: schedule is ready for the next run of the order.
- Inactive: schedule had a critical failure and cannot be used.
- Stopped: schedule was manually stopped by a user.
- Paused: schedule was manually paused. The pause button becomes a play button to resume the schedule.
- N/A: no schedule set for this order.
-
Schedule control buttons: changes the next run of active schedules. See Pause or Stop Schedules for more information.
- Stop: halts an active schedule permanently.
- Pause: places an active schedule on a temporary pause, until it is resumed. Order runs in progress continue to execute, but no new order runs are generated.
- Play: resumes a paused schedule. Scheduled order runs missed during the paused time are not run.
-
Order Run: the ID for the order run. Click one of these links to open the Order Run Details page. Hover over any truncated order ID to view the full identifier. Orders with multiple order runs display the three most recent orders with a Show More button.
- Timings: when and for how long the order run occurred.
- Order Run Status: this column shows the current status of the order run.
- Active: order run is executing.
- Complete: order run finished processing without errors.
- Error: order run failed.
- Time Exceeded: order run stopped at the time limit set for the variation. Note that order runs can be configured to stop upon reaching the time limit. Time-exceeded orders that are stopped may be resumed manually.
- Stopped: order run was manually stopped by a user.
- Resumed: order run was resumed as a new order run.
- Not Run: order run was skipped when the order infrastructure was unavailable. The order run can be manually run.
- Actions: Click to Copy Order Run (for a completed status), Resume Order Run (for an error status), or Delete Order Run.
Delete previous orders¶
To clean up the order list, delete old orders that are no longer needed.
- Click Order Actions and select Delete All or Delete Completed.
- Click Select All, then click Delete.
- Check a specific order run, then click Delete.
- Click More for a specific order run, then select Delete Order Run
Note
Order runs history: Automation maintains the order and order run data of inactive orders for three months, after which time the data is deleted. Data for active orders is retained. Deleting a kitchen without promoting its order runs to a parent kitchen deletes all data—active or not.
CLI order-list command¶
A list of past and present orders is available in the command line interface (CLI) with the order-list command.
Tip
DKCloudCommand option: Use the order-list, order-delete, or order-stop commands in the command line interface.
Visual example in Automation¶
