Skip to main content

Flow Properties

Flow properties allow you to set advanced properties on a flow.

To open flow properties, right click inside the flow and select Properties.

General

Description

This is the description of the flow, it can be set and used when exporting this flow for the community.

Author

The name of the author of this flow.

Variables

These are variables that are set when the Flow starts.

Flow templates may create these.

These variables can be used in flow elements like any other variable.

These variables can be overwritten/modified during the flow run, these are just their initial values.


Fields

These fields let you configure fields that will be used when exporting this flow as a template.

If you do not wish to export a flow as a template, you do not need to set these.

NameDescription
NameThe name of the field. See below
TypeThe type for the field, this is used to determine what input is shown to the user when using the template
RequiredIf this field is required and must be set
DefaultThe default value of this field
IfIf this field is only shown if the another field value matches the following conditions, put a name from another field here
If ValueEither the string value or a regular expression the other field must match. For booleans user true or false
If NotIf the field should be shown if the value does NOT match

Field Name

The field name can either be a name of a variable you can use in a flow, for example Output_Path, which you can then use in multiple flow elements.

Or it can be the strong name of a flow element field.

Strong Names

The strong name is {FlowElementName}.{FlowElementField}.

To make strong names work, the flow element must be named without spaces or special characters, for example to set a Codec on a FFMPEG Builder: Audio Add Track you would need to set the name on that flow element.

For example Add_Audio_Track then the strong name would be Add_Audio_Track.Codec