Parameters

Parameters are key value pairs that can modify the behaviour of an engine during workflow execution. The workflow is typically unaware of these parameters, and they are set by the user when creating or updating an engine in Workbench or when submitting a workflow run.

Parameters can do everything from setting the log level of the engine to specifying a different destination for the outputs of the workflow. Each engine supports a different set of parameters that are described in the relevant engine documentation.

• Google Cloud Platform

• AWS HealthOmics

• Microsoft Azure

• On-Premises

Parameter Sets

You can define common parameter sets for engines in Workbench directly from the engines parameter page to prevent you from having to define them every time you configure a run. These sets are not submitted automatically with workflow runs, but they can be selected when submitting the run from the engine tab.

Each engine can have multiple parameter sets, allowing you to easily switch between different configurations depending on your needs.

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