Label and Link - Revision history

Ollvihe: /* Run script action */

2026-07-30T09:04:14Z

Run script action

← Older revision		Revision as of 09:04, 30 July 2026
Line 60:		Line 60:
	* '''chartSettings''': Dictionary containing the dashboard component configuration.		* '''chartSettings''': Dictionary containing the dashboard component configuration.

	Example ~~of a run script~~ action:		Example action:
	<syntaxhighlight lang="json" line>		<syntaxhighlight lang="json" line>
	[		[

Ollvihe: /* Set variables action */

2026-07-30T09:04:04Z

Set variables action

← Older revision		Revision as of 09:04, 30 July 2026
Line 35:		Line 35:
	In the stringfied valued parameters it's possible to refer to the dashboard variables using tags (format '''<#variableName>''').		In the stringfied valued parameters it's possible to refer to the dashboard variables using tags (format '''<#variableName>''').

	Example ~~of a set variables~~ action:		Example action:
	<syntaxhighlight lang="json" line>		<syntaxhighlight lang="json" line>
	[		[

Ollvihe: /* Set variables action */

2026-07-30T09:03:33Z

Set variables action

← Older revision		Revision as of 09:03, 30 July 2026
Line 32:		Line 32:

	Note that any string value is assumed to be in the [[Stringified_Value_Format\|stringfied value format]].		Note that any string value is assumed to be in the [[Stringified_Value_Format\|stringfied value format]].

			In the stringfied valued parameters it's possible to refer to the dashboard variables using tags (format '''<#variableName>''').

	Example of a set variables action:		Example of a set variables action:
Line 42:		Line 44:
	"sys:dashboardIdentifier": "0target1",		"sys:dashboardIdentifier": "0target1",
	"filter": "",		"filter": "",
	"~~arrayVariable~~": ["0a", "0b", "0c"],		"arrayParameter": ["0a", "0b", "0c"],
	"~~booleanVariable~~": true		"booleanParameter": true,
			"parameterFromVariable": "0<#variableName>"
	}		}
	}		}

Ollvihe: /* Run script action */

2026-07-30T08:39:59Z

Run script action

← Older revision		Revision as of 08:39, 30 July 2026
Line 53:		Line 53:

	The parameters are passed to the script and are available as following script variables:		The parameters are passed to the script and are available as following script variables:
	* '''variables''': Dictionary of all dashboard variables ~~with~~ values when the action was started.		* '''variables''': Dictionary of all dashboard variables and values when the action was started.
	* '''action''': Dictionary containing settings of the clicked action. This is used to access the action parameters.		* '''action''': Dictionary containing settings of the clicked action. This is used to access the action parameters.
	* '''chartSettings''': Dictionary containing the dashboard component configuration.		* '''chartSettings''': Dictionary containing the dashboard component configuration.
Line 64:		Line 64:
	"scriptName": "My action",		"scriptName": "My action",
	"parameters": {		"parameters": {
	"parameter1": "~~value1~~",		"parameter1": "0value1",
	"parameter2": 5		"parameter2": 5
	}		}

Ollvihe: /* Dashboard component actions */

2026-07-30T08:36:22Z

Dashboard component actions

← Older revision		Revision as of 08:36, 30 July 2026
Line 23:		Line 23:

	== Dashboard component actions ==		== Dashboard component actions ==
	~~It is possible to have~~ the Label and Link component ~~either~~ set [[Dashboard_Variables\|variable]] values or to run a script ~~and have the~~ script ~~show the~~ return value as a popup dialog or set dashboard variables. The ~~configuration~~ is ~~done~~ as JSON. When an action is configured, the action can be run by clicking the Label and Link component in the Preview mode~~. Only a single action can be configured~~.		Clicking the Label and Link component can set [[Dashboard_Variables\|variable]] values or run a script. The script run return value is shown as a popup dialog or the return value can set dashboard variables. The action is configured as JSON, and only a single action can be configured. When an action is configured, the action can be run by clicking the Label and Link component in the Preview mode.

	=== Set variables action ===		=== Set variables action ===
	When the action type is '''SetVariable''', the defined dashboard variable values are set. This action type supports the '''parameters''' field which is a JSON object that defines the variables to be set. If the sys:dashboard or sys:dashboardIdentifier is among the variables, the variables are set in the session context, and otherwise in the dashboard context.		When the action type is '''SetVariable''', the defined dashboard variable values are set. This action type supports the '''parameters''' field which is a JSON object that defines the variables to be set. If the sys:dashboard or sys:dashboardIdentifier is among the variables, the variables are set in the session context, and otherwise in the dashboard context. Parameters can be defined as follows:
			* [[Stringified_Value_Format\|Stringfied value format]]
			* Array of items where each item is in the [[Stringified_Value_Format\|stringfied value format]]
			* JSON object, number, boolean, null, or empty string.

			Note that any string value is assumed to be in the [[Stringified_Value_Format\|stringfied value format]].

	Example of a set variables action:		Example of a set variables action:
Line 34:		Line 39:
	"type": "SetVariables",		"type": "SetVariables",
	"parameters": {		"parameters": {
	"ModelId": "1",		"ModelId": 1,
	"sys:dashboardIdentifier": "~~target1~~"		"sys:dashboardIdentifier": "0target1",
			"filter": "",
			"arrayVariable": ["0a", "0b", "0c"],
			"booleanVariable": true
	}		}
	}		}

Ollvihe: /* Clickable link */

2025-08-16T19:22:34Z

Clickable link

← Older revision		Revision as of 19:22, 16 August 2025
Line 20:		Line 20:

	== Clickable link ==		== Clickable link ==
	'''Link target''' field in the ~~Link & Label~~ settings defines a link to another dashboard (defined as the target [[Dashboard_Variables#System_Variables\|dashboard identifier]]) or to an external web page. The external link is identified as a external web link if it's starting with ''http://'' or ''https://''. The target dashboard opens to the same browser tab and the external web page opens to a new tab.		'''Link target''' field in the settings defines a link to another dashboard (defined as the target [[Dashboard_Variables#System_Variables\|dashboard identifier]]) or to an external web page. The external link is identified as a external web link if it's starting with ''http://'' or ''https://''. The target dashboard opens to the same browser tab and the external web page opens to a new tab.

	== Dashboard component actions ==		== Dashboard component actions ==

Ollvihe: /* Link */

2025-08-16T19:22:07Z

Link

← Older revision		Revision as of 19:22, 16 August 2025
Line 19:		Line 19:
	* '''Border corner radius''': Rounding of the border corners.		* '''Border corner radius''': Rounding of the border corners.

	== ~~Link~~ ==		== Clickable link ==
	'''Link target''' defines a link to ~~other~~ dashboard (defined as the target dashboard identifier) or to an external web page. The link is identified as a external web link if it's starting with ''http://'' or ''https://''.		'''Link target''' field in the Link & Label settings defines a link to another dashboard (defined as the target [[Dashboard_Variables#System_Variables\|dashboard identifier]]) or to an external web page. The external link is identified as a external web link if it's starting with ''http://'' or ''https://''. The target dashboard opens to the same browser tab and the external web page opens to a new tab.

	== Dashboard component actions ==		== Dashboard component actions ==

Ollvihe: /* Set variables action */

2025-08-16T19:20:13Z

Set variables action

← Older revision		Revision as of 19:20, 16 August 2025
Line 28:		Line 28:
	When the action type is '''SetVariable''', the defined dashboard variable values are set. This action type supports the '''parameters''' field which is a JSON object that defines the variables to be set. If the sys:dashboard or sys:dashboardIdentifier is among the variables, the variables are set in the session context, and otherwise in the dashboard context.		When the action type is '''SetVariable''', the defined dashboard variable values are set. This action type supports the '''parameters''' field which is a JSON object that defines the variables to be set. If the sys:dashboard or sys:dashboardIdentifier is among the variables, the variables are set in the session context, and otherwise in the dashboard context.

	Example of a ~~SetVariable~~ action:		Example of a set variables action:
	<syntaxhighlight lang="json" line>		<syntaxhighlight lang="json" line>
	[		[

Ollvihe: /* Run script action */

2025-08-16T19:20:04Z

Run script action

← Older revision		Revision as of 19:20, 16 August 2025
Line 42:		Line 42:

	=== Run script action ===		=== Run script action ===
	When the action type is '''RunScript''', the defined script is run and its return value is shown as a popup dialog or ~~sets~~ dashboard ~~variables~~. If the script returns a json object, the variable-value pairs in the json object are set as dashboard variables. If the script returns other value than a json object (such as a string), the return value is shown as a popup message. The same action parameters are supported as in the [[Actions_to_Run_Script_in_Table#Action_settings\|actions to run a script in a table]].		When the action type is '''RunScript''', the defined script is run and its return value is shown as a popup dialog or dashboard variable values are set based on the result. If the script returns a json object, the variable-value pairs in the json object are set as dashboard variables. If the script returns other value than a json object (such as a string), the return value is shown as a popup message. The same action parameters are supported as in the [[Actions_to_Run_Script_in_Table#Action_settings\|actions to run a script in a table]]. See also the [[Actions_to_Run_Script_in_Table#Example_scripts\|example scripts]].

	The parameters are passed to the script and are available as variables ~~in the script~~:		The parameters are passed to the script and are available as following script variables:
	* '''variables''': ~~A dictionary~~ of dashboard variables.		* '''variables''': Dictionary of all dashboard variables with values when the action was started.
	* '''action''': ~~A dictionary~~ containing settings of the clicked action. This is used to access the action parameters.		* '''action''': Dictionary containing settings of the clicked action. This is used to access the action parameters.
	* '''chartSettings''': ~~A dictionary~~ containing the dashboard component ~~settings~~.		* '''chartSettings''': Dictionary containing the dashboard component configuration.

	Example of a ~~RunScript~~ action:		Example of a run script action:
	<syntaxhighlight lang="json" line>		<syntaxhighlight lang="json" line>
	[		[

Ollvihe: /* Dashboard component actions */

2025-08-16T19:01:41Z

Dashboard component actions

← Older revision		Revision as of 19:01, 16 August 2025
Line 23:		Line 23:

	== Dashboard component actions ==		== Dashboard component actions ==
	It is possible to have the Label and Link component either set [[Dashboard_Variables\|variable]] values or to run a script and have the script show the return value as a popup dialog or set dashboard variables. The configuration is done as JSON. When an action is configured, the action can be run by clicking the Label and Link component in the Preview mode. Only a single action can be configured. ~~The~~ action ~~types are:~~		It is possible to have the Label and Link component either set [[Dashboard_Variables\|variable]] values or to run a script and have the script show the return value as a popup dialog or set dashboard variables. The configuration is done as JSON. When an action is configured, the action can be run by clicking the Label and Link component in the Preview mode. Only a single action can be configured.
	* '''SetVariable'''~~: Sets~~ the defined dashboard variable values. This action type supports the ~~following field:~~
	** '''parameters'''~~: A~~ JSON object that defines the variables to be set. If the sys:dashboard or sys:dashboardIdentifier is among the variables, the variables are set in the session context, and otherwise in the dashboard context.		=== Set variables action ===
	:: Example of a SetVariable action:		When the action type is '''SetVariable''', the defined dashboard variable values are set. This action type supports the '''parameters''' field which is a JSON object that defines the variables to be set. If the sys:dashboard or sys:dashboardIdentifier is among the variables, the variables are set in the session context, and otherwise in the dashboard context.
	:: <syntaxhighlight lang="json" line>
			Example of a SetVariable action:
			<syntaxhighlight lang="json" line>
	[		[
	{		{
Line 36:		Line 38:
	}		}
	}		}
	]</syntaxhighlight>		]
	* '''RunScript'''~~: Runs~~ the defined script and ~~shows~~ return value as popup dialog or sets dashboard variables. If the script returns a json object, the ~~key~~-value pairs in the json object are set as dashboard variables. If the script returns other value than a json object, the return value is shown as a popup message. The same action parameters are supported as in the [[Actions_to_Run_Script_in_Table#Action_settings\|actions to run a script in a table]]. The parameters are passed to the script and are available as variables in the script:		</syntaxhighlight>
	** '''variables''': A dictionary of dashboard variables.
	** '''action''': A dictionary containing settings of the clicked action. This is used to access the action parameters.		=== Run script action ===
	** '''chartSettings''': A dictionary containing the dashboard component settings.		When the action type is '''RunScript''', the defined script is run and its return value is shown as a popup dialog or sets dashboard variables. If the script returns a json object, the variable-value pairs in the json object are set as dashboard variables. If the script returns other value than a json object (such as a string), the return value is shown as a popup message. The same action parameters are supported as in the [[Actions_to_Run_Script_in_Table#Action_settings\|actions to run a script in a table]].
	:: Example of a RunScript action:
	:: <syntaxhighlight lang="json" line>		The parameters are passed to the script and are available as variables in the script:
			* '''variables''': A dictionary of dashboard variables.
			* '''action''': A dictionary containing settings of the clicked action. This is used to access the action parameters.
			* '''chartSettings''': A dictionary containing the dashboard component settings.

			Example of a RunScript action:
			<syntaxhighlight lang="json" line>
	[		[
	{		{
Line 52:		Line 60:
	}		}
	}		}
	]</syntaxhighlight>		]
			</syntaxhighlight>