Skip to content

Retrieve Data#

:retrieve-data-lg:

The Retrieve Data task in conjunction with the Store Data task provides a way to share common cache between workflow pages. A stored value can be retrieved using a unique identifier that matches the one specified in the Store Data task.

Screenshot showing a resource name field labeled "Retrieve Resource Name".

Inputs#

Name Data Type Description
Activate any Retrieve all values

Outputs#

Name Data Type Description
<custom list> <custom> Retrieved cached value
Success Boolean true value emitted when the values are retrieved
Error Error Error that occurred during the processing of this task

Settings#

In the General tab, you have the usual settings and the following setting:

Name Data Type Default Description
Trigger on Store Boolean false When true, the task will emit the values when they are changed
Emit in new context Boolean false When true, the emitted value will be wrapped around a new execution context

Screenshot showing a table with columns labeled "Name", "Data Type", "Default", and "Description".

In the Outputs tab, you have the usual settings and the following setting:

Name Data Type Default Description
Name String "Not specified" Output value Name
Identifier String Identifier that will match with the store data
Type Long
Decimal
DateTime
Boolean
String
Integer
The Output value type
Collection Type None
Array
Map
Default Value any The Output value, default value.

Screenshot showing a settings page with options for collection type, including None, Array, and Map.

Behavior#

This task retrieves a cached value by matching its identifier with data stored by the Store Data task. If a match is found, the value is retrieved; otherwise, the default value is emitted.

Remarks#

Combining Store + Retrieve (with Trigger OnStore) can be used to transfer data between different workflows. This is known as a wormhole and is strongly discouraged. Please use Sub Workflows to implement this kind of behavior.

This task uses a specific structure of context-based data called zone. More information on this topic can be read in the Zones page.