Server Configuration Properties in the Database
Property
Description
mksis.collectSupportPackage.additionalFiles
When the Collect Support Package diagnostic is used, a fixed set of files are collected. This parameter allows you to add additional files to that comma delimited list. PTC RV&S Support may request that you modify this property if a diagnostic tool is installed on your system.
mksis.constraintsAPI.maxAllowedValues
Limits the number of allowed values that are shown when using a constraints command. If the number of values for a constraint exceeds this limit, the allowed values are not shown in the response for that constraint.
This value can be set to any integer from -1 to 10,000. The default value is -1, which means that no limit is defined.
mksis.databaseBackupLocation
Specifies the backup path for the embedded Derby database.
Default is installdir/bin/backup.
mksis.includeIntegrityGUILinks
Controls PTC RV&S client URL links in e-mail notifications generated by the PTC RV&S client and the server.
When set to true, integrity:// links are included in all client- and server-generated e-mail notifications. The PTC RV&S URL link appears after the http:// Web URL link.
When set to false, integrity:// links are excluded from client- and server-generated e-mail notifications.
Default is true (enabled).
If this property is enabled, the following virtual fields can be added to PTC RV&S reports using the client GUI and Web interface: Current Item ID (GUI Link), Test Case ID (GUI Link), Test Step ID (GUI Link). The virtual fields appear as hyperlinks in reports. Disabling this property does not impact PTC RV&S reports that already contain those fields; reports that contain those fields continue to contain them even if other edits are made (unless explicitly removed by the user).
* 
Changes to this property take effect immediately.
This property has no effect on http:// Web URL links.
For more information on PTC RV&S client URL links, see the PTC RV&S Help Center.
mksis.flexLicenseInterval
Controls how frequently (in seconds) the FLEX license usage is polled and recorded in the server statistics. If multiple PTC RV&S servers point to the same FLEX license server, enable this setting on one PTC RV&S server.
Default is 0 (disabled).
mksis.groupCacheRefreshInterval
Controls how frequently (in seconds) the realm’s group cache is refreshed in the background. The minimum allowed value is 300 seconds.
* 
The new cache refresh properties replace the mksis.cacheDurationproperties that controlled the caching of various internal realm-dependant values. Previous values are not migrated to the new properties. If you had customized the settings for the mksis.cacheDurationproperties, you should review the new cache refresh properties to determine if the default values should also be customized in your environment.
The default value is 3600 (seconds), equaling an interval of one hour.
This property is dynamically updated by the server and new values take effect as soon as the changes are saved.
mksis.heartbeat
For high availability fail-over server configurations, the heartbeat is the number of seconds that elapses before the secondary server starts after the primary server fails.
Default is 0 (disabled).
mksis.ldapCacheRefreshInterval
Controls how frequently (in seconds) the LDAP realm information is refreshed in the background. The minimum allowed value is 300 seconds.a
The default value is 43200 (seconds), equaling an interval of 12 hours.
This property is dynamically updated by the server and new values take effect as soon as the changes are saved.
mksis.logging.additional
Specifies additional logging categories to be modified. The policy is in the format category:level[,category:level...]. When the property is changed, the specified categories are modified. To disable a category, specify a level of -1 (do not remove the category). This property should not be modified manually, but be set by the logging command with the --permanent option.
mksis.logging.count
Number of log files to be maintained. If this number is exceeded when the log file is rolled over, then the oldest is deleted. This policy is only effective if logging is appropriately configured in the log4j2.xml file. There must be an appender named ExceptionAwareRollingFile with name LogToServerLog. This is the default with new installations; however, older installations may require reconfiguration.
Default is 50.
* 
The server updates the log4j2.xml file based on the changed value of this property. Ensure that the file has the required read and write permissions. The server fails to start if the file is not writable.
mksis.logging.email.from
E-mail address sending log error e-mail messages.
* 
The address may not contain spaces. For example, PTC RV&S Server@ptc.com or PTC RV&S Administrator is not acceptable.
If you are using closed SMTP mail relay, ensure that the e-mail address entered here must match the e-mail address entered in the is.properties file.
mksis.logging.email.subject
Subject displaying in log error e-mail messages.
Default is PTC RV&S serverErrors.
mksis.logging.email.threshold
Log messages at the specified level are e-mailed to the addresses listed in mksis.logging.email.to. Log messages explicitly tagged for e-mail are always sent. Acceptable values include: DIAGNOSTIC, WARNING, ERROR or FATAL.
Default is FATAL.
* 
To prevent a potentially high volume of e-mail, retain the default FATAL value.
mksis.logging.email.to
Comma-delimited list of e-mail addresses to send PTC RV&S server log messages to.
* 
This property and mksis.mailserver must be configured to send log error messages.
mksis.logging.inmemory.errorcount
Number of error log lines retained in memory. The log output displays recent server errors.
All lines are retained in memory, so setting the size too high can impact server performance.
Default is 50.
mksis.logging.inmemory.linecount
Number of log lines retained in memory. The log lines display recent server log output.
All lines are retained in memory, so setting the size too high can impact server performance.
Default is 500.
mksis.logging.licenseExpiry.enable
Controls logging of license expiry warnings. If set to true, PTC RV&S licenses are checked periodically and a warning is logged if a license is expired or set to expire within the next week. An e-mail message is sent to the administrators listed in the mksis.logging.email.to property, displaying the license expiry date, log message, and license server details.
On Linux, logging at the ERROR log level writes to the SYSLOG.
If the mksis.logging.email.to and mksis.mailserver properties are set, the e-mail message displays all ERROR events (including the license expiry warning).
Default is true.
mksis.logging.rollover.ToEnd
Log file naming during rollover. When the log size is hit, the log file is renamed from server.log to server.#.log. If set to true, this policy sets # as one more than the largest number found in the log directory. If set to false, this policy sets # as 1, with all other log files being renumbered upwards. This policy is only effective if the logging is appropriately configured in the log4j2.xml file.
There must be an appender ExceptionAwareRollingFile with name LogToServerLog. This is the default with new installations; however, older installations may require reconfiguration.
Default is true.
mksis.logging.size
Size of the log files, in megabytes, before they are rolled over. This is just an estimation; the actual rollover may not occur immediately. This policy is effective only if logging is appropriately configured in the log4j2.xml file.
There must be an appender ExceptionAwareRollingFile with name LogToServerLog. This is the default with new installations; however, older installations may require reconfiguration.
Default is 10.
* 
The server updates the log4j2.xml file based on the changed value of this property. Ensure that the file has the required read and write permissions. The server fails to start if the file is not writable.
mksis.logging.syslog.enable
PTC RV&S Server provides the following pre-set syslog appender configuration in a commented out format in the log4j2.xml file:
format = RFC5424
appName = RVSServer
facility = Local7
newLine = true
If you wish to enable the preset configurations, do the following:
Set mksis.logging.syslog.enable to true and uncomment all occurrences of LogToSyslog appender.
Restart the server to reload the configuration changes done in the log4j2.xml file.
If you wish to use a customized configurations, do the following:
Set mksis.logging.syslog.enable to false.
Manually add the required SyslogAppender configuration to the log4j2.xml.file.
Restart the server to reload the configuration changes done in the log4j2.xml file.
mksis.logging.syslog.hostname
Specifies the syslog host name, where errors are logged to the syslog daemon.
Default is localhost.
mksis.logging.syslog.port
Specifies the default syslog port number used to send logging messages to the syslog daemon.
Default is 514.
mksis.logging.syslog.protocol
Specifies the protocol used to transport logging messages to the syslog daemon.
Default is UDP.
mksis.mailserver
Name of mail server used by event trigger environment bean method sendMail(). For example, to use the emailAdvanced.js trigger script, this property must be set. Default is property not enabled.
Port of mail server used for e-mail notification and by event trigger environment bean method sendMail(). Default port is 25.
Host name or TCP/IP address of SMTP server for e-mail notification. Must specify to enable e-mail notifications, for example, mksis.im.smtpserver=smtp1.abc.com.
Default is :25.
* 
You can also use this property and mksis.logging.email.to to e-mail PTC RV&S Server log error messages. For more information, see the following properties:
mksis.logging.email.threshold
mksis.logging.email.to
mksis.logging.email.from
mksis.logging.email.subject.
mksis.metrics.enableEndpoint
When set to true, enables the URL to provide statistical data in Prometheus metrics format.
Default value of the property is false.
mksis.metrics.allowedUsers
Enables the administrator to add the users who can access the metrics endpoint. For the value of the property, the administrator can add multiple usernames as comma separated values.
* 
To prevent inactive users from accessing the metrics, ensure that you do not include them in the allowed users list or remove them from the list as soon as their status changes to inactive.
mksis.metrics.enableLatency
Enables the capture of latency data for inbound and outbound data flows from both the main and FSA servers.
Default value of the property is false.
mksis.serverLicenseInterval
Controls how frequently (in seconds) the server license usage is polled and recorded in server statistics. To disable collection of server license usage data, set to 0.
Default is 60.
mksis.statisticsInterval
Number of seconds between server statistics recordings. To aid in diagnosing intermittent performance problems, lower the value.
Default is 3600.
mksis.statisticsPurge
Duration that server statistics are purged. Acceptable values are: weekly, monthly, or none (if you plan on performing this activity manually).
Default is weekly.
mksis.thingworx.websocket.appkey
This property is applicable only if you are using PTC Navigate Manage Traces. Set the value of this property to the PTC RV&S application key that you noted during the PTC Navigate Manage Traces installation and configuration process.
For more information, see the PTC Navigate Manage Traces Installation and Configuration Guide.
mksis.thingworx.websocket.url
This property is applicable only if you are using PTC Navigate Manage Traces. Set the value of this property to the URL of the ThingWorx WebSocket. The WebSocket protocol must specify a secure connection ( "wss://<server>:<port>/ThingWorx/WS”). A WebSocket secure (WSS) connection is required.
For more information, see the PTC Navigate Manage Traces Installation and Configuration Guide.
mksis.triggers.environmentalVariables
File containing runtime properties for event trigger environment beans. Default is data/triggers/env.properties.
* 
For any changes to take affect, the server must be restarted.
mksis.triggers.scripts
Directory location for event trigger scripts.
Default is triggers/scripts.
* 
For any changes to take affect, the server must be restarted.
mksis.userCacheRefreshInterval
Controls how frequently (in seconds) the realm’s user cache is refreshed in the background. The minimum allowed value is 300 seconds.a
The default value is 3600 (seconds), equaling an interval of one hour.
This property is dynamically updated by the server and new values take effect as soon as the changes are saved.
mksis.webservices.tmpfile.enable
Controls whether or not the Web Services temporary file deletion thread is enabled. The default value is true, allowing the deletion of temporary files.
mksis.webservices.tmpfile.ageThreshold
Determines how old (in minutes) the Web Services temporary files can be before being deleted. The default value is 1440(or 24 hours), allowing the deletion of temporary Web Services files that are 24 hours old.
mksis.webservices.tmpfile.repeatDelay
Determines the frequency (in minutes) for running the Web Services temporary file deletion thread. The default value is 120(or 2 hours), allowing the deletion thread to run every 2 hours.
mksis.httpSessionTimeout
Sets the timeout for the server’s global HTTP sessions. If an HTTP session remains inactive for longer than the timeout period, the session expires. Sessions associated with the Web interface can avoid this timeout if they are artificially kept active with the mksis.httpSessionHeartbeat property. A value of 0 effectively ignores this property and the session timeout for the Web interface becomes the server's configured value. The value is stored as seconds.
Default is 300.
mksis.httpSessionHeartbeat
If set to true, the Web interface issues a “heartbeat” to artificially keep the HTTP session active while the browser window is open. If set to false, the HTTP session expires after the time specified in the mksis.httpSessionTimeout property.
Default is true.
mksis.apiHttpSessionTimeout
Sets the timeout for the server’s API HTTP sessions. The value is stored in seconds.
Default is 3600.
mksis.httpSessionWindow
Sets the duration in seconds that the Web interface heartbeat must ping the server before the HTTP session expires.
See mksis.httpSessionTimeout for details.
mksis.concurrent.enableBatchEditParallelization
If set to true, parallelization is enabled for performing batch edit operations.
Default is false.
* 
On setting the value of this property to true, batch edit happens in parallel for all the selected items and the operation is terminated on the first encountered error. The error message lists the item id of the item in which the error was encountered.
mksis.concurrent.maxThreadsPerCPUCore
Indicates the number of threads per CPU core to be allocated for concurrent execution.
Default value is 14
Minimum value is 1
Maximum value is 16
mksis.concurrent.taskLimitForCommonPool
Indicates the upper limit of the number of tasks to be processed concurrently using the common thread pool. The number of tasks beyond this limit will be executed using separate thread pools.
Default value is 256
Minimum value is 8
Maximum value is 1024
mksis.concurrent.commonPoolRatioInPercentage
Indicates the percentage allocation of the number of threads to be used by a common thread pool. The remaining number of threads will be used for separate thread pools.
Default value is 50
Minimum value is 0
Maximum value is 100
mksis.concurrent.maxThreadsForAdditionalPool
Indicates the number of threads allocated for each of the additional pools. The number is set to 0 if the allocation is done programmatically.
Default value is 0
Minimum value is 0
Maximum value is 16
Was this helpful?