Product Features
Flows Manager

Manage the Flow Canvas

17min

Once you click the Go To Flow Definition icon for a Flows Manager, you can manage the flow canvas.

Go To Flow Definition icon
Go To Flow Definition icon


Filter Nodes

You can search for individual nodes by using the search bar.

Filter nodes search bar
Filter nodes search bar


Deploy Flows

There are several options available when deploying a flow. The options in the Deploy drop-down list indicate the type of save that is currently active for a deploy action.

Deploy flow options
Deploy flow options

  • Full: This option allows you to save the flow logic for all tabbed flows in the workspace. Everything in the workspace is deployed.

Note: If many flows containing complex logic have been created, a full save may not be your best deploy option.

  • Modified Flows: This option only saves and deploys flows that contain changed nodes.
  • Modified Nodes: This is the fastest option for individual node changes, as it only saves and deploys the updated nodes.
  • Restart Flows: This option restarts the currently deployed flows.

Flow Canvas Menu

Open the menu in the top-right corner to view options for the flow canvas.

Flow Canvas menu
Flow Canvas menu

  • Edit: Edit options for nodes and the canvas.
  • View: View options for the canvas.
  • Arrange: Options to arrange nodes on the canvas.
  • Import: See the "Import Nodes" section below.
  • Export: See the "Export Nodes" section below.
  • Search flows
  • Configuration nodes: See the "Configuration Nodes" section below.
  • Flows: Add, rename, or delete flows.
  • Subflows: See the "Subflows" section below.
  • Groups: Options to group, ungroup, and merge selections on the canvas.
  • Settings: See Manage User Settings.

Import Nodes

Importing nodes allows you to easily deploy flow logic for a variety of devices and use cases.

The import operation relies on a previous export to the library, download, or clipboard copy. Using import from the menu offers three tabs: ClipboardLocal, and Examples.

The Clipboard tab provides a way to paste code saved to the clipboard or select a JSON file from your hard drive to import. To import a JSON file saved from a previous export, use the Library tab.

You can import the nodes from the following ways:

  • Copy and paste one or more nodes and their connecting wires to a flow
  • Nodes that were downloaded to your hard drive
  • Nodes were exported to the library
  • Nodes that appear in the examples tab

Before You Begin

  • Make sure you have exported nodes to examples, creating a JSON file.
  • Make sure you have selected a flow tab into which the nodes will be imported.
Import nodes dialog box
Import nodes dialog box


Import Nodes Options

  • Clipboard import: Copy and paste the flow or select a JSON file to import. You can paste one or more nodes and their connecting wires to a flow.
  • Local import: Select a JSON file from the list.
  • Examples import: Select a JSON file from the list.

After selecting the nodes to import, select if the import should go to the current flow or a new flow. When you import to a new flow, the system automatically creates a new flow tab and displays the nodes and wires freely so you can place them in the new flow.

Export Nodes

Exporting nodes allows you to download a file of flows.

Using Export from the menu offers two tabs: Clipboard and Local.

The Clipboard tab temporarily saves node data to the clipboard. To save node data for a longer term, use the Library tab.

Note: When exporting, passwords are not exposed.

You can export one or more nodes and their connecting wires and then paste them to a flow.

Before You Begin

Select the nodes and connecting wires within a flow tab.

Export nodes dialog box
Export nodes dialog box


[1] Select if you want to export selected nodes, the current flow, or all flows.

[2] Select to view the nodes in list view or in JSON format. If you view in JSON format, you have the option of viewing the code in compact or formatted style.

Export Nodes Options

  • Copy to the clipboard: You can export the selected nodes and wires for just the selected nodes, the current flow, or all flows. Click Copy to clipboard to copy the code to your clipboard.
  • Download the code: To download the code, click Download. A JSON file is downloaded to your hard drive.
  • Export to library: To export to the local drive, click the Local tab, enter a file name for the JSON file in the Export as field, and then click Export to library. You can use the JSON file located in the library to import the nodes and connecting wires to another flow.

Configuration Nodes

Selecting Configuration nodes opens the Config tab beneath the canvas to display used and unused nodes.

Configuration nodes tab
Configuration nodes tab


When you delete a node from a flow, it may not be deleted from the back-end. Server-based nodes that require network / connectivity settings, such as MQTT nodes, are found here if they have been deleted from a flow. You may want to remove these types of unused nodes from the back-end because they may continue to try connecting to a port and degrade performance. To view unused nodes, click unused to filter the nodes displayed. Not all deleted nodes appear in the Config tab. When you save a flow or the entire workspace, a pop-up message notifies you if there are unused nodes.

Subflows

Subflows serve as sub-routines to place complex logic into code blocks, which then can be called from the main flow. As with any structured programming language, this modular approach simplifies troubleshooting, modifications, and basic understanding.

Subflow tab
Subflow tab


You have two options for creating a subflow.

To create a subflow, select Subflows > Create Subflow.

To create a subflow from an existing flow, drag and select the nodes to include, and then select Subflows > Selection to Subflow.

Flow Tabs Menu

Use the flow tabs menu to add new tabs, manage existing tabs, and show/hide tabs.

Click the + icon to add a new tab.

Flow Tabs menu
Flow Tabs menu


Additional Options

Review the following additional options for the flow canvas.

Note: To view messages, drag the vertical window bar up.

Additional options for the flow canvas
Additional options for the flow canvas


[1] Toggle the navigator to navigate the entire canvas. Also zoom in and out of the canvas.

[2] Info: Review information for flows.

[3] Help: Search help for using the canvas and flows.

[4] Debug messages: Review debug messages for flows that are running.

[5] Configuration nodes: See the "Configuration Nodes" section above.

[6] Context Data

[7] Dashboard: The Flows dashboard allows you to visualize data and information pertaining to your flows. You can organize the dashboard into tabs and groups, and then add widgets and links to display specific information. You can then make aesthetic choices for the look and feel of your dashboard.

The following tabs allow you to customize how you view the data.

  • Layout: Allows you to add tabs or links and to launch the Node-RED dashboard where you can review your dashboard.
  • Site: Allows you to configure the Node-RED options.
  • Theme: Allows you to select the style, font color, and font for the dashboard.
  • Angular