Skip to main content




Service Studio version:

Session Variable

  • Edit
    Collaborate with us
    Edit this page on GitHub
  • Use Session Variables to store data server-side in a key-value format. Use it to cache, for example, for configurations and app context data. Session Variables clear when users log out of the app or close all the browser windows.

    The Session Variables feature is only available for Traditional Web Apps.

    Session Variables are available only in Traditional Web Apps. Avoid referencing elements with Session Variables in Reactive Web or Mobile Apps, as the platform can't keep the values of Session Variables in this scenario between requests. This is due to the runtime differences in the Reactive Web Apps / Mobile Apps on one side, which run in the client-side context, and Traditional Web Apps that run in the server-side context.

    You can use the variables with many data types, but avoid using them for compound data types due to performance considerations.

    To add a Session Variable, click Data tab > Session Variables > Add Session Variable.


    Name Description Mandatory Default value Observations
    Name Identifies an element in the scope where it is defined, like a screen, action, or module. Yes
    Description Text that documents the element. Useful for documentation purpose.
    The maximum size of this property is 2000 characters.
    Data Type The variable data type. Yes
    Default Value Initial value of this element. If undefined, the default value of the data type is used. The default value of a session variable must be a literal.
    • Was this article helpful?