Canvas, nodes & edges

The canvas is the workflow designer's working surface. Nodes represent triggers and activities. Edges connect the nodes and determine the execution path.

To make changes, the workflow has to be locked with Edit.

Working with the canvas

ActionHow
Pan the viewHold the middle or right mouse button and drag
ZoomMouse wheel
Show the whole workflowHome
Toggle full screenF11
Move the selectionDrag the nodes with the mouse

The minimap shows the current position within the workflow. Auto-layout arranges the nodes automatically.

Adding a node

  1. Choose the trigger or activity type you want in the node library.
  2. Drag the entry onto the canvas.
  3. Select the node.
  4. Enter its settings in the properties panel.

The most important node types:

Node typePurpose
TriggerStarts the workflow
ActivityPerforms a work step
GroupGroups nodes visually only
Sticky noteAdds a note and is not executed

Editing nodes

  • Select a node to open its settings.
  • Select several nodes with Ctrl or Shift.
  • Ctrl+D duplicates the selection.
  • Delete or Backspace deletes the selection.
  • Ctrl+C puts the selected nodes and the edges between them on the clipboard as workflow JSON, for example to look at in VS Code. A selected group brings its nodes along. Configuration values come along, except secrets, which are written as *** so they do not end up on the clipboard: values of secret keys (such as password, apiKey, secret, connectionString, Authorization), values that look like a credential (a credential header line, a known token format or private key, a quoted password="…"-style assignment), and literal request-header values other than Accept, Content-Type and User-Agent. A header value that is only a {{…}} reference, optionally after a scheme such as Bearer, stays readable. Set masked values again after pasting.
  • Ctrl+V inserts such JSON, also from another workflow or a text editor. The nodes get new IDs, and conditions and references between them are updated. Each copy also gets its own output variable (such as name_2), and references inside the copy follow it; Ctrl+D does the same. A copy from the designer lands offset next to its original, JSON from elsewhere in the middle of the visible canvas. Invalid JSON is reported.
  • With several nodes selected, shared values such as machine, timeout or enabled state can be changed together.

Connecting nodes

  1. Drag from a node's output port.
  2. Drop the connection on the target node's input port.
  3. Select the edge to set a label or a condition.

A port responds a little outside its visible dot, and a dragged connection snaps to a nearby port, even when zoomed out.

The arrow direction shows the direction of execution. An edge can run always, only on success, only on failure, or based on a condition of your own. Details are in Edge conditions. An edge that runs always carries no label — only a condition, or a label you write yourself, is shown on the canvas.

An edge's plus symbol inserts a new activity between two existing nodes.

An existing edge can be re-routed to a different target without recreating it: either select the edge and drag its target end onto the new node, or — more convenient on large graphs — right-click the edge, choose Detach target, and then click the new target node. The preview line continuously shows which of the four connection points it will land on: whichever one is nearest to the click. This includes the node the edge is already attached to — clicking it again simply moves the connection point. Label, condition and the disabled state move along; Esc or a click on empty canvas cancels.

State during an execution

StateAppearance
RunningAnimated highlight
SucceededGreen
FailedRed
SkippedGrey and dashed
PausedOrange

Disabled nodes and edges are dimmed and are not used during execution.

Adjusting the view

The view options provide the following aids when needed:

  • Grid and snap-to-grid
  • Different node representations and sizes
  • Automatic layout directions
  • Machine colours
  • Error and execution coverage
  • The critical path
  • Data flow on edges

These options do not change the execution logic. Auto-layout does, however, move the stored node positions.

Important keyboard shortcuts

ShortcutAction
Ctrl+ZUndo
Ctrl+YRedo
Ctrl+ASelect all nodes
Ctrl+C / Ctrl+VCopy / paste
Ctrl+DDuplicate
DeleteDelete
HomeShow the whole workflow

Further settings and testing functions are under Properties, modes & shortcuts.

All chapters