SmartFlows

SmartFlows enables the visual, low- or no-code construction of workflows to filter data models and perform automation actions on the results. The result is that complex decision-based automations can be created in a single layout without requiring extensive knowledge of BQL or Flow JSON schemas.

Getting started

SmartFlows are accessed from the Automation menu. To get started with a SmartFlow, click the Create button at the top of the table and give the SmartFlow a Title and optional Description. Then use the Select data model button to choose the data model the SmartFlow will query. Like Automations, SmartFlows can be triggered manually, on a schedule, or as part of Orchestration.

Once the SmartFlow has been created, a blank workflow canvas is presented. Use the toolbar to drag and drop new Filter and Action nodes onto the canvas. Use the connection points on Filter and Action nodes to drag new connections to other nodes.

The START node

This is where the SmartFlow will begin. Drag the connector point on the bottom of the START node to a Filter node which will start the SmartFlow execution.

Chaining and branching

The power in SmartFlows comes from the ability to "chain" nodes together to form an execution path. In addition, Filter nodes have two different output connections - one for passing on items that match the given filter criteria, and one for passing on items that do not match.

While the SmartFlow must start with a Filter node, there is no other restriction on chaining nodes together. Filters can be chained to other Filters and Actions either through the matched or unmatched connectors, and Actions can be chained to additional Filters or further Actions.

Filter nodes

Filter nodes issue queries against the set of data models passed in from a previous Filter or Action node. The list of data models that match the query are passed along to the node connected to the filter's Matched Items connection point (on the bottom). Optionally, the set of data models that do NOT match the query are passed along to the node connected to the filter's Unmatched Items connection point (on the right-hand side).

Queries can be defined in Filter nodes by using the Visual Query Builder, or by directly editing BQL. Also note that the Query Timeout value can be adjusted to limit the amount of time a query is permitted to execute.

If a title is provided for a Filter node, that title will be displayed inside the Filter node on the canvas. To always show the BQL for all Filter nodes, enable the Always show filter BQL option in the Options section of the toolbar.

Action nodes

Action nodes execute the specified Automation action against the set of data models passed into it. Action nodes can then pass on that same data set to further Action nodes, or to other Filter nodes for further querying before additional Action nodes are connected.

If a title is provided for an Action node, that title will be displayed inside the Action node on the canvas. Otherwise, the selected Automation action name will be displayed instead.

Publishing and running a SmartFlow

After editing a SmartFlow, click the Publish button to commit your changes. Then click the Run button to manually begin execution of the SmartFlow.