Skip to main content

Managing Flows

Create, deploy, organize, and maintain your automation workflows

Learn how to effectively manage your EdgeFlow workflows - from creation to deployment, organization, and maintenance.

Creating Flows

Method 1: New Flow Button

  1. Navigate to the Workflows page
  2. Click the + New Flow button
  3. Enter a name for your flow
  4. Click Create to open the Flow Editor

Method 2: Import Existing Flow

  1. Navigate to the Workflows page
  2. Click the Import button
  3. Select a JSON flow file or paste JSON content
  4. Click Import

Flow Lifecycle

๐Ÿ“ Created
โ†’
๐Ÿš€ Deployed
โ†’
โ–ถ Running
โŸท
โ–  Stopped

Flow States

State Description Actions Available
Idle Flow is saved but has never been deployed Edit, Deploy, Delete
Running Flow is actively executing Stop, Edit*, View Logs
Stopped Flow was running but is now stopped Start, Edit, Delete
Error Flow encountered an error View Error, Edit, Restart

*Editing a running flow requires redeployment for changes to take effect.

Deploying Flows

Deploying pushes your flow changes to the runtime engine. Until you deploy, changes only exist in the editor.

Deploy Options

๐Ÿ”„ Full Deploy

Stops all flows and redeploys everything from scratch. Use when you need a clean state.

Shortcut: Ctrl+Shift+D

๐ŸŽฏ Modified Nodes

Most granular option. Only restarts nodes that changed within modified flows.

Auto-Save vs Deploy

Important: EdgeFlow auto-saves your changes as you edit, but this only saves to the database. You must click Deploy for changes to take effect in the running system.

Starting and Stopping Flows

Start a Flow

  • Click the โ–ถ Play button on the flow card
  • Or open the flow and click Start in the toolbar
  • Or use the API: POST /api/v1/flows/:id/start

Stop a Flow

  • Click the โ–  Stop button on the flow card
  • Or open the flow and click Stop in the toolbar
  • Or use the API: POST /api/v1/flows/:id/stop

Organizing Flows

Naming Conventions

Use descriptive names that indicate the flow's purpose:

โœ“ Good
  • Kitchen Temperature Monitor
  • MQTT Sensor Data Logger
  • Daily Backup at Midnight
  • GPIO LED Controller
โœ— Avoid
  • Flow 1
  • test
  • New Flow (2)
  • asdf

Flow Descriptions

Add descriptions to document what your flow does. Open flow settings and fill in the Description field. This appears in the workflow list and helps others understand the purpose.

Export and Import

Exporting Flows

  1. From the Workflows page, click the โ‹ฎ menu on a flow
  2. Select Export
  3. Save the JSON file

Or in the editor: Ctrl+E

Import Flow JSON

{
  "name": "Temperature Alert",
  "description": "Alerts when temperature exceeds threshold",
  "nodes": {
    "inject-1": {
      "id": "inject-1",
      "type": "inject",
      "name": "Every 30s",
      "config": { "repeat": "30" },
      "position": [100, 100]
    },
    "function-1": {
      "id": "function-1",
      "type": "function",
      "name": "Check Temp",
      "config": { ... },
      "position": [300, 100]
    }
  },
  "connections": [
    { "source": "inject-1", "target": "function-1" }
  ]
}

Duplicating Flows

Create a copy of an existing flow as a starting point for a new automation:

  1. Click the โ‹ฎ menu on the flow card
  2. Select Duplicate
  3. Enter a new name for the copy
  4. Click Create

Deleting Flows

Warning: Deleting a flow is permanent and cannot be undone. Export important flows before deleting them.
  1. Stop the flow if it's running
  2. Click the โ‹ฎ menu on the flow card
  3. Select Delete
  4. Confirm the deletion

Best Practices

๐Ÿ“ Document Your Flows

Add descriptions and use comment nodes to explain complex logic.

๐Ÿ’พ Export Backups

Regularly export important flows as JSON backups.

๐Ÿงช Test Before Deploy

Use inject and debug nodes to test flow logic before running in production.

๐Ÿ”„ Version Control

Store exported flow JSON in git for version history.

๐Ÿ“Š Monitor Executions

Check execution logs regularly to catch issues early.

๐Ÿงน Clean Up

Delete old test flows and unused drafts to keep the list manageable.