Skip to main content
Version: 4.14.6

Flow Settings

Every flow has settings that can be configured via the settings tab.

Flow settings

The following settings are available:

  • Name
  • Flow component
  • Transport
  • Components Timeout
  • Trace Configuration
  • Environment Variables

Name​

The flow name can be changed after creation, but the name has to be unique. Saving the flow is not possible when the name is not unique.

Flow component​

This setting transforms the flow to a flow component. For more information of Flow components you can read this guide.

Transport​

The transport mechanism used between flow steps (components). Default is the best setting in most cases.

TransportQueueExplanationUsage
DefaultNoNo transport mechanism is used. Components are called directly after each other.Simple use case (Standalone flows)
SynchronousNoWhen you configure your flow to be synchronous, the output of the last component in your flow will be used as a response to the first component.For synchronous (request/response) interactions with strict order of messages.
AsynchronousYesWhen you configure your flow to be asynchronous, messages are stored an in-memory blocking queue between components.For asynchronous (fire-and-forget) interactions. Especially to increase performance when using steps with high load (for example enrichment)
QueuesYesAll messages will pass through a queuing mechanism. This means that the messages are stored on a broker outside of the flow until the next component has received and acknowledged it.For synchronous (request/response) or asynchronous (fire-and-forget) interactions with large messages and guaranteed delivery. Note this mechanism can be slower to process messages in a flow.

Components timeout​

This settings only works when the Transport flow is Queues. This settings control the timeout between communication of components. When a component doesn't respond before the timeout has been reached, the exchange will be passed to the error route. The default timeout is 20 seconds.

Trace Configuration​

By turning Trace Configuration on, all exchanges between components will be logged. These logs can be viewed in the Flow Manager. The logs will only be stored during the set period, after that it will be deleted.

Flow variables​

To work with specific variables in the Test and Production environments you can define flow variables. These can be used for many purposes, for example: usernames, passwords, URL's,...

Flow variables can be used in components by using the following notation:


#{name}

When a flow is installed in Test or Production it will be replaced with the corresponding value set in the flow variables.

Encryption​

Flow variables are frequently used to store passwords and other sensitive information. That's why we decided to encrypt all flow variables before they are stored in the database, they will never be stored as plain text. They only get decrypted to show them in the flow settings and when a flow is installed.

Meta data​

Every flow also has some meta data defined in the flow variables. These can be used for many purposes like generating detailed error messages. These variables are always at the top of the table and have a grey background color. They can't be removed or edited.

Headers in flow variables​

You can insert header notation in the values of a flow variable. In a running flow it will set with the value of the header (if it exists) in every location where the flow variable notation is used.

Example
When a flow variable with Name name & Value ${header.this} is set and the flow is installed with the #{name} notation in a Velocity component:

If header this (before the Velocity component):

  • value is (set to) anything -> #{name} is replaced with anything
  • value is empty -> #{name} is empty
  • doesn't exist -> #{name} is empty
Last updated on