Variables in QPR UI - Revision history

Ollvihe: /* Variables Usage Example */

2019-12-23T10:29:26Z

Variables Usage Example

Ollvihe: /* Context Variables and Web Browser History */

2019-12-23T10:29:04Z

Context Variables and Web Browser History

Ollvihe at 15:13, 15 October 2019

2019-10-15T15:13:01Z

Ollvihe: /* System Variables */

2019-06-19T19:01:43Z

System Variables

Ollvihe: /* System Variables */

2019-06-19T19:01:07Z

System Variables

Ollvihe: /* See Also */

2019-05-16T20:49:07Z

Ollvihe at 20:42, 16 May 2019

2019-05-16T20:42:50Z

Ollvihe at 20:40, 16 May 2019

2019-05-16T20:40:46Z

Ollvihe: Ollvihe moved page Context Variables in QPR UI to Variables in QPR UI

2019-05-16T20:39:46Z

Ollvihe moved page Context Variables in QPR UI to Variables in QPR UI

Ollvihe: /* Setting Variable Values in URL */

2018-11-26T13:58:01Z

Setting Variable Values in URL

← Older revision		Revision as of 10:29, 23 December 2019
Line 90:		Line 90:

	Note that for path <nowiki>http://localhost:8080/ui/#/home/</nowiki> the login with the sys:password parameter doesn't work.		Note that for path <nowiki>http://localhost:8080/ui/#/home/</nowiki> the login with the sys:password parameter doesn't work.
−	\|}
−
−	~~== Variables Usage Example ==~~
−	~~There is a view with one panel, in which there is one presentation object. The '''Session''' variable values are defined as follows:<br>~~
−	~~{\| class="wikitable"~~
−	~~!'''Variable name'''~~
−	~~! '''Value'''~~
−	\|-
−	~~\|\|AccountManager~~
−	~~\|\|John Smith~~
−	\|-
−	~~\|\|Country~~
−	~~\|\|Sweden~~
−	\|}
−
−	~~In the '''View Properties''', the following variable values are defined:<br>~~
−	~~{\| class="wikitable"~~
−	~~!'''Variable name'''~~
−	~~! '''Value'''~~
−	~~! '''Behavior'''~~
−	\|-
−	~~\|\|AccountManager~~
−	~~\|\|William Taylor~~
−	~~\|\|Stored variable~~
−	\|-
−	~~\|\|CustomerGroup~~
−	~~\|\|Kids~~
−	~~\|\|Local variable~~
−	\|}
−
−	~~In the '''Panel Properties''', the following variable values are defined:<br>~~
−	~~{\| class="wikitable"~~
−	~~!'''Variable name'''~~
−	~~! '''Value'''~~
−	~~! '''Behavior'''~~
−	\|-
−	~~\|\|AccountManager~~
−	~~\|\|Susan Chapman~~
−	~~\|\|Local variable~~
−	\|-
−	~~\|\|Country~~
−	~~\|\|Finland~~
−	~~\|\|Local variable~~
−	\|}
−
−	~~In the '''Presentation Object Properties''', the following variable values are defined:<br>~~
−	~~{\| class="wikitable"~~
−	~~!'''Variable name'''~~
−	~~! '''Value'''~~
−	~~! '''Behavior'''~~
−	\|-
−	~~\|\|ProductGroup~~
−	~~\|\|Umbrellas~~
−	~~\|\|Stored variable~~
−	\|}
−
−	~~In the '''Effective View Context''', these result into the values shown below. Note the '''Source''' column displaying the information where the effective context comes from:<br>~~
−	~~{\| class="wikitable"~~
−	~~!'''Variable name'''~~
−	~~! '''Value'''~~
−	~~! '''Source'''~~
−	~~! '''Scope'''~~
−	\|-
−	~~\|\|AccountManager~~
−	~~\|\|William Taylor~~
−	~~\|\|Scope of the view~~
−	~~\|\|View~~
−	\|-
−	~~\|\|Country~~
−	~~\|\|Sweden~~
−	~~\|\|Inherited from session context~~
−	~~\|\|Session~~
−	\|-
−	~~\|\|CustomerGroup~~
−	~~\|\|Kids~~
−	~~\|\|Scope of the view~~
−	~~\|\|View~~
−	\|}
−
−	~~In the '''Effective Panel Context''', these result into the values shown below. Note the '''Source''' column displaying the information where the effective context comes from:<br>~~
−	~~{\| class="wikitable"~~
−	~~!'''Variable name'''~~
−	~~! '''Value'''~~
−	~~! '''Source'''~~
−	~~! '''Scope'''~~
−	\|-
−	~~\|\|AccountManager~~
−	~~\|\|Susan Chapman~~
−	~~\|\|Initialized from the panel's context~~
−	~~\|\|Panel~~
−	\|-
−	~~\|\|Country~~
−	~~\|\|Finland~~
−	~~\|\|Initialized from the panel's context~~
−	~~\|\|Panel~~
−	\|-
−	~~\|\|CustomerGroup~~
−	~~\|\|Kids~~
−	~~\|\|Inherited from the effective context of the view~~
−	~~\|\|View~~
−	\|}
−
−	~~In the '''Effective Presentation Object Context''', these result into the values shown below. Note the '''Source''' column displaying the information where the effective context comes from:~~
−	~~{\| class="wikitable"~~
−	~~!'''Variable name'''~~
−	~~! '''Value'''~~
−	~~! '''Source'''~~
−	~~! '''Scope'''~~
−	\|-
−	~~\|\|AccountManager~~
−	~~\|\|Susan Chapman~~
−	~~\|\|Inherited from the effective context of the panel~~
−	~~\|\|Panel~~
−	\|-
−	~~\|\|Country~~
−	~~\|\|Finland~~
−	~~\|\|Inherited from the effective context of the panel~~
−	~~\|\|Panel~~
−	\|-
−	~~\|\|ProductGroup~~
−	~~\|\|Umbrellas~~
−	~~\|\|Scope of the presentation object~~
−	~~\|\|Presentation object~~
−	\|-
−	~~\|\|CustomerGroup~~
−	~~\|\|Kids~~
−	~~\|\|Inherited from the effective context of the view~~
−	~~\|\|View~~
−	\|}
−
−	~~To put it more concisely, the context variable values (and their behaviors) are as follows:<br>~~
−	~~{\| class="wikitable"~~
−	~~!Context Variable\|\|Session\|\|View\|\|Panel\|\|Presentation Object~~
−	\|-
−	~~\|AccountManager\|\|John Smith\|\|William Taylor (Stored variable)\|\|Susan Chapman (Local variable)\|\|~~
−	\|-
−	~~\|Country\|\|Sweden\|\| \|\|Finland (Local variable) \|\|~~
−	\|-
−	~~\|ProductGroup\|\| \|\| \|\| \|\|Umbrellas (Stored variable)~~
−	\|-
−	~~\|CustomerGroup\|\| \|\|Kids (Local variable)\|\| \|\|~~
−	\|}
−
−	~~The effective context values are:~~
−	~~<br>~~
−	~~{\| class="wikitable"~~
−	~~!Context Variable\|\|Session\|\|View\|\|Panel\|\|Presentation Object~~
−	\|-
−	~~\|AccountManager\|\|John Smith\|\|William Taylor\|\|Susan Chapman\|\|Susan Chapman~~
−	\|-
−	~~\|Country\|\|Sweden\|\|Sweden\|\|Finland\|\|Finland~~
−	\|-
−	~~\|ProductGroup\|\| \|\| \|\| \|\|Umbrellas~~
−	\|-
−	~~\|CustomerGroup\|\| \|\|Kids\|\|Kids\|\|Kids~~
	\|}		\|}

@@ Line 248: / Line 248: @@
 == Context Variables and Web Browser History ==
-Any time the '''session context''' is modified (like when clicking a [[Pushbutton_Properties|Pushbutton]] or modifying [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)#QPR_ProcessAnalyzer_Presentation_Object_.28PAPO.29|ProcessAnalyzer Presentation Object]] settings that cause session variables to be modified), a browser history entry is created. The preceding values in the session context can be restored via the browser's '''Back''' button. Left-clicking the Back button will restore the previous session context values, whereas right-clicking the Back button will show a list of session context changes to select from. Selecting an entry on the list will restore the session context from that entry.
+Any time the '''session context''' is modified, a new browser history entry is created. The preceding values in the session context can be restored via the browser's '''Back''' button. Left-clicking the Back button will restore the previous session context values, whereas right-clicking the Back button will show a list of session context changes to select from. Selecting an entry on the list will restore the session context from that entry.
 <br>
 [[File:BrowserHistory.png]]

← Older revision		Revision as of 15:13, 15 October 2019
Line 1:		Line 1:
−	'''Variables''' in QPR UI are for storing session time information and communicating between different user interface elements, such as views, panels and presentation objects.	+	'''Variables''' in QPR UI are for storing session time information and communicating between different user interface elements, such as views, panels and presentation objects. Variables can only contain textual (string) values. If other types of values are provided, they are converted into strings.

	__TOC__		__TOC__

@@ Line 76: / Line 76: @@
 |-
 ||sys:settingsPanel
-||View level variable defining whether the right side settings page is opened and which tab in the pane is open. sys:settingsPanel is defined as a JSON object with following properties:
+||View level variable defining whether the right side settings page is open and which tab in the pane is active. sys:settingsPanel is defined as a JSON object with following properties:
 * isOpen: '''true''' (settings pane is open) or '''false''' (settings pane is closed)
 * activePage: '''model''' or '''settings'''

@@ Line 74: / Line 74: @@
 ||sys:sessionId
 ||QPR UI user session id. Can be used to pass the session id to other QPR Suite product to use it in [[Common QPR Authentication|common QPR Authentication]]. The variable value is readonly. The session id is accepted by the '''xsession''' parameter in all QPR products.
 |-
 ||sys:username

@@ Line 249: / Line 249: @@
 == See Also ==
 * [[Variable Tag in QPR UI]]
 [[Category: QPR UI]]

← Older revision		Revision as of 20:42, 16 May 2019
Line 41:		Line 41:

	Note that when using variables a url, variable values need to be url encoded (more information: https://www.w3schools.com/tags/ref_urlencode.asp).		Note that when using variables a url, variable values need to be url encoded (more information: https://www.w3schools.com/tags/ref_urlencode.asp).
		+
		+	== System Variables ==
		+	QPR UI has the '''system variables''' defined in the table below. System variables have a special functionality in the system. All system variables start with '''sys:''' prefix, and thus it's a good practice not to name other variables to start with that to avoid accidental use of system variables.
		+
		+	When using variables a url pointing to QPR UI, variable values need to be url encoded (more information: https://www.w3schools.com/tags/ref_urlencode.asp).
		+
		+	{\| class="wikitable"
		+	!'''Variable name'''
		+	! '''Description'''
		+	\|-
		+	\|\|sys:dashboard
		+	\|\|Id of the currently open view. Another view can be opened by changing this variable value.
		+	\|-
		+	\|\|sys:dashboardIdentifier
		+	\|\|Use this variable when you want to open another view using a '''path''' the target view. The path can be defined as:
		+	* '''Absolute path''' where the path starts from the folders hierarchy root. The absolute path always points to the view defined by the path. Example: ''/Folder/Sub folder/ViewIdentifier''.
		+	* '''Relative path''' where the path starts from the folder where the currently opened view is located. Relative paths can be used to link between views within a folder branch and the links remain, even if the branch is moved to other folder. Example: ''Folder/Sub folder/viewidentifier''.
		+
		+	Absolute paths always starts with the slash ('''/'''), whereas relative paths don't start with slash.
		+
		+	sys:dashboardIdentifier variable can only be used in the session context. Setting the sys:dashboardIdentifier variable value will automatically set the corresponding value to sys:dashboard variable. sys:dashboardIdentifier will be removed automatically after.
		+	\|-
		+	\|\|sys:hideViewHeader
		+	\|\|Defines whether the top main toolbar in the view is hidden ('''true''') or visible ('''false''').
		+	\|-
		+	\|\|sys:mobileModeThreshold
		+	\|\|The width in pixels to use as the breakpoint for mobile mode of locked QPR UI views. When a screen width is smaller than the threshold, the view is shown in mobile mode. In the mobile mode, panels are stacked vertically and each panel's height equals the screen height. Supported values are integers. Default value is 800 pixels, which is used if this variable isn't defined or an invalid value is defined. Defining "0" as the value will disable the mobile mode. Note that sys:mobileModeThreshold has only effect in the view's effective context.
		+	\|-
		+	\|\|sys:password
		+	\|\|Use this parameter to provide password to login automatically to QPR UI without going to the login screen. You also need to provide the sys:username parameter. sys:username and sys:password parameters are removed from the URL after the login, and thus they won't be stored as QPR UI variables. Note however, that the username and password can be stored in the browser history. See url examples in the description of the sys:username parameter.
		+	\|-
		+	\|\|sys:sessionId
		+	\|\|QPR UI user session id. Can be used to pass the session id to other QPR Suite product to use it in [[Common QPR Authentication\|common QPR Authentication]]. The variable value is readonly. The session id is accepted by the '''xsession''' parameter in all QPR products.
		+	\|-
		+	\|\|sys:username
		+	\|\|Use this parameter to provide username to login automatically to QPR UI without visiting the login screen. To be able to authenticate, you also need to provide the ''sys:password'' parameter. sys:username and sys:password parameters are removed from the URL after the login, and so that they won't be stored as QPR UI variables. Note however, that the username and password can be stored in the browser history. sys:username and sys:password parameters only work when authenticating using QPR Suite or QPR ProcessAnalyzer; credentials for the federated authentication identity provider cannot be used here.
		+
		+	Example url's:
		+	* <nowiki>https://localhost:8080/ui/#/dashboard?sys:dashboard=24026&sys:username=qpr&sys:password=demo</nowiki>
		+	* <nowiki>http://localhost:8080/ui/#/login?sys:username=qpr&sys:password=demo</nowiki>
		+
		+	Note that for path <nowiki>http://localhost:8080/ui/#/home/</nowiki> the login with the sys:password parameter doesn't work.
		+	\|}

	== Variables Usage Example ==		== Variables Usage Example ==

@@ Line 1: / Line 1: @@
-'''Context variables''' in QPR UI are for storing session time information and communicating between different user interface elements, such as views, panels and presentation objects.
+'''Variables''' in QPR UI are for storing session time information and communicating between different user interface elements, such as views, panels and presentation objects.
 __TOC__
-== Context Variable Behaviors ==
+== Variable Behaviors ==
 Variables can be defined for '''views''', '''panels''' and '''presentation objects''' (called '''UI elements''') which form a '''scope''' for the defined variables. Variables are visible and accessible in the scope where they have been defined and also in all '''sub scopes''' in the hierarchy of UI elements. For example, a variable defined in a view scope is visible in all panels and presentation objects in the view. Also a variable defined in a panel is visible in all presentation objects in the panel, but not in presentation objects in other panels. In addition to UI elements (view, panel and presentation object), variables can exist in '''session''' scope. The session scope is visible in all views, i.e. session variables are preserved when opening another view. Thus the visibility hierarchy for variables is (starting from the top):
 * Session
@@ Line 33: / Line 33: @@
 Note that variables in the session scope cannot be defined like the UI element variables, but session scope variables are created when they are set for the first time during a user session.
-When presentation objects set variable values, either the nearest UI element scope variable or the session scope variable can be set. In a [[Data_Grid_Properties#Data_Grid_Click_and_Popup_Menu_Events|data grid actions]] the setting is called '''scope''' with alternatives ''local'' and ''global'', and in [[HTML_Properties#Setting_Context_Variables_in_JavaScript|HTML presentation object functions]], it's done using a parameter named '''presentation object runtime id'''. When setting a UI element variable, always the nearest variable value in the hierarchy is set. For example, when setting a value from a data grid, the data grid presentation object is the nearest scope, the panel is the next and the view scope is after the panel. If there is no variable in any UI element scope defined, the value is set to the session scope.
+When presentation objects set variable values, either the nearest UI element scope variable or the session scope variable can be set. In a [[Data_Grid_Properties#Data_Grid_Click_and_Popup_Menu_Events|data grid actions]] the setting is called '''scope''' with alternatives ''local'' and ''global'', and in [[HTML_Properties#Setting_Variables_in_JavaScript|HTML presentation object functions]], it's done using a parameter named '''presentation object runtime id'''. When setting a UI element variable, always the nearest variable value in the hierarchy is set. For example, when setting a value from a data grid, the data grid presentation object is the nearest scope, the panel is the next and the view scope is after the panel. If there is no variable in any UI element scope defined, the value is set to the session scope.
 When creating bookmarks, currently only the session scope variables are stored to the bookmark.
 == Setting Variable Values in URL ==
-It's possible to set context variable values in the url pointing to QPR UI. To do this, for each variable add "'''&<variable name>=<variable value>'''" in the end of the URL. For example: <nowiki>http(s)://SERVERNAME/ui/#/dashboard?sys:dashboard=24026&myvariable1=myvalue1&myvariable2=myvalue2</nowiki>
+It's possible to set variable values in the url pointing to QPR UI. To do this, for each variable add "'''&<variable name>=<variable value>'''" in the end of the URL. For example: <nowiki>http(s)://SERVERNAME/ui/#/dashboard?sys:dashboard=24026&myvariable1=myvalue1&myvariable2=myvalue2</nowiki>
 Note that when using variables a url, variable values need to be url encoded (more information: https://www.w3schools.com/tags/ref_urlencode.asp).
-== Context Variables Usage Example ==
+== Variables Usage Example ==
-There is a view with one panel, in which there is one presentation object. The '''Session''' context variable values are defined as follows:<br>
+There is a view with one panel, in which there is one presentation object. The '''Session''' variable values are defined as follows:<br>
 {| class="wikitable"
 !'''Variable name'''
@@ Line 55: / Line 55: @@
 |}
-In the '''View Properties''', the following context variable values are defined:<br>
+In the '''View Properties''', the following variable values are defined:<br>
 {| class="wikitable"
 !'''Variable name'''
@@ Line 70: / Line 70: @@
 |}
-In the '''Panel Properties''', the following context variable values are defined:<br>
+In the '''Panel Properties''', the following variable values are defined:<br>
 {| class="wikitable"
 !'''Variable name'''
@@ Line 85: / Line 85: @@
 |}
-In the '''Presentation Object Properties''', the following context variable values are defined:<br>
+In the '''Presentation Object Properties''', the following variable values are defined:<br>
 {| class="wikitable"
 !'''Variable name'''

← Older revision	Revision as of 20:39, 16 May 2019
(No difference)