General system settings are organized into multiple tabbed sections.
The URL to use as the valid externally accessible URL of the Collaborator server. If the port number is other than default 8080, then specify it as well.
This URL will be reported to clients, used in notification emails, webhooks and so forth.
|System Message||Administrators can optionally insert a message to display throughout the system. This can be useful for reminders, Collaborator announcements, or general information.|
|Name||A caption for the block of extra links.|
|Extra Dashboard Links||
List of additional links to display on the Home page. One link per line.
Specify links in the following format:
|Show System Fun Facts||
Fun facts are lines of information displayed on the Home page. Collaborator rotates through a number of internal facts based on aggregated review metrics.
Set this to Hide and remove extra fun facts from the list to disable the feature.
|Extra Fun Facts||Additional lines that can be displayed as fun facts.|
This tab contains settings that affect the visual appearance of the web interface, its labels, prompts, and so forth.
|Company / Unit||Arbitrary text that will be displayed at the top of the Collaborator web page. This distinguishes the server from other servers. This personalizes the server and also makes it easy for users to distinguish between different installations you might have.|
|User Login Prompt||
The text to display on the front page when the user logs in. This text is displayed just below the Username field.
The default text suggests using the same login as the version control system, however you might want to change this to be more specific. Or, in the case of LDAP authentication, you could instruct the user to use that login.
|Global "Create User"||
If you are not using LDAP authentication, every user in the system must be explicitly created. The system administrator can create users at any time, but an easier technique is to allow users to create their own accounts from the Login screen.
When this option is enabled, this account creation form is displayed, otherwise it is hidden.
This option is not needed if you are using LDAP authentication. In that case, user accounts are created automatically when a user first successfully authenticates on the Login screen.
|Default Tab Width||
Default width of a tab, in spaces, to use when displaying source code for all users.
Users can customize the tab width by going to the Display Options Panel in the Diff Viewer and configuring the Tab Width option.
|Chat Refresh Interval||
The minimum time (in seconds) to wait before auto-updating chat conversations in the Diff Viewer.
If you increase the refresh time, new chat display will become less responsive, but server load will decrease. This also reduces contention for connections on the browser side because most modern browsers limit the number of simultaneous server connections to 2.
|Name Abbreviation Length||The minimum number of letters to use when abbreviating user names during a review.|
|Defect Label (singular)||
User-visible label for defect (lowercase). Appears in phrases like
|Defects Label (plural)||
User-visible label for defects (lowercase). Appears in phrases like
|Group Label (singular)||
User-visible label for Group. Appears in phrases like
|Group Label (plural)||
User-visible label for Groups. Appears in phrases like
|Compact View||When this option is enabled, some user interface elements will be collapsed to occupy less vertical space.|
|Allow Users to Move Comments||(BETA) Allow users to move comments in MS Word documents (.doc and .docx), PDFs and images. Supported in Chrome and Firefox only.|
Whether to display your company logo on Login screen and on Home screen and Review Screen, respectively. See Brand Your Server.
Once enabled, click on the placeholder or the current logo and upload new image with your company logo.
The company logo images must be in PNG format. Transparent background is recommended. Image resolution is not limited. Large images will be resized to fit into 640x480 area on the Login screen and into 250x50 area on the Home screen and Review Screen.
|Select default WebUI theme||Specifies the default pre-defined theme of the web interface. This specifies the visual style of the Web interface for new and existing users (unless they explicitly specify their own preferred WebUI theme in User Preferences).|
|Note:||Displaying your company logos is only supported in Collaborator Enterprise. For a complete list of differences between Collaborator editions, see About Collaborator Editions.|
This tab contains settings that control different types of access restrictions.
|Allow Regular Users to Perform System Dump||
Defines whether the regular users can perform the system dump.
Select Yes to allow users to access the system debugging information.
Defines who should be allowed to view the Reports section of the user interface. You can choose everyone, everyone but with review permissions applied, only administrators, or disabled (no one).
Enabled for everyone – Everyone will see the Reports section; no restrictions are enforced on what information is returned.
Respect permission – Everyone will see the Reports section; users can only see report content for reviews that they can access. Since administrators can always access all reviews, this setting does not affect the content of their reports.
Administrators only – Only administrators will see the Reports section.
Disabled – No one will see the Reports section.
|Allow Regular Users to Access Web UI Debugging||
Defines whether the regular users can access the Web UI debugging link Report Error located at the bottom of the Home page and Review Screen.
Select Yes to allow users to access the link.
|Subscriptions Access||Select Users to allow users to edit subscriptions. Select Administrators to provide access to administrators only.|
|Subscriptions Mode||Mandatory Enforce Role – Subscribed users must be participants in a review, and they must use the role specified on their subscription page.
Mandatory do not Enforce Role – Subscribed users must be participants in a review, however they can change their role once added to the review.
Requested – Subscribed users are automatically added to a review but can be manually removed.
Disabled – Subscriptions are not used.
|Allow Subscriptions as||Administrators can choose whether users that subscribe to a review can subscribe a moderator, reviewer, or observer by choosing Allow or Do not Allow from the drop-down lists below.|
|Restrict Access to Fix Defect||
Defines whether the system restricts the participants that can mark a defect fixed.
If set to Yes, only the creator of the defect and administrators will be able to mark a defect fixed. Otherwise, all roles that are allowed to mark a defect fixed will have such a privilege.
|Allow Create Review to||Specifies who is able to create new reviews. By default, every user can create a review. If set to Group members only, only users that belongs to a group other than All Users will be able create reviews.|
|Restrict Access to Review||
Defines whether the system always restricts access to review such that only certain users are allowed to view the review. In each review the review creator can select to further restrict access. Administrators can always access all reviews.
Anyone – No global restrictions on who can access reviews.
Group Based – Users must have access to the review group to access reviews.
Participants – Users must be participants in the review to access reviews.
Participants and Group Based – Users must be participants in the review and currently have access to the review group to access reviews.
Participant or Group Based – Users may be participants in the review or have access to the review group to access reviews.
|Restrict Upload to / Deletes from Review||
Defines whether only creators of a review are allowed to upload files to and delete files from a review.
If set to Yes, only review creators and administrators will be allowed to upload files to or delete files from the review. However, the option will be available on the Review Screen to override at the review creator’s discretion. If set to No, all participants will be allowed to upload and delete files.
|Allow Invite by Email||Defines whether it is possible to invite a colleague by email.|
|Restrict Email Invite||
Used for the Invite a colleague feature. The regular expression in this field is used to match email addresses that can be invited to reviews. For example,
|Allow Archive to ZIP||
Defines whether the system restricts access to archiving of reviews.
Administrators – Only users with administrator privileges can use this feature.
Group Administrators – Only users with administrator or group administrator privileges can use this feature.
All users – All users, who can access the review (based on the review permissions), can use this feature.
|Allow Archive to Zip for Open Reviews||Defines whether it is possible to archive a review in any phase. Otherwise only completed, canceled, or rejected reviews can be archived.|
|Allow Duplicate Group Names||Defines whether it is possible to create groups having the same names.|
This tab contains settings that control different aspects of review process.
|Allow System Administrator to Perform Reviews||
Defines whether the main system administrator is allowed to participate in reviews.
If you are using internal authentication the setting is typically No because the main administrator account is special and should be used only for system configuration and not to actually do reviews.
If you are using LDAP authentication, the setting is typically Yes, because the main administrator is usually an actual human being who will also want to participate in reviews.
This setting affects whether the system account is allowed to create a new review and whether it appears in, for example, drop-down lists for review participants.
|Allow "Mark All Read"||
Defines whether the users are allowed to mark all conversations read in one click in the conversation area of the Diff Viewer.
This is a convenient operation, so most administrators leave this enabled. However this makes it easy for someone to not actually read a lot of comments because they are not forced to visit each conversation individually.
|Allow Reopening Completed Reviews||
Defines whether the participants are allowed to reopen the review by making additional comments once a review has been completed.
If not allowed, an administrator is still able to re-open a review by clicking a link.
|Allow Editing General Information of Completed Reviews||Defines whether the participants are allowed to edit the review title and custom fields once a review has been completed. This setting does not apply to participant custom fields.|
|Create a Commit Action Item for Completed Reviews||By default, when a pre-commit review is completed, the author(s) are given an action item as a reminder to commit the changes to the underlying source control system. The author then has the option of using the Tray Notifier to commit the changes. In some workflows, this is not the correct behavior. In that case, choose Do Not Create to avoid this prompt.|
|Allow Deleting/Cancelling Reviews||
Defines whether a review creator or author can cancel or delete the review at any time.
If the selected is Do not allow, only an administrator will have the permissions to cancel a review. Other participants are never allowed to cancel a review.
|Allow Reject Review||
Reject review allows a user to stop a review which has passed the planning state but yet in a terminal state such as completed or canceled. Rejecting a review is different than canceling or deleting because the administrator can require the user to specify a reason for the rejection. The reason values can be configured in the Review Custom Fields section of the administration pages.
Administrators can always reject reviews. Select Administrators and Reviewers to allow non-observer participants to reject reviews.
|Default Review Deadline||If set to non-zero, this is the default number of days until reviews are due. If zero, users will not be prompted for a review deadline when creating a new review.|
Defines whether users are able to see that metrics are collected including time spent in review, number of defects, and so on.
If set to No, metrics are still collected and can be retrieved directly from the database, however the information is not displayed to the user during review or in the Reports section.
|Character Sets for Diff Viewer||
Gives users the option to view file contents in various character sets.
Usually the Collaborator character set auto-detection will detect the correct character set, but when it does not, users will be able to select between these character sets for displaying the file contents. To avoid confusion, limit this list to the character sets that you expect your users to require.
Click Supported Character Sets to view all supported character sets.
|Enable User File Activity Log||Specifies whether to log file activity of review participants. The gathered data is used when generating the File Activity section of Review Detail Reports.|
|Review Reject Reasons||List of reasons to choose from when rejecting a review. Leave this list empty if providing a reason is not required.|
|Who can hide files||Specifies who is able to hide and unhide files in reviews. Available options: Authors, Participants, Nobody.|
|What phases can you hide/unhide files||Specifies on what phases users could hide and unhide files. Available options: Planning only, Planning and Annotating, At any time.|
|When a hidden file changes||Specifies what action to perform in case the hidden file has been changed. Available options: Keep the file hidden, Un-hide the file.|
This tab holds settings that control electronic signature process.
|Note:||Electronic signatures are only supported in Collaborator Enterprise. For a complete list of difference between Collaborator editions, see About Collaborator Editions.|
|Enable Electronic Signature||
Electronic signatures allow users in the selected role(s) to either sign off on or decline to sign off on a completed review.
Global-based electronic signatures add an additional sign-off process for all reviews. Users whose roles were selected in the Roles that are required to sign-off on Reviews setting will be required to sign or decline the review once it is completed.
Template-based electronic signatures add an additional sign-off process only to reviews with specific templates. Users whose roles were selected in the Role Configuration screen will be required to sign or decline the review once it is completed.
|Roles that are required to sign-off on Reviews||Here, the admin can select one or more roles that will be prompted to sign off on completed reviews. This setting takes effect when global-based electronic signatures are enabled.|
|Sign Review Prompt||This is the text that will appear on the Review Screen next to the Sign button.|
|Decline Review Prompt||This is the text that will appear on the Review Screen next to the Decline button.|
This tab holds settings that control SAML single sign-on authentication. Check Single Sign-On to learn more about single sign-on authentication and Configure Single Sign-On via SAML for detailed instructions on enabling SAML single sign-on.
|Note:||Single sign-on authentication is only supported in Collaborator Enterprise. For a complete list of differences between Collaborator editions, see About Collaborator Editions.|
|Enable Single Sign-on||Enables SAML single sign-on authorization on this Collaborator server.|
The URL of the entity that is expected to receive the SAML message. In our case, this will be the URL of the Collaborator server.
For instance: https://yourcollabserver.com.
Your Collaborator server must be accessible to SSO server. Configure a firewall or enable tunneled connections to do so.
|SSO login endpoint URL||The URL where to redirect users for single sign-on procedure, if a session is not already established.|
|SSO logout endpoint URL||The URL where to redirect users for single logout procedure.|
|X.509 Certificate||The public certificate that establishes trust between SSO server and Collaborator server.|
|SAML NameIDPolicy Format||
Specifies the format of the
|Enable AD/LDAP lookup||Specifies whether Collaborator should retrieve user membership in groups from the LDAP/Active Directory. See Synching User Group Membership with LDAP/Active Directory.|
Defines the name of SAML response parameter that contains LDAP username. See Synching User Group Membership with LDAP/Active Directory.
If the parameter name is not specified, or the parameter returns empty value the synchronization is not performed.
This tab holds settings that allow create items in your bug tracking system directly from Collaborator reviews.
|Create Bug URL||
The URL to your bug tracking system that creates a new bug. Optionally use the special text
To track a defect externally, the user must first create the defect in Collaborator, then select and edit that defect to choose the Track Externally option.
These are the examples of URL for some popular bug-tracking systems:
This tab holds settings that relate to Command-Line Client, GUI Client and other desktop clients.
|Client Installer Link||
URL to the version of the client installers that you want presented to users of the system.
This is typically redirected to a local page maintained by the administrator.
|Minimum Client Build||
Minimum allowable build number for the various client applications including the Command-Line Client, the GUI Client, the Tray Notifier, and the Eclipse Plug-in.
Use this to ensure your clients are reasonably up to date. This is especially important if there is a feature or bug-fix you know is necessary for your system.
The help text in the GUI will identify the oldest stable, compatible build number and will list the most recent known build number for your reference.
|Login Ticket Time-To-Live||
Defines how long a login ticket should remain valid. If
This tab controls how Collaborator server should treat certain types of files: images, binary, executables.
|Restricted File Types||
Specifies which files cannot be uploaded to reviews (to avoid malicious file uploads). By default, Collaborator blocks the following file types: executable files (.exe), batch files (.bat), Windows Installer files (.msi), Mac OS disk images (.dmg), and Unix script files (.sh).
Filename matching is done using the
|Binary File Types||
Binary files attached to reviews are not displayed in the Diff Viewer, and instead must be opened by external applications. Here you can configure which files are to be treated as binary.
Filename matching is done using the
|Image File Types||
Image files are reviewed in the browser in the Diff Viewer using a special image Diff Viewer. Here you can configure which files are treated as images. By default, GIF, JPEG, and PNG images are handled as images. The content of the files must be renderable by the users" browsers for images to actually be reviewable. Images that require special software to view should be treated as Binary Files so they can be rendered by that software.
Filename matching is done using the
|This tab is visible only if LDAP or Active Directory authentication is enabled.|
This tab specifies whether Collaborator should retrieve user settings and group members from the LDAP or Active Directory and defines the mapping between Collaborator user settings and LDAP/AD scheme attributes. For LDAP directories, mapping users requires additional configuration, as described in LDAP or Active Directory Authentication.
|Enable LDAP mapping||
Specifies whether Collaborator should retrieve user settings from the LDAP or Active Directory.
Once enabled, Collaborator will automatically populate user settings when a user logs into the server.
Defines the mapping between the respective user settings and the LDAP or Active Directory scheme attributes.
May contain attribute placeholders (attribute names enclosed in curly braces) and plain text:
If the attribute does not exist, or its value is not specified for some particular user, the placeholder will be replaced with blank value:
To learn about possible LDAP and Active Directory attributes, see this comprehensive list.
|Enable LDAP groups synchronization||
Specifies whether Collaborator should synchronize its native groups with group information from the LDAP or Active Directory.
Once enabled, Collaborator will check user membership in groups in the LDAP/Active Directory and automatically add this user to the corresponding groups on the Collaborator server. If a group with the specified name does not exist, Collaborator will act according to the "Automatically create new groups" setting below.
See Syncing Groups for details.
|Automatically create new groups||Specifies whether to create new groups on the Collaborator server when a group with the specified name does not exist. If enabled, Collaborator will create new group, if disabled Collaborator will only synchronize membership of existing groups.|
|Automatic group creation filter||A Java-style regular expression used to filter LDAP groups before automatic group creation. Any FQDN that does not match the pattern will be excluded.|