Data Storage

Using the Data Storage component, you can easily manage and operate on lists and objects by setting or retrieving any desired data. This process employs a key-value store mechanism, where the key represents the field’s name and the value corresponds to the particular data’s actual value.

Categories: helpers

Type: dataStorage/v1

---

Actions

Append Value to List

Name: appendValueToList

Append value to the end of a list. If the list does not exist, it will be created.

Properties

Name	Label	Type	Control Type	Description	Required
scope	Scope	STRING Options CURRENT_EXECUTION, WORKFLOW, ACCOUNT	SELECT	The namespace for appending a value.	true
key	Key	STRING	TEXT	The identifier of a list must be unique within the chosen scope, or a new value will overwrite the existing one.	true
type	Type	STRING Options ARRAY, BOOLEAN, DATE, DATE_TIME, INTEGER, NULL, NUMBER, OBJECT, STRING, TIME	SELECT	The value type.	null
value	Value	ARRAY Items []	ARRAY_BUILDER	The value to set under given key.	true
value	Value	BOOLEAN Options true, false	SELECT	The value to set under given key.	true
value	Value	DATE	DATE	The value to set under given key.	true
value	Value	DATE_TIME	DATE_TIME	The value to set under given key.	true
value	Value	INTEGER	INTEGER	The value to set under given key.	true
value	Value	NULL	NULL	The value to set under given key.	true
value	Value	NUMBER	NUMBER	The value to set under given key.	true
value	Value	OBJECT Properties {}	OBJECT_BUILDER	The value to set under given key.	true
value	Value	STRING	TEXT	The value to set under given key.	true
value	Value	TIME	TIME	The value to set under given key.	true
appendListAsSingleItem	Append a List as a Single Item	BOOLEAN Options true, false	SELECT	When set to true, and the value is a list, it will be added as a single value rather than concatenating the lists.	null

JSON Example

{
  "label" : "Append Value to List",
  "name" : "appendValueToList",
  "parameters" : {
    "scope" : "",
    "key" : "",
    "type" : "",
    "value" : "00:00:00",
    "appendListAsSingleItem" : false
  },
  "type" : "dataStorage/v1/appendValueToList"
}

Atomic Increment

Name: atomicIncrement

The numeric value can be incremented atomically, and the action can be used concurrently from multiple executions.

Properties

Name	Label	Type	Control Type	Description	Required
key	Key	STRING	TEXT	The identifier of a value to increment.	true
scope	Scope	STRING Options CURRENT_EXECUTION, WORKFLOW, ACCOUNT	SELECT	The namespace to obtain a value from.	true
valueToAdd	Value to Add	INTEGER	INTEGER	The value that can be added to the existing numeric value, which may have a negative value.	null

Output

Type: INTEGER

JSON Example

{
  "label" : "Atomic Increment",
  "name" : "atomicIncrement",
  "parameters" : {
    "key" : "",
    "scope" : "",
    "valueToAdd" : 1
  },
  "type" : "dataStorage/v1/atomicIncrement"
}

Await Get Value

Name: awaitGetValue

Wait for a value under a specified key, until it’s available.

Properties

Name	Label	Type	Control Type	Description	Required
key	Key	STRING	TEXT	The identifier of a value to wait for.	true
scope	Scope	STRING Options CURRENT_EXECUTION, WORKFLOW, ACCOUNT	SELECT	The namespace to obtain a value from.	true
type	Type	STRING Options ARRAY, BOOLEAN, DATE, DATE_TIME, INTEGER, NULL, NUMBER, OBJECT, STRING, TIME	SELECT	The value type.	null
defaultValue	Default Value	ARRAY Items []	ARRAY_BUILDER	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	BOOLEAN Options true, false	SELECT	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	DATE	DATE	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	DATE_TIME	DATE_TIME	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	INTEGER	INTEGER	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	NULL	NULL	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	NUMBER	NUMBER	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	OBJECT Properties {}	OBJECT_BUILDER	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	STRING	TEXT	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	TIME	TIME	The default value to return if no value exists under the given key.	true
timeout	Timeout	INTEGER	INTEGER	If a value is not found within the specified time, the action returns a null value. Therefore, the maximum wait time should be set accordingly.	true

JSON Example

{
  "label" : "Await Get Value",
  "name" : "awaitGetValue",
  "parameters" : {
    "key" : "",
    "scope" : "",
    "type" : "",
    "defaultValue" : "00:00:00",
    "timeout" : 1
  },
  "type" : "dataStorage/v1/awaitGetValue"
}

Delete Value

Name: deleteValue

Remove a value associated with a key in the specified scope.

Properties

Name	Label	Type	Control Type	Description	Required
key	Key	STRING	TEXT	The identifier of a value to delete, stored earlier in the selected scope.	true
scope	Scope	STRING Options CURRENT_EXECUTION, WORKFLOW, ACCOUNT	SELECT	The namespace to delete a value from. The value should have been previously accessible, either in the present workflow execution, or the workflow itself for all the executions, or the user account for all the workflows the user has.	true

JSON Example

{
  "label" : "Delete Value",
  "name" : "deleteValue",
  "parameters" : {
    "key" : "",
    "scope" : ""
  },
  "type" : "dataStorage/v1/deleteValue"
}

Delete Value from List

Name: deleteValueFromlist

Delete a value from the given index in a list.

Properties

Name	Label	Type	Control Type	Description	Required
key	Key	STRING	TEXT	The identifier of a list to delete value from, stored earlier in the selected scope.	true
scope	Scope	STRING Options CURRENT_EXECUTION, WORKFLOW, ACCOUNT	SELECT	The namespace to delete a value from. The value should have been previously accessible, either in the present workflow execution, or the workflow itself for all the executions, or the user account for all the workflows the user has.	true
index	Index	INTEGER	INTEGER	The specified index in the list will be removed, and if it doesn’t exist, the list will remain unaltered.	true

JSON Example

{
  "label" : "Delete Value from List",
  "name" : "deleteValueFromlist",
  "parameters" : {
    "key" : "",
    "scope" : "",
    "index" : 1
  },
  "type" : "dataStorage/v1/deleteValueFromlist"
}

Get All Entries(Keys and Values)

Name: getAllEntries

Retrieve all the currently existing keys from storage, along with their values within the provided scope.

Properties

Name	Label	Type	Control Type	Description	Required
scope	Scope	STRING Options CURRENT_EXECUTION, WORKFLOW, ACCOUNT	SELECT	The namespace to get keys from.	true

Output

Type: ARRAY

Properties

Name	Type	Control Type
	OBJECT Properties {}	OBJECT_BUILDER

JSON Example

{
  "label" : "Get All Entries(Keys and Values)",
  "name" : "getAllEntries",
  "parameters" : {
    "scope" : ""
  },
  "type" : "dataStorage/v1/getAllEntries"
}

Get Value

Name: getValue

Retrieve a previously assigned value within the specified scope using its corresponding key.

Properties

Name	Label	Type	Control Type	Description	Required
key	Key	STRING	TEXT	The identifier of a value to get, stored earlier in the selected scope.	true
scope	Scope	STRING Options CURRENT_EXECUTION, WORKFLOW, ACCOUNT	SELECT	The namespace to get a value from. The value should have been previously accessible, either in the present workflow execution, or the workflow itself for all the executions, or the user account for all the workflows the user has.	true
type	Type	STRING Options ARRAY, BOOLEAN, DATE, DATE_TIME, INTEGER, NULL, NUMBER, OBJECT, STRING, TIME	SELECT	The value type.	null
defaultValue	Default Value	ARRAY Items []	ARRAY_BUILDER	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	BOOLEAN Options true, false	SELECT	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	DATE	DATE	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	DATE_TIME	DATE_TIME	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	INTEGER	INTEGER	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	NULL	NULL	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	NUMBER	NUMBER	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	OBJECT Properties {}	OBJECT_BUILDER	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	STRING	TEXT	The default value to return if no value exists under the given key.	true
defaultValue	Default Value	TIME	TIME	The default value to return if no value exists under the given key.	true

JSON Example

{
  "label" : "Get Value",
  "name" : "getValue",
  "parameters" : {
    "key" : "",
    "scope" : "",
    "type" : "",
    "defaultValue" : "00:00:00"
  },
  "type" : "dataStorage/v1/getValue"
}

Set Value

Name: setValue

Set a value under a key, in the specified scope.

Properties

Name	Label	Type	Control Type	Description	Required
key	Key	STRING	TEXT	The identifier of a value. Must be unique across all keys within the chosen scope to prevent overwriting the existing value with a new one. Also, it must be less than 1024 bytes in length.	true
scope	Scope	STRING Options CURRENT_EXECUTION, WORKFLOW, ACCOUNT	SELECT	The namespace to set a value in. The value should have been previously accessible, either in the present workflow execution, or the workflow itself for all the executions, or the user account for all the workflows the user has.	true
type	Type	STRING Options ARRAY, BOOLEAN, DATE, DATE_TIME, INTEGER, NULL, NUMBER, OBJECT, STRING, TIME	SELECT	The value type.	null
value	Value	ARRAY Items []	ARRAY_BUILDER	The value to set under the specified key.	true
value	Value	BOOLEAN Options true, false	SELECT	The value to set under the specified key.	true
value	Value	DATE	DATE	The value to set under the specified key.	true
value	Value	DATE_TIME	DATE_TIME	The value to set under the specified key.	true
value	Value	INTEGER	INTEGER	The value to set under the specified key.	true
value	Value	NULL	NULL	The value to set under the specified key.	true
value	Value	NUMBER	NUMBER	The value to set under the specified key.	true
value	Value	OBJECT Properties {}	OBJECT_BUILDER	The value to set under the specified key.	true
value	Value	STRING	TEXT	The value to set under the specified key.	true
value	Value	TIME	TIME	The value to set under the specified key.	true

JSON Example

{
  "label" : "Set Value",
  "name" : "setValue",
  "parameters" : {
    "key" : "",
    "scope" : "",
    "type" : "",
    "value" : "00:00:00"
  },
  "type" : "dataStorage/v1/setValue"
}

Set Value in List

Name: setValueInList

Set value under a specified index in a list.

Properties

Name	Label	Type	Control Type	Description	Required
key	Key	STRING	TEXT	The identifier of a list. Must be unique across all keys within the chosen scope to prevent overwriting the existing value with a new one. Also, it must be less than 1024 bytes in length.	true
scope	Scope	STRING Options CURRENT_EXECUTION, WORKFLOW, ACCOUNT	SELECT	The namespace to set a value in. The value should have been previously accessible, either in the present workflow execution, or the workflow itself for all the executions, or the user account for all the workflows the user has.	true
index	Index	INTEGER	INTEGER	The index in a list to set a value under. The previous value will be overridden.	true
type	Type	STRING Options ARRAY, BOOLEAN, DATE, DATE_TIME, INTEGER, NULL, NUMBER, OBJECT, STRING, TIME	SELECT	The value type.	null
value	Value	ARRAY Items []	ARRAY_BUILDER	The value to set under the specified list’s key.	true
value	Value	BOOLEAN Options true, false	SELECT	The value to set under the specified list’s key.	true
value	Value	DATE	DATE	The value to set under the specified list’s key.	true
value	Value	DATE_TIME	DATE_TIME	The value to set under the specified list’s key.	true
value	Value	INTEGER	INTEGER	The value to set under the specified key.	true
value	Value	NULL	NULL	The value to set under the specified key.	true
value	Value	NUMBER	NUMBER	The value to set under the specified list’s key.	true
value	Value	OBJECT Properties {}	OBJECT_BUILDER	The value to set under the specified list’s key.	true
value	Value	STRING	TEXT	The value to set under the specified list’s key.	true
value	Value	TIME	TIME	The value to set under the specified list’s key.	true

JSON Example

{
  "label" : "Set Value in List",
  "name" : "setValueInList",
  "parameters" : {
    "key" : "",
    "scope" : "",
    "index" : 1,
    "type" : "",
    "value" : "00:00:00"
  },
  "type" : "dataStorage/v1/setValueInList"
}