Toggle menu

Save to Session Action

The save to session action field type lets you save data into the current session, creating one if required, against a named variable. For a more detailed look at the order actions are processed in see the The Form Lifecycle: Control and Action Processing reference article.

Properties

LabelDescriptionType Name
Data functionThe JavaScript function that is executed server-side to set the data you want to store. The Helper Library functions are available for use in this function. This simple example returns the value of a helper variable named "data"

function( helper, processor, props, context ) {
    return helper.getVariable("data");
}
ACTIONFUNC
KeyThe name, or key, under which the data is stored within the current sessionKEY

Action Results

The following can be accessed using .utilGetActionResults once the action has been processed.

"FIELDNAME": {
    "success": "true"
}

Storage Location

Any data saved via the Save to Session action is available within the Form Context under the USER.FORMSESSIONSTORE property.

"FORMSESSIONSTORE": {
    "exampleKey": "exampleData",
}

Last modified on 28 January 2021

Share this page

Facebook icon Twitter icon email icon

Print

print icon