This topic describes some of the most frequently used Java Virtual Machine options.
You can find the options for the Java Virtual Machine in the
.vmoptions files that are located in Collaborator install folder. The file name corresponds to the name of the appropriate executable file.
For server the path will be: <Collaborator Server>/ccollab-server.vmoptions
For command-line client the path will be: <Collaborator Client>/ccollab.vmoptions
For GUI client the path will be: <Collaborator Client>/ccollabgui.vmoptions
|You must restart the Collaborator server or client before these settings take effect.|
To specify Java system properties that will be available to Collaborator, use this syntax:
|The last line in the
The maximum number of threads allocated to convert binary documents into images for review. This value must be a positive integer. Default is 4.
If set to a non-blank value, this property prevents the Collaborator server from checking for license updates.
A Boolean setting (values: true/false) to disable in-product chat for trial users.
The number of milliseconds to wait between attempts to connect to the SMTP server.
The maximum number of e-mails sent during a single check up for stalled reviews and reviews approaching deadline. Default is 100.
A Boolean setting (values: true/false) to disable SAML single sign-on authentication.
A Boolean setting (values: true/false) to disable comments in review materials. If enabled, only defects can be added. Default is false.
The time in milliseconds to allow database queries to run before logging a warning message. This is used to help debug bottlenecks and characterize the behavior of complex queries such as those used by the custom reports system. Default is 2000 milliseconds.
The time in milliseconds to wait between updating remote system item statuses. For those remote systems which do not support webhooks. Default is 120000 milliseconds.
The time in milliseconds to wait for issue creation meta info from the remote issue-tracker. Default is 60000 milliseconds.
The time in milliseconds to wait between pull request update and a call to Bitbucket server API. Default is 5000 milliseconds.
Specifies the timeout (in milliseconds) of the remote system connection when updating remote system item statuses. Default is 3000 milliseconds.
Specifies the preselected search scopes for reviews in the Oracle database. Can be empty (no preselected scopes), or can contain any combination of the following comma-separated values:
id- Search for substring matches among review identifiers.
title- Search for substring matches among review titles.
creator- Search for substring matches among review creators.
reviewCustomFields- Search for substring matches in review custom fields.
checklistCustomFields- Search for substring matches in checklist custom fields.
participantCustomFields- Search for substring matches in participant custom fields.
Specifies the preselected search scopes for changelists in the Oracle database. Can be empty (no preselected scopes), or can contain any combination of the following comma-separated values:
comment- Search for substring matches in changelist comments.
author- Search for substring matches among changelist authors.
scmIdentifier- Search for substring matches among changelist identifiers.
Specifies the preselected search scopes for files in the Oracle database. Can be empty (no preselected scopes), or can contain the
fileName value to preselect a search scope for substring matches in filenames.
Specifies the preselected search scopes for defects in the Oracle database. Can be empty (no preselected scopes), or can contain any combination of the following comma-separated values:
text- Search for substring matches in defect descriptions.
customFields- Search for substring matches in defect custom fields.
Specifies the preselected search scopes for comments in the Oracle database. Can be empty (no preselected scopes), or can contain the
conversations value to preselect a search scope for substring matches in review comments.
The number of entries allowed in the diff cache. The size of any given entry can vary significantly, but this tuning parameter provides a rough mechanism for tuning the cache size. Default is 2000.
The resolution scale of converting PDF and Word documents into images displayed in DiffViewer. Default is 162.
We do not recommend changing this option unless DiffViewer has troubles displaying small characters, diagrams or documents look blurry. In this case, to get clear images, you will need to increase the resolution scale, restart Collaborator server and clear browser cache.
The maximum size of the parse lines cache. Values should be a memory size in kilobytes or megabytes indicated by the case-insensitive suffixes "k" and "m" respectively. For example, 20 megabytes could be indicated by "20m" or "20M". Default value is 5 megabytes.
The maximum number of entries in the client log file which is enabled by Capture Debugging Log. The default value is 160000 which results in a log file that is approximately 50MB.
The delay, in milliseconds, between runs of the application state recorder. The state recorder periodically writes information about the state of the application into the database for future trend analysis. Default is 15 minutes.
The delay, in milliseconds, before the application state recorder starts. Delaying the application state recorder allows the application initialization process to complete before anything is written to the database. Default is 5 minutes.
The maximum number of chat update requests allowed per minute. This value will be used for active reviews and the clients and servers will automatically scale back the request rate as activity on the review declines.
A Boolean setting (values: true/false) to hide the Collaborator News panel in the WebUI.
Specifies whether Web Clients will use Adobe Flash component to upload files. By default, the option is disabled and Web Clients use more secure HTML5 component for uploads.
A Boolean setting (values: true/false) that specifies whether to disable author check-up of Perforce changelists. If set to true, users could upload changelists of other authors.
The timeout, in milliseconds, for SMTP connections. The value must be a positive integer.
The timeout, in milliseconds, for SMTP requests. The value must be a positive integer.
A Boolean setting (values: true/false) to indicate whether or not accepted comments should be ignored in the reporting of review statistics in the Review Detailed Report.
The timeout, in seconds, for XML-RPC sessions. The value must be a positive integer. Default is 30.
Applies to the triggers on the Admin > Triggers page. Specifies the maximum allowable time for the trigger execution in seconds. If the execution time exceeds this value, Collaborator stops the trigger and logs an exception. 0 means there is no limit set.
Specifies the authentication adapter used to authenticate users. Do not set this property unless directed by SmartBear technical support.
Specifies if the reviewers in Waiting state will receive notifications of other participant/author activity during the Rework phase. If this option is not specified or is true, reviewers will get notifications, otherwise they will not.
Prevents review pools from being deleted. If a review pool group name matches the specified regular expression, this group cannot be deleted.
A Boolean setting to allow the roles of the locked review pools to be changed by anyone.
This setting has effect only if the
com.smartbear.reviewpools.lock.regex setting is specified.
A comma-separated list of system role names that are allowed to modify locked review pools and their roles. Administrators are always allowed to modify the locked review pools and their roles.
This setting has effect only if the
com.smartbear.reviewpools.lock.regex setting is specified.
A generic Java machine option that specifies the location of the Java keystore file containing the collection of CA certificates trusted by this application process (trust store).
This option is NOT recommended. To set trust store location for Collaborator tomcat server it is better to use
truststoreFile attribute the
Connector element of the <Collaborator Server>/tomcat/conf/server.xml configuration file.
Specifies whether to include comments and whitespaces when calculating line of code (LOC) metrics. If set to
SLOC, comments and whitespaces will be ignored in metric calculations.
If set to a non-blank value, this property indicates that Collaborator server is running on 32-bit Java virtual machine. This indication is needed for accurate creation of dump file.
A Boolean setting (values: true/false) that specifies whether webhooks created by the Easy Add Repository would have SSL verification enabled or disabled.
By default, SSL verification of webhooks is disabled to avoid handshake issues on Collaborator servers with self-signed or untrusted certificate authority (CA) root certificates.
Specifies the minimum zoom level (in percentage) of images, Word and PDF files displayed in Diff Viewer. Default is 10.
Specifies the maximum zoom level (in percentage) of images, Word and PDF files displayed in Diff Viewer. Default is 500.
Specifies the increment of zoom level (in percentage) of images, Word and PDF files displayed in Diff Viewer. Default is 10.
A Boolean setting (values: true/false) that specifies which predicate (REGEXP_LIKE or LIKE) Collaborator will use to query the data from Oracle database.
By default, when this option is not specified or when the option is set to false, Collaborator uses REGEXP_LIKE predicate in queries.
When the option is set to true, Collaborator will use a faster LIKE predicate in queries. We recommend to use this option if you encounter performance issues on Oracle database.
The following properties are specific to Collaborator clients:
The size, in bytes, to truncate uploaded files in the changelist. This threshold prevents clients from inadvertently overloading the server with files too large to process. The minimum threshold value is 4MB.
If any of your clients uses this option, avoid using the
ensure-content-reviewed triggers. In this case, these two triggers will compare only the remaining parts of the truncated files. Consider using the
ensure-reviewed trigger instead.
A Boolean setting (values: true/false) to indicate whether or not certain binary files (specified by the Binary File Types setting) are ignored when uploading changelists.
A Boolean setting (values: true/false) to use project path instead of configpath if your PTC projects have variant sub-projects.
There are two aspects that affect the Java Virtual Machine regarding memory management and that may affect application performance. One is the maximum heap size and the other is the configuration of the garbage collector (GC).
The default maximum heap size that is available for Collaborator client applications depends on the Java Runtime Environment (JRE) version being used: 64 MB if you have JRE version 5.0 and earlier, or 1 GB or one quarter of physical memory (whichever is smaller) for later versions, unless your computer has only one processor or less than 2 GB of RAM (in this case, 64 MB will be used).
By default, the maximum heap size for the Collaborator Server is set to 1 GB. You can increase the maximum heap size by using the
-Xmx switch. For example, to set the maximum heap to 2 GB, use the following line:
You can use the letters
K to specify gigabytes, megabytes and kilobytes. You can specify only whole numbers. So, for example, instead of using
-Xmx1.5G, you have to use
-Xmx1536M. Note that some Java virtual machines do not support the
Increasing the maximum heap size can help you if you got the errors like
java.lang.OutOfMemoryError: Java heap space errors in your logs.
We recommend that you increase the maximum heap size to 2 GB or even more, depending on the typical size of documents that your users upload to the server.
In addition to increasing the heap size, you will also likely need to change the garbage collector's settings, especially if you see the "
java.lang.OutOfMemoryError: GC overhead limit" error in your server logs, or experience severe performance degradation.
To change the garbage collector settings for the Collaborator Server, add the following line to the ccollab-server.vmoptions file:
If you are using Java 7 Update 45 or later, use the following line instead:
We do not recommend applying these settings, if your computer has 2 or fewer processors (cores). If you are running into performance issues when performing reviews, you should consider running the Collaborator Server in a system that has at least 4 processors (cores). Changing these garbage collector settings will improve your server performance, especially if you also use the
-Xmx option to increase the maximum heap size.
Note that the operating system can report that your Java process consumes more memory than the maximum heap size you specified. This happens because other parts of the Java runtime, for example, PermGen, consume memory as well. You can try using the
-XX parameters to tune these parts. See Oracle HotSpot VM documentation for complete information. Note that quite often the
-X/-XX options are JVM-specific and Oracle can change them without notice. We recommend that you consult documentation of your Java Virtual Machine.
By default, the server will use the <Collaborator Server>/tomcat/temp subfolder under the Collaborator Server installation folder as the temporary folder. To use an alternate location, specify the Java temporary folder variable in ccollab-server.vmoptions, for example:
Similarly (though less likely to be needed), this can be done for the Collaborator clients in the corresponding
To configure server proxies, use the ccollab-server.vmoptions file. See Network Configuration for information on available settings.
To debug LDAP or SSL connection problems as well as other network related issues, add the following line to the ccollab-server.vmoptions file:
After restart, Collaborator will create an additional log file,
output.log, on the server computer with trace information on the issue.