Parameters

Parameters are key-value pairs that modify engine behavior during workflow execution. While workflows typically don't interact with these parameters directly, users can set them when creating or updating engines, or when submitting workflow runs.

Each engine type supports different parameters that can:

  • Modify engine log levels

  • Specify output destinations

  • Configure other engine-specific behaviors

For detailed parameter options, see your engine's documentation:

Parameter Sets

Parameter sets allow you to save common engine configurations in Workbench. While not automatically applied to workflow runs, these sets can be selected during run submission from the engine tab.

You can create multiple parameter sets per engine, making it easy to switch between different configurations.

Viewing Parameter Sets

Since every engine has its own presets you will need to navigate to the engine you want to view the parameter sets for. You can follow these steps to view the parameter sets:

  1. Navigate to the Engines Page

  2. Select the engine you want to view the presets for

  3. Click on the Parameters tab

  4. You will see a list of presets for the engine

  5. Click on a preset to view the parameter values or change the name of the preset

Creating a Parameter Sets

Every parameter set consists of a name and a set of key-value pairs that define the parameters for the engine. You can create a new preset by following these steps:

  1. Navigate to the Engines Page

  2. Select the engine you want to create a preset for

  3. Click on the Parameters tab

  4. Click on the Add Parameter Set button

  5. Enter a name for the preset

  6. Enter the key-value pairs for the parameters you want to set as JSON in the editor

  7. click on the Save button

Default Preset

You can select on of the presets as the default preset. This preset will be automatically selected when submitting a workflow run form the User interface. It will not be applied automatically.

  1. Navigate to the Engines Page

  2. Select the engine you want to set the default preset for

  3. Click on the Parameters tab

  4. Hover over the preset you want to set as the default

  5. Click on the star icon to set the preset as the default

Deleting a Parameter Set

You can easily delete a parameter set by following these steps:

  1. Navigate to the Engines Page

  2. Select the engine you want to delete a preset for

  3. Click on the Parameters tab

  4. Hover over the preset you want to delete

  5. Click on the trash icon to delete the preset

Last updated