Skip to main content




Service Studio version:

Client Variable

  • Edit
    Collaborate with us
    Edit this page on GitHub
  • Use Client Variables to store basic data types client-side in a key-value format in Mobile and Reactive Web Apps. You can use them to cache, for example, configurations and app context data. The amount of data you have available for all Client Variables across an environment depends on the browser.

    The value of a Client Variable is shared across different apps in the same environment, under these conditions:

    • User Provider of the apps is the same
    • The apps are running in the same browser

    You can share the value of Client Variables through apps by using them in:

    • Public Blocks
    • Public Client Actions

    Client Variables reset to their default values when the user signs out of the app or when the platform signs out the user automatically. However, do not use Client Variables to store sensitive or confidential information.

    Create a Client Variable

    You can add a Client Variable by clicking Data tab > Client Variables > Add Client 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 client variable must be a literal.
    • Was this article helpful?