Job Parameters

Details on how to parameterize a Job, accessible from the Jobs table in Typhoon Test Hub.

It is possible to create multiple parameters in order to easily change how a Job should behave from a Trigger. These options are shown in Job parameters form.

Manage job parameters

Figure 1. Manage parameters
  • A parameter can be added by clicking on the button. This opens a form similar to the one shown in Figure 1.
  • Each parameter can be removed by clicking on the button.
  • Every parameter can be collapsed by clicking on the arrow up button (). When any of the parameters is collapsed, its name will be presented on the collapsed view. On the collapsed view, clicking on the arrow right button () will expand the parameter.
  • All parameters can be collapsed at once by clicking on the double up arrow button () in the top right corner of the parameters list.
  • All parameters can be expanded at once by clicking on the double down arrow button () in the top right corner of the parameters list.
  • Parameters in the list can be reordered by using drag and drop.

Parameter types

There are 3 types of parameters: Choice, Multiple choice, and Text.

  • Choice: When the checkbox is checked, the value is 'true', when unchecked the value is 'false'

  • Multiple choice: Select the option from the given dropdown menu. The available options must be defined during parameter creation, with at least two options provided

  • Text: Enter the desired text or value in the text field.

In addition to type, every Parameter has the following fields:
  • Name: which must be unique within a Job
  • Optional: when checked makes a parameter optional, meaning it doesn't need to have a default value (it can be left blank). If this option is marked for a multiple choice parameter an empty option will be added. Note that empty will be passed as the parameter value when using it.
  • Default value: initial value which will be used as the default value when using a Parameter. It is mandatory if the Parameter is not marked as optional. When creating a multiple choice parameter, the first option listed will be automatically set as the default value (the Default value field will not appear).
Figure 2. Multiple choice parameter

For a multiple choice parameter, options can be added by clicking on the add option button (). Every option can be edited by clicking on the option name and options can be removed by clicking on the button.

Note: In order to save a form, all input fields must be valid. Required fields are signed with *.

Parameter utilization when writing an execution command

In the Job Execution field, you can retrieve the selected value by adding "$" before the name of the parameter.

Example: If you have a parameter called test_coverage, the code required to pass the selected test_coverage value to --coverage would be: 
python3 -m pytest --coverage=$test_coverage
Note: When running an Agent on Windows, instead use:
--coverage=%test_coverage%