About notification templates

Notification templates provide a means of sending customized messages to users about events in the system.

Template types provided

The system includes a set of notification template types, as follows:

Each type includes a set of translated messages. The messages use variables to provide context.

Global usage

The provided templates can be used globally as follows:

Messages stored in Translations

The notification message used is stored in a translation associated with the template type. Each translation specifies information about its notification message:

You can edit the translations in both the provided notification templates and in notification templates that you create.

Message format

Messages can be sent in one of two message types:

Variables in templates

The system parses the templates for a number of variables (see Using environment variables and register variables).

Custom templates for specified projects and steps

You can create customized notification templates based on the provided notification types. The customized templates must be associated with a project or an individual step within a project. See Creating new templates for specific projects and steps.

About the Templates panel

Use the Templates panel to set up notification about events. To view the panel, select Projects > Templates.

Screen image of the Templates panel in the Projects panel

The panel lists all the templates that come with Rational Build Forge. When you create a new template, you specify the following fields:

Type
The type of message. You select an existing template type.
Project
Required: the project for which to send the message.
Step
Optional: a step in the specified project for which to send the message

About the Translations panel

Use the Translations panel to set up messages that are used by templates. To view the panel, select Projects > Templates, then select a template from the list. A list of Translations for the template is shown. Each item in the list displays the following information:

Language
Required. The language for the message.
Description
Used as the title of the Translation in the list.
From
Optional: an email address to use in the From field of the message. The following email address formats are supported. Username is the email user name. Name is an arbitrary string, usually a given name in some form.
username@host.com
name username@host.com
name "<username@host.com>"
name <username@host.com>
name "username@host.com"
Subject
Required: a string to use in the Subject field of the message. It can contain variables.
Body
Required: the text of the message. It can contain variables.

Feedback