What Predefined Presentation Variables Are Available?

Table 2-3 contains a list of the predefined presentation variables that you can reference in analyses, dashboards, KPIs, and agents. (Note that the syntax for these predefined presentation variables omits the variables. qualifier, for example, @{session.locale} rather than @{session.variables.locale}.)

Note:

For time zone variables, the time zone for a user must be set to a value other than Default in order for this variable to work. (Users set their preferred time zone in the "My Account dialog: Preferences tab.")

Table 2-3 Predefined Presentation Variables

Scope	Presentation Variable	Example
system	productVersion	system.productVersion = 11.1.1.3 (Build 090619.0110.000)
system	currentTime	system.currentTime = 6/29/2009 7:35:59 PM
session	locale	session.locale = en-us
session	language	session.language = en
session	rtl This indicates whether the language selection in the Login page is a right to left language. For example, if the language selection is Hebrew, then this variable returns true.	session.rtl = false
session	timeZone	session.timeZone = (GMT-06:00) Central America
session	timeZone.id This returns a value that is not localized.	session.timeZone.id = (GMT-06:00) Central America
session	timeZone.name This returns a localized value.	session.timeZone.name = (GMT-06:00) Central America
session	timeZone.value This returns a localized value.	session.timeZone.value = (GMT-06:00) Central America
session	loginTime	session.loginTime = 6/29/2009 7:12:01 PM
session	logoutTime	session.logoutTime = 6/29/2009 8:02:01 PM
session	lastAccessTime	session.lastAccessTime = 6/29/2009 7:35:59 PM
session	currentUser	session.currentUser = Administrator
session	currency.name	session.currency.name = $ English - United States
session	currency.symbol	session.currency.symbol = $
session	currency.userPreference	session.currency.userPreference = Global Currency 2
session	accessibility This indicates whether accessibility mode is enabled for the current user session.	session.accessibility = true
user	id	user.id = Administrator
user	displayName	user.displayName = Administrator
user	homeDirectory	user.homeDirectory = /users/administrator
dashboard	currentPage	dashboard.currentPage = page 1
dashboard	xml	dashboard.xml = the dashboard XML
dashboard	dashboard.currency.name	dashboard.currency.name = Euro
dashboard	dashboard.currency.symbol	dashboard.currency.symbol = $
dashboard	dashboard.currency.userPreference	dashboard.currency.userPreference = Global Currency 1
dashboard	dashboard.path This returns the path in the catalog.	dashboard.path = /users/administrator/_portal/Sales
dashboard	dashboard.name	dashboard.name = MyDashboard
dashboard	dashboard.caption This returns the localized name of the dashboard.	dashboard.caption = Sales
dashboard	dashboard.location This returns the URL for the location.	dashboard.location = Dashboard&PortalPath=/users/administrator/_portal
dashboard	dashboard.description	dashboard.description = Sales by region and district
dashboard	dashboard.author	dashboard.author = Administrator
dashboard.currentPage	dashboard.currentPage.name	dashboard.currentPage.name = Sales page 1
dashboard.currentPage	dashboard.currentPage.path	dashboard.currentPage.path = /users/administrator/_portal/Sales/page 1
dashboard. current Page	dashboard.currentPage.currency.name	dashboard.currentpage.currency. name = USD
dashboard.current Page	dashboard.currentPage.currency.symbol	dashboard.currentPage.currency. symbol = USD
dashboard. current Page	dashboard.currentPage.currency.userPreference	dashboard.currentPage.currency.userPreference = Global Currency 2
analysis	report.currency.name	report.currency.name = $ English - United States
analysis	report.currency.symbol	report.currency.symbol = $
analysis	report.currency.userPreference	report.currency.userPreference = Global Currency 2