PA Configuration database table: Difference between revisions
No edit summary |
|||
Line 131: | Line 131: | ||
|| | || | ||
The name of the SAML attribute in the assertion that will be used as the user's login name. If this field is not given or is empty, the '''saml:Assertion''' > ''' saml:Subject''' > '''saml:NameID''' attribute is used in the assertion. If this setting is given, one of the '''saml:Assertion''' > '''saml:AttributeStatement''' > '''saml:Attribute''' elements in the assertion is used (the '''Name''' attribute in the '''saml:Attribute''' element is used for matching). Please note that the first mentioned saml:NameID element is different than the usual SAML attributes that are defined using saml:Attribute elements. If an email address is used as a user id, the value of the setting could be for example ''<nowiki>http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress</nowiki>''. | The name of the SAML attribute in the assertion that will be used as the user's login name. If this field is not given or is empty, the '''saml:Assertion''' > ''' saml:Subject''' > '''saml:NameID''' attribute is used in the assertion. If this setting is given, one of the '''saml:Assertion''' > '''saml:AttributeStatement''' > '''saml:Attribute''' elements in the assertion is used (the '''Name''' attribute in the '''saml:Attribute''' element is used for matching). Please note that the first mentioned saml:NameID element is different than the usual SAML attributes that are defined using saml:Attribute elements. If an email address is used as a user id, the value of the setting could be for example ''<nowiki>http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress</nowiki>''. | ||
|} | |} | ||
Revision as of 16:59, 29 January 2022
QPR ProcessAnalyzer database has a configuration table PA_Configuration containing settings listed in the tables below. You need SQL Server Management Studio to edit the settings in the configuration table. QPR ProcessAnalyzer Server needs to be restarted (e.g. IIS application pool recycled) for the changes to take effect.
General Settings
Name | Default value | Description |
---|---|---|
SessionIdleTimeout | 3600 | Idle user session expiration timeout in seconds. User session expires if the session hasn't been used after this amount of time. |
SessionMaximumDuration | 86400 | Maximum duration for a user session in seconds. Even if a session is used so that the SessionIdleTimeout is not reached, the session is expired after this amount of time. |
SandboxDatabaseConnectionString | Connection string to scripting sandbox database (ETL). If not defined, ETL scripts cannot be run. Connection string for the scripting sandbox database is similar to the QPR ProcessAnalyzer database connection string. | |
DefaultUiLanguage | en_US | Language code for the UI language that new user accounts get by default. Thus, a created user account has this language until the user changes her/his language. Also the login page is translated using this language when QPR ProcessAnalyzer is used for the first time in that web browser (when user has changed the language, it's remembered by the browser). This setting must be one of the supported language codes (xx_XX):
|
DefaultDateFormat | MM/dd/yyyy | Default date format that new user accounts get by default. The date format does not contain the time part (e.g. hours, minutes and seconds). Defined using the .Net date format (https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings). |
DefaultFirstDayOfWeek | 0 | Default first day of the week that new user accounts get by default. 0 is Sunday and 1 is Monday. This information is used by the UI when showing e.g. calendars. |
DefaultUse12HourClock | false | Defines whether the 12-hour clock is used by default (instead of the 24-hour clock) for the new user accounts when showing time information in the UI. Defined as true or false. More information about the 12-hour clock: https://en.wikipedia.org/wiki/12-hour_clock. |
SnowflakeConnectionString | ODBC connection string for the Snowflake connection, that needs to be configured to process models in the Snowflake. The connection string has following format:
Driver={SnowflakeDSIIDriver};Server=<account_identifier>.snowflakecomputing.com;Database=QPRPA;Schema=QPRPA;Warehouse=QPRPA;Role=QPRPA;uid=QPRPA;pwd=<password>, where <password> is the Snowflake user password and <account_identifier> is the Snowflake account identifier. In the example, the database, schema, warehouse, role and user are named to QPRPA. In addition to this setting, the Snowflake ODBC driver needs to be installed in the machine running the QPR ProcessAnalyzer Server. When this setting has been configured, users can create Snowflake stored datatables and models using Snowflake calculation. More information about Snowflake connection configuration. | |
NumberOfParallelModelReaders | 4 | Models and datatable contents can be loaded with multiple simultaneous connections to the database to speed up the loading. This setting determines how many parallel loaders/readers at maximum (loaders are loading at the same time). For smaller models there are less parallel loaders than the defined limit: If there are less than 100000 rows in the table, there is only one loader. If there are less than 200000 rows in the table, there are only two loaders, and so on.
The more there are parallel loaders, the more processor load and network bandwidth is consumed, and other operations in QPR ProcessAnalyzer might slow down. Note also that the performance optimum is achieved with a certain number of parallel loaders which differs between environment. Thus to achieve the best performance, data loading should be tested with different number of parallel loaders. Increasing number of parallel loaders beyond the optimum decreases the performance. |
StartupModelLoadingMaxParallelism | 2 | Maximum number of QPR ProcessAnalyzer models that are loaded into memory simultaneously by the Automatic Loading on Server Startup. If there are more models to be loaded on the server startup than this setting, loading for the rest of the models is started one by one when previous model loadings are completed. If this setting is not defined, 2 is used as a default value.
Loading more models at the same time will speed up the whole model loading process, but on the other hand, it causes more load on the system, which affects the system responsiveness for users. Model loading consists of (1) transferring data from the datasource to QPR ProcessAnalyzer and (2) loaded data preprocessing into a model. The former uses mainly network bandwidth (if datasource is in a different server) and the latter uses mainly processor capacity in the QPR ProcessAnalyzer server. This setting affects only the model loading during the server startup and it doesn't restrict models loadings initiated by users. |
AllowExternalDatasources | True | Determines whether the ImportOdbc function in the expression language and the ODBC model datasource can be used. This setting is for disabling the ODBC interfaces for data security reasons. By default, the ODBC interfaces are available. |
AllowNonTemporaryETLTargetTable | False | Defined whether ETL scripts are allowed to create global temporary database tables (tables starting with ##). More information about temporary tables: https://docs.microsoft.com/en-us/sql/t-sql/statements/create-table-transact-sql?view=sql-server-ver15#temporary-tables. |
DatabaseBulkCopyTimeout | 600 | BulkCopyTimeout given for QPR ProcessAnalyzer database SqlBulkCopy operations. |
DatabaseBulkCopyBatchSize | 5000 | BulkCopyBatchSize given for QPR ProcessAnalyzer database SqlBulkCopy operations. |
SandboxDatabaseBulkCopyTimeout | 600 | BulkCopyTimeout given for sandbox SqlBulkCopy operations. |
SandboxDatabaseBulkCopyBatchSize | 5000 | BulkCopyBatchSize given for sandbox SqlBulkCopy operations. |
SMTP Server Settings
SMTP server settings are neede for QPR ProcessAnalyzer to be able to send email messages. Email sending is used by the notifications functionality and the SendEmail function in the expression language.
Name | Description |
---|---|
SmtpServer | DNS name, host name or IP address of the SMTP server. Mandatory setting for the email sending to work. |
SmtpPort | TCP port number of the SMTP server. If not defined, port 25 is used by default. |
SmtpAuthenticationUsername | User name for authenticating to the SMTP server. If not defined, no authentication is used to connect to the SMTP server. |
SmtpFromAddress | Email address where email messages sent by QPR ProcessAnalyzer appear to be coming from. This doesn't need to be a real email address, although the address used may affect email spam filters. The setting configured here is the default email address to use in following cases:
|
SmtpAuthenticationPassword | Password for authenticating to the SMTP server. |
SmtpEnableSSL | True or False depending whether SSL connection to the SMTP server is used or not. If not defined, False is the default value. |
SAML 2.0 Federated Authentication Settings
Note that the SAMLMetadataUrl and ServiceProviderLocation are mandatory for the federated authentication to work.
Name | Description |
---|---|
SAMLMetadataUrl |
Metadata URL of the identity provider (IdP). Check that the metadata url can actually be opened using a web browser. The metadata is an XML document, so it should start <?xml version="1.0" encoding="UTF-8"?> followed by an EntityDescriptor tag. The metadata URL might look something like https://your.federated.identity.provider.com/saml/metadata. This setting is mandatory for the federated authentication to work. |
ServiceProviderLocation |
This setting specifies the QPR ProcessAnalyzer server location (the root path which contains e.g. the ui folder). It's used by the url to redirect back to QPR ProcessAnalyzer after a successful authentication from the identity provider. The setting is defined in the following form: https://SERVERNAME/qprpa, for example https://processanalyzer.onqpr.com/qprpa. Note that the actual redirect back url is https://SERVERNAME/qprpa/api/samlsignin, i.e. /api/samlsignin is automatically included to the url. This setting is mandatory for the federated authentication to work. |
SAMLUserIdAttribute |
The name of the SAML attribute in the assertion that will be used as the user's login name. If this field is not given or is empty, the saml:Assertion > saml:Subject > saml:NameID attribute is used in the assertion. If this setting is given, one of the saml:Assertion > saml:AttributeStatement > saml:Attribute elements in the assertion is used (the Name attribute in the saml:Attribute element is used for matching). Please note that the first mentioned saml:NameID element is different than the usual SAML attributes that are defined using saml:Attribute elements. If an email address is used as a user id, the value of the setting could be for example http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. |
Readonly Information
Name | Description |
---|---|
DatabaseId | Unique identifier for the QPR ProcessAnalyzer database, which is generated when the database is initialized during the server installation. If this setting is empty, a new unique database id is generated for this setting, and that value is used after that. |
DatabaseVersion | Database schema version. It will be updated automatically when the newer version of QPR ProcessAnalyzer Server connects to the database and performs migration for the database schema. |
InitializationScriptDatabaseVersion | Database version that was when the database was initialized when the software was installed. Do not change this setting. |
MinimumDatabaseVersion | Minimum allowed database version for QPR ProcessAnalyzer Server connecting to the database. This is a legacy setting and it should not be used. |