Notifier Templates Configuration
In this section you can find reference information on the location and syntax of notifier templates, connection with the build events, patterns used to represent important information, and examples:
Notifier Templates
Location
Notifier templates reside in the notifier configuration file:
Syntax notes
Syntax of the notifier configuration files is described in the respective *.dtd files. Notifier configuration file contains two sections:
- <templates/> that contains notifier-specific templates with notification messages
- <events/> that contains the list of events to be notified about, with the references to the associated templates
<templates>
All templates are placed into the <templates> section, for example:
- Email templates must have <subject/> and <body/> sub-elements.
- Jabber templates text should be placed directly into the <template/> tag.
- System Tray Notifier templates must have <message/> and <link/> sub elements. The <message/> element contains template of the message and the <link/> element contains a pattern for a link corresponding to the message.
<events>
Templates are attached to events. For now supported notification events are:
- build started (event type build_started)
- build successful (event type build_successful)
- build failed (event type build_failed)
- build is failing (the first error notification, event type build_failing)
- responsibility changes (event type responsible_changed)
If an event does not have a template attached, it is ignored, and the users will not receive notifications even if they subscribed to them.
Example of events attachment:
It is possible to attach template to a build configuration too:
In this case for the build configuration with id "Ant" a template with id "build_successful_ant_tpl" will be used (if it exists). For all other build configurations default template will be used (referenced here by id "build_successful_tpl").
Substitution patterns
Each notification event supports it's own set of substitution patterns.
"build_started" event patterns:
- {PROJECT_NAME} - project name
- {BUILD_CONFIG_NAME} - build configuration name
- {BUILD_NUMBER} - build number
- {CHANGES} - list of first 10 changes included in the build
- {CHANGES_WITH_FILES} - list of first 10 changes included in the build with changed files
- {AGENT_NAME} - agent name where build is running
- {AGENT_HOST} - hostname of an agent where build is running
- {BUILD_RESULTS_LINK} - link to a build results page
- {BUILD_CONFIG_LINK} - link to a build configuration home page
"build_successful", "build_failed" and "build_failing" event types patterns:
- {PROJECT_NAME} - project name
- {BUILD_CONFIG_NAME} - build configuration name
- {BUILD_NUMBER} - build number
- {SHORT_STATUS_DESCRIPTION} - short description of current status: number of failed tests, number of passed tests and so on (in braces)
- {COMPILATION_ERRORS} - compilation errors block (replaced with empty string if there were no errors)
- {FAILED_TESTS_ERRORS} - failed tests errors block (replaced with empty string if there were no errors)
- {CHANGES} - list of first 10 changes included in the build
- {CHANGES_WITH_FILES} - list of first 10 changes included in the build with changed files
- {AGENT_NAME} - agent name where build is running
- {AGENT_HOST} - hostname of an agent where build is running
- {BUILD_CONFIG_LINK} - link to a build configuration home page
- {BUILD_RESULTS_LINK} - link to a build results page
- {BUILD_LOG_LINK} - link to a build log page
- {BUILD_CHANGES_LINK} - link to a build changes page
- {BUILD_ARTIFACTS_LINK} - link to a build artifacts page
"responsible_changed" patterns:
- {PROJECT_NAME} - project name
- {BUILD_CONFIG_NAME} - build configuration name
- {RESPONSIBLE} - full name and comment of a person who took responsibility for a build failure
- {BUILD_CONFIG_LINK} - link to a build configuration home page
Note: <subject/> element for email notifier supports all patterns that can be used within <body/> for the specified event type.
Note: additionally {EDIT_NOTIFICATIONS_LINK} pattern is supported. This pattern is replaced with the link to the user's notification configuration page.
Examples
Email notifier configuration
Jabber notifier configuration
