Toggle menu

Save to Session Action

The save to session action field type lets a user save data into their current user session, which can then be accessed by forms. All data is stored in the FORMSESSIONSTORE user context variable. This action lets you manipulate the data and save it against a named key.

Properties

LabelDescriptionType Name
Data functionThe JavaScript function that is executed server-side to add data to the session store. The usual form helper functions are available for use in this function. This simple example will store the text "example data"

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

Storage Location

Any data saved using the Save to Session action is stored within the Form Context under the USER.FORMSESSIONSTORE property. It can be retrieved using .getSiteVariable and FORMSESSIONSTORE.

"FORMSESSIONSTORE": {
    "exampleKey": "example data",
}

Action Results

The following is returned using .utilGetActionResults once the action has been processed.

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

Last modified on 3 October 2025