PA Configuration database table: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
(Created page with "In QPR ProcessAnalyzer database, there is a configuration table '''PA_Configuration'''. It contains settings listed in the table below. You need '''SQL Server Management Studi...")
 
No edit summary
Line 7: Line 7:
||<current&nbsp;version>
||<current&nbsp;version>
||Database schema version. It will be updated automatically when a client with a new version connects to the database and does the migration (see '''UpdateDatabaseIfNeeded''' setting documentation for web.config).
||Database schema version. It will be updated automatically when a client with a new version connects to the database and does the migration (see '''UpdateDatabaseIfNeeded''' setting documentation for web.config).
|-
||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 to '''0''', so the bin is not emptied every time the server is started. Default value is 0, meaning that nothing is done.
|-
|-
||InitializationScriptDatabaseVersion
||InitializationScriptDatabaseVersion
Line 28: Line 32:
||If set, contains the EXTERNAL version number (=product version) of a client libraries that is recommended for using QPR ProcessAnalyzer Server. The value should either be empty or contain a string in format '''<major>.<minor>''' where '''<major>''' is major version number and '''<minor>''' is minor version number. Example: "2018.4".
||If set, contains the EXTERNAL version number (=product version) of a client libraries that is recommended for using QPR ProcessAnalyzer Server. The value should either be empty or contain a string in format '''<major>.<minor>''' where '''<major>''' is major version number and '''<minor>''' is minor version number. Example: "2018.4".
Having the value empty equals to the case where the <major> and <minor> version numbers are equal to the external version number of the client library that connected to the database.
Having the value empty equals to the case where the <major> and <minor> version numbers are equal to the external version number of the client library that connected to the database.
|-
||ExcelAddInInstallationUrl
||<empty>
||Installation package URL shown to a user when the user doesn't have the recommended client version installed.
|-
|-
|DatabaseAvailabilityMode
|DatabaseAvailabilityMode
Line 36: Line 44:
* '''1''': Archived (when connecting with Excel Client, client tells the user that the database is archived and is not used for production)
* '''1''': Archived (when connecting with Excel Client, client tells the user that the database is archived and is not used for production)
* '''2''': Unavailable (users can't connect to PA database marked as unavailable)
* '''2''': Unavailable (users can't connect to PA database marked as unavailable)
|-
||ExcelAddInInstallationUrl
||<empty>
||Installation package URL shown to a user when the user doesn't have the recommended client version installed.
|-
|-
||SessionIdleTimeout
||SessionIdleTimeout
Line 92: Line 96:
||<empty>
||<empty>
||Authentication related setting, more information: [[LDAP/AD Authentication in QPR ProcessAnalyzer Server]].
||Authentication related setting, more information: [[LDAP/AD Authentication in QPR ProcessAnalyzer Server]].
|-
||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 to '''0''', so the bin is not emptied every time the server is started. Default value is 0, meaning that nothing is done.
|}
|}

Revision as of 19:34, 6 October 2018

In QPR ProcessAnalyzer database, there is a configuration table PA_Configuration. It contains settings listed in the table below. You need SQL Server Management Studio to edit the settings in the configuration table. QPR ProcessAnalyzer Service needs to be restarted for the changes to take effect.

Name Default value Description
DatabaseVersion <current version> Database schema version. It will be updated automatically when a client with a new version connects to the database and does the migration (see UpdateDatabaseIfNeeded setting documentation for web.config).
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 to 0, so the bin is not emptied every time the server is started. Default value is 0, meaning that nothing is done.
InitializationScriptDatabaseVersion
DatabaseBulkCopyTimeout 600 BulkCopyTimeout given for non-sandbox SqlBulkCopy operations.
DatabaseBulkCopyBatchSize 5000 BulkCopyBatchSize given for non-sandbox SqlBulkCopy operations.
DatabaseId <random GUID> 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.
RecommendedClientVersion <empty> If set, contains the EXTERNAL version number (=product version) of a client libraries that is recommended for using QPR ProcessAnalyzer Server. The value should either be empty or contain a string in format <major>.<minor> where <major> is major version number and <minor> is minor version number. Example: "2018.4".

Having the value empty equals to the case where the <major> and <minor> version numbers are equal to the external version number of the client library that connected to the database.

ExcelAddInInstallationUrl <empty> Installation package URL shown to a user when the user doesn't have the recommended client version installed.
DatabaseAvailabilityMode 0

One of the following options:

  • 0: Available (no usage restrictions)
  • 1: Archived (when connecting with Excel Client, client tells the user that the database is archived and is not used for production)
  • 2: Unavailable (users can't connect to PA database marked as unavailable)
SessionIdleTimeout 3600 Idle user session expiration time in seconds. User session expires if the session hasn't been used after this amount of time.
SessionMaximumDuration 86400 Maximum duration in seconds for an active session. Even if a session is used actively so that the SessionIdleTimeout is not reached, the session is expired after this amount of time.
SandboxDatabaseConnectionString <empty> If set, defines the connection string to ETL sandbox database. If not defined, running ETL scripts is not possible.
SandboxDatabaseBulkCopyTimeout 600 BulkCopyTimeout given for sandbox SqlBulkCopy operations.
SandboxDatabaseBulkCopyBatchSize 5000 BulkCopyBatchSize given for sandbox SqlBulkCopy operations.
AllowNonTemporaryETLTargetTable false Are ETL scripts allowed to create global temporary database tables (tables starting with ##).
AuthenticationMethod 1 Authentication related setting, more information: LDAP/AD Authentication in QPR ProcessAnalyzer Server.
LDAPConnectionString <empty> Authentication related setting, more information: LDAP/AD Authentication in QPR ProcessAnalyzer Server.
LDAPUserFilter <empty> Authentication related setting, more information: LDAP/AD Authentication in QPR ProcessAnalyzer Server.
LDAPUserSearchBase <empty> Authentication related setting, more information: LDAP/AD Authentication in QPR ProcessAnalyzer Server.
LDAPUserIdAttributeName <empty> Authentication related setting, more information: LDAP/AD Authentication in QPR ProcessAnalyzer Server.
LDAPServerUserName <empty> Authentication related setting, more information: LDAP/AD Authentication in QPR ProcessAnalyzer Server.
LDAPServerPassword <empty> Authentication related setting, more information: LDAP/AD Authentication in QPR ProcessAnalyzer Server.