Run an Order¶
The processing of a recipe variation is known as running an order. Orders are specific to a kitchen-recipe-variation combination.
You can start an order run for recipe variations from the Recipes page, Variation page, after setting a schedule, and from the command line.
The UI uses a multi-step wizard to run an order. It includes steps to set a schedule, update variables, and more. Note some steps are optional.
How to run an order¶
First, navigate to the appropriate kitchen.
From the Recipes page¶
Select a recipe from the list. Click Run Variation next to the variation name. For more details on each step in the wizard, see Run Variation multi-step wizard below.
From the Variation page¶
Select a recipe from the list, then select the name of the variation that you want to run. Click Run Variation. For more details on each step in the wizard, see Run Variation multi-step wizard below.
To activate an order schedule¶
After setting a schedule and associating it with a variation, the Run Variation wizard must be completed to activate that schedule.
In the Run Variation dialog, make sure the correct schedule is selected in the Schedule field, finish the dialog, then click Run.
Note that if an order run misses its scheduled start time for any reason, the system will continue to attempt to execute the order for up to 120 seconds.
Tip
Use an empty schedule to set run once resources. When you apply a schedule to a variation and activate that scheduled order, the system will allocate resources—up to the maximum 1024 MB of RAM and 2048 MB of disk space—to every order run done for that schedule. To set resource maximums for run-once orders, create a schedule without a frequency and only enter values for RAM and disk space.
From the command line¶
Run orders using the order-run command.
Run Variation multi-step wizard¶
- Step 1: Details.
- In the Schedule field, select a pre-configured schedule to activate it for the variation, or select Run Once.
- Variations that do not have a schedule assigned default to Run Once. See Configure Schedules for more information.
- When done, click Next to continue with the next step or Skip Optionals and Run to run the order.
-
Optional. Step 2: Variables.
- Review and update the current variable values as needed. Runtime overrides appear bold and are highlighted in purple as they're updated.
- Click the down arrow to expand a value.
- Hover over a JSON tag to view the content.
- Set runtime overrides as needed.
Note
You must supply an override value to any variable marked required. You cannot override the value of a locked variable, shown at the bottom of the list in gray with a block icon.
-
To save variable changes, click outside the variable field or click X.
Note that if there is an invalid JSON entry, changes will not be saved.
-
To reverse edits, click Reset changes in the value area.
-
When done, click Next to continue with the next step or Skip Optionals and Run to run the order.
Note you cannot advance if any variable values have an invalid format or if required variables have not been entered.
-
Optional. Step 3: Orders.
- The Orders step only appears when a variation has existing, active schedules that can duplicate a new scheduled order. This step is not avaiable when starting run-once orders
- Use this step to review and cancel existing orders as needed.
- When done, click Next to continue with the next step or Skip Optionals and Run to run the order.
- Step 4: Summary.
- Review your settings and changes.
- Click Previous to return to a previous step.
- Click Run Variation.
When the system creates the order, click the linked Order ID to be directed to the Orders page. The Order Run Details page includes information about any run-once variation.
Visual examples in Automation¶
Variables changed in the Run Variation dialogue are highlighted and bold.
Expand any value to view the details and make or reset changes.
The Orders step shows existing orders if a schedule is active.
Troubleshooting: Order Problems