You can configure customized, automatic email notifications on a per-server configuration, per-project, or per-component basis. You can design your own text or HTML-based message templates or use the default templates provided in the Notifications folder, a subfolder of the server installation folder. All email notification messages (both plain text and HTML) are sent in UTF-8 encoding.
You can define custom email templates to use with email notifications for the following components:
When a server configuration starts for the first time, the contents of the Notification folder in the installation directory are copied to the repository for the server configuration in a corresponding Notification folder. You can make customizations to the default templates in the Notification folder found in the server configuration repository. The predefined email notification files consist of a set of component-level XML configuration files – one for each desired component and an arbitrary number of email message body templates that can have any name that you choose. However, the configuration files must be named as follows:
The predefined email message body templates are named:
Where itemTypeAbbr corresponds to cr, req, task, or topic.
Each time that you start the server configuration, it scans the contents of the Notification folder. If the configuration (.xml) files are invalid and you have email notification enabled for your server configuration, the server issues an error message in the server log and fails to start.
You can also make dynamic updates to the message templates in the repository Notification folder without restarting the server configuration. The server checks for changes in the configuration and message template files every two minutes and immediately applies valid changes found in the files.
If the server finds a corrupted configuration and/or template file while the server configuration is running, a predefined email message is sent to the Admin group. Email notification becomes unavailable until you restore a valid configuration in the Notification folder. While any of the files in the Notification folder are in an invalid state, the server sends users the standard email notifications.
Within each of the sample templates provided in the Notification folder in your repository, you will find fields that you can use in your own customized templates. Three types of fields are used:
You cannot embed images in the HTML email message templates. However, you can use a URL to an image on a web site that users can access.