Workflow designer v2

The Workflow designer provides visual and YAML views of the same Workflow definition. Use it to build, validate, run, inspect, save, and release a Workflow.

Open the designer

Open Workflows, select a v2 Workflow, then select Design. You can also click New Workflow to open a new design directly.

Top bar

The top bar controls the Workflow and the context in which you are viewing or testing it.

Area What it does
Back Returns to the Workflow explorer while preserving the current folder context. Unsaved changes trigger a confirmation.
Folder Opens the Workflow's folder in a new tab.
Workflow name Renames the current design. Click the name or edit control, then apply or discard the draft.
Save Opens revision management and focuses the optional commit message. Saving is available in the Test Environment.
More actions Downloads the current YAML. Saved Workflows can also expose relationships and audit trail actions when those features are available.
Environment Selects the Environment used to fetch, run, inspect, and manage the Workflow. The menu can show the Environment's active revision information.
Cluster Specifies Cloud or a compatible local Cluster for the entire Workflow.
Run or Stop Starts the current design in Debug mode and opens Logs, or stops the active run.
Enabled or Disabled Changes the Workflow's status in the selected Environment. Status controls trigger activation and is separate from saving.

Canvas and code views

Use the view selector in the bottom-right toolbar:

  • Canvas edits Steps and Properties visually.
  • Code edits the Workflow YAML directly.

Switching views keeps both representations synchronized. Code changes are parsed and validated before the canvas applies them. Invalid YAML remains available for correction and is reported in Problems.

The code editor supports Workflow-aware Expression completion. Its toolbar also provides code zoom; formatting and word-wrap controls are available from the editor.

Canvas layouts

The layout picker provides three ways to view the same Steps:

  • Detailed shows full Step Parameters, Returns, nested scopes, and Property editors.
  • Flow — vertical shows a compact top-to-bottom execution flow.
  • Flow — horizontal shows a compact left-to-right execution flow.

Your layout preference does not change the Workflow definition.

Add and configure Steps

In the Detailed canvas, click a + control at the required insertion point. The Add step panel guides you through the available choices:

  1. Search for or select a Node.
  2. Select a Method when the Node exposes more than one.
  3. Select a Connection when the Method requires one.
  4. Select a template when the Method provides templates.

The designer generates a versioned Step with the Parameters and Returns exposed by that choice. It gives the Step a unique name and selects it after insertion.

Select a Property to edit it. Use Value for a literal or Expression for runtime data. Object fields and array item shapes appear as nested Properties. Property edit mode can add, rename, reorder, nest, change, or remove authored Properties where the contract permits it.

Canvas controls

The bottom-right toolbar changes according to the current view and selection.

Control Availability and effect
Layout Canvas only. Switches between Detailed and the two flow layouts.
Pan Moves around the canvas.
Select steps Selects one or more Steps for copy or cut. Clipboard access depends on browser support and permission.
Preview mode Canvas only. Shows evaluated design-time samples and can be toggled with Ctrl+Shift+P.
Copy and cut Appear when Steps are selected and clipboard access is available.
Undo and redo Reverses or reapplies canvas changes. These controls are temporarily unavailable during inference or Property structure editing.
Expand or collapse all Changes the detail shown for all Steps. The shortcut is Alt+Shift+E.
Home Returns to the default canvas position or brings the selected Step back into view.
Search Finds Steps and Properties. The shortcut is Ctrl+F.
Zoom Code view only. Changes the editor text size.

Use Ctrl+S to open the save field. Use Ctrl+Enter to run the Workflow or stop its active run.

Side actions

The action bar on the right opens supporting panes:

Action Purpose
Add Step Available in Code view. Inserts a generated Step at the current YAML position.
Assistant Opens the built-in AI Workflow assistant. Proposed design changes require review before they replace the current design.
Create a ticket Opens help and support options.
Manage revisions Reviews saved revisions and contains the save commit field. See Revision Management Pane.
Manage releases Reviews and manages the revision published to each Environment. See Release Management Pane.
Batch infer Obtains design-time shape for eligible Steps. Availability depends on the current design and permissions.

Designer console

The resizable console at the bottom of the designer has three tabs:

  • Logs shows the active or most recent designer run, including Step activity and logged Properties.
  • Preview shows evaluated Expression samples and the number of available preview results.
  • Problems lists errors and warnings from client validation and server compilation. See Problems Pane for its counts, fields, search, and filter controls.

The collapsed console shows the first current diagnostic. Expand it to search or filter the selected tab.

Clicking Run expands Logs. The designer starts the current valid design in Debug mode, including unsaved changes. If this is a new Workflow, the Console first assigns it the identity required for a logged run. Save afterward to record the current design as a revision.

Save, status, and release are different

These controls affect different parts of the Workflow lifecycle:

  • Run tests the current design in the selected Environment.
  • Save records changed design content as a revision and publishes it to the Test Environment. An optional commit message describes the revision.
  • Release Management promotes a selected revision from Test to later Environments.
  • Enabled or Disabled determines whether published triggers can activate the Workflow in that Environment.

See Build a Workflow, Workflow YAML, Compiled execution, Data mapping, and AI Workflow assistant for the main authoring journey.

For the complete shell controls, see Workflow Designer Top Bar, Workflow Designer View Controls, and Workflow Designer Keyboard Shortcuts.

For the designer console and right-side action panel, see Designer Console and Logs, Expression Preview Pane, and Assistant Pane.