Note

The documentation you're currently reading is for version 2.4.1. Click here to view documentation for the latest stable version.

Workflow Designer

Workflow Designer is an HTML5-based graphical tool for managing workflows. Using a web browser, users can quickly create new workflows and modify existing ones.

Workflow Designer provides a graphical representation of workflow, side-by-side with the underlying code. Users can quickly add new actions to the workflow, and connect them together. Updates to the graphical workflow are immediately reflected in the code, and vice-versa.

_images/workflow_designer.png

Workflow Designer is launched from the main Brocade Workflow Composer Web UI. First login to https://YOUR_HOST_IP/. You can launch Designer in two different ways - either by creating a new workflow, or by editing an existing workflow:

Create a New Workflow

From the Web UI, click on the “Actions” button at the top of the screen. From there, click the round “+” button at the bottom center of the screen:

_images/launch_designer.png

This will launch Workflow Designer with a new, blank workflow:

_images/new_workflow.png

Note

Note: You must set a name for the workflow before you can save it. Click on the “gears” icon at the top centre to access workflow settings. Here you can specify which pack the workflow belongs to, and its name.

Edit an Existing Workflow

You can also edit existing workflows

Note

Note that Workflow Designer can only be used to edit Mistral workflows. It can not be used to edit ActionChain workflows.

Using the Brocade Workflow Composer Web UI, go the Actions tab, and navigate to a mistral-v2 workflow. Select the workflow and click “Edit” at the bottom of the workflow details pane:

_images/existing_workflow.png

This will launch a new browser tab with your workflow:

_images/bgp_workflow.png

Using Workflow Designer

Add Action

The left-hand side of the screen shows all available actions installed on this system, grouped by pack. You can search for actions, and drag them into the centre. Do this with all the actions you need.

Edit/Remove Action

Clicking on the “Pen” icon on an action will let you rename the action.

Click on the “X” on an action and it will be removed from the canvas.

Note

All the above steps - adding, linking, editing actions - can also be done using the code window on the right-hand side. Changes made to the code are immediately reflected in the central pane. Similarly, changes made in the central pane are immediately updated in the code.

Settings

Click on the “gears” icon at the top centre to access workflow settings. Here you can specify which pack the workflow belongs to, its name, and whether it should be enabled:

_images/workflow_settings.png

You can also add input parameters to the workflow, to allow sensors and other actions to pass data into this workflow.

Toolbar

The toolbar at the top of the canvas provides quick access to these actions:

  • Undo: undo previous actions. Click multiple times to go back multiple steps.
  • Redo: redo the action that was just undron. Click multiple times to go forward multiple steps.
  • Redraw: re-draw the workflow layout to suit the current screen size.
  • Save: save the workflow to the database.
  • Run: manually run the workflow.
_images/workflow_toolbar.png