| width | 70% |
|---|
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
| width | 30% |
|---|
| Panel | ||||||
|---|---|---|---|---|---|---|
On this page:
Related pages: |
Enable email notifications
Email notifications can be configured separately for each project. See Suspect Configuration for more information.
To disable email notifications for a project you can just un-check 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 for more information.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
> Add-onsthe 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 'g' + 'g' + start typing 'E-Mail Templates'. (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
You can also display a preview of your template by clicking the Preview button and reset the template shown in the text area back to the default one by clicking the Reset button.
| Info |
|---|
While it's possible to select the recipients separately for each project, the email template will apply globally to all projects used with the R4J plugin. |
Template Data Structure
| language | xml |
|---|---|
| firstline | 1 |
| title | XML represantation of the data regarding a suspect |
| linenumbers | true |
| collapse | true |
.
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
| Code Block | ||
|---|---|---|
| ||
<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> |
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 |