Properties in the notification.properties File

When Event Service starts, it reads the contents of the notification.properties file. This file contains messages that go into e-mail notifications and other properties (see Table 3, Notification Properties ). Never delete a record from this file. The notification.properties file is in:

Install Home\lib\msgs

Each line in the notification.properties file is formatted as:

name=value

The name ends in .string or .text. If the property name ends in .string, then the value is constant. Conversely, if the value contains a variable, then the property name ends with .text. Variables start with a left curly brace ( { ) and end with a right curly brace ( } ). Variables contain a number that starts with zero.

When the Event Service creates e-mail notification messages, it frequently replaces a replacement token (see Table 2, Replacement Tokens ) with the property value from the notification.properties file. Consider this variable property value assignment in the notification.properties file:

NotificationOriginator.text={0} triggered email notification

With this definition, the <BRIO_TAG_USER> replacement token in an e-mail notification template file is replaced with the name of the user who triggered the e-mail notification, followed by the text triggered e-mail notification. If a user named bob triggers the e-mail notification, then the string reads: bob triggered e-mail notification.

Table 3. Notification Properties

Property	Description
attachmentsDisabled	Text to insert into the e-mail notification when the attachment cannot be added because attachments are disabled for the domain. Editing the system properties using Administer module can enable e-mail attachments.
attachmentErrorUnknown	Text to insert into the e-mail notification when adding an attachment to the e-mail fails for some unknown reason
attachmentNotAllowed	Text to insert into the e-mail notification when the attachment cannot be added due to an access violation. If you receive an access violation, check the item permissions.
attachmentTooBig	Text to insert into the e-mail notification when the attachment cannot be added because it is too big. Editing the system properties in the Administer module can set the maximum size of the e-mail attachment.
cancelCategorySubscriptionSmartcut	Text to insert into the e-mail notification when specifying a SmartCut to the folder subscription. The location of the {0} identifies when the SmartCut to the subscription is placed.
CancelItemSubscriptionSmartcut	Text to insert in the e-mail notification when specifying a SmartCut to the item subscription. The location of the {0} identifies when the SmartCut to the subscription is placed.
cancelProgramOutputSubscriptionSmartcut	Text to insert in the e-mail notification when specifying a SmartCut to a job output subscription. The location of the {0} identifies when the SmartCut to the subscription is placed.
categorySubscriptionSubject E	E-mail subject field when a folder subscription notification e-mail is sent. The string “{0}” is replaced with the item name. Folder subscription e-mails are sent to users who subscribed to a folder when a file or other interesting item is added to the folder. To include a single quotation mark in the subject, enter two single quotation marks. For example, to produce the subject Information You’ve Subscribed To, enter as the value of this field: Information You’’ve Subscribed To.
charset	Character set used to encode the subject field for e-mail notifications
exceptionMessage	Heading for exception information reported in the e-mail notification. This property is only used when sending e-mail notifications for items with associated exception information.
htmlEmail	Whether e-mail notifications are in HTML or text format. If this property’s value is true, then e-mail notifications are in HTML.
itemSubscriptionSubject	E-mail subject field when an item subscription notification e-mail is sent. The string “{0}” is replaced with the item name. Item subscription e-mails are sent to users who subscribed to a EPM Workspace item when a new version of the file is imported or its properties are changed. To include a single quotation mark in the subject, enter two single quotation marks. For example, to produce the subject Information You’ve Subscribed To, enter as the value of this field: Information You’’ve Subscribed To.
notificationDescription	Item subscription e-mail notifications contain the description that end users provided when they created a new version of a file. The string “{0}” is replaced with the file description associated with the new version.
notificationOriginator	User who triggered the e-mail notification. The string “{0}” is replaced with the user name. Item and folder subscription e-mail notifications contain the user who triggered the e-mail notification in the e-mail body. The notificationOriginator property allows customized formatting. For example, the customer could change this value to: notificationOriginatortext={0} triggered this email notification With the above definition, the e-mail notification body contains: “bob triggered this e-mail notification” if the EPM Workspace user “bob” triggered the notification.
jobOutputSubscriptionSubject	E-mail subject field when a job output subscription notification e-mail is sent. The string “{0}” is replaced with the job name. Job output subscription e-mails are sent to users who subscribed to a job, when new output of that job is imported. To include a single quotation mark in the subject, enter two single quotation marks. For example, to produce the subject Information You’ve Subscribed To, enter as the value of this field: Information You’’ve Subscribed To.
scheduledJobFailed	Text to place in the e-mail notification when a scheduled job fails to run. The string {0} is replaced by the reason for the failure. The reason can be the text defined in scheduledJobFailedJobKilled or scheduledJobFailedUnknown properties, or it can be the text returned from the external program that was unsuccessfully executed.
scheduledJobFailedJobKilled	When a scheduled job is killed and the user requested e-mail notification
scheduledJobFailedUnknown	Reason why the job failed when a scheduled job fails for unknown reasons and e-mail notification was requested
scheduledJobRetry	Text of the e-mail message sent by the scheduler when it couldn't run the job for some reason and is attempting to retry the job again. This is sent when notifications were requested.
scheduledJobSubject	E-mail subject field when a scheduled job e-mail notification is sent. The string {0} is replaced with the schedule name and the string {1} is replaced with the job name. This type of e-mail notification is sent when a scheduled job is executed and the person who scheduled the job checked the box for e-mail notification. To include a single quotation mark in the subject, enter two single quotation marks. For example, to produce the subject Information You’ve Subscribed To, enter as the value of this field: Information You’ve Subscribed To.
scheduledJobUnableToSched	Text of the e-mail message that is sent by the scheduler when it couldn't run the job for some reason. This is sent if notifications were requested and all retries are exhausted.
smartcut	Allows additional text to be added with the SmartCut to the item. The {0} must be present in the string and identifies the location where the SmartCut is placed.
unknownSmartcut	String used when the SmartCut cannot be determined
viewScheduleSmartcut	Text to place in e-mail notifications when a scheduled job is run. The user must request e-mail notification when scheduling the job to get this information. The location of the {0} identifies where the SmartCut to the schedule is placed.