Manual jobs

Overview of Manual job settings, which define the procedure that will be performed by a user.

From the Manual jobs table (Figure 1), you can see the most important information about existing manual jobs. From here you can also create a new manual job, as well as update, or delete an existing one. Manual jobs can be grouped under custom categories. A new group can be created by clicking on the plus button () next to the All tab. More on group management can be found here.

Figure 1. Manual jobs table

The manual jobs table shows the following information:

  1. Status: Status of the last ran execution. When created, Manual job has a status Idle, until the first execution is started. All possible states for the execution can be found here.
  2. Name
  3. Executions: Number of executions made of the Manual job
  4. Last finish: The time when the last execution of the Manual job was completed
  5. Last duration: Duration of last execution
  6. Last report: Status of last uploaded report

Additionally, you can start a Manual job directly from this table.

The manual jobs table allows selected items inside it. When at least one item is selected, buttons will appear above it that allow certain actions.

Figure 2. Manual jobs table with selected items

By clicking button , dialog will appear that allows changing assignees for the selected Manual jobs.

Figure 3. Change assignees dialog for selected Manual jobs

By clicking button , dialog will appear that allows changing mark for execution for the selected Manual jobs.

Figure 4. Mark for execution dialog for selected Manual jobs

By clicking button , dialog will appear that shows sum of weights for the selected Manual jobs.

Figure 5. Weights sum dialog for selected Manual jobs
Groups created by clicking the button and which are used for organization purposes, can be updated or deleted by selecting the appropriate option from the menu that appears when the user clicks on the three dots in the focused tab (the All tab cannot be modified or deleted). Additionally, tabs can be reordered by choosing the approproate option from the same menu.
Figure 6. Options from the group menu
Note: By clicking on the button, columns of the table can be customized - hidden or shown depending on the preference. Columns of the table can be reordered by using drag and drop in the table header. When positioning cursor in between two columns, cursor for column resizing will show and enable change of the column's width. All changes made to the table will be automatically preserved.
Note: By inserting text in the Search input field, the table rows are filtered. Filtering is done based on the textual content of the table cells. By clicking on the button, the Search input field is cleared and filtering is cancelled.

Manual job details

Figure 7. Manual job details

In the Details section, you can find:

  1. Configuration tab: Here are displayed configuration data.
  2. Parameters tab: Same as in job parameters, this tab is for managing parameters in order to easily change how a Manual job should behave.
  3. Changes history tab: Contains Manual job's history of changes.
  4. Executions tab: Contains a table of executions that are made by running this manual job.
  5. Reports tab: Contains generated reports by running this manual job.

You can also delete a manual job by clicking on the Delete manual job button.

Configuration tab

The tab displays configuration details for the selected Manual job and allows for updates. Within the configuration tags can be marked as parametrizable. If a field is made parametrizable, the Manual job will have that field available as a parameter when running a manual job, within the run dialog. The default value of the parametrized field will be set to the value specified in the manual job configuration, but the user can change it when running the Manual job.

A timeout can also be defined as a time limit that specifies how long an execution can run before it is automatically interrupted.

Changes history tab

Changes history for the selected Manual job is visible from this tab (Figure 8).

Figure 8. Manual job changes history

All snapshots (events) will be exported to JSON format and automatically downloaded by clicking on the button. By selecting each line in the table, single snapshot will be shown enabling preview of the made changes and allowing user to perform comparison between the selected snapshot and and any chosen snapshot.

Figure 9. Selected snapshot preiew

Single snapshot (event) can be exported as JSON and downloaded by clicking on the button. Snapshots can be compared through UI or as JSON, with JSON option having more clearly displayed differences between the two snapshots using Monaco editor.

Figure 10. Snapshot comparisson through UI
Figure 11. Snapshot comparisson through JSON

Deleting manual job

Clicking on the Delete manual job opens a confirm dialog.

Figure 12. Manual job delete

If the Executions box is checked, then all executions made by this Manual job will be deleted (pipline execution and all nested job executions). When this option is clicked additional information in the dialog will be available.

Figure 13. Manual job delete additional information in the dialog

If the Reports box is checked, then all Reports generated by this Manual job will be deleted.

If the Artifacts box is checked, then all Artifacts generated by this Manual job will be deleted.
Note: Manual job can not be deleted if there is at least one unfinished execution of that Manual job.

Create manual job

A new manual job can be added by clicking on the button. This opens the dialog window shown in Figure 14.
Figure 14. Add new manual job dialog

From this dialog, several options for defining the Manual job are available:

  1. Give a name which will be used to refer to it throughout the Typhoon Test Hub. The name must be unique.
  2. Write a description of the Manual job.
  3. Select the groups of categories where this Manual job should be displayed.
  4. Select one or more Users to which this Manual job is assigned.
  5. Define the weight of the Manual job.
  6. Mark that the Manual job should be executed.
  7. Select one or more Tags which will be used to tag executions of the Manual job. Tags field can be parametrizable. In that case tags will be available as parameter when running selected Manual job.
  8. Add one or more link to the external source that is connected or corresponds to this Manual job. For each link you need to define source type and value.
  9. Add one or more Steps to je Manual job procedure.
Within the advanced options section, general retention policy can be enabled for executions, by defining for how long executions should be preserved. Policy can be defined in the following way:
  • Preserve latest - where number of executions that would be preserved needs to be entered.
  • Preserve for - where period needs to be entered (number and unit, where unit can be days/weeks/months/years) for which executions needs to be preserved.
Figure 15. Retention policy definition
The global retention policy can also be parameterized, and parameterized policies can be valuable when dealing with jobs, pipelines, or triggers that have different configurations or parameters and are used frequently. With parameterized policies, we can better filter out the executions we want to preserve based on their characteristics. Execution filters are used in order to filter executions and to write parametrized policy.
Figure 16. Example of a parametrized retention policy definition
Once a parametrized retention policy is defined, it will be visible in the advanced section of the form.
Figure 17. Example of a parametrized retention policy definition
Within the advanced options section, there is also section for configuring notifications, which enables notification of important events to an external platform. Currently supported configurations are: Users can define one or more configurations by completing the form for the selected configuration. Notifications will be sent when:
Note: In order to save a form, all input fields must be valid. Required fields are signed with *.

Manual job procedure

Manual job procedure consists of one or more steps. By clicking the button you can add a step to the procedure. Each step can have one or more nested steps (substeps). Nested step can be added by clicking the button . A step can be removed by clicking the button . When this button is clicked, a confirmation dialog will appear which also has option to prevent from later repeated confirmations.

Figure 18. Step removal dialog

By clicking on the button you can add a measurement to the step. A dialog will appear to define a measurement. By clicking the same button you can modify the measurement. A measurement can be removed by clicking the button . When this button is clicked, a confirmation dialog will appear which also has option to prevent from later repeated confirmations. Measurement contains any value that is recorded during the manual job step.

Figure 19. Measurement definition dialog

For this dialog, several options for defining a measurement are available:

  1. Give a name of the measurement.
  2. Write a description of the measurement.
  3. Choose one of the following types for the measurement: text, number, choice (boolean), single choice and multiple choice.
  4. Choose if measurement value is optional.
  5. Define a default value for the measurement.

Start manual job

When a manual job has no parameters, like Test voltage in Figure 1, clicking on the Start button will cause a new execution to be made, which will be visible in the corresponding table on the Executions page. If the job has parameters, then the action button in the table will appear like this: . Starting a Manual job with a parameter works the same way as starting a Job with a parameter. An example can be found here.