Downloads (PDF, HTML & XML formats)
[Crucible Knowledge Base]
Documentation for Crucible 3.0.x. Documentation for other versions is available too.
Email notifications in Crucible can be customised to change their formatting, by editing template files. This page contains instructions for this process.
Template files for Crucible are stored in the
folder.
/template/crucible/<Crucible home directory>
There are sets of templates for both HTML and plain-text emails. Note that these templates do not support embedding full diffs into notifications. They are only for changing the appearance and order of certain content inside the messages.
If you edit the templates of an operational Crucible instance, you may disrupt notifications that are being sent at that time. To avoid this, shut Crucible down during template editing.
crucible-notification-subject.ftl
template file from <Crucible home directory>
/template/crucible/
in a text editor. This template is used as the subject template for all Crucible email notifications.Header information will be included at the beginning of the email body text.
<Crucible home directory>
/template/
in a text editor. This template is used as the header template for all Crucible email notifications.Footer information will be included at the end of the email body text.
<Crucible home directory>
/template/
in a text editor. 'crucible-notification-footer.ftl' is used as the footer template for all Crucible email notifications.After an edit, the change to the email template will take place immediately. No restart is required.
Try and avoid editing the live template file, as Crucible may try to use it while you are editing. This could have unpredictable results. Instead, back up the template file (it's wise to keep original versions of all these files), edit a copy you have made, then overwrite the 'live' template once you have finished.
The email notification templates use the Freemarker format. Freemarker is a general templating engine enabling automated content.
If you are familiar with Freemarker, more advanced customisations can be made to the email notification templates. However, you make such adjustments at your own risk.
The following template files for Crucible notification are stored in the
folder.
/template/<Crucible home directory>
Template filename | Purpose |
---|---|
crucible-notification-subject.ftl | Subject template |
crucible-notification-header.ftl | Header template |
crucible-notification-footer.ftl | Footer template |
state-closed-notification.ftl | State Closed template |
all-completed-notification.ftl | All Completed template |
state-changed-notification.ftl | State Changed template |
completed-notification.ftl | Completed template |
general-notification.ftl | General notification template |
uncompleted-notification.ftl | 'Uncompleted' template |
all-no-longer-completed-notification.ftl | All-No-Longer-Completed template |
comment-notification.ftl | Comment template |
reply-notification.ftl | Reply template |
review-precis-plain.ftl | Precis template |
review-reminder-notification.ftl | Review Reminder template |
See also Customising FishEye Email Notifications.
2 Comments
Malik Mangier
There's a Bug report currently opened tracking the fact that email subject customization does not work: CRUC-4180 - Getting issue details... STATUS
Malik Mangier
In fact a lot of information from this page needs to be updated. This is tracked as CRUC-6297 - Getting issue details... STATUS