2.1.2 Define a Workflow Using Workflow Builder

Use Workflow Builder to create a workflow definition visually. You can add tasks, arrange the flow, configure task properties, and define how tasks interact without writing the full JSON manually.

The builder generates the workflow definition in JSON. Review the generated workflow JSON before saving the workflow definition. After creating and saving the workflow definition, you can use it to start workflow executions.

A workflow definition contains the workflow metadata and the list of tasks that make up the workflow. Each task that you add to the canvas becomes part of the workflow definition. Worker tasks are based on task definitions, while system tasks and operators use built-in task types.

To define a workflow using Workflow Builder:

1. Open the navigation menu and click Definitions.
2. Click the Workflows tab.

   The Workflows list page opens and displays the workflow definitions that have been created.

3. Click .
   The Workflow Builder is displayed. On the right pane, the Workflow tab displays all the details of the workflow as shown in the following figure. On the left pane, the components of the workflow are depicted visually.
   

   

   
   
4. In the Workflow Details group, you must enter a unique name for the workflow definition. The name can be up to 128-characters long. Use only letters, numbers, underscores (_), and hyphens (-). Spaces and other special characters are not supported. You cannot change the workflow name after the workflow definition is created.
   You can also specify optional workflow definition values, such as description, version, timeout configuration, failure workflow, input parameters, and output parameters. See Specify Values for Workflow Definition Options.
5. To add a task in your workflow using the builder, place your cursor on the arrow mark. A plus sign appears as shown in the following image.
   
   

   

   
   
6. Click the plus icon. Many tasks are displayed.
   
   

   

   
   
7. Click View All to view all the tasks that you can add using the Workflow Builder.
   
   

   

   
   
8. Search for a task or browse the available task groups.
   • All Tasks: Displays all task types that you can add to the workflow.
   • System Tasks: Displays built-in system tasks.
   • Operators: Displays control-flow and operator tasks, such as branching, joining, waiting, terminating, or looping tasks.
   • Worker Tasks: Displays reusable worker task definitions that have been created as task definitions. These task definitions are stored separately and can be reused across workflow definitions.
9. Click a task that you want to add to the workflow. The following image shows an agentic task is added to the workflow.
   
   

   

   
   
10. Click the task on the canvas and enter the task details in the Task tab.

    Configure values such as the task name, task reference name, input parameters, optional behavior, timeout settings, and other task-specific parameters. The task reference name must be unique within a workflow definition. For information about each task and its parameters, see Create System Tasks and Operator Tasks.

    
    

    

    
    
11. Click Save.
12. MicroTx Workflows displays the changes in JSON code. Review all the changes.
13. Click Confirm Save to save the changes.

    If you do not want to save the changes, click Cancel, and then click Reset to undo all the changes that you have made since the workflow was last saved.

14. Optional. To download the JSON of the workflow, click Download.

The new workflow is displayed on the Workflows list page.