Skip to main content

Create and Run a Workflow

Xircuits page listing visual workflow files with Open Studio entry point

Xircuits page listing visual workflow files with Open Studio entry point

Build visual workflows by connecting component nodes, then run them as one-off jobs with configurable parameters.

Prerequisites

Steps

Create a workflow

  1. In Xircuits Studio, click File > New > Xircuits Workflow.
  2. A blank canvas opens.
  3. Drag components from the Component Library panel onto the canvas.
  4. Connect component nodes by clicking and dragging from an output port to an input port.
  5. Configure each component's parameters by clicking on it and editing the properties panel.
  6. Click Save to save the workflow as a .xircuits file.

Compile the workflow

  1. Click the Compile button in the toolbar.
  2. The workflow is validated and compiled. Any errors are displayed in the console panel.

Run the workflow

  1. Click the Run button in the toolbar.
  2. (Optional) Set runtime arguments and parameters in the run dialog.
  3. Click Execute to start the job.
  4. Monitor progress in the console output panel.
tip

Start with simple two- or three-node workflows to familiarize yourself with the component connection model before building complex pipelines.

info

Running a workflow creates a one-off job. For recurring execution, create a schedule (see Create a Recurring Schedule).

Verify

  • The workflow file appears in the file browser with a .xircuits extension.
  • Compilation completes without errors.
  • The job runs and output appears in the console panel.