Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Note
iconfalse

Summary

This guide is to show you how to setup customized event notifications.



Info
iconfalse

Prerequisites

This tutorial requirethe following:

  • Email This Issue add-on installed in JIRA
  • A license key saved in JIRA
  • Have an SMTP server configured in JIRA

Note: You must be a Jira administrator to be able to perform the below settings.



Info
iconfalse

Objectives

By following this guide you will be able to carry out the following actions:

  • Create email templates for issue events
  • Configure notifications with issue events
  • Associate the notifications with your projects and/or issue types



Step-by-step guide

In order to be able to send out customized email templates, you must follow the below steps:

  1. Create email templates for issue events

  2. Test your template settings (optional)

  3. Configure notifications with issue events

  4. Associate the notifications with your projects and/or issue type

Follow the below steps in order to create an email template:

  1. Open the JETI Administration page and click on Email templates

  2. Click Add to add a template for your outgoing emails. This can be based on Themes or Jira event templates (e.g. Issue Created)




  3. Customize the template according to your needs, use the field picker to add issue fields, custom fields, comments or issue linking information, etc. (e.g. call this template Custom Template)

  4. Click Save at the bottom of the page to save your template or click Cancel to discard the draft.

To create multiple email templates, repeat steps 1-4 as many times as needed.

Follow the below steps in order to test your template (optional):

  1. Open the JETI Administration page and click on Email templates

  2. Click on the three dots in the row of the template you wish to test and click Test:


Follow the below steps in order to configure notification events:

  1. Open the JETI Administration page and click on Notifications

  2. Click Add to create a new Notification Template (e.g. Custom Notifications)

  3. Set a Name, Description, and an Event Processor for the notification event

  4. Click Add to proceed



  5. Click Add to add a New Event Notification



  6. Select an event type to associate with the event notification. This can be based on Issue Event Notifications or Service Desk Management Customer Notifications



  7. Fill out the fields to configure the notification event as shown below:

    Attribute nameDescription
    Event typeThe event type(s) selected for the notifications (you can optionally specify multiple event types for a notification with this field)
    TemplateSelect the email template you want to use for the notification
    JQL Filter

    Enter a JQL query fragment to limit the Context to issues matching this criteria.

    Recipients

    Add users to the Recipients (To), Copy Recipients (Cc) and Blind Copy Recipients (BCC) fields by typing their JIRA user names/full names or email addresses (adding multiple users separated by commas).

    To add members of a specific project role, select from the drop down list.

    Content

    Specify additional content of the email. You may leave these fields empty and rely on the selected Template.

    Add attachments to email

    Attachment rule to specify which issue attachments you want to add to the emails

    Email settings

    Specify options that will be applied to the notification email (e.g. adding recipients to watchers)


  8. Click Save

To add multiple events, repeat steps 3-8 as many times as needed.

Follow the below steps in order to associate notifications with your projects and/or issue types:

  1. Open the JETI Administration page and click on Contexts

  2. Click Add to add a new context and fill out the fields as below:

Attribute nameDescription
ProjectSelect the project you want to apply the context settings to. Leave the field empty to apply this context for all projects.
Issue TypeSelect the issue type you want to apply the context settings to. Leave the field empty to apply this context for all issue types.
TemplateSelect a default template for this context to use (e.g. the one you customized above, Custom Template). This template will be used when sending emails using the Email button.
External Watchers FieldAdd external recipients as watchers to the issue.
Sender Name Pattern

Enter a name that appears in the emails as the sender. If left empty, JETI will use JIRA's default settings.
Specify (in Velocity markup syntax) how to format the sender's name in outgoing emails.

From Email Address

Enter the email address you want to use as the "from address" in the emails. If left empty, JETI will use the default settings.

Specify (in Velocity markup syntax) how to format the From Email Address in outgoing emails.


To add multiple contexts, repeat step 2 as many times as needed.



Info
iconfalse

Content by Label
showLabelsfalse
max5
spacesPLUG
showSpacefalse
sortmodified
excerpttrue
reversetrue
typepage
excerptTypesimple
cqllabel in ( "kb-how-to-article" , "tutorial" , "jeti" ) and type = "page" and space = "PLUG"
labelstutorial jeti kb-how-to-article