Storing Secrets for Scripts: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 7: Line 7:
Note: Currently [[SQL Scripting Commands#--.23ImportSqlQuery|ImportSqlQuery]] and [[SQL Scripting Commands#--.23ImportOleDbQuery|ImportOleDbQuery]] don't yet support defining password as a secure string.
Note: Currently [[SQL Scripting Commands#--.23ImportSqlQuery|ImportSqlQuery]] and [[SQL Scripting Commands#--.23ImportOleDbQuery|ImportOleDbQuery]] don't yet support defining password as a secure string.


== Using Secrets ==
== Setting secrets ==
Secrets can be set using [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#SetSecret|SetSecret]] function for Project entities. There is also [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Project|Secrets]] property for project entities to list all secrets in the project.
 
== Using secrets ==
Secrets can be used in the following commands:
Secrets can be used in the following commands:
* [[SQL Scripting Commands|SQL scripting commands]]: ImportOdbcQuery, ImportSalesforceQuery and ImportSapQuery.
* [[SQL Scripting Commands|SQL scripting commands]]: ImportOdbcQuery, ImportSalesforceQuery and ImportSapQuery.
* [[QPR_ProcessAnalyzer_Model_Datasources#Loading_Data_from_ODBC_Datasource|ODBC datasources of model]].
* [[QPR_ProcessAnalyzer_Model_Datasources#Loading_Data_from_ODBC_Datasource|ODBC datasources of model]].
* [[DataFrame_in_Expression_Language#ImportOdbcSecure|ImportODBCSecure]] function (expression language)
* [[DataFrame_in_Expression_Language#ImportOdbcSecure|ImportODBCSecure]] function (expression language)

Revision as of 11:55, 18 January 2024

Secrets provide a way to store passwords and other confidential data in QPR ProcessAnalyzer, so that it can be used without users seeing 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.

When the secure strings are stored, the purpose (called type of the secure string) of the secure string is also defined. Following types are available: Odbc connection strings, SAP passwords and Salesforce passwords. For example, if a secure string type is SAP password, it cannot be used as an ODBC connection string.

Secure strings are project specific, so their permissions come from the project. To use a secure string, the user needs to have at least GenericRead permission to the project.

Note: Currently ImportSqlQuery and ImportOleDbQuery don't yet support defining password as a secure string.

Setting secrets

Secrets can be set using SetSecret function for Project entities. There is also Secrets property for project entities to list all secrets in the project.

Using secrets

Secrets can be used in the following commands: