Managing Suspect Email Notifications

Overview

R4J can be configured to send email notifications to designated users every time a suspect is triggered. See Configuring the Suspect Logic to learn how to configure suspect triggers.

The default email notification contains a great deal of information about the suspect. This includes the name and key of the issue that triggered the suspect, information about the user who made the changes leading to the suspect as well as linked issues that might be affected by the changes. The template for the email can be customized by the Jira administrator.

Notifications are sent from the email address of the suspect’s project - see Configuring a project's email address.

Customizing email content

Like Jira itself, R4J generates emails in reaction to specific events. Unlike Jira, R4J uses XSLT for generating email notifications instead of the Apache Velocity template engine. XSLT (Extensible Stylesheet Language Transformations) can be used to transform XML documents into other formats. The emails are generated by R4J in HTML format using a template written in XSLT together with an XML document containing all necessary information regarding the suspect.

How to customize the suspect template

To customize the XSLT template you must be a Jira Administrator.

  • Select the Jira adminstration icon > Manage apps, then select R4J - Requirements Management for Jira > E-Mail Templates from the sidebar. (Keyboard shortcut: Enter "." and start typing "e-mail templates".)

  • Select the Suspect Notification template from the drop down menu.

  • Edit the XSLT template within the text area below the drop down menu.

  • Select the Save button to save the template.

There are two other options:

  • Preview: Shows the results of applying the template to an issue.

  • Reset: Returns the template back to the default.

XML representation of a suspect

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 <result> <baseUrl>URL of 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>