Change the name of a Flow
To change the name of a Flow, just click its name under the toolbar or double-click on the Flow canvas to open its properties window. Enter the new name and click Apply.
Open a Flow
Click the Open option in the toolbar to access the Flow chooser. You can directly select the required Flow in the Flows dropdown menu, where you will see the Flows created by all the users in your domain, grouped by owner. Alternatively, you can use the User filter and Status filter dropdown menus to filter the list of Flows by user and status (Running, Stopped, or Unloaded).
The Open on a new tab option is checked by default. Uncheck it if you want to open the chosen Flow on the current tab.
Opening a Flow on the current tab
If you choose to open a Flow on the current tab, note that the previous Flow will disappear if you did not save it before.
Save a Flow
Make the necessary changes in your Flow and click Save to record the last version. A confirmation message will appear at the top left corner of the window.
Certain actions will make the Flow save automatically, such as checking the events going through two different units clicking a specific link in the Flow. You will always see a notification when that happens.
Work with multiple Flows
To allow users to switch between different Flows, compare content from different Flows or show specific related information in different graphs, The Flow Editor allows you to add as many Flows as needed on different tabs.
- When you access the Flow Editor in a new session, you will see a single Unnamed tab, in Scratch status (orange). You can start working on this tab and then rename it and save your Flow.
- When you clone a Flow or create a new Flow on the current tab, you will be able to choose if you want to create it in the current tab or in a new one. If you do not choose this option, the new Flow will replace the current content. For this reason, remember to save your Flow before creating a new one on the current tab. Otherwise, the current content will disappear.
- When you open an already existing Flow on the current tab, you will be able to choose if you want to open it in the current tab or in a new one. If you decide to open it on the current tab, it will replace the current content. For this reason, remember to save your Flow before opening another Flow on the current tab. Otherwise, the current content will disappear.
- You can drag and drop these tabs to reorder them as desired.
- Right-click a tab to close tabs in two ways:
- Close others: click this option to close all other tabs except the one you have selected.
- Close to the right: choose this option to close all tabs to the right of the one you have selected.
Start and stop a Flow
Once you have defined your Flow, click the Start button in the toolbar to run it and start streaming and processing your data. The Flow status will turn to Running. To stop it, just click the Stop button next to it. The Flow status will turn to Stopped.
Why can't I run my Flow?
Note that you must save your Flow by clicking the Save button before you run it.
Reset a Flow
Some Flow units have an internal status that defines their current condition. For example, the status of the DevoSource unit is the date of the last event it processes.
You can click the Reset button in the toolbar to reset the internal status of all the units in your Flow. This means that all the units that have an internal status will return to its default condition.
Unload a Flow
You can click the Unload button in the toolbar to unload a saved Flow from the server. This may come in handy if you have multiple Flows and you want to free some resources in the server by unloading Flows that you are not currently using. When you unload your Flow, its status will switch to Unloaded.
Unloading VS deleting
Note that this action is not the same as deleting a Flow; you can always recover an unloaded Flow by running it again. When you delete a Flow, it will be removed from the server permanently.
Delete a Flow
To delete a Flow from your domain, just click the Delete icon in the toolbar. The flow status will automatically turn to Scratch and it will not be available to choose it from your flow list the next time you try to access it.
Why can't I delete my Flow?
Note that you can only delete flows that have been previously saved in the system. That is to say, you cannot delete a Flow that has been recently created and is still in Scratch status.
Clone a Flow
To clone your Flow, just click the Clone icon in the toolbar. A window will appear prompting you to enter the name for the clone. Enter the name, click Apply and the cloned Flow will be open.
The clone will be created on a different tab by default. Uncheck the Open on a new tab option if you want to replace the current Flow. Remember that it will be deleted if you don't save it before.
Import and export a Flow
Use the Import and Export buttons in the toolbar to export the current Flow in JSON format, or import a new Flow in a JSON file from your local machine.
Undo and redo actions
Use the Undo and Redo options in the toolbar to undo changes in your Flow or redo any action.
Clear your Flow
Remove all the units and links from your Flow by clicking the Delete option in the toolbar.
Print your Flow
Click the Print option in the toolbar to print a static version of your Flow diagram.