Skip to content

Define Recipe Base Variables

You can declare your recipe's base variables set from the Recipes page or by editing the variables.json file in the File Editor.

Recipe variables can parameterize data points, such as the name of a file to be retrieved from a data source or a connection configuration that needs to be used by multiple nodes. For connection configurations, variables can also reference secrets that are stored securely in the vault.

Variable requirements

  • Variables larger than 1 MB in size are not supported.
  • Variable names must adhere to DataKitchen's naming conventions. They are case-sensitive, can include alphanumeric and underscore characters, cannot start with numbers, and cannot contain hyphens or dashes.
    • Do not use the names reserved for system variables to define custom variables, as this can create conflicts and errors in recipes.

Define base variables from the Recipes page

  1. Navigate to the Recipes page.
  2. Select the Variable Sets tab.
  3. In the Base Recipe Variables row, click Actions.
  4. Select Edit.
  5. Click Add Variable.
  6. Enter a variable name, type, and value.
  7. Select Add notes for changelog , describe the changes, then click Update.

Remove a variable

To remove a variable from the Base Recipe Variables, follow steps 1 to 4 above. Click Remove Variable in that variable's row.

Define base variables from the File Editor

  1. Navigate to the Recipes page.
  2. Select Recipe Actions > View Files.
  3. Select variables.json from the file editor list.

  4. Enter a variable name and value in the variable-list object.

    Use properly formed JSON.

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