Workflow Editor¶
The workflow editor allows creating new workflows from scratch, or extending or adjusting existing workflows.
The workflow editor consists of three areas:
The main area in the center contains the workflow itself consisting of the connected tasks.
The left side-bar lists available task types that can be added to the workflow.
The right side-bar contains allows configuring the currently selected task.
Main Area: Workflow Tasks¶
In the center the workflow tasks can be rearranged by dragging the blue titlebars. Dragging on the white background allows panning in larger workflows. Use the mouse wheel and the CTRL key to zoom in and out.
Changing the connections between tasks is possible by dragging from the light area below the task’s title bar. If multiple connections are possible a dialog allows selecting the parameters that should be changed.
Left side-bar: Add Task¶
The left side-bar contains the available task types that can be added to the workflow. Use the filter box to search for a specific task type, and double click or drag a task into the workflow. It automatically connects to the currently selected task if possible.
Right side-bar: Configure Task¶
The right sidebar allows configuring the currently selected task.
Fixed parameters use the same fixed value every time.
None parameters are unused.
Output parameters are connected to an output of a previous task.
Define-on-first parameters are interactively defined on the first run. The defined template value is then reused automatically, but can also be updated if required.
Switching between Runs and Editor¶
The small text in the corner is a convenient way to open and switch between the workflow editor tab and the workflow runs tab of an active workflow.
Starting and Stopping the Workflow¶
The / button is located in the lower left corner of the main area of the workflow editor. It is also available in the :menu: Workflows menu.
Deleting Tasks¶
Tasks can only be deleted in the workflow editor. The workflow has to be stopped before deleting tasks is possible, and only tasks that have no followers can be deleted directly.
The button is located in the lower left corner of the main area of the workflow editor. It deletes the currently selected task from the workflow. As a shortcut the Delete key can be used.
The button is located in the dropdown menu of the button. It deletes an entire branch of tasks from the workflow (the currently selected task and all follower tasks connected to it).
Deleting a task is a permanent operation and deletes all associated data for existing runs of the workflow.
Cloning Tasks¶
The button is located in the lower left corner of the main area of the workflow editor. It clones the currently selected task to duplicate it.
The button duplicates an entire branch of tasks.
The and buttons allow duplicating a branch of tasks between workflows.
Copying Task Configuration¶
The button copies the current task configuration to the clipboard. The button applies the copied configuration to another task.
Renaming and Remarks¶
Tasks can be renamed to document a workflow and make it easier to use. Input and output parameters can also be renamed using the small black triangle next to the parameter name.
Task remarks further allow adding notes, instructions and reminders to the user of the workflow. They will appear when the task is selected and in the respective interactive UI.