Workflow Builder provides a graphical user interface for arranging and connecting tasks on a canvas to create a workflow. The main view displays a list of all workflows in the system.
Figure: Workflow Builder GUI: Main View
|1||New workflow||Create new workflow|
|2||Select workflow||Select workflow(s) for deletion|
|3||Filter workflows||Enter text to filter list of workflows in table|
|4||Edit workflow||Open workflow in canvas for editing|
|5||Run workflow||Start job manually from a workflow|
|6||Delete workflow||Delete selected workflow(s)|
The edit canvas view displays a workflow's tasks and transitions.
Figure: Workflow Builder GUI: Canvas View
|7||Save/Update||Save new Workflow (or Save changes to Workflow)|
|8||Start||Start manual run of Workflow|
|9||Clone||Make duplicate copy of Workflow|
|10||Close||Close Workflow and return to main page|
|11||Source application||Select application providing desired task|
|12||Task list||Pick application task|
|13||Add task||Add shown task to workflow canvas|
|14||Transition binding||Associate a new transition to either the leading task's exit status or a forEach loop|
|15||Transition action||Specify a standard or revert transition|
|16||Zoom In/Out||Make tasks and text larger or smaller on canvas|
|17||Copy task||Duplicated selected task|
|18||Add transition||Add new transition for selected transition binding and transition action|
|19||Fit workflow||Adjust workflow to fit canvas|
|20||Delete selected||Delete any selected task or transition|
|21||Workflow canvas||The workflow design canvas|
|22||Transition||Connects one task to another|
|23||Task||A functional block within a Workflow|
Create a Workflow
To create a new workflow:
On the main page of Workflow Builder, click the NEW WORKFLOW button in the title bar.
Figure: Title Bar
Enter a unique name in the Workflow Name field.
Click the SAVE button.
Figure: Create Workflow Dialog
Workflow Builder shows a blank canvas with only start and end terminators.
Figure: New Workflow
Edit a Workflow
To edit a workflow:
- On the main page of Workflow Builder, click a workflow's Edit button to open the Workflow Builder canvas.
- When finished editing the workflow, click the Update button in the title bar. A confirmation box will appear to confirm that changes were saved.
Rename a Workflow
To rename a workflow:
On the main page of Workflow Builder, click a workflow's Edit button to open the Workflow canvas.
Click the Settings button in the title bar. Workflow Builder will open the Workflow Settings dialog.
Type the new workflow name into the Workflow Name field.
Figure: Rename Workflow
As an option, workflow groups restrict who is authorized to start jobs from a workflow. When workflow groups are assigned, only group members can start jobs from the workflow.
Workflow groups are a similar concept to task groups that restrict who is authorized to work a manual task.
To set optional workflow groups:
- On the main page of Workflow Builder, click a workflow's Edit to open Workflow canvas.
- Click the Settings button in the title bar. Workflow Builder will open the Workflow Settings dialog.
- Begin typing the name of a group in the Workflow Groups field. Matching group names will appear in a list after you begin typing.
- Click the correct group name to add that group to workflow groups. The group will not be added unless it is selected from the list. Add as many groups to the workflow groups as desired.
- Click UPDATE.
Resize Workflow to Fit Window
To resize a workflow:
- Click the Fit Window button in the upper right corner of the Workflow Builder canvas. The workflow will be reduced to fit within the visible area of the canvas.
- Click SAVE or UPDATE in the title bar to save the resized workflow.
Clone a Workflow
To clone a workflow:
On the main page of Workflow Builder, click a workflow's Edit button to open Workflow canvas.
Click Clone button in title bar. Workflow Builder will open the Clone Workflow dialog.
Type a name for the cloned workflow.
Figure: Clone Workflow Dialog
Start a Workflow
To start a workflow:
On the main page of Workflow Builder, locate the workflow in the table.
Click the Start button at the far right to open the Job Description dialog (see figure below). Alternately, on the Workflow Builder canvas page, click the Start button on the title bar.
Enter a description for the job (optional).
Figure: Job Description
Workflow Builder will analyze the workflow and find all job variables. If a workflow requires job variables, Workflow Builder will display the Set Variables dialog box where you can see the required job variables set to null values (see figure below).
Enter the desired values with the required data types, e.g.,
Figure: Set Variables Dialog
Close a Workflow
To close a workflow:
- On the Workflow Builder canvas page, click the UPDATE button in the title bar if you want to save changes before closing. A confirmation box will appear to confirm that changes were saved.
- Click the Close to close the Workflow and return to the main page.
Delete a Workflow
To delete a workflow:
- On the main page of Workflow Builder, check the box to the left of the Workflow(s) you want to delete. Multiple workflows may be deleted, or only one.
- Click the DELETE button at the top of the page. A confirmation window will appear at the top of the view.
- Click OK to confirm.
⚠️ A Workflow cannot be deleted or changed while it has jobs actively running.
Q: What happens if my workflow is incomplete or has an error?
A: When a workflow is incomplete or has an error, it is saved as a draft. The "DRAFT" indicator appears on the bottom-right corner of the canvas, with the number of errors in the Workflow. An error modal also displays with a description of the errors. You can close the modal by clicking CLOSE. To see the errors again, click DRAFT.