Storing Secrets for Scripts: Difference between revisions
No edit summary |
|||
| Line 19: | Line 19: | ||
* '''KVS_VALUE''': The actual secured value, which is typically a password or a connection string. | * '''KVS_VALUE''': The actual secured value, which is typically a password or a connection string. | ||
== Using Secure | == Using Secure Strings == | ||
The secure strings can be used in the following places: | The secure strings can be used in the following places: | ||
Revision as of 19:13, 15 March 2020
The secure strings provide a way to store passwords an other confidential information to QPR ProcessAnalyzer in a way that the information can be used, but no user can see the information in plaintext. For example, in ETL scripts SAP, Salesforce and ODBC passwords can be stored as secure strings, which can then be referred in the ETL script commands.
When the secure strings are stored, the purpose (type) of the secure string is also defined. Following types are available: Odbc connection strings, SAP passwords, Salesforce passwords, ADO.Net Sql connection strings and OleDb connection strings. For example, if a secure string's type SAP password, it cannot be used as an ODBC connection string.
Storing Secure Strings
Secure strings are stored in the QPR ProcessAnalyzer database in the PA_KEY_VALUE_STORE table. The database administrator can store new secure strings, using the following instructions.
The PA_KEY_VALUE_STORE table has the following columns:
- KVS_ID: Row id. Leave empty.
- KVS_TYPE: Type of the secure string to determine its purpose. Available values are:
- 1: ODBC connection string. Can be used in the ImportODBCSecure function and ImportOdbcQuery command.
- 2: SAP password. Can be used in the ImportSapQuery command.
- 3: Salesforce password. Can be used in the ImportSalesforceQuery command.
- 4: Sql connection string. Can be used in the ImportSqlQuery command.
- 5: OleDb connection string. Can be used in the ImportOleDbQuery command.
- KVS_PROJECT_ID: If of the project, to which the secure string is stored.
- KVS_KEY: Key of the secure string. Use a descriptive value. Note that there cannot be any duplicates within the same project id.
- KVS_VALUE: The actual secured value, which is typically a password or a connection string.
Using Secure Strings
The secure strings can be used in the following places:
- SQL scripting commands: ImportOdbcQuery, ImportOleDbQuery, ImportSalesforceQuery, ImportSapQuery and ImportSqlQuery.
- In the models' ODBC datasources.
- In the ImportODBCSecure function in the expression language