Skip to main content

Persist Data Component

Persist small amounts of data that will be available later in the execution or in subsequent executions of the Instance

Component key: persist-data

Description#

The persist data component provides functionality to persist small amounts of data for use during an integration execution or in subsequent integration executions. This is helpful if you want to save a bit of data during an integration invocation for use in a later step, or in a subsequent execution.

For details on how to persist data between flow invocations, see the building integrations article.

Data can be persisted in three ways:

  • For just the duration of the execution. Data persists ephemerally for only as long as a flow runs. You might use the Execution - actions, for example, as an accumulator in a loop.
  • Between executions of a specific flow. Data persists between instance executions and is scoped for a specific flow. One flow cannot access another flow's data. The Flow - actions are handy for saving data from one flow's run, and referencing it in a subsequent run of that same flow.
  • Globally, for all flows in an instance. Data persists between instance executions and is scoped for the entire instance. The Cross Flow - actions let flows within an instance reference one another's persisted data.

Actions#

Cross Flow - Add Value To Set#

Add a value to the set with the specified key, creating the set as needed | key: addCrossFlowValueToSet

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value

Cross Flow - Append Value To List#

Append a value to the list with the specified key, creating the list as needed | key: appendCrossFlowValueToList

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value

Cross Flow - Decrement Value#

Decrement the stored integer value with the specified key by the specified amount | key: decrementCrossFlowValue

InputDefaultNotesExample
Input
Amount
data
Default
1
Notes
This is the amount that will be used for incrementing/decrementing
Example
1
Input
Key
data
/ Required
Default
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Cross Flow - Get Value#

Get the value with the specified key, returning the specified default value if key not present | key: getCrossFlowValue

InputNotesExample
Input
Default Value
data
Notes
This is the value that will be returned if there is no value present
Example
Example Default Value
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Output Example Payload#

{  "data": "Example Saved Value"}

Cross Flow - Increment Value#

Increment the stored integer value with the specified key by the specified amount | key: incrementCrossFlowValue

InputDefaultNotesExample
Input
Amount
data
Default
1
Notes
This is the amount that will be used for incrementing/decrementing
Example
1
Input
Key
data
/ Required
Default
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Cross Flow - Remove Value#

Remove the value with the specified key | key: removeCrossFlowValue

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Cross Flow - Remove Value From List#

Remove the value from the list with the specified key | key: removeCrossFlowValueFromList

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value

Cross Flow - Remove Value From Set#

Remove the value from the set with the specified key | key: removeCrossFlowValueFromSet

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value

Cross Flow - Save Current Time#

Save the current time in UTC using the specified key | key: saveCrossFlowCurrentTime

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Cross Flow - Save Value#

Save a value with the specified key for use at a later time | key: saveCrossFlowValue

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value

Execution - Add Value To Set#

Add a value to the set with the specified key, creating the set as needed | key: addExecutionValueToSet

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value

Execution - Append Value To List#

Append a value to the list with the specified key, creating the list as needed | key: appendExecutionValueToList

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value

Execution - Decrement Value#

Decrement the stored integer value with the specified key by the specified amount | key: decrementExecutionValue

InputDefaultNotesExample
Input
Amount
data
Default
1
Notes
This is the amount that will be used for incrementing/decrementing
Example
1
Input
Key
data
/ Required
Default
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Execution - Get Value#

Get the value with the specified key, returning the specified default value if key not present | key: getExecutionValue

InputNotesExample
Input
Default Value
data
Notes
This is the value that will be returned if there is no value present
Example
Example Default Value
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Output Example Payload#

{  "data": "Example Saved Value"}

Execution - Increment Value#

Increment the stored integer value with the specified key by the specified amount | key: incrementExecutionValue

InputDefaultNotesExample
Input
Amount
data
Default
1
Notes
This is the amount that will be used for incrementing/decrementing
Example
1
Input
Key
data
/ Required
Default
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Execution - Remove Value#

Remove the value with the specified key | key: removeExecutionValue

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Execution - Remove Value From List#

Remove the value from the list with the specified key | key: removeExecutionValueFromList

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value

Execution - Remove Value From Set#

Remove the value from the set with the specified key | key: removeExecutionValueFromSet

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value

Execution - Save Current Time#

Save the current time in UTC using the specified key | key: saveExecutionCurrentTime

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Execution - Save Value#

Save a value with the specified key for use at a later time | key: saveExecutionValue

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value

Flow - Add Value To Set#

Add a value to the set with the specified key, creating the set as needed | key: addInstanceValueToSet

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value

Flow - Append Value To List#

Append a value to the list with the specified key, creating the list as needed | key: appendInstanceValueToList

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value

Flow - Decrement Value#

Decrement the stored integer value with the specified key by the specified amount | key: decrementInstanceValue

InputDefaultNotesExample
Input
Amount
data
Default
1
Notes
This is the amount that will be used for incrementing/decrementing
Example
1
Input
Key
data
/ Required
Default
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Flow - Get Value#

Get the value with the specified key, returning the specified default value if key not present | key: getInstanceValue

InputNotesExample
Input
Default Value
data
Notes
This is the value that will be returned if there is no value present
Example
Example Default Value
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Output Example Payload#

{  "data": "Example Saved Value"}

Flow - Increment Value#

Increment the stored integer value with the specified key by the specified amount | key: incrementInstanceValue

InputDefaultNotesExample
Input
Amount
data
Default
1
Notes
This is the amount that will be used for incrementing/decrementing
Example
1
Input
Key
data
/ Required
Default
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Flow - Remove Value#

Remove the value with the specified key | key: removeInstanceValue

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Flow - Remove Value From List#

Remove the value from the list with the specified key | key: removeInstanceValueFromList

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value

Flow - Remove Value From Set#

Remove the value from the set with the specified key | key: removeInstanceValueFromSet

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value

Flow - Save Current Time#

Save the current time in UTC using the specified key | key: saveInstanceCurrentTime

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key

Flow - Save Value#

Save a value with the specified key for use at a later time | key: saveInstanceValue

InputNotesExample
Input
Key
data
/ Required
Notes
This is the key that will be used to refer to the stored value
Example
Example Key
Input
Value
data
/ Required
Notes
This is the value that will be stored
Example
Example Value