Getlist

Retrieves values that were previously stored using Putvalue.

Supported Script Types

Related Actions

These database, table, or list actions store and retrieve data in a database table in order to make the data accessible to other scripts; it behaves like a list of fields or values. Use them for storing multiple values, or values needed further along in other scripts. The values are listed in a table temporarily from 1 hour to 168 hours (7 days). The default TimeToLive (TTL) is 24 hours; however, you can manually remove (delete) the data to maintain complete control within your scripts.

These actions utilize a unique data type that can only be accessed using the appropriate Studio actions: Putvalue, Getvalue, Remvalue, Getlist, and Clearlist. The data are not accessible any other way. Users cannot get to this database and use it, regardless of their permissions.

Notes:

  • If several variables need to be accessed by other scripts/contacts, a database is generally the best solution.
  • Non-persistent public variables can be shared by other scripts/contacts throughout the life of the script that sets those variables. The variables are automatically cleaned up once they are released.

Properties

Property Details
Scope

Select the level that the values this action handles are visible to other contacts. Only contacts that share the same scope will be able to access the same data. Options are: 

The Scope you select must match the Scope set in all other list actions that you include in your script. The list actions are Putvalue, Getvalue, Remvalue, Getlist, and Clearlist. Even when the Name of the list is the same, they will not be recognized if the Scope settings do not match.

Name The used to identify the value. This can be any name or number. Names are not case sensitive. When the value is retrieved using Getvalue, Name must be the same. If the Name property does do not match, they will not recognize each other, even if the Scope setting is the same.
Variable The name of the variable that you want to hold the variable value.
ItemCountVar The name of the variable that will receive the number of values that were received. This variable can be used with other actions, such as LOOP and PARSE to separate values in the array.

Branches

Branch Details

Default

Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the other branches are not defined.

NoData

Path taken if there are no values for the specified properties.

Tips & Tricks

  • Each value will be appended to a pipe (|) delimited string.
  • Strings formatted in this manner can be accessed as an array.