Skip to main content
Feedback

Flow states

A 'state' refers to the metadata record created and maintained for a running flow execution. It contains all the required Runtime data, such as values, the current step, and all other metadata needed for the flow to function.

State expiration (When complete)​

Once a flow state has reached its final step, which signifies the end of the workflow process, it is considered 'done' and will be 'deleted' after three days. The deletion removes all state content (such as values and user interactions) but keeps the state record, allowing it to continue being historically reported via the Dashboard.

State expiration (Absolute)​

You can configure states to expire after a set amount of time since launch. Once a state expires, any user who tries to join or progress through it receives a message informing them that “The state with ID 12345 has now expired” and will no longer be able to interact with the flow.

Configure this setting on the Flow Properties when editing a Flow.

For example, to define a flow expiration time for an existing flow:

  1. Open the flow for which you wish to set the expiration time.
  2. Click Properties in the right-hand menu to open the Flow Properties form. See Flow Properties.
  3. In the State section of the form, enter a value (in days) in the Number of days before the in-flight States should be deleted field. By default, this setting is configured not to delete 'in-flight' states. For example, upon flow execution, if the current element has not reached its final step in the workflow process, the system retains the data until the state deletion. See State Deletion.
  4. Save the flow. Once you publish and execute, it will expire after the specified duration, making it unavailable for further interaction.

State expiration (Inactivity)

You can configure states to expire after a set amount of inactivity. Once a state expires, any user who tries to join or progress through it receives a message informing them that “The state with ID 12345 has now expired” and will no longer be able to interact with the flow.

Configure this setting on the Flow Properties form when editing a Flow.

For example, to define a flow inactivity expiration time for an existing flow:

  1. Open the flow for which you wish to set the inactivity expiration time.
  2. Click Properties in the right-hand menu to open the Flow Properties form. See Flow Properties.
  3. In the State section of the form, enter a value (in days) into the Number of days of inactivity before the in-flight States should be deleted field. You can define this setting as a value between 1 - 180 days, where 180 days is the maximum number of days you can set.
  4. Save the flow. Once you publish and execute it, it will expire if there is no activity within the defined time, and you will no longer be able to interact with it.
note

The default setting for newly created flows is 30 days.

State deletion

States older than 24 months will be permanently removed, including their associated state ID records. This maintenance routine will happen regardless of any set expiration settings.

You cannot generate reports for states over 24 months from their execution start date.

On this Page