Email notifications

R4J can send email notifications to selected users everytime a suspect is triggered.

The notifications can be send to one or more of the following users:

the assignee of the issue that triggered the suspect
the reporter of the issue that triggered the suspect
specific users

By default the email notification contains all available information regarding the suspect. This includes the name and key of the issue that triggered the suspect, basic information about the user who made the changes leading to the suspect as well as linked issues that might be affected by the changes.

On this page:

Related pages:

XSLT Reference

Enable email notifications

Email notifications can be configured seperately for each project. See Suspect Configuration for more information.

To disable email notifications for a project you can just uncheck all recipients in suspect configuration view.

Configure a project's email address

The email notifications will be sent from the corresponding project email address.

This address is part of the JIRA project settings. See Configuring a project's email address for more information.

Customizing email content

Just like JIRA itself R4J generates emails in reaction to specific events. But instead of the Apache Velocity template engine R4J is using XSLT for generating email notifications. XSLT stands for 'Extensible Stylesheet Language Transformations' and can be used to transform XML documents into other formats.

The mails are generated by R4J in HTML format using a given template written in XSLT together with a XML document containing all nessecary information regarding the suspect.

How to customize email templates

Log in as JIRA Administrator
Choose > Add-ons
Select Requirements > E-Mail Templates from the sidebar
Keyboard shortcut 'g' + 'g' + start typing 'E-Mail Templates'
Select an email template from the dropdown menu to edit
Currently R4J only sends notifications in case of a suspect therefore 'Suspect Notification' is the only template that can be edited
Create/Edit a template within the textarea right below the dropdown menu
Click on the Save button to save the template

You can also display a preview of your template by clicking the Preview button and reset the template shown in the textarea back to the default one by clicking the Reset button.

While it's possible to select the recipients seperately for each project, the email template will apply globally to all projects used with the R4J plugin.

Template Data Structure

XML represantation of the data regarding a suspect

<result>

  <baseUrl>Url to your JIRA instance</baseUrl>
  <instanceName>Name of your JIRA instance</instanceName>

  <issue>
    <key>Issue key</key>
    <summary>Summary</summary>
    <description>Description</description>
    <type>Issue type</type>
    <link>Formatted link to issue</link>
  </issue>

  <suspectUser>
    <username>Username</username>
    <displayName>User's full display name</displayName>
    <link>Formatted link to user</link>
  </suspectUser>

  <suspectTime>Time of suspect change</suspectTime>

  <suspects> -> List of linked issue(s)
    <issue>
      <key>Issue key</key>
      <summary>Summary</summary>
      <description>Description</description>
      <type>Issue type</type>
      <link>Formatted link to issue</link>
    </issue>
  </suspects>

</result>

XML Field Description

result

Top level element for the data regarding the suspect.

Field	Description
baseUrl	Url to your JIRA instance
instanceName	name of your JIRA instance
issue	the issue that triggered the suspect
suspectUser	the user who made the changes leading to the suspect
suspectTime	date and time of the changes
suspects	a list of all issues linked to the issue that triggered the suspect

issue

Field	Description
key	the JIRA issue key
summary	the issue summary
description	the issue description
type	the issue type
link	a formatted link to the issue

suspectUser

Field	Description
username	the username
displayName	the user's full name
link	a formatted link to the user

suspects

a list of all issues linked to the issue that triggered the suspect. Contains one or more objects of type issue.

Managing Email Notifications