Managing Scripts - Revision history

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 ===

Ollvihe: /* Scripts List */

2022-12-13T20:47:54Z

Scripts List

← Older revision		Revision as of 20:47, 13 December 2022
Line 8:		Line 8:
	* '''Status''': Status of the script, which is one of following: ''Ready'', ''Running'' or ''Stopping''. For more information about script statuses, see below.		* '''Status''': Status of the script, which is one of following: ''Ready'', ''Running'' or ''Stopping''. For more information about script statuses, see below.
	* '''Last run duration''': Duration of the last ended run of the script (the last run result can be any).		* '''Last run duration''': Duration of the last ended run of the script (the last run result can be any).
	* '''Last run date''': Date and time when the last run ~~was started~~.		* '''Last run date''': Date and time when the last run ended. If you need to know the last run start time, subtract the ''Last run duration'' from this time.
	* '''Last run result''': Result of the last run of the script. Either of following: ''Completed'', ''Failed'' or ''Aborted''. For more information about last run results, see below.		* '''Last run result''': Result of the last run of the script. Either of following: ''Completed'', ''Failed'' or ''Aborted''. For more information about last run results, see below.
	* '''Id''': Script id that uniquely identifies the script in the system.		* '''Id''': Script id that uniquely identifies the script in the system.

Ollvihe: /* Deleting Script */

2022-09-27T21:08:35Z

Deleting Script

← Older revision		Revision as of 21:08, 27 September 2022
Line 75:		Line 75:
	# Select one or several scripts to be deleted.		# Select one or several scripts to be deleted.
	# Click the '''Delete''' button and click '''Delete''' to the confirmation message.		# Click the '''Delete''' button and click '''Delete''' to the confirmation message.

			Note that if the script is being run, it cannot be deleted.

	=== Renaming Script ===		=== Renaming Script ===

Ollvihe: /* Viewing Script Log */

2022-04-11T15:34:07Z

Viewing Script Log

← Older revision		Revision as of 15:34, 11 April 2022
Line 53:		Line 53:

	=== Viewing Script Log ===		=== Viewing Script Log ===
	It's possible to see the script log of the last ~~ended~~ run, and monitor the currently running script ~~log~~. Logs for ~~the~~ older runs are not available in the UI.		It's possible to see the script log of the last run, and monitor the currently running script progress. Logs for older runs are not available in the UI, nut they are stored by the system.

	To see the logs:		To see the logs:

Ollvihe: /* Viewing Script Log */

2022-04-11T15:07:10Z

Viewing Script Log

← Older revision		Revision as of 15:07, 11 April 2022
Line 61:		Line 61:
	# If keeping the current run log open, the latest log entries are updated automatically every two seconds.		# If keeping the current run log open, the latest log entries are updated automatically every two seconds.

	~~Script logs contain following~~ information:		More information about [[QPR_ProcessAnalyzer_Logs#Script_Log\|Script Log]].
	* All errors occurring during the script run (script run also stops when an error occurs).
	* All log writes made by commands in the script code (in expression scripts ''WriteLog'' function calls, and in SQL scripts ''--#~~WriteLog'' and ''PRINT'' commands).~~
	* For SQL scripts, all executed scripting commands (commands starting with ''--#'').

	=== Creating Script ===		=== Creating Script ===

Ollvihe: /* Viewing Script Log */

2022-04-11T15:06:11Z

Viewing Script Log

← Older revision		Revision as of 15:06, 11 April 2022
Line 53:		Line 53:

	=== Viewing Script Log ===		=== Viewing Script Log ===
	It's possible to see the script log of the last ~~completed~~ run, and monitor the currently running script log. Logs for the older runs are not available in the UI.		It's possible to see the script log of the last ended run, and monitor the currently running script log. Logs for the older runs are not available in the UI.

	To see the logs:		To see the logs:

Ollvihe at 09:30, 11 March 2022

2022-03-11T09:30:42Z

← Older revision		Revision as of 09:30, 11 March 2022
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 as part of the [[QPR_ProcessAnalyzer_Project_Workspace\|Project Workspace]].

	When a script is running, it's not possible to start another run of the same script, ~~but~~ the first run needs to end ~~before starting another. Still, multiple scripts can run at the same time~~. 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.

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