Skip to content

Inject Order Override Variables

When you run an order, you have the option to inject an order override variable from the Run Variation dialog or from the command line with the order-run command.

You can set constraints on a variation's order overrides. See Set order override constraints below for more information.

Warning

Variables follow a hierarchy. Except for system variables, the variable values re-defined at this level override any of the same variables set elsewhere (i.e. order override variables take precedence over all other parameters feeding into the recipe).

Apply order overrides

The UI uses a multi-step wizard to run an order. The Variables step displays the compiled values of all recipe variation input parameters. You can make changes to variable values here as needed.

For detailed steps, see Order-Time Overrides: How to.

Set order override constraints

You can change the confirmation of any variable in a variation to restrict how and if a user can override its value at runtime.

Note

The command line interface (CLI) does not yet enforce these requirements.

  1. Navigate to the Variation page, then select the Variables tab.
  2. Find the variable you want to set override constraints for.
  3. Click in the associated cell of the Order Override Constraints column.

  4. Select a restriction, and if needed, set the data type.

    • Optional: the user can enter an override value at runtime.

    • Required: the user must enter an override value for this variable at runtime.

      Required variables do not need to have default values defined.

    • Locked: the users cannot override the value of this variable at runtime.

    • Hidden: this variable will not appear in the Run Variation dialog when running an order.

      Note

      This is the default setting for all variables.

    • Data type: to require a specific format for an override, select String, Number, Boolean, JSON.

      The default value is the current data type of the base, variation override, or kitchen override variable.

      Data types are not displayed for locked and hidden variables.

  5. Click anywhere outside of the column to save the changes.

  6. Select Add notes for changelog , describe the changes, then click Update.

Visual example in Automation

Change the configuration of variables to set override constraints.

(Variable configurations)