Introduction
Application Variables are useful for defining global data that can be used across Forms, Rules, and Dashboards. The variable value can be updated in a single place with impact across the entire application, allowing for quick and consistent changes to values, filters, and more.
There are two types of Application Variables we can define:
- Standard Variables
- Member Variables
Note: For information on Defined Sets, check out this article.
In this article we'll take a look at how to configure each of these variables, as well as the reserved System Variables, that are available as well.
Standard Variable
Standard Variables can be defined however you want. They can hold a single piece of data, such as a number, or a more complex definition.
In addition, Standard Variables are recursive by nature, thus they can contain other variables in their definition. To reference another variable within a definition, use the syntax:
${variable_name}
To define a Standard Variable, navigate to the Standard Variables node under All Variables & Sets in the right-hand navigation pane of the MODELER. Then click the Add button in the top-left corner.
In the Add Variable window, all you need to do is give your variable a name and definition. If your definition is more complex, you can create the variable without one at first and then edit it later.
Once the variable is created, we'll have to deploy the application. When migrating Application Variables from one environment to another, we can use the Import or Export functionality. Remember that you also have the option of updating and managing the variable with a script.
Tip: For some examples of using Standard Variables, check out this article.
Member Variable
To create a Member Variable, navigate to the Member Variables node under All Variables & Sets in the right-hand navigation pane of the MODELER. Then click the Add button in the top-left corner.
In the Member Variables configuration window, you can give a name to the variable and define the Member List, Hierarchy, and Member that you want your variable to represent.
Click Save and now you can access your Member Variable across Kepion.
Tip: For some examples of using Member Variables, check out this article.
System Variable
Kepion also features System Variables which can be utilized in the same way as other Standard Variables. The key difference being that System Variables will always resolve to the system-defined term, even if overridden with a user-defined variable.
These variables are defined as:
- ${user}: The currently logged in user
- ${plan}: The name of the plan
- ${submission}: The name of the submission
- ${subid}: The id of the submission
- ${page}: The current dashboard page context
- ${contributor-page}: The relative path to either the HTML5 or Silverlight version of Kepion.
- ${contributor-page-no-splash}: The same as the above, but without the Kepion splash page.
Tip: For more information on the contributor-page variables, check out this article.
To demonstrate the precedence of these variables over user-defined ones, let's create a Standard Variable, as in the example above, and set the name to user and the value to Kepion Solution.
If we then add it to our Dashboard, notice that the text will still resolve to the current logged-in user. It would not display Kepion Solution.
Comments
0 comments
Please sign in to leave a comment.