User Preferences

Applies to Collaborator 14.7, last modified on December 18, 2024

To edit your settings and preferences, use the Settings menubar command:

Account Information

Login

The token you use to log into the system. Typically this will be identical to your version control login name.

Normally, you cannot edit your own login name. However, system administrators are able to edit anyone's login name, so contact an administrator if you need this done.

Password

The password needed to log into the system. Can be blank for "no password," although in all cases the password will be displayed with many dots as shown in the screenshot above. This prevents the causal observer from knowing anything about your password, even its length.

Password can include only Latin uppercase/lowercase letters, digits and the following special characters !@#$%^&*()-_+.

When changing your password you have to type it in twice to confirm.

Instead of using password, you can use login ticket for authentication in Collaborator desktop clients. Login tickets are special alpha-numeric identifiers that act as user credentials for a limited time period. By default, tickets are valid for 30 days. Collaborator administrators can decrease or increase ticket's time-to-live.

To obtain a ticket, press Generate Login Ticket and copy the resulting alpha-numeric identifier. Now you can specify it instead of password in Collaborator desktop clients. Generating new login ticket, invalidates any existing login tickets.

To invalidate any existing login tickets, press Invalidate Login Ticket. This will cause Collaborator desktop clients to re-authenticate.

First Name and Last Name

Your first and last name, respectively.

If your server uses LDAP or AD authorization, these fields are read-only.

Department

Name of your department, if any.

If your server uses LDAP or AD authorization, this field is read-only.

Display Name

Your display name as seen by other users everywhere in the system. Up to 128 characters long. Typically, you can modify this setting yourself. However this can be disabled by Collaborator administrations, so that only administrators could modify all user display names.

If you leave this field blank your login name will be used for your name. This is undesirable however; most other users will not know you by your login name.

Phone Number

The phone number other users can reach you at. This field is optional.

Time Zone

Your time zone. This will be used to determine users's displayed date/time.

This is defaulted to the time zone selected on the Collaborator server.

Is Administrator

Controls whether you are a system administrator. Typically, you are not able to change this field, unless you are an administrator. Be careful: If you remove administrative access from yourself, there is no going back! (Unless another administrator adds you back.)

Is Enabled

This field is used by system administrators to determine whether you are allowed to log into the system. If you are looking at your preferences, you can log in, so you will always see this as "enabled".

Permissions Information

Can Edit Templates

Controls whether you have permissions to manage templates. Typically, you are not able to change this field, unless you are an administrator.

Can Edit Custom Fields

Controls whether you have permissions to manage custom fields. Typically, you are not able to change this field, unless you are an administrator.

Can Edit Checklists

Controls whether you have permissions to manage checklists. Typically, you are not able to change this field, unless you are an administrator.

Can Edit Roles

Controls whether you have permissions to manage roles. Typically, you are not able to change this field, unless you are an administrator.

Can Edit Automatic Links

Controls whether you have permissions to manage automatic links. Typically, you are not able to change this field, unless you are an administrator.

Can Create Child Groups

Controls whether you have permissions to create child groups. Actual for group administrators. Typically, you are not able to change this field, unless you are an administrator.

Can Configure Remote Systems

Controls whether you have permissions to manage remote system integrations. Typically, you are not able to change this field, unless you are an administrator.

Can Modify Completed Reviews Without Re-opening

Controls whether you have permissions to modify review details after the review is closed. If enabled, you can modify general review information and add comments in the Chat section of closed reviews even when you are not participant of that review. Typically, you are not able to change this field, unless you are an administrator.

Can create new Projects

Controls whether you have permissions to create projects. Permission is enabled when Allow to create Projects option is set to "Specified users only".

Notification Preferences

Email Address

The email address that you want all notifications delivered to, and also to display to other users in the system in case they want to contact you directly via email.

Although this field is technically not required, you really should fill it in, and if you do not, you will get a warning in your Action Items list.

Notification Level

This controls how many emails you want to get. See the Explain link for details on the options. Generally, these are the choices:

  • Get all notifications, even if you were the cause of the notification event.
  • Get notification only of those events that you did not cause yourself.
  • Get no email notifications.

Notification Channel

Specifies how to deliver notifications: as e-mail notifications, as in-app notifications or use both channels.

Default Wait State

Specifies the default level of notifications when you perform the "Wait" action during reviews. Possible values are:

  • Any Activity Occurs
  • Activity by Author Occurs
  • File Activity Occurs
  • Someone Pokes Me

Default Send To State

Specifies the default level of notifications when you perform the "Send To" action during reviews. Possible values are:

  • Any Activity Occurs
  • Activity by Author Occurs
  • File Activity Occurs
  • Someone Pokes Me

Get CC'ed

This allows you to receive copies of notifications on changes if you are the author of the review.

Display Preferences

Tutorial Mode

Controls whether those little yellow tutorial boxes are displayed throughout the system. By default, these boxes are displayed to help you understand the user interface.

Revision Ordering

Controls how file revisions are displayed, alphabetically or by order of upload.

Materials Display Mode

Allows the selection of the default display mode (Overlay or Separate) of materials on the Review Screen.

File View

Controls which style should be used to display files within a changelist. Choices include Compressed Tree, Tree, or Flat.

Compact View

When enabled, the Review Screen is presented in a format that uses less vertical space.

Select WebUI theme

Specifies which of pre-defined Web Client themes you would like to use. This setting overrides the default WebUI theme selected by administrator.

Date Format Pattern

Specifies the preferred format of date values. The format pattern may include the following elements:

Element Description

yy

The last two digits of the year (that is, 2001 would be displayed as "01").

yyyy

The full year (that is, 2001 would be displayed as "2001").

M

The one- or two-digit month number.

MM

The two-digit month number. Single-digit values are preceded by a zero.

MMM

The three-character month abbreviation.

MMMM

The full month name.

d

The one- or two-digit day.

dd

The two-digit day. Single-digit day values are preceded by a zero.

EEE

The three-character weekday abbreviation.

EEEE

The full weekday name.

Allowed date separator symbols are: slash (/), dash (-), period (.), comma (,), blank space or empty separator (no symbols at all). Year, month and day of month portions are mandatory for date format patterns.

Below are some examples of date format patterns:

Pattern Displayed Value

yyyy-MM-dd

2001-05-15

d/M/yy

15/5/01

d MMMM yyyy, EEEE

15 May 2001, Tuesday

Time Format Pattern

Specifies the preferred format of time values. The format pattern may include the following elements:

Element Description

h

The one- or two-digit hour.

hh

The two-digit hour. Single-digit hour values are preceded by a zero.

m

The one- or two-digit minute.

mm

The two-digit minute. Single-digit minute values are preceded by a zero.

s

The one- or two digit second.

ss

The two digit second. Single-digit second values are preceded by a zero.

ms

The milliseconds.

a

The time would be displayed in the 12-hour format.

z

The alphanumeric time zone offset from UTC (that is, Pacific Standard Time would be displayed as "UTC-8").

Z

The four-digit time zone offset from UTC (that is, Pacific Standard Time would be displayed as "-8000").

Allowed time separator symbols are: colon (:), dash (-), period (.), comma (,) or blank space. Hour portion is mandatory for time format patterns.

Below are some examples of time format patterns:

Pattern Displayed Value

hh:mm

09:17

h:m:ss.ms

9:17:38.486

h:m a z

9:17 AM UTC-5

Default Revision Comparison of Diff Viewer

Allows the user to select which file revisions (if available) will be compared, by default, when the Diff Viewer is launched.

The available options are:

  • All - Compare the current revision of a file against its base revision - that is, a state of file before any changes related to current review have been made. For pre-commit reviews, base revision is the revision that you checked out from the repository. For post-commit reviews, base revision is the revision that precedes your commit.

  • First vs Last - Compare the most recent revision of a file against its first revision that was uploaded during this review.

  • Branch only - Compare the current revision of a file against its base revision excluding changes merged from other branches.

  • Last commit - Compare the current revision of a file and its previous revision.

  • Accepted - Compare the current revision of a file against its latest accepted revision. During the review, participants may accept some particular revisions of a file to denote that they agree with the changes. Uploading a further revision of that file clears the Accepted mark. If a participant has not accepted any revision yet, then compares the current revision of a file against its base revision.

  • Commits - Compare the most recent revision against any arbitrary revision chosen in the Select revision drop-down.

The Branch only mode may produce slightly different output depending on whether the review was created manually or via repository integration. In reviews created manually it is not always possible to filter-out merge changes, so sometimes they still could be displayed. Reviews created via integration have broader access to the repository and thus can exclude merge changes more thoroughly.

Enable Next Page Scrolling in Diff Viewer

Specifies whether Diff Viewer should display the next page when reached the end of current page in document reviews.

Default Scale for Documents in Diff Viewer

Specifies the initial zoom level when reviewing Word processing and PDF documents, presentations, images and vector graphics. You can set the scale to various percentages, Page Width or Full Page.

When you change scale of current document in the Diff Viewer it will be cached so that all further pages of that document would be displayed in the same scale.

Revision Caption Pattern

Specifies what information should be displayed as the revision caption in the simple mode of revision selection of  Diff Viewer. Any combination of the following is possible:

  • Provider - Display provider type, like 'git', 'mercurial', 'none', 'local changes', and so on.
  • Creation Time - Display item creation time.
  • Item ID - Display unique item identifier. For example, commit ID.
  • Description - Display item description. For example, commit message.

Ignore Whitespaces

Controls whether white-spaces are taken into account when showing differences.

This setting affects how line differences are displayed in Diff Viewer. Once enabled, line numbers and conversation position displayed in Diff Viewer may vary from line numbers and conversation position displayed in Review Screen and reports.

Ignore Capitalization

Controls whether capitalization is taken into account when showing differences.

This setting affects how line differences are displayed in Diff Viewer. Once enabled, line numbers and conversation position displayed in Diff Viewer may vary from line numbers and conversation position displayed in Review Screen and reports.

Ignore Sequence Number

Controls whether COBOL sequence numbers are taken into account when showing differences.

This setting affects how line differences are displayed in Diff Viewer. Once enabled, line numbers and conversation position displayed in Diff Viewer may vary from line numbers and conversation position displayed in Review Screen and reports.

Review Subscriptions Preferences

Review Subscriptions allow you to automatically subscribe and be included in reviews with a preferred author. In the Review Author field, select the login name of the user to whose reviews you would like to be subscribed. If no authors are selected for a given review, the subscription will use the name of the review creator instead - unless the review creator is flagged as a system admin. Choose your role type (Reviewer, Observer, or Moderator) in the review in the My Role field. Keep in mind that actual role names may vary depending on your role configuration.

Group Subscriptions Preferences

Group-based Subscriptions allow you to be automatically included in reviews where an author belongs to a given group at the moment, when review is created. In the Group field, the group to which you would like to be subscribed and where you are a member. Choose your role type (Reviewer, Observer, or Moderator) in the review in the My Role field. Keep in mind that actual role names may vary depending on your role configuration. If user is deleted from the group he/she was subscribed to, such subscription is deleted. Changes in group such as adding/removing users to/from group affect subscription behavior only for new review (created after changes in group). Subscription is applied to directly selected group only: child groups, if any, are ignored.

File Subscriptions Preferences

File Subscriptions allow you to automatically subscribe and be included in reviews where a particular file is under a review. Choose your role type (Reviewer, Observer, or Moderator) in the My Role field. In the File Pattern field, enter an Ant-style expression as the pattern to match the file(s) of interest. The expression will be matched to the file path and repository name; it will not look for matches in the complete repository path with URL and other server descriptions. Ant-style expressions can include "*" to match any substring within a given directory, or "**" to match any substring of any length, ignoring directory separators. If possible, avoid beginning the pattern with wildcard characters as it can significantly decrease the performance of subscription processing.

Template Subscriptions Preferences

Template Subscriptions allow you to automatically subscribe and be included in reviews having a particular template. Select the name of a template you would like to subscribe to in the Review Template field and specify your desired role type (Reviewer, Observer, or Moderator) in the My Role field.

Remote Accounts Preferences

Linking Collaborator  and source control accounts

Click the image to enlarge it.

Remote Accounts allow you to specify correspondence between your user name or email address in Collaborator and your accounts in various remote servers. These settings are used to match user names for Collaborator integrations with remote servers. See Link User Accounts.

See Also

Account Management

Highlight search results