[Collapse]Collaborator 10
 [Expand]General Information/viewarticle/80040/
 [Expand]Getting Started/viewarticle/80359/
 [Collapse]Collaborator Server/viewarticle/80060/
  [Expand]Installation/viewarticle/80365/
  [Expand]Server Administration/viewarticle/80108/
  [Collapse]Collaborator Settings/viewarticle/80061/
    System/viewarticle/80070/
    Email/viewarticle/80098/
    Version Control/viewarticle/80064/
    Triggers/viewarticle/80100/
    Remote System Integration/viewarticle/80059/
    System Status/viewarticle/80104/
    Users/viewarticle/80086/
   [Expand]Groups/viewarticle/80073/
    Review Templates/viewarticle/80069/
    Custom Fields/viewarticle/80062/
    Checklists/viewarticle/80068/
    Roles/viewarticle/80077/
    Automatic Links/viewarticle/80056/
    Notification Templates/viewarticle/80058/
    Savings Report/viewarticle/91110/
 [Expand]Web Client/viewarticle/80107/
 [Expand]Desktop Clients/viewarticle/80151/
 [Expand]Version Control Integration/viewarticle/80048/
 [Expand]External Integrations/viewarticle/80340/
 [Expand]Techniques & Best Practices/viewarticle/80403/
 [Expand]Appendices/viewarticle/80117/
Updated: 12/23/2016 Applies To: Collaborator 10 Rating: No votes Click to rate: PoorNot badAverageGoodExcellent

Collaborator Server > Collaborator Settings

Top |Previous |Next

Administration: General System Settings

General system settings are organized into the following tabbed sections:

Settings

Settings Tab

This tab contains settings that affect the entire system.

admin-general-system

External URL

The URL to use as the "official" URL for the Collaborator server. This URL will be reported to clients, used in notification emails, and so forth. It should be something that is accessible from as many other computers as possible. If the port number is other than default 80, then specify it as well.

admin-general-systemwidemessage

System Message

Administrators can optionally insert a message to be displayed throughout the system.

This can be useful for reminders, Collaborator announcements, or general information.

admin-general-extralinks

Name

A caption for the block of extra links.

Extra Dashboard Links

List of additional links to be displayed on the Home page. One link per line. Links should be specified in the following format: LinkTitle - LinkURL

admin-general-funfacts

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 aggregate review metrics.

If this is set to "Hide" and there are no extra fun facts listed, this feature is completely disabled.

Extra Fun Facts

Additional lines to be displayed can be entered in this field.

Display Options Tab

This tab contains settings that affect the visual appearance of web-interface, its labels, prompts and so forth.

admin-general-display

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 create-account form is displayed, otherwise it is hidden.

This option does not make sense if you are using LDAP authentication because in that case user accounts are created automatically when a user first successfully authenticates on the Login screen.

Use Global Tab Width

If 'Yes' all users will use the same tab width. If 'No' each user can configure their own preference (the global setting is the default).

Global-Tab Width

Width of a tab (in spaces) for all users to use when displaying reviewed files.

Chat Refresh Interval

The minimum time (in seconds) to wait before auto-updating chat conversations in the diff viewer.

If 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" (lower case). Shows in phrases, like "Marked defect fixed". If the word 'defect' has a negative connotation in your environment, specify a different word (for instance, "item" or "finding" and so on).

Defects Label (plural)

User-visible label for "defects" (lower case). Shows in phrases, like "Can not finish because there are open defects". If the word 'defects' has a negative connotation in your environment, specify a different word (for instance, "items" or "findings" and so on).

Select Group Prompt

Text to display on the 'New Review' page prompting user to select a Group to associate with the Review.

Group Label (singular)

User-visible label for "Group". Shows in phrases, like "This Review is associated with that Group".

Group Label (plural)

User-visible label for "Groups". Shows in phrases, like "Select one of the Groups to associate with the Review".

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.

Company Logo on Loginand

Company Logo on Home

Whether to display your company logo on Login screen and on Home and Review Summary screens, respectively. See Branding Your Server.

Once enabled, click on the placeholder/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 Login screen and into 250x50 area on Home and Review Summary screens.

Note: Ability to display your company logos on Login and Home screens is only supported in Collaborator Enterprise. For a complete list of differences between Collaborator editions, please see the comparison page.

Access Restrictions Tab

This tab contains settings that control different types of access restrictions.

admin-general-access

Allow Regular Users to Perform System Dump

Should regular users be allowed to perform system dump?

Selecting "Yes" will give users, as well as administrators, access to the system debugging information.

Reports Access

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 permissions: Everyone will see the "Reports" section; users can only see report content for reviews that they can access. Note that 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.

Subscriptions Access

Selecting "Users" will allow users, as well as administrators, access to edit subscriptions. Choose "Administrators" to give access to only administrators.

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 ...

The Administrator can choose whether users that subscribe to a review can subscribe as a Moderator, Reviewer, or Observer by choosing "Allow" or "do not Allow" from the drop downs below.

Restrict Access to Fix Defect

Should the system restrict 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

Should the system always restrict 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's associated 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's associated group to access reviews

Participant or Group Based: Users may be participants in the review or have access to the review’s associated group to access reviews

Restrict Uploads to / Deletes from Review

Should only creators of a review be 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 Create Review screen to override at the review creator's discretion. If set to "no," all participants will be allowed to upload and delete files.

Note: This feature is only supported in Collaborator Enterprise. For a complete list of differences between Collaborator editions, please see the comparison page.

Search

Sets the limits on the Search feature. "Allow Searching of all text" enables unrestricted searching, while "Limit searches to review numbers only" limits the search feature to only allow searching for review ID numbers.

Allow Invite by Email?

Should it be possible to invite a colleague by e-mail?

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, '[\w\.-]+@company.com'.

Allow Archive to zip

Should the system restrict 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 duplicate group names

Should it be possible to create groups having the same names?

Review Process Tab

This tab contains settings that control different aspects of review process.

admin-general-reviewoptions

Allow System Administrator to Perform Reviews

Should the main system administrator be allowed to participate in reviews?

If you are using internal authentication the setting is typically "no" because the main "admin" 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"

Should users be given the option 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

Once a review has completed, should participants be allowed to re-open the review just by making an additional comment?

If not allowed, an administrator is still able to re-open a review by clicking a link.

Allow Editing General Information of Completed Reviews

Once a review has completed, should participants be allowed to edit the review title and custom fields? 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

Should the review creator or author be able to cancel the review at any time?

If "do not allow" is selected, 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 cancelled. Rejecting a review is different than cancelling 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.

Show Metrics

Should users be 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

Give users the option to view file contents in various character sets.

Usually Collaborator's 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 File Activity section of Review Detail Reports.

admin-general-rejectreasons

Review Reject Reasons

List of reasons to choose from when rejecting a review. Leave this list empty if providing a reason is not required.

Electronic Signatures Tab

This tab holds settings that control electronic signature process.

Note: Electronic Signatures are only supported in Collaborator Enterprise. For a complete list of differences between Collaborator editions, please see the comparison page.

admin-general-electronic-signatures

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 adds 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 summary screen next to the Sign button.

Decline Review Prompt

This is the text that will appear on the review summary screen next to the Decline button.

Bug-Tracking Integration Tab

This tab holds settings that allow create items in your bug tracking system directly from Collaborator reviews.

admin-general-bugtrack

Create Bug URL

The URL to your bug tracking system that creates a new bug. Optionally use the special text BUGSUBJECT as the starting subject line for the bug. This setting is used when the user is prompted to create a bug in your external issue tracking system.

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.

Below are examples of URL, for some popular bug tracking systems:

FogBugz: http://bugserver/default.php?command=new&pg=pgEditBug

Bugzilla: http://bugserver/enter_bug.cgi

JIRA: http://bugserver/secure/CreateIssue!default.jspa

External Clients Tab

This tab holds settings that relate to Command-Line Client, GUI Client and other desktop clients.

admin-general-versions

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 an intranet 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. A value of '0' indicates that the ticket remains valid eternally.

File Types Tab

This tab controls how Collaborator server should treat certain types of files: images, binary, executables.

admin-general-restrictedfiletypes

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 '*' and '?' wildcards characters. '*' matches 0 or more contiguous characters, and '?' matches exactly one character. The character matching is case-insensitive on Windows platforms and case-sensitive on all other platforms.

admin-general-binaryfiletypes

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. By default, Microsoft Word, Microsoft Excel and Rich Text files are considered binary.

Filename matching is done using the '*' and '?' wildcards characters. '*' matches 0 or more contiguous characters, and '?' matches exactly one character. The character matching is case-insensitive on Windows platforms and case-sensitive on all other platforms.

admin-general-imagefiletypes

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 '*' and '?' wildcards characters. '*' matches 0 or more contiguous characters, and '?' matches exactly one character. The character matching is case-insensitive on Windows platforms and case-sensitive on all other platforms.




© 2019 SmartBear Software. All rights reserved.
Email Send feedback on this document