Skip to content

Flow configuration

The flow configuration is a JSON object that defines the flow execution. It contains the following properties:

  • mutex
  • clearAllCaches
  • clearFlowExecutionCaches
  • timeout
  • priority

Mutex (mutex)

Mutex is a feature that prevents multiple flow executions from running at the same time. If a flow execution is running and another flow execution with the mutex option is started, the second flow will not start.

The mutex option is wither an integer or an array of integers. The integers represent the flow ID of the blocking flow.

Clear all caches (clearAllCaches)

This is an old configuration that is older than the context-aware cache. It literally clears all caches. Be careful with this feature as some features will also use the Redis cache.

Clear flow execution caches (clearFlowExecutionCaches)

This is a new configuration that clears only the caches that are related to the flow execution.

Timeout (timeout)

This config represents the time in seconds after which the flow execution will be stopped if no action is recorded. The default value is stored in the environment variable DEFAULT_FLOW_TIMEOUT which is set to 600 seconds by default.

Priority (priority)

This setting is a string that represents the priority of the flow execution. The priority is used to determine the order of the flow executions. The default value is low. The possible values are low, normal, high and pm. If you are using worker reservation with a custom transport configuration, then you might have additional priorities.