Skip to content

Order-Time Overrides

When submitting an order, you have the option to pass runtime overrides.

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).

Set 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. At this step, you can continue with the values as listed or edit values as needed.

Tip

You can set constraints or requirements for order-time override values from the Variation page. By default, order override constraints are set to Hidden. See Inject Order Override Variables for more information.

How to

  1. Start an order run.

    Note that the Variables step is optional. Do not click Skip Optionals and Run.

  2. At the Variables step, review the variables and their values.

    • Hover your curser over JSON tags to view code contents.
    • Use the Search field and Filter to find specific variables.
    • Note, you cannot override the value of a locked variable (shown at the bottom of the list in gray with a block icon).
    • Values marked as Required must be updated.
  3. Edit variable values as needed.
    1. Expand a variable to open the editor.
    2. Add variable values and/or overwrite existing entries in the Value column.
    3. To save variable changes, click outside the value field or click X.
    4. Click Resent changes to discard edits.

  4. Verify your overrides.

    Overrides appear bold and are highlighted in purple when changed.

  5. Complete the wizard to run the variation.

Visual example in Automation

(Screenshot of Variables step)

Set order overrides in the command line

Use the order-run command with the --params option to pass order-time overrides from the command line.

~ $ dk order-run --kitchen staging_test --recipe test_recipe --params '{"email":"user2@company.com"}' --yes
Current context is: default
YYYY-MM-DD HH:MM:SS - Create an Order:
        Kitchen: staging_test
        Recipe: test_recipe
        Variation: test_overrides

Order ID is: 55b49efa-9680-11e9-9d6a-0242ac110002
The following variables will be overridden:
email: user2@company.com