Storing Secrets for Scripts - Revision history

TeeHiet: TK-58110

2025-07-08T05:56:12Z

TK-58110

← Older revision		Revision as of 05:56, 8 July 2025
Line 6:		Line 6:

	== Setting secrets ==		== Setting secrets ==
	Secrets can be set by calling the [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#SetSecret\|SetSecret]] function for the project, or the corresponding generic context [[Generic_Functions_in_QPR_ProcessAnalyzer#SetSecret\|SetSecret]] function. ~~Secrets~~ can also be defined in the [[Project_Properties_Dialog#Secrets\|Project Properties Dialog]].		Secrets can be set by calling the [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#SetSecret\|SetSecret]] function for the project, or the corresponding generic context [[Generic_Functions_in_QPR_ProcessAnalyzer#SetSecret\|SetSecret]] function. Project secrets can also be defined in the [[Project_Properties_Dialog#Secrets\|Project Properties Dialog]].

	Example: Set a project secret (for project id 1):		Example: Set a project secret (for project id 1):

TeeHiet: TK-58110

2025-07-08T05:45:07Z

TK-58110

← Older revision		Revision as of 05:45, 8 July 2025
Line 6:		Line 6:

	== Setting secrets ==		== Setting secrets ==
	Secrets can be set by calling the [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#SetSecret\|SetSecret]] function for the project, or the corresponding generic context [[Generic_Functions_in_QPR_ProcessAnalyzer#SetSecret\|SetSecret]] function.		Secrets can be set by calling the [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#SetSecret\|SetSecret]] function for the project, or the corresponding generic context [[Generic_Functions_in_QPR_ProcessAnalyzer#SetSecret\|SetSecret]] function. Secrets can also be defined in the [[Project_Properties_Dialog#Secrets\|Project Properties Dialog]].

	Example: Set a project secret (for project id 1):		Example: Set a project secret (for project id 1):

Ollvihe: /* Listing secrets */

2025-05-12T10:41:46Z

Listing secrets

← Older revision		Revision as of 10:41, 12 May 2025
Line 19:		Line 19:

	== Listing secrets ==		== Listing secrets ==
	To list all secrets in the project, ~~there is a property~~ [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Project\|Secrets]] for ~~projects~~. For the global secrets, there is the corresponding global [[Generic_Properties_in_Expression_Language#Secrets\|Secrets]] property. Note that the secret value cannot be retrieved even by system administrators.		To list all secrets in the project, use the [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Project\|Secrets]] property for the project. For the global secrets, there is the corresponding global [[Generic_Properties_in_Expression_Language#Secrets\|Secrets]] property. Note that the secret value cannot be retrieved even by system administrators.

	Example: ~~Show~~ project secrets (for project id 1):		Example: List project secrets (for project id 1):
	<pre>		<pre>
	ToJson(ProjectById(1).Secrets);		ToJson(ProjectById(1).Secrets);
	</pre>		</pre>

	Example: ~~Show~~ global secrets:		Example: List global secrets:
	<pre>		<pre>
	ToJson(Secrets);		ToJson(Secrets);

Ollvihe: /* Setting and listing secrets */

2025-05-12T10:40:43Z

Setting and listing secrets

← Older revision		Revision as of 10:40, 12 May 2025
Line 5:		Line 5:
	Each secret has a type which defines in which command the secret can be used. The purpose of the type is to improve security, so that the secret can only be used in the intended command.		Each secret has a type which defines in which command the secret can be used. The purpose of the type is to improve security, so that the secret can only be used in the intended command.

	== Setting ~~and listing~~ secrets ==		== Setting secrets ==
	Secrets can be set by calling the [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#SetSecret\|SetSecret]] function for the project, or the corresponding generic context [[Generic_Functions_in_QPR_ProcessAnalyzer#SetSecret\|SetSecret]] function.		Secrets can be set by calling the [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#SetSecret\|SetSecret]] function for the project, or the corresponding generic context [[Generic_Functions_in_QPR_ProcessAnalyzer#SetSecret\|SetSecret]] function.

	~~There is~~ a ~~property [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Project\|Secrets]]~~ for ~~projects to list all secrets in the~~ project. ~~For the global secrets~~, ~~there is the corresponding global [[Generic_Properties_in_Expression_Language#Secrets\|Secrets]] property. Note that the secret value cannot be retrieved even by system administrators.~~		Example: Set a project secret (for project id 1):
			<pre>
			ProjectById(1).SetSecret("sap", "SapAdminPassword", "I l0ve 5AP!");
			</pre>

	Example: Set a global ~~and a project-specific~~ secret:		Example: Set a global secret:
	<pre>		<pre>
	SetSecret("sap", "SapReaderPassword", "I l0ve 5AP!");		SetSecret("sap", "SapReaderPassword", "I l0ve 5AP!");
	~~ProjectById(1).SetSecret("sap", "SapAdminPassword", "I l0ve 5AP!");~~
	</pre>		</pre>

	Example: Show ~~global~~ secrets:		== Listing secrets ==
			To list all secrets in the project, there is a property [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Project\|Secrets]] for projects. For the global secrets, there is the corresponding global [[Generic_Properties_in_Expression_Language#Secrets\|Secrets]] property. Note that the secret value cannot be retrieved even by system administrators.

			Example: Show project secrets (for project id 1):
	<pre>		<pre>
	ToJson(Secrets);		ToJson(ProjectById(1).Secrets);
	</pre>		</pre>

	Example: Show ~~project's secret~~:		Example: Show global secrets:
	<pre>		<pre>
	ToJson(~~ProjectById(1).~~Secrets);		ToJson(Secrets);
	</pre>		</pre>

Ollvihe: /* Setting and listing secrets */

2025-03-27T09:44:04Z

Setting and listing secrets

← Older revision		Revision as of 09:44, 27 March 2025
Line 18:		Line 18:
	Example: Show global secrets:		Example: Show global secrets:
	<pre>		<pre>
	ToJson(Secrets)		ToJson(Secrets);
	</pre>		</pre>

	Example: Show project's secret:		Example: Show project's secret:
	<pre>		<pre>
	ToJson(ProjectById(1).Secrets)		ToJson(ProjectById(1).Secrets);
	</pre>		</pre>

Ollvihe: /* Setting and listing secrets */

2025-03-27T09:43:48Z

Setting and listing secrets

← Older revision		Revision as of 09:43, 27 March 2025
Line 9:		Line 9:

	There is a property [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Project\|Secrets]] for projects to list all secrets in the project. For the global secrets, there is the corresponding global [[Generic_Properties_in_Expression_Language#Secrets\|Secrets]] property. Note that the secret value cannot be retrieved even by system administrators.		There is a property [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Project\|Secrets]] for projects to list all secrets in the project. For the global secrets, there is the corresponding global [[Generic_Properties_in_Expression_Language#Secrets\|Secrets]] property. Note that the secret value cannot be retrieved even by system administrators.

			Example: Set a global and a project-specific secret:
			<pre>
			SetSecret("sap", "SapReaderPassword", "I l0ve 5AP!");
			ProjectById(1).SetSecret("sap", "SapAdminPassword", "I l0ve 5AP!");
			</pre>

			Example: Show global secrets:
			<pre>
			ToJson(Secrets)
			</pre>

			Example: Show project's secret:
			<pre>
			ToJson(ProjectById(1).Secrets)
			</pre>

	== Using secrets ==		== Using secrets ==

Ollvihe: /* Setting and listing secrets */

2025-03-27T09:39:41Z

Setting and listing secrets

← Older revision		Revision as of 09:39, 27 March 2025
Line 6:		Line 6:

	== Setting and listing secrets ==		== Setting and listing secrets ==
	Secrets can be set by calling the [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#SetSecret\|SetSecret]] function for ~~Project entity~~, or the corresponding generic context SetSecret function.		Secrets can be set by calling the [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#SetSecret\|SetSecret]] function for the project, or the corresponding generic context [[Generic_Functions_in_QPR_ProcessAnalyzer#SetSecret\|SetSecret]] function.

	There is a property [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Project\|Secrets]] for projects to list all secrets in the project. For the global secrets, there is the corresponding global Secrets property. Note that the secret value cannot be retrieved even by system administrators.		There is a property [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Project\|Secrets]] for projects to list all secrets in the project. For the global secrets, there is the corresponding global [[Generic_Properties_in_Expression_Language#Secrets\|Secrets]] property. Note that the secret value cannot be retrieved even by system administrators.

	== Using secrets ==		== Using secrets ==

Ollvihe at 09:34, 27 March 2025

2025-03-27T09:34:53Z

← Older revision		Revision as of 09:34, 27 March 2025
Line 1:		Line 1:
	Secrets provide a method to store passwords and other confidential data in QPR ProcessAnalyzer, and use them without being able to see the stored secret values. For example in scripts, SAP, Salesforce and ODBC passwords can be stored as secrets, which can be referred by their names in the script commands.		Secrets provide a method to store passwords and other confidential data in QPR ProcessAnalyzer, and use them without being able to see the stored secret values. For example in scripts, SAP, Salesforce and ODBC passwords can be stored as secrets, which can be referred by their names in the script commands.

	There are project-specific and global secrets. To use a secret, the user needs to have ''GenericRead'' permission to the project (or global ''GenericRead'' to use global secrets). To define a secret, the ''ManageProject'' permission to the project is needed (or global ''ManageProject'' to define global secrets).		There are project-specific and global secrets. To use a secret, the user needs to have ''GenericRead'' permission to the project (or global ''GenericRead'' to use global secrets). To define a secret, the ''ManageProject'' permission to the project is needed (or global ''ManageProject'' to define global secrets). If both a global and a project-specific secret with the same name and type are set, the project-specific secret will be used in that project, and thus the global secret is unavailable for that project.

	Each secret has a type which defines in which command the secret can be used. The purpose of the type is to improve security, so that the secret can only be used in the intended command.		Each secret has a type which defines in which command the secret can be used. The purpose of the type is to improve security, so that the secret can only be used in the intended command.

Ollvihe at 09:28, 27 March 2025

2025-03-27T09:28:26Z

← Older revision		Revision as of 09:28, 27 March 2025
Line 1:		Line 1:
	Secrets provide method to store passwords and other confidential data in QPR ProcessAnalyzer, ~~so that they can be used~~ without ~~users~~ being able to see the ~~original plaintext~~. For example in ~~ETL~~ scripts, SAP, Salesforce and ODBC passwords can be stored as secrets, which can be referred by their names in the ~~ETL~~ script commands.		Secrets provide a method to store passwords and other confidential data in QPR ProcessAnalyzer, and use them without being able to see the stored secret values. For example in scripts, SAP, Salesforce and ODBC passwords can be stored as secrets, which can be referred by their names in the script commands.

			There are project-specific and global secrets. To use a secret, the user needs to have ''GenericRead'' permission to the project (or global ''GenericRead'' to use global secrets). To define a secret, the ''ManageProject'' permission to the project is needed (or global ''ManageProject'' to define global secrets).

	Each secret has a type which defines in which command the secret can be used. The purpose of the type is to improve security, so that the secret can only be used in the intended command.		Each secret has a type which defines in which command the secret can be used. The purpose of the type is to improve security, so that the secret can only be used in the intended command.

	There are project-specific and global secrets. To use a secret, the user needs to have ''GenericRead'' permission to the project (or global ''GenericRead'' to use the global secrets). To define a secret, the ''ManageProject'' permission to the project is needed (or global ''ManageProject'' to define the global secrets).

	== Setting and listing secrets ==		== Setting and listing secrets ==

Ollvihe: /* Setting secrets */

2025-03-27T09:06:51Z

Setting secrets

← Older revision		Revision as of 09:06, 27 March 2025
Line 5:		Line 5:
	There are project-specific and global secrets. To use a secret, the user needs to have ''GenericRead'' permission to the project (or global ''GenericRead'' to use the global secrets). To define a secret, the ''ManageProject'' permission to the project is needed (or global ''ManageProject'' to define the global secrets).		There are project-specific and global secrets. To use a secret, the user needs to have ''GenericRead'' permission to the project (or global ''GenericRead'' to use the global secrets). To define a secret, the ''ManageProject'' permission to the project is needed (or global ''ManageProject'' to define the global secrets).

	== Setting secrets ==		== Setting and listing secrets ==
	Secrets can be set by calling the [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#SetSecret\|SetSecret]] function for Project entity, or the corresponding generic context SetSecret function.		Secrets can be set by calling the [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#SetSecret\|SetSecret]] function for Project entity, or the corresponding generic context SetSecret function.