Table of Contents | ||||||
---|---|---|---|---|---|---|
|
What is a template?
Devo Flow templates are designed to streamline data analysis and context sharing within Flow. Use them to create parameters that can be easily inserted into units.
Working with templates
Template manager
You can view all the available templates in your domain via the Flow Manager.
...
The Flow Manager provides information on Flows in your domain in two tabs: Flows, and Templates.
...
Managing templates
From this view, you can carry out the following actions:
Instantiate template | This will create an instance for the selected template. To learn more about instances, see the section below. | |
---|---|---|
Load in a new tab | This opens the Template in a new tab, allowing you to keep the Flow Management view open in a different tab. | |
Clone | & | Click this button and then select Clone to clone the selected Template. A new window will appear, where you can assign a new name for the cloned Template. Click Apply and the new Template will appear. You can now make modifications to this Template without changing the original. |
Create a Template
These are the basic steps you must follow to define a new Devo Flow Template:
...
Rw ui steps macro | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
After accessing the Flow Editor area, click the go to File in the toolbar and select New template.
You can choose to create the Template 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 template a name, then select Apply. The name of your template will appear at the top of the canvas, next to a color circle that indicates its current status. When you create a template, its status is always Scratch (orange) until you first save it. Learn more about flow statuses here.
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.
Once you have created and configured all the units required for the template, you can change some of the configurations using Parameters.When the template is instantiated, you can use parameters to adapt and insert your own data variables. Let’s say you have a template containing a Tick unit, a Repeater, and a Devo Sink unit. However, you wish to modify specific parameters of the Tick unit without having to redo the Flow. Click the parameters icon to open the form.
Select Add parameter and fill in the properties: In the original Flow, the Tick will send an integer of 4 as specified in its properties. With this new parameter, we are modifying this integer value to 3, whilst maintaining the rest of the Flow chain. Select Create and the new parameter will appear in the list.
You can only run Flows and Instances. Therefore, in order to use a template, it must be instantiated. Go to File → Instantiate template.
In the New Instance window, enter a name and select Create instance. A new window will open with your instance, indicating that your Template is ready to use. To learn more about instances, see the section below. |
Publish a template
Once you have initiated a Template, instead of having to reinstantiate it every time you make changes, you can Publish it to reflect any changes made. For this, use the Publish option in the toolbar.
...
Rw ui textbox macro |
---|
Icon greyed-out? You must first Save the Template using the option in the toolbar in order to enable the Publish button. |
Working with Instances
An instance is a Flow created from a Template. The Flow is activated so that you can test it, save it, run it and more.
Open an instance
You can open an instance in two ways.
...
You can also use the Flow Manager to see a list of instances.
Using instances
As well as the common Flow operations, the Instance toolbar provides buttons specific to instances:
...
Parameters: Click this button to open the Parameters window with the available parameters.
Master template: This will take you to the original template that the instance was created from.
Detach instance
If you have an instance you wish to convert to a Flow, use the Detach instance option in the File menu.
...