| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
What permissions do I need?
To create Flows, you need the Own flows permission.
Create a Flow from scratch
A flow is composed of at least 2 units linked between them, in which the data comes from an output port of one component to an input port of the next one. Creating a new Devo Flow is really simple: you only need to select the required units in the panel at the left of the editor, drag them into the canvas and link them as required to define your stream process.
These are the basic steps you must follow to define a new Devo Flow:
From the Homepage, simply go to New Flow:
If you are using the Flow area:
| Rw ui steps macro | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
After accessing the Flow Editor area, click the go to File in the toolbar and select New flow.
You can choose to create the Flow in a new tab, or disable the Open in a new tab tickbox to replace the current tab. The previous Flow will disappear if you did not save it before opening in the current tab.
Give the new flow a name, then select Apply. The name of your flow will appear at the top of the canvas, next to a color circle that indicates its current status. When you create a flow, its status is always Scratch (orange) until you first save it. Learn more about flow statuses in the section below. 
Now you can start adding the required units to the canvas. Search units in the left panel using the available search box or navigating through the different categories. Select the required units and drop them into the canvas. 
Click a unit on the canvas to see information about it, access its edition options to clone it, delete it, and more, or open the inspector to configure it. Each unit has different configuration options and requires different fields to be filled. Learn more in Unit types. 
Next, you must link the different units to define the required flow. As seen in the above capture, units may have one or several input/output ports, depending on their characteristics. For example, see the unit Devo Full Query in the capture below. In this case, we join the second port of the unit, which generates an event for each query result, with a Mail unit, which sends the received events to a specified email address. Each unit's port and characteristics are clearly defined in their info section. 
Once the Flow is defined, click the Save button in the toolbar. Then, you can click the Start button to run the created flow. You can access the output events produced by every single unit in your flow in the Events window. Events window how to open and work with the Events window. |
| Anchor | ||||
|---|---|---|---|---|
|
Flow icons explained
Flow status
A Flow can have 4 different statuses depending on its condition. You can check the status of your Flow by looking at the indicator next to the Flow name.
| Anchor | ||||
|---|---|---|---|---|
|
Scratch |
| This is the status that your Flow has when you create it and will stay until you save the Flow for the first time. Then, the Flow status will change to Stopped. This means that the Flow has not been recorded into the server yet, and cannot be run until you save it. |
|---|---|---|
Stopped |
| This is the status that your Flow has when you first save your new Flow, or when you click the Stop button when the Flow is running. This means that the Flow is saved but is not sending or processing any data. To run the Flow, you must click the Start button. |
Running |
| This is the status that your Flow has when you run it by clicking the Start button in the toolbar. This means that the Flow is running and is sending and processing events as configured. To stop it, click the Stop button in the toolbar, which will change the status to Stopped. |
Unloaded |
| This is the status that your Flow has when you click the Unload button in the toolbar. This unloads a saved Flow from the server in order to free space. Note that this is not the same as deleting a Flow. Learn more about unloading a Flow here. |
Type icons
Next to the status icon, you will also see icons for Templates and Instances.
