Dashboard Variables - Revision history

Ollvihe: /* System Variables */

2025-08-27T18:02:35Z

System Variables

← Older revision		Revision as of 18:02, 27 August 2025
Line 84:		Line 84:

	== System Variables ==		== System Variables ==
	QPR ProcessAnalyzer ~~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~~.		QPR ProcessAnalyzer supports '''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 with the same prefix to avoid misinterpretation.

	When ~~using~~ variables in the QPR ProcessAnalyzer url, variable values need to be url encoded (more information: https://www.w3schools.com/tags/ref_urlencode.asp).		When defining variables to the QPR ProcessAnalyzer url, variable values need to be url encoded (more information: https://www.w3schools.com/tags/ref_urlencode.asp).

	{\| class="wikitable"		{\| class="wikitable"
Line 96:		Line 96:
	\|-		\|-
	\|\|sys:dashboardIdentifier		\|\|sys:dashboardIdentifier
	\|\|Use this variable when you want to open a dashboard by a path ~~defined by~~ the ~~textual identifiers~~. The path can be defined as:		\|\|Use this variable when you want to open a dashboard by a path (consisting of a project name(s) and the dashboard identifier). The path can be defined as:
	* '''Absolute path''' where the path starts from the projects hierarchy root. The absolute path always points to the dashboard defined by the path. Example: ''/Project/~~Sub~~ project/DashboardIdentifier''.		* '''Absolute path''' where the path starts from the projects hierarchy root. The absolute path always points to the dashboard defined by the path. Example: ''/Project/Child project/DashboardIdentifier''.
	* '''Relative path''' where the path starts from the project where the currently opened dashboard is located. Relative paths can be used to link between dashboards within a project branch and the links remain, even if the branch is moved to other project. Example: ''Project/~~Sub~~ project/Dashboardidentifier''.		* '''Relative path''' where the path starts from the project where the currently opened dashboard is located. Relative paths can be used to link between dashboards within a project branch and the links remain, even if the branch is moved to other project. Example: ''Project/Child project/Dashboardidentifier''.

	Absolute paths always starts with the slash ('''/'''), whereas relative paths don't start with slash.		Absolute paths always starts with the slash ('''/'''), whereas relative paths don't start with a slash.

	sys:dashboardIdentifier variable can only be used in the session variables. Setting the sys:dashboardIdentifier variable value will automatically set the corresponding value to sys:dashboard variable. sys:dashboardIdentifier will be removed automatically after. When both sys:dashboard and sys:dashboardIdentifier are defined, sys:dashboardIdentifier has the priority.		sys:dashboardIdentifier variable can only be used in the session variables. Setting the sys:dashboardIdentifier variable value will automatically set the corresponding value to sys:dashboard variable. sys:dashboardIdentifier will be removed automatically after. When both sys:dashboard and sys:dashboardIdentifier are defined, sys:dashboardIdentifier has the priority.

Ollvihe: /* Dashboard Variables */

2024-01-12T11:38:24Z

Dashboard Variables

← Older revision		Revision as of 11:38, 12 January 2024
Line 4:		Line 4:

	== Dashboard Variables ==		== Dashboard Variables ==
	Dashboard variables can be defined for ~~each dashboard~~. ~~It's done~~ by opening a dashboard, clicking the dots menu on top right, clicking '''Dashboard Properties''' and opening tab '''Variables'''.		Dashboard variables can be defined for dashboards, and the variables in the below table have a special meaning. Variables can be set by opening a dashboard, clicking the dots menu on top right, clicking '''Dashboard Properties''' and opening tab '''Variables'''.
	{\| class="wikitable"		{\| class="wikitable"
	!'''Variable name'''		!'''Variable name'''
Line 10:		Line 10:
	\|-		\|-
	\|\|SortOrder		\|\|SortOrder
	\|\|Defines ~~a custom~~ order ~~as a number~~ in which dashboards are shown in the navigation menu. By default, dashboards are shown in the alphabetical order by name. Dashboards with a custom order defined (sort by the order number) are shown before dashboards without custom order (sort by dashboard name).		\|\|Defines an order in which dashboards are shown in the [[Navigation_Menu\|navigation menu]]. The variable value needs to be defined as a number. By default, dashboards are shown in the alphabetical order by name. Dashboards with a custom order defined (sort ascending by the order number) are shown before dashboards without the custom order (and they sort by dashboard name).
	\|-		\|-
	\|\|HiddenInNavigation		\|\|HiddenInNavigation
	\|\|Dashboards can be hidden from the navigation menu by defining this variable value to ''true''. ~~Note that a~~ hidden dashboard is still shown in the navigation menu when the dashboard is currently open. For example, ~~drilldown~~ dashboards, which ~~users don't open directly (instead through another dashboard)~~, can be hidden in the navigation menu.		\|\|Dashboards can be hidden from the navigation menu by defining this variable value to ''true''. A hidden dashboard is still shown in the navigation menu when the dashboard is currently open. For example, details dashboards, which are only opened from other dashboards, can be hidden in the navigation menu.
	\|-		\|-
	\|\|DashboardFilter		\|\|DashboardFilter

Ollvihe: /* Dashboard Variable Behaviors */

2023-02-27T15:21:19Z

Dashboard Variable Behaviors

← Older revision		Revision as of 15:21, 27 February 2023
Line 51:		Line 51:

	== Dashboard Variable Behaviors ==		== Dashboard Variable Behaviors ==
	Variables can exist in '''user session''' and '''dashboard ~~level~~'''. The dashboard variables are available within that dashboard only. The user session variables can be used to pass information between dashboards, because depending on the dashboard variable behavior, the dashboard variables may get initial values from the session variables. Note also that if there is no dashboard variable with the same name, the session variable is visible for the dashboard.		Variables can exist in '''user session''' and '''dashboard'''. The dashboard variables are available within that dashboard only, and they are defined in the ''Dashboard Properties''. The user session variables (shown in the '''Session Variables''') can be used to pass information between dashboards, because depending on the dashboard variable behavior, the dashboard variables may get initial values from the session variables. Note also that if there is no dashboard variable with the same name, the session variable is visible for the dashboard.

	Dashboard variables have a '''behavior''' which determine how the variables work when set and get their values. The following behaviors are available:		Dashboard variables have a '''behavior''' which determine how the variables work when set and get their values. The following behaviors are available:

Ollvihe: /* Set Variables in URL */

2023-02-27T15:20:21Z

Set Variables in URL

← Older revision		Revision as of 15:20, 27 February 2023
Line 81:		Line 81:
	To handle special characters, the variable values in the url need to be url encoded (more information: https://www.w3schools.com/tags/ref_urlencode.asp).		To handle special characters, the variable values in the url need to be url encoded (more information: https://www.w3schools.com/tags/ref_urlencode.asp).

	~~The variables~~ will go to the session ~~context~~. If the variables need to be available in the dashboard, the variable behavior ''Optional parameter'' or ''Default value'' needs to be used. If the dashboard variable behavior is ''Local'' or ''Stored'', the variable doesn't have any interaction with the user session variables. No also that if there is no variable defined in the dashboard, the session variable is applied in the dashboard level.		Variables set in the URL will go to the user session ('''Session variable''' in the dots menu). If the variables need to be available in the dashboard, the variable behavior ''Optional parameter'' or ''Default value'' needs to be used. If the dashboard variable behavior is ''Local'' or ''Stored'', the variable doesn't have any interaction with the user session variables. No also that if there is no variable defined in the dashboard, the session variable is applied in the dashboard level.

	== System Variables ==		== System Variables ==

Ollvihe: /* Set Variables in URL */

2023-02-27T15:19:22Z

Set Variables in URL

← Older revision		Revision as of 15:19, 27 February 2023
Line 81:		Line 81:
	To handle special characters, the variable values in the url need to be url encoded (more information: https://www.w3schools.com/tags/ref_urlencode.asp).		To handle special characters, the variable values in the url need to be url encoded (more information: https://www.w3schools.com/tags/ref_urlencode.asp).

	The variables will go to the session context. If the variables need to go the dashboard, the variable behavior ~~needs to be~~ Optional parameter or Default value. If variable behavior		The variables will go to the session context. If the variables need to be available in the dashboard, the variable behavior ''Optional parameter'' or ''Default value'' needs to be used. If the dashboard variable behavior is ''Local'' or ''Stored'', the variable doesn't have any interaction with the user session variables. No also that if there is no variable defined in the dashboard, the session variable is applied in the dashboard level.

	== System Variables ==		== System Variables ==

Ollvihe: /* Dashboard Variable Behaviors */

2023-02-27T15:17:28Z

Dashboard Variable Behaviors

← Older revision		Revision as of 15:17, 27 February 2023
Line 51:		Line 51:

	== Dashboard Variable Behaviors ==		== Dashboard Variable Behaviors ==
	Variables can exist in '''user session ~~and~~''' '''dashboard level'''. The dashboard variables are available within that dashboard only. The user session variables can be used to pass information between dashboards, because depending on the dashboard variable behavior, the dashboard variables may get initial values from the session variables. Note also that if there is no dashboard variable with the same name, the session variable is visible for the dashboard.		Variables can exist in '''user session''' and '''dashboard level'''. The dashboard variables are available within that dashboard only. The user session variables can be used to pass information between dashboards, because depending on the dashboard variable behavior, the dashboard variables may get initial values from the session variables. Note also that if there is no dashboard variable with the same name, the session variable is visible for the dashboard.

	Dashboard variables have a '''behavior''' which determine how the variables work when set and get their values. The following behaviors are available:		Dashboard variables have a '''behavior''' which determine how the variables work when set and get their values. The following behaviors are available:

Ollvihe: /* Dashboard Variable Behaviors */

2023-02-27T15:17:01Z

Dashboard Variable Behaviors

← Older revision		Revision as of 15:17, 27 February 2023
Line 60:		Line 60:
	\|-		\|-
	\|\|Local variable		\|\|Local variable
	\|\|Local variables are visible in the ~~scope where the variable is defined~~. ~~When initialized, the~~ local ~~variable gets a value that~~ is ~~in its definition (~~in the Variables tab). When a local variable value is changed, its new value only ~~lives~~ as long as the dashboard is open.		\|\|Local variables are visible only in the dashboard. The initial value of local variables is defined in the ''Variables'' tab. When a local variable value is changed, its new value only exists as long as the dashboard is open.
	\|-		\|-
	\|\|Stored variable		\|\|Stored variable
	\|\|Stored variables work like Local variables, except that when the dashboard is saved, the current value of the Stored variable is saved to the dashboard ~~at the level where the Stored variable is defined~~.		\|\|Stored variables work like Local variables, except that when the dashboard is saved, the current value of the Stored variable is saved to the dashboard.
	\|-		\|-
	\|\|Optional parameter		\|\|Optional parameter
	\|\|Optional parameters work like the local variables, except that the optional parameters get their initial ~~values from the upper scope when the variables are initialized. For example, optional parameters in dashboard scope get their values~~ from the session when a dashboard is opened. If a variable ~~having~~ the same name doesn't exist in ~~any of~~ the ~~upper scope~~, the optional parameter will have the value that is set in its definition (in the Variables tab)~~. After the optional parameter value is initialized, any changes in the upper scope variables don't affect the optional parameter value~~.		\|\|Optional parameters work like the local variables, except that the optional parameters get their initial value from the user session when dashboard is opened. If a variable with the same name doesn't exist in the user session, the optional parameter will have the value that is set in its definition (in the Variables tab).
	\|-		\|-
	\|\|Default value		\|\|Default value
	\|\|Unlike local variables and optional parameters, Default value variables are not independent variables but they are just default values for non-existing variables. Thus, if a variable with the same name exists in the ~~upper scope~~, the ~~defined default~~ value ~~variable~~ doesn't have any effect. Only if no ~~upper scope~~ variable exists, the value defined for the ~~default~~ value variable (in the Variables tab) is ~~used in the default value variables' scope when referring to~~ a ~~variable with that name. Default value variable values cannot be set by presentation objects, so when trying to set an default value~~ variable value, the value is set to the session ~~scope variable~~.		\|\|Unlike local variables and optional parameters, Default value variables are not independent variables but they are just default values for non-existing variables. Thus, if a variable with the same name exists in the user session, the variable with Default value behavior doesn't have any effect. Only if no user session variable exists, the value defined for the Default value variable (in the Variables tab) is applied. When setting a variable value, the value is set to the user session.
	\|}		\|}

Ollvihe: /* Defining Variables in URL */

2023-02-27T15:11:35Z

Defining Variables in URL

← Older revision		Revision as of 15:11, 27 February 2023
Line 50:		Line 50:
	\|}		\|}

	== Variable Behaviors ==		== Dashboard Variable Behaviors ==
	Variables can ~~be defined for~~ '''user session~~''', '''dashboards'''~~ and '''~~presentation objects~~''' ~~which form a~~ ''~~scope~~'~~' for the~~ variables~~. Variables~~ are ~~visible and accessible in the scope where they have been defined~~. The user session ~~scope~~ can be used to pass information between dashboards.		Variables can exist in '''user session and''' '''dashboard level'''. The dashboard variables are available within that dashboard only. The user session variables can be used to pass information between dashboards, because depending on the dashboard variable behavior, the dashboard variables may get initial values from the session variables. Note also that if there is no dashboard variable with the same name, the session variable is visible for the dashboard.

	~~Each defined variable~~ have a '''behavior''' which determine how the variables work when ~~setting~~ and ~~getting~~ their values. The following behaviors are available:		Dashboard variables have a '''behavior''' which determine how the variables work when set and get their values. The following behaviors are available:

	{\| class="wikitable"		{\| class="wikitable"
Line 74:		Line 74:
	Variables in the session cannot be defined like the dashboard variables, because session variables are created when they are set for the first time during a user session.		Variables in the session cannot be defined like the dashboard variables, because session variables are created when they are set for the first time during a user session.

	== ~~Defining~~ Variables in URL ==		== Set Variables in URL ==
	It's possible to ~~define~~ variables in the url when opening QPR ProcessAnalyzer. ~~To do this, for~~ each variable add "'''&<variable name>=<variable value>'''" in the end of the URL. For example:		It's possible to set variables in the url when opening QPR ProcessAnalyzer. For each variable add "'''&<variable name>=<variable value>'''" in the end of the URL. For example:
	<pre>		<pre>
	https://SERVERNAME/ui/#/dashboard?sys:dashboard=1234&myvariable1=myvalue1&myvariable2=myvalue2		https://SERVERNAME/ui/#/dashboard?sys:dashboard=1234&myvariable1=myvalue1&myvariable2=myvalue2
	</pre>		</pre>
	~~Note that when using variables a url~~, variable values need to be url encoded (more information: https://www.w3schools.com/tags/ref_urlencode.asp).		To handle special characters, the variable values in the url need to be url encoded (more information: https://www.w3schools.com/tags/ref_urlencode.asp).

			The variables will go to the session context. If the variables need to go the dashboard, the variable behavior needs to be Optional parameter or Default value. If variable behavior

	== System Variables ==		== System Variables ==

Ollvihe at 15:02, 27 February 2023

2023-02-27T15:02:02Z

@@ Line 49: / Line 49: @@
 ||BPMN model stored to the dashboard.
 |}
 == System Variables ==
@@ Line 86: / Line 117: @@
 ||Use this parameter to provide password to login automatically to QPR ProcessAnalyzer 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. Note however, that the username and password can be stored in the browser history. Note also, that passing a password in a url is a considerable security risk. When using this method, it's very important to use encrypted (https) connection. See url examples in the description of the sys:username parameter.
 |}
 [[Category: QPR ProcessAnalyzer]]

Ollvihe: /* Dashboard Variables */

2022-08-28T20:18:59Z

Dashboard Variables

← Older revision		Revision as of 20:18, 28 August 2022
Line 28:		Line 28:
	\|-		\|-
	\|\|FilterId		\|\|FilterId
	\|\|Id of the selected filter id. When empty, the selected filter rules don't belong to any saved filter, When -1, there are no filter rules selected (i.e., ''All cases'' is selected).		\|\|Id of the selected saved filter. When empty, the selected filter rules don't belong to any saved filter, When -1, there are no filter rules selected (i.e., ''All cases'' is selected).
	\|-		\|-
	\|\|ModelId		\|\|ModelId

← Older revision		Revision as of 15:17, 27 February 2023
Line 60:		Line 60:
	\|-		\|-
	\|\|Local variable		\|\|Local variable
	\|\|Local variables are visible in the ~~scope where the variable is defined~~. ~~When initialized, the~~ local ~~variable gets a value that~~ is ~~in its definition (~~in the Variables tab). When a local variable value is changed, its new value only ~~lives~~ as long as the dashboard is open.		\|\|Local variables are visible only in the dashboard. The initial value of local variables is defined in the ''Variables'' tab. When a local variable value is changed, its new value only exists as long as the dashboard is open.
	\|-		\|-
	\|\|Stored variable		\|\|Stored variable
	\|\|Stored variables work like Local variables, except that when the dashboard is saved, the current value of the Stored variable is saved to the dashboard ~~at the level where the Stored variable is defined~~.		\|\|Stored variables work like Local variables, except that when the dashboard is saved, the current value of the Stored variable is saved to the dashboard.
	\|-		\|-
	\|\|Optional parameter		\|\|Optional parameter
	\|\|Optional parameters work like the local variables, except that the optional parameters get their initial ~~values from the upper scope when the variables are initialized. For example, optional parameters in dashboard scope get their values~~ from the session when a dashboard is opened. If a variable ~~having~~ the same name doesn't exist in ~~any of~~ the ~~upper scope~~, the optional parameter will have the value that is set in its definition (in the Variables tab)~~. After the optional parameter value is initialized, any changes in the upper scope variables don't affect the optional parameter value~~.		\|\|Optional parameters work like the local variables, except that the optional parameters get their initial value from the user session when dashboard is opened. If a variable with the same name doesn't exist in the user session, the optional parameter will have the value that is set in its definition (in the Variables tab).
	\|-		\|-
	\|\|Default value		\|\|Default value
	\|\|Unlike local variables and optional parameters, Default value variables are not independent variables but they are just default values for non-existing variables. Thus, if a variable with the same name exists in the ~~upper scope~~, the ~~defined default~~ value ~~variable~~ doesn't have any effect. Only if no ~~upper scope~~ variable exists, the value defined for the ~~default~~ value variable (in the Variables tab) is ~~used in the default value variables' scope when referring to~~ a ~~variable with that name. Default value variable values cannot be set by presentation objects, so when trying to set an default value~~ variable value, the value is set to the session ~~scope variable~~.		\|\|Unlike local variables and optional parameters, Default value variables are not independent variables but they are just default values for non-existing variables. Thus, if a variable with the same name exists in the user session, the variable with Default value behavior doesn't have any effect. Only if no user session variable exists, the value defined for the Default value variable (in the Variables tab) is applied. When setting a variable value, the value is set to the user session.
	\|}		\|}