Server settings in appsettings.json: Difference between revisions
(Created page with "The appsettings.json file is the main settings file for the QPR ProcessAnalyzer Server application. Go through the settings in the table below to set suitable values to the appsettings.json. <div style="border:1px solid #dfdfdf;padding:0.5em 1em 0.5em 1em;background-color:#E7EAEC;margin:10px 0px 0px 10px;"> The appsettings.json needs to be a correctly formatted json file, and thus the backslashes and quotation marks in string values need to be escaped as follows: \ →...") |
(No difference)
|
Latest revision as of 15:18, 22 November 2025
The appsettings.json file is the main settings file for the QPR ProcessAnalyzer Server application. Go through the settings in the table below to set suitable values to the appsettings.json.
The appsettings.json needs to be a correctly formatted json file, and thus the backslashes and quotation marks in string values need to be escaped as follows: \ → \\ and " → \".
| Setting | Description |
|---|---|
| SqlDatabaseConnectionString | Define the connection string to QPR ProcessAnalyzer database in SQL Server. Check whether you are using an SQL Server default instance or a named instance, and whether an SQL Server authentication or Windows authentication is used.
Connect to SQL Server default instance using SQL Server authentication: Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword; Connect to SQL Server default instance using Windows authentication: Server=myServerAddress;Database=myDataBase;Trusted_Connection=True; Connect to SQL Server named instance using SQL Server authentication: Server=myServerName\\myInstanceName;Database=myDataBase;User Id=myUsername;Password=myPassword; Connect to SQL Server named instance using Windows authentication: Server=myServerName\\myInstanceName;Database=myDataBase;Trusted_Connection=True; More information about connections strings: https://www.connectionstrings.com/sqlconnection. |
| LogFilePath | Location of the QPR ProcessAnalyzer Server log file (defined as the full path with the file name). For example: C:\\ProgramData\\QPR Software\\QPR ProcessAnalyzer\\Logs\\PA.log (json escapings are included). |
| ProductActivationCode | QPR ProcessAnalyzer Server product license activation code. Ask your organization license activation code from customercare@qpr.com.
QPR ProcessAnalyzer Server automatically activates itself if the code is specified and there is an internet connection in the server computer. If there is no internet access, the activation need to be done manually by using the Activation Utility. |
| FirstName | (mandatory) Contact person's first name (in the user organization) (used for QPR ProcessAnalyzer Server activation). |
| LastName | (mandatory) Contact person's last name (used for QPR ProcessAnalyzer Server activation). |
| (mandatory) Contact person's email address (used for QPR ProcessAnalyzer Server activation). | |
| LicenseFilePath | QPR ProcessAnalyzer Server license file path including the file name. For example C:\\ProgramData\\QPR Software\\QPR ProcessAnalyzer\\pa_service.lf (json escapings are included). The license file is created when the QPR ProcessAnalyzer Server is activated. If changing the activation code, this file needs to be deleted manually to enable reactivation. |
| CorsOrigins | Defines how QPR ProcessAnalyzer Server responds to the CORS preflight requests. By default, this setting is empty, meaning that CORS is not allowed. To allow CORS from all origins, specify * (note that this is the least secure option). If CORS need to be enabled for a specific site(s), they are defined as a comma separated list to this setting. More about CORS: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS. |
| UseXForwardedForAsClientIp | If QPR ProcessAnalyzer Server is running behind a web traffic load balancer (e.g. in Amazon Web Services), the following setting needs to be set to True. In that case, the client ip address is fetched from http request X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For) field instead of the source of the ip packet. Client ip address is needed for logging and as a security confirmation in addition to the session id. When there is no load balancer and thus X-Forwarded-For is not set, it's important to have this setting as False. |
| EMSAddress | Activation server address https://activation.qpr.com/ that is contacted when the QPR ProcessAnalyzer Server is activated. Do not change this setting. |
| UseProxyServer | If needed, define the proxy server for QPR ProcessAnalyzer Server activation. |
| ModelLoadOnStartup | Determines whether QPR ProcessAnalyzer models having setting LoadOnStartup as true are loaded automatically during server startup. By default, this setting should be set to True. This setting can be used to temporarily disable automatic model loading for all models when for example automatic model loading causes issues. |
| ResponsePollingInterval | Time (in milliseconds) after which pending requests return with an exception, and the request continues to run in the QPR ProcessAnalyzer Server. This behavior is needed by QPR ScriptLauncher which will then make a further request to query the progress of the task. Note that the UI doesn't support this behavior, so set the limit large enough so that it's not exceeded in normal usage, e.g. 10 minutes (600000 ms). The default values is 10 minutes. NOTE: This is a legacy setting which will be removed in future. |
| ProxyAddress | If needed, define the proxy server for QPR ProcessAnalyzer Server activation. |
| Country | (optional) User country (used for QPR ProcessAnalyzer Server activation). |
| JobTitle | (optional) Contact person's job title (used for QPR ProcessAnalyzer Server activation). |
| PhoneNumber | (optional) Contact person's phone number (used for QPR ProcessAnalyzer Server activation). |
| Address | (optional) User address (used for QPR ProcessAnalyzer Server activation). |
| PostalCode | (optional) User postal code (used for QPR ProcessAnalyzer Server activation). |
| Region | (optional) User region (used for QPR ProcessAnalyzer Server activation). |
| Organization | (optional) User organization (used for QPR ProcessAnalyzer Server activation). |
| DropUnusedFiltersAfter |
Duration after which filters that have not been used, are dropped from the memory. Defined in format HH:mm:ss or d.HH:mm:ss, for example 01:00:00 (one hour), 00:30:00 (30 minutes) or 1.00:00:00 (24 hours). When a calculation uses a filter, the filter's last used time is updated (also model's last used time is updated). This setting can be overridden for each model in the model settings. Note that this setting doesn't concern Snowflake models. |