Workflow Builder is graphical interface inside Uniconfig UI to create, modify and manage workflows.
Creating new workflow¶
To create new workflow click on
New button in
Workflows -> Definition tab and
fill in workflow general parameters. Then you can proceed with adding tasks.
name is required and must be unique. Keep in mind that name cannot be changed later.
Other parameters are optional and can be changed anytime.
Editing existing workflow¶
To edit already existing workflow, find the workflow in
Definitions tab, click on it and then click on
Diagram of the workflow will be rendered on canvas. Now you can restructure workflow, add new tasks, remove tasks or edit workflow information and parameters.
To add new task on canvas, find the task in the left menu, drag and drop the task on canvas.
To remove one task, select task by clicking on it once and press
Delete on keyboard.
To remove multiple tasks, hold
Shift and left click on respective tasks, then press
Delete on keyboard.
To edit or add task parameters, double-click on task placed on canvas.
Input parameters can be declared as:
Input provided by user, e.g.:
Variable provided by other task, e.g.:
Statically defined, e.g.:
For full documentation of tasks read https://netflix.github.io/conductor/configuration/taskdef/.
Fork & Join¶
Fork is used to schedule parallel set of tasks.
A Join task MUST follow Fork task.
A decision task is similar to if…else statement in a programming language. The task takes 2 parameters:
name of the parameter in task input whose value will be used evaluated (default is
value that will be compared with
param(or other specified input variable)
is equal to are evaluated as equal, the workflow will continue to
otherwise the workflow will continue in
Else branch is optional and can be empty.
Lambda Task helps execute ad hoc logic at Workflow run-time, using javax &
This is particularly helpful in running simple evaluations in Conductor server, over creating Workers.
The task output can then be referenced in downstream tasks like:
An HTTP system task is used to make calls to another microservice over HTTP.
You can use
DELETE Methods and also you can set your custom header.
Task that can terminate a workflow with a given status and modify the workflow’s output with a given parameter. It can act as a “return” statement for conditions where you simply want to terminate your workflow.
For example, if you have a decision where the first condition is met, you want to execute some tasks, otherwise you want to finish your workflow.
can only accept “COMPLETED” or “FAILED”
task cannot be optional
Expected workflow output
Event task provides ability to publish an event (message) to either Conductor or an external eventing system like SQS. Event tasks are useful for creating event based dependencies for workflows and tasks.
When producing an event with Conductor as sink, the event name follows the structure:
A wait task is implemented as a gate that remains in
IN_PROGRESS state unless marked as
FAILED by an external trigger. To use a wait task, set the task type as
Subworkflows acts as a regular task in parent workflow. Subworkflow can be unbundled into its respective tasks (or other nested subworkflows)
by selecting (clicking) on it and then by clicking on
Simple tasks differs in color shade from Subworkflow tasks and cannot be expanded.
You can expand unbundled tasks/subworkflows further or you can simply delete, edit, restructure or add new tasks.
Unbundling and editing subworkflow (as a part of other workflow) will not change the original definition of subworkflow.
Adding worklow information¶
To provide additional workflow information, click on
Edit general in upper right corner.
We can specify custom output parameters of workflow, by using JSON template to generate the output of the workflow. If not specified, the output is defined as the output of the last executed task.
Let’s say we have task with taskReferenceName:
task1 which returns
summary and we want output of the workflow to be output of this specific task only.
The outputParameter value named e.g.
finalResult will be:
For full documentation of workflow parameters and definition read https://netflix.github.io/conductor/configuration/workflowdef/.
Defaults & Description¶
Here, we can define default values and descriptions for workflow inputs. Each input value declared as
will appear in dropdown list of available input parameters.
Save and execute workflow¶
To Save workflow, click on
Save button in upper left corner. Then you can find the workflow in
Workflows -> Definitions tab.
To Execute workflow directly from builder, click on
Execute button. You will be
prompted to provide input parameters.
Executing workflow will also save workflow.
Import and export of workflow¶
To import workflow on canvas, click on
Import in upper left corner and select valid JSON definition of the workflow.
Imported workflow will not be saved untill you click on Save or Execute
To export and save workflow in JSON format into your file system, click on
In order to choose a location to which you want to export worklow, you have to have it enabled in browser settings. Default location is Downloads folder.
Creating custom workflow subsets¶
In order to create new custom subset containing workflows, assign a label with prefix
CUSTOM_ to the workflow and it will appear as
a new group in left side menu.