Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

What permissions do I need?

What you will see in this view is permissions dependent. Users with Domain flows permission will see all the Templates in the domain, whereas users with Own flows permission will see only Templates created by them.

...

Working with templates

Template manager

...

From this view, you can carry out the following actions:

Instantiate template

Image Modified

This will create an instance for the selected template. To learn more about instances, see the section below.

Load in a new tab

Image Modified

This opens the Template in a new tab, allowing you to keep the Flow Management view open in a different tab.

Clone

Image Modified

&

Image Modified

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
Rw step

After accessing the Flow Editor area, click the go to File in the toolbar and select New template.

Rw step

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.

Rw step

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.

Rw step

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.

Image RemovedImage Added
Info

Alternative ways to add units

You can also add new units by right-clicking anywhere on the canvas and selecting Add unit.

Rw step

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.

Image Added
Rw step

Select Add parameter and fill in the properties:

Image Added

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.

Info

Save your template to save new parameters.

If you add or modify any parameter, keep in mind that the changes will not be reflected in your template until you save it.

Rw step

You can only run Flows and Instances. Therefore, in order to use a template, it must be instantiated.

Go to File → Instantiate template.

Rw step

In the New Instance window, enter a name and select Create instance.

Image Added

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.

...

This way, modifying the original template will also modify it in any instances it is contained in.

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.

Image Added

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.

If you already have a Flow open, go to File → Open and select the instance from the list.

You can filter for instances, or scroll to the desired Instance.

...

Info

Open in a new tab

Make sure to tick this option if you wish to keep the current Flow open.

Image Removed

Unticking this option will open the Instance in the same tab, replacing the current tab.

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:

...

  1. Parameters: Click this button to open the Parameters window with the available parameters.

  2. 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.

...

Info

Option disabled?

You must first save your instance on the server before you can save it as a Flow.

Template manager

You can view all the available templates in your domain via the Flow Manager.

If it is your first time accessing Flow, you can open the Flow Manager directly from the Flow Homepage.

...

If you already have a Flow open, click the Flow Manager icon in the left-hand side.

...

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

Image Added

This will create an instance for the selected template. To learn more about instances, see the section below.

Load in a new tab

Image Added

This opens the Template in a new tab, allowing you to keep the Flow Management view open in a different tab.

Clone

Image Added

&

Image Added

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:

From the Homepage, simply go to New Template:

...

If you are using the Flow area:

Rw ui steps macro
Rw step

After accessing the Flow Editor area, click the go to File in the toolbar and select New template.

Rw step

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.

Rw step

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.

Rw step

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.

Image Added
Info

Alternative ways to add units

You can also add new units by right-clicking anywhere on the canvas and selecting Add unit.

Rw step

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.

Image RemovedImage Added
Rw step

Select Add parameter and fill in the properties:

Image RemovedImage Added

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.

Info

Save your template to save new parameters.

If you add or modify any parameter, keep in mind that the changes will not be reflected in your template until you save it.

Rw step

You can only run Flows and Instances. Therefore, in order to use a template, it must be instantiated.

Go to File → Instantiate template.

Image Removed
Rw step

In the New Instance window, enter a name and select Create instance.

Image RemovedImage Added

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.

...

This way, modifying the original template will also modify it in any instances it is contained in. A new window will show you the results of the changes.

...

Rw ui textbox macro
typeinfo

Icon greyed-out?

You must first Save the Template using the option in the toolbar in order to enable the Publish button.

Image RemovedImage Added

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:

...

  1. Parameters: Click this button to open the Parameters window with the available parameters.

  2. 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.

...