Tasks#
A task is a visual block that performs a specific function. In programming language terms, it can be described as a function or a method, because it has a name, input and output values and performs an action.
- Task Name and Description
- Options
- Inputs
- Outputs
Behavior#
The behavior of the task may vary depending on its settings and potentially on some inputs.
As a rule of thumb, if the task is executed successfully, the Success output will trigger a true value. If it fails for some reason, an error object will be emitted on the Error output. This error object contains the description of the occurrence.
Info
Take advantage of the Task coloring to give a visual aid to the meaning. Error/Failure-ending Tasks can be drawn in red, whereas Success-ending Tasks in green.
The activation of a task varies within the different tasks. For more details, refer to the appropriate section of each task.
Using the Task settings page, you can set the name and description of the task, the color that it will show when drawn and specific settings for each Task.
Warning
Driver tasks have a pre-defined color that can be overridden
Inputs and Outputs#
Some Tasks allow defining custom inputs or outputs. The custom entries are filled in specific tabs of the settings pages for each Task. You can find a list of configured entries on the left side of each task, where you can also add new entries or remove existing ones. On the right side you will find the list of properties defined for the custom entry. Depending on the Task, different properties may be required.
Warning
In the Tasks that allow custom inputs or outputs, due to some limitations of the current implementation, the same names cannot be used within the same Task.
Experimental and Deprecated Tasks#
Some Tasks may be marked as experimental when the availability of the Task is not certain and is depending on the acceptance and generic use or if a new and improved solution is found.
Other Tasks may also be marked as deprecated, indicating that they will be discontinued in the next major version.
These different states will be visually signaled and color-coded within the Workflow Designer, as shown in the examples below:
| State | Selection tile | Workflow designer |
|---|---|---|
| Deprecated |  |  |
| Experimental |  |  |
Table: Deprecated and Experimental Tasks
Info
When a Task has one of these states defined, a popup with relevant information about the current state will be displayed above the selection tile when you hover over the tile.