Notification Templates

Applies to Collaborator 14.6, last modified on November 06, 2024

On the Notification Templates page, you can customize the content of e-mail and in-app notifications Collaborator sends to review participants. To learn more about these notifications, please see Notifications.

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

Notification Types

At the top of the page, there is a drop-down list of available notifications:

The notification template list

You can find a detailed description for each of these events below.

Edit notification template

To modify a notification template:

  1. Select the desired notification from the drop-down list.

  2. Specify the email subject in the Title Template box.

  3. Enter the text of the email in the Message Template edit box.

  4. Click Save to apply the changes.

  • The text in the Title Template and Message Template boxes can include Collaborator variables – for example, ${review.id} or ${review.creator.note}. With these variables, you can insert specific information about a review and user into notifications. To learn more about these variables, see Variable Substitution.
  • Any links to Collaborator server from the notifications, use server's URL as specified by the External URL setting.

Enable and disable notifications

To enable or disable a notification:

  1. Select the notification you need from the drop-down list.

  2. To enable the notification, leave the Suppress Notification check box clear.

    To disable the notification, select this check box.

Restore default settings

To restore the default notification settings, click Restore Default Templates on the Notification Templates page.

Discover Notification Recipients

To indicate the notification recipients, Collaborator puts the following keywords at the notification name’s beginning:

Recipient Description
Author The author of the review, for which the event is generated. The author is also called review creator.
User All participants of the review (except for the author).
List All participants of the review (except for the author) plus the email address (or mailing list) specified by the Notification List setting of Collaborator. Using these notifications are convenient for notifying multiple users, including those users who are not mentioned in the participant list of a review.

The User NNNN notifications and List NNNN notifications are fired on the same events. If the Notification List setting is not blank (contains some e-mails), Collaborator triggers the List NNNN notifications. Otherwise it triggers the User NNNN notifications.

Reviewer All users with the Reviewer role on the review.
Poke The user, who is poked (that is, notified explicitly).

Events Description

The drop-down list at the top of the settings page displays notification in alphabetical order. The following is a list of notifications, organized by type.

Review phase notifications

This section describes the notifications Collaborator sends when a review phase changes.

Annotating

Canceled

Completed

Inspection

Planning

Rejected

Rework

Signing

Stalled

Approaching Deadline

Changes in file and participant lists

Changes in comments

See Also

Notifications
Variable Substitution
Collaborator Settings

Highlight search results