Template File Replacement Tokens

Template files define the format and content of e-mail notification messages. The template files can contain tokens that are replaced with runtime values, and other data. For example, HTML tags are typically placed in the HTML template files.

Replacement tokens are enclosed in less than (<) and greater than (>) signs and start with the string BRIO_TAG. Their values are dynamically replaced in e-mail notifications.

Table 2. Replacement Tokens 

Token

Description

<BRIO_TAG_USER>

Name of the user who triggered the e-mail notification. Applies to item and folder e-mail notifications.

The notificationOriginator property in the notification.properties file provides a parameterized message that you can use to add text around the user name in the e-mail notification message.

<BRIO_TAG_DESC>

Description that users enter when they create an item in the repository. Users can enter descriptions when they add a version of a file to the repository. When this occurs, this tag is replaced by the user’s description.

The notificationDescription property in the notification.properties file provides a parameterized message that you can use to add text around the users description in the e-mail notification message.

<BRIO_OBJECT_LINK>

SmartCut to the item that is the target of the e-mail notification

For an item subscription, it would be the SmartCut to the file that was the target (for example, the file that had a new version created). For a program output subscription, it specifies the SmartCut to the program output.

<BRIO_OBJECT_FULLPATH>

Full path of the item that triggered the e-mail notification

This is useful within a template HTML file as a target rather than the SmartCut.

<BRIO_TAG_MODIFY_LINK>

SmartCut to the link to modify the subscription to the item that triggered the e-mail

This is useful to allow a user to discontinue or modify the subscription.

<BRIO_TAG_MODIFY_MSG>

Text associated with changing a subscription. The notification.properties file specifies properties that are substituted for this replacement token:

  • cancelItemSubscriptionSmartcut—Specifies text for changing an item subscription

  • cancelCategorySubscriptionSmartcut—Specifies text for changing a folder subscription

  • cancelProgramOutputSubscriptionSmartcut—Specifies text for changing a program output subscription

<BRIO_TAG_EXCEPTION_TITLE>

String to use as the title for an exception message

This replacement token is replaced with the exceptionMessage value in the notification.properties file.

<BRIO_TAG_EXCEPTION_MSG>

This replacement token is replaced with the exception messages that are the result of a job’s execution in the Job Service.

<BRIO_TAG_RETRY_MSG>

Reason why a scheduled job is being retried

The notification.properties file specifies properties that are substituted for this replacement token:

  • scheduledJobRetry—An error occurred and the job is being retried

<BRIO_TAG_USER_DEFINED>

Body component for e-mail notifications about the scheduled job

<BRIO_TAG_NO_ATTACHMENT>

Reason why no attachment was attached to the e-mail notification. Typically, this is not put into the e-mail notification.

If an attachment was requested in the subscription and yet no attachment is attached, then this replacement token is used to let the user know why no attachment was applied.

The notification.properties file specifies properties that are substituted for this replacement token:

  • attachmentErrorUnknown—An unknown error occurred

  • attachmentTooBig—The size of the e-mail attachment is larger than the maximum set by the administrator

  • attachmentNotAllowed—There was a permission violation and the attachment could not be attached

  • attachmentsDisabled—The administrator disabled e-mail attachments