PA Configuration database table: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
Line 77: Line 77:
* '''1'''=Archived: when connecting with Excel Client, user is informed that the database is archived and is not used for production
* '''1'''=Archived: when connecting with Excel Client, user is informed that the database is archived and is not used for production
* '''2'''=Unavailable: users can't connect to the database
* '''2'''=Unavailable: users can't connect to the database
|}
== SMTP Server Settings ==
SMTP server settings need to be set for QPR ProcessAnalyzer to be able to send email. Email sending is used e.g. by the notifications functionality and the SendEmail function in the expression language.
{| class="wikitable" style="text-align: left"
!Name !!Description
|-
||SmtpServer
||
|-
||SmtpPort
||
|-
||SmtpAuthenticationUsername
||
|-
||SmtpAuthenticationPassword
||
|-
||SmtpEnableSSL
||
|}
|}



Revision as of 20:52, 1 October 2020

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.

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. This time should be set same as QPR UI session expiration timeout.
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. This setting must be one of the supported language codes (xx_XX):
  • Finnish: fi_FI
  • French: fr_FR
  • English: en_US
  • German: de_DE
  • Russian: ru_RU
  • Spanish: es_ES
  • Swedish: sv_SE
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.
DeleteModelsInRecycleBinOnStartup 0 When set to 1, deleted QPR ProcessAnalyzer models in the recycle bin are permanently deleted when restarting the QPR ProcessAnalyzer Server. After restarting, the DeleteModelsInRecycleBinOnStartup is automatically set back to 0, so the recycle bin is not emptied every time the server is started.
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.
DatabaseAvailabilityMode 0

One of the following options:

  • 0=Available: no limitations for usage
  • 1=Archived: when connecting with Excel Client, user is informed that the database is archived and is not used for production
  • 2=Unavailable: users can't connect to the database

SMTP Server Settings

SMTP server settings need to be set for QPR ProcessAnalyzer to be able to send email. Email sending is used e.g. by the notifications functionality and the SendEmail function in the expression language.

Name Description
SmtpServer
SmtpPort
SmtpAuthenticationUsername
SmtpAuthenticationPassword
SmtpEnableSSL

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.

LDAP Authentication Settings

Name Description
AuthenticationMethod Authentication related settings, see detailed information in LDAP/AD Authentication.
LDAPConnectionString
LDAPUserFilter
LDAPUserSearchBase
LDAPUserIdAttributeName
LDAPServerUserName
LDAPServerPassword

Readonly Information

Name Description
DatabaseId Unique identifier for the database. Unless the database has been copied from another database, there shouldn't be two databases with the same database id.
DatabaseVersion Database schema version. It will be updated automatically when a QPR ProcessAnalyzer Server of a newer version connects to the database and performs migration for the database.
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.