Managing Scripts - Revision history

TeeHiet: TK-64041

2026-04-27T11:07:58Z

TK-64041

← Older revision		Revision as of 11:07, 27 April 2026
Line 42:		Line 42:
	* '''Created''': Date and time when the script was created.		* '''Created''': Date and time when the script was created.
	* '''Created by''': User who created the script.		* '''Created by''': User who created the script.

			The script Properties has the following information on the '''Input'' tab:
			* '''JSON schema for input parameters''': A text box for defining the [[QPR_ProcessAnalyzer_as_MCP_Server#Defining_Input_Parameters\|input parameters]].

			The script Properties has the following information on the '''Output'' tab:
			* '''JSON schema for script output''': A text box for defining the [[QPR_ProcessAnalyzer_as_MCP_Server#Defining_Structured_Tool_Output\|output parameters]].

	The Script Properties has the following information on the '''MCP''' tab:		The Script Properties has the following information on the '''MCP''' tab:
	* '''MCP tool''': A checkbox to select whether the script can be used as an [[QPR_ProcessAnalyzer_as_MCP_Server\|MCP]] tool. Only System Administrators can modify this setting. Note that once a script has been defined as an MCP tool, only System Administrators are able to modify the script itself.		* '''MCP tool''': A checkbox to select whether the script can be used as an [[QPR_ProcessAnalyzer_as_MCP_Server\|MCP]] tool. Only System Administrators can modify this setting. Note that once a script has been defined as an MCP tool, only System Administrators are able to modify the script itself.
			* '''JSON for MCP tool configuration''': A text box for defining the [[QPR_ProcessAnalyzer_as_MCP_Server#MCP_Tool_Configuration\|MCP tool configuration]].

	The Script Properties has the following information on the '''Description''' tab:		The Script Properties has the following information on the '''Description''' tab:

TeeHiet: TK-63184

2026-04-09T18:51:02Z

TK-63184

← Older revision		Revision as of 18:51, 9 April 2026
Line 54:		Line 54:
	# Open the '''Scripts''' tab.		# Open the '''Scripts''' tab.
	# Select the script and in the right-click context menu select '''Edit'''. Alternatively, you can hover the script and click the ''Edit'' button in the end of the row.		# Select the script and in the right-click context menu select '''Edit'''. Alternatively, you can hover the script and click the ''Edit'' button in the end of the row.

			If the script has been defined as an MCP tool, only System Administrators are able to edit the script.

	The script editor can show multiple scripts in the tabs, allowing to easily switch between the scrips. The editor remembers all scripts that have been opened during the session.		The script editor can show multiple scripts in the tabs, allowing to easily switch between the scrips. The editor remembers all scripts that have been opened during the session.

TeeHiet: TK-63184

2026-04-09T18:50:06Z

TK-63184

← Older revision		Revision as of 18:50, 9 April 2026
Line 44:		Line 44:

	The Script Properties has the following information on the '''MCP''' tab:		The Script Properties has the following information on the '''MCP''' tab:
	* '''MCP tool''': A checkbox to select whether the script can be used as an [[QPR_ProcessAnalyzer_as_MCP_Server\|MCP]] tool.		* '''MCP tool''': A checkbox to select whether the script can be used as an [[QPR_ProcessAnalyzer_as_MCP_Server\|MCP]] tool. Only System Administrators can modify this setting. Note that once a script has been defined as an MCP tool, only System Administrators are able to modify the script itself.

	The Script Properties has the following information on the '''Description''' tab:		The Script Properties has the following information on the '''Description''' tab:

TeeHiet: TK-63184

2026-04-09T11:49:51Z

TK-63184

← Older revision		Revision as of 11:49, 9 April 2026
Line 30:		Line 30:
	=== Script Properties ===		=== Script Properties ===
	To open Script Properties, '''right-click''' the script on the Scripts tab in the Workspace and select '''Properties'''.<br>		To open Script Properties, '''right-click''' the script on the Scripts tab in the Workspace and select '''Properties'''.<br>
	The Script Properties lists the following information on the '''General'' tab:		The Script Properties lists the following information on the '''General''' tab:
	* '''Script ID''': A unique ID in the system.		* '''Script ID''': A unique ID in the system.
	* '''Language''': The script's language, either "SQL" or "Expression".		* '''Language''': The script's language, either "SQL" or "Expression".
Line 43:		Line 43:
	* '''Created by''': User who created the script.		* '''Created by''': User who created the script.

	The Script Properties has the following information on the '''MCP'' tab:		The Script Properties has the following information on the '''MCP''' tab:
	* '''MCP tool''': A checkbox to select whether the script can be used as an [[QPR_ProcessAnalyzer_as_MCP_Server\|MCP]] tool.		* '''MCP tool''': A checkbox to select whether the script can be used as an [[QPR_ProcessAnalyzer_as_MCP_Server\|MCP]] tool.

	The Script Properties has the following information on the '''Description'' tab:		The Script Properties has the following information on the '''Description''' tab:
	* A textbox to edit the description of the script.		* A textbox to edit the description of the script.

TeeHiet: TK-63184

2026-04-09T11:49:29Z

TK-63184

@@ Line 29: / Line 29: @@
 === Script Properties ===
-WIP
+To open Script Properties, '''right-click''' the script on the Scripts tab in the Workspace and select '''Properties'''.<br>
 === Editing Script ===

TeeHiet: TK-63184

2026-04-09T09:55:38Z

TK-63184

← Older revision		Revision as of 09:55, 9 April 2026
Line 27:		Line 27:
	* '''Failed''': The last run ended to an error or exception. To see more information about the reason of the failure, see the [[#Viewing_Script_Log\|last run log]].		* '''Failed''': The last run ended to an error or exception. To see more information about the reason of the failure, see the [[#Viewing_Script_Log\|last run log]].
	* '''Aborted''': The last run was stopped by a user, so the script did not run till the end.		* '''Aborted''': The last run was stopped by a user, so the script did not run till the end.

			=== Script Properties ===
			WIP

	=== Editing Script ===		=== Editing Script ===

Ollvihe: /* Creating Script */

2025-06-06T11:51:04Z

Creating Script

← Older revision		Revision as of 11:51, 6 June 2025
Line 75:		Line 75:

	Note that the scripting language cannot be changed after the script has been created, so a new script needs to be created to change the language.		Note that the scripting language cannot be changed after the script has been created, so a new script needs to be created to change the language.

			Note that each script in the same project needs to have a unique name.

	=== Deleting Script ===		=== Deleting Script ===

Ollvihe: /* Running Script */

2024-03-28T15:12:35Z

Running Script

← Older revision		Revision as of 15:12, 28 March 2024
Line 44:		Line 44:
	* To close a script, click the ''Close'' button for the tab showing the script. If there are unsaved changes, you need to either save or cancel changes.		* To close a script, click the ''Close'' button for the tab showing the script. If there are unsaved changes, you need to either save or cancel changes.

	=== ~~Running~~ Script ===		=== Starting Script ===
	# On the left side projects hierarchy, select the project where the script is located.		# On the left side projects hierarchy, select the project where the script is located.
	# Open the '''Scripts''' tab.		# Open the '''Scripts''' tab.

Ollvihe at 13:42, 31 August 2023

2023-08-31T13:42:32Z

← Older revision		Revision as of 13:42, 31 August 2023
Line 1:		Line 1:
	In QPR ProcessAnalyzer, scripts can be used for ETL tasks and to automate routines. Scripts are managed ~~as part of~~ the [[QPR_ProcessAnalyzer_Project_Workspace\|Project Workspace]].		In QPR ProcessAnalyzer, scripts can be used for ETL tasks and to automate routines. Scripts are managed in the [[QPR_ProcessAnalyzer_Project_Workspace\|Project Workspace]].

	When a script is running, it's not possible to start another run of the same script, so the first run needs to end to start new. Scripts can call other scripts and a called scripts can run multiple times simultaneously. In the stack of called scripts, the script log is generated to the top level script. Also the top level script shows that it's running and the called scripts do not.

			=== Running vs. Calling Scripts ===
	''Running'' a script means starting executing a stored script, which can be done in the UI or using the ScriptLauncher. A script can also ''call'' other scripts during the run. The differences between the running and calling are:		''Running'' a script means starting executing a stored script, which can be done in the UI or using the ScriptLauncher. A script can also ''call'' other scripts during the run. The differences between the running and calling are:
	* Script can run only once at a time, whereas there are no limitations on how many times a script can be called at the same time		* Script can run only once at a time, whereas there are no limitations on how many times a script can be called at the same time
Line 8:		Line 7:
	* Script status shows whether the script is being run or not. The status does not change, when a script is called from other script.		* Script status shows whether the script is being run or not. The status does not change, when a script is called from other script.

	~~Script runs can be [[Managing_Scripts#Running_Script\|started]] and [[Managing_Scripts#Stopping_Script\|stopped]] in the UI. Note that when~~ running ~~scripts using the UI~~, ~~return values or results~~ of the script ~~cannot be viewed~~. ~~If you want to use~~ scripts ~~that return data~~, ~~there are following options:~~		When a script is running, it's not possible to start another run of the same script, so the first run needs to end to start new. Scripts can call other scripts and a called scripts can run multiple times simultaneously. In the stack of called scripts, the script log is generated to the top level script. Also the top level script shows that it's running and the called scripts do not.
	* Script can write data to the script log
	* Script can write data to ~~a datatable~~
	* Script can be called from a dashboard and ~~use~~ the ~~dashboard to present the returned data (see more below)~~.

	=== Scripts List ===		=== Scripts List ===
Line 103:		Line 99:
	# Select the script to be duplicated.		# Select the script to be duplicated.
	# Click the '''Duplicate''' button. A duplicate of the script is created.		# Click the '''Duplicate''' button. A duplicate of the script is created.

			=== Viewing Script Run Results ===
			Script runs can be [[Managing_Scripts#Running_Script\|started]] and [[Managing_Scripts#Stopping_Script\|stopped]] in the UI. Note that when running scripts using the UI, return values or results of the script cannot be viewed. If you want to use scripts that return data, there are following options:
			* Script can write data to the script log
			* Script can write data to a datatable
			* Script can be called from a dashboard and use the dashboard to present the returned data (see more below).

Ollvihe at 13:40, 31 August 2023

2023-08-31T13:40:21Z

← Older revision		Revision as of 13:40, 31 August 2023
Line 2:		Line 2:

	When a script is running, it's not possible to start another run of the same script, so the first run needs to end to start new. Scripts can call other scripts and a called scripts can run multiple times simultaneously. In the stack of called scripts, the script log is generated to the top level script. Also the top level script shows that it's running and the called scripts do not.		When a script is running, it's not possible to start another run of the same script, so the first run needs to end to start new. Scripts can call other scripts and a called scripts can run multiple times simultaneously. In the stack of called scripts, the script log is generated to the top level script. Also the top level script shows that it's running and the called scripts do not.

			''Running'' a script means starting executing a stored script, which can be done in the UI or using the ScriptLauncher. A script can also ''call'' other scripts during the run. The differences between the running and calling are:
			* Script can run only once at a time, whereas there are no limitations on how many times a script can be called at the same time
			* Script log is written to the running script. No script log is written to the called script.
			* Script status shows whether the script is being run or not. The status does not change, when a script is called from other script.

			Script runs can be [[Managing_Scripts#Running_Script\|started]] and [[Managing_Scripts#Stopping_Script\|stopped]] in the UI. Note that when running scripts using the UI, return values or results of the script cannot be viewed. If you want to use scripts that return data, there are following options:
			* Script can write data to the script log
			* Script can write data to a datatable
			* Script can be called from a dashboard and use the dashboard to present the returned data (see more below).

	=== Scripts List ===		=== Scripts List ===