Enhance Jira Service Management with Email This Issue

This tutorial explains the steps you understand how you can enhance Jira Service Management with Email This Issue to process incoming emails or to send customer notifications.

Use Case

The below tutorial covers the following use case:

  • external customer reports a ticket via email, a new issue is created from email and a customer account is created automatically
  • service management agent requests more information form the customer by commenting the issue, customer is notified
  • customer replies to the email, the issue is commented, old content from the email is stripped out
  • service management agent resolves and closes the issue, customer is notified.

Step-by-step guide

There two major aspects you must configure to implement the above use case:

  • Mail Handler
  • Event Notifications

Prepare Email Templates for Customer Notifications

Email templates are needed only if you want to send emails to your customers.

  1. Go to Email Templates
  2. Click Add to add one template from each of these Themes:
    1. Service Management Customer Invitation: If customers may be created automatically with Public Signup Enabled in Service Management 
    2. Service Management Request Participant Added Notification: if you want to notify participants when they are added
    3. Service Management Auto Acknowledge: if you want to automatically acknowledge incoming emails
    4. Service Management Request Created / Updated / Resolved / Public Comment Added: if you want to setup event notifications for Customers
  3. Use the default template content, you can customize the templates any time later.

Configure Mail Handler to Process Emails

  1. Go to JIRA Administration / Incoming Mail
  2. Add an IMAP or POP connection to an email account, let's say support@mycompany.com.
  3. Add a Mail Handler with the below parameters:
    1. Name: give a descriptive name, like "MyCompany Support Handler"
    2. Server: select the email account you configured above
    3. Handler: select Email This Issue Mail Handler
    4. Project: select the Service Management project in which you want to track your ticket, let's say the project is: Helpdesk
    5. Issue Type Select the type you want to use to represent a ticket, e.g. Request
    6. Specify a default reporter: a user who has Create Issue and Add Comment permissions in the project
    7. Leave other settings with the default value (do not enable Create Users option)
  4. Go to Administration / Issues, add a multi-user picker custom field, call it External Participant. Make sure the field is accessible in the project and issue type you configured above.
  5. Go to JETI Administration / Mail Handlers (JIRA_BASE_URL/secure/admin/jeti/jetiAutoReply.jspa)
  6. Click Add to add a Mail Handler Context
  7. Set the attributes of the Mail Handler Context:
    1. Project: select the Service Management project you configured your mail handler.
    2. Issue Type: select the default  issue type you configured above (Request).
    3. Select the Email Processing Strategy: Service Management : Create or Comment Requests
    4. Select the Customer Request Type to use. Request Types are dependent on the selected Issue Type.
    5. In "When Customers are Created", select the template based on theme "Service Management Customer Invitation" or leave it empty
    6. In "When Participants are Added", select the template based on theme "Service Management Request Participant Added Notification" or leave it empty
    7. In "Service Management Comment Visibility", select "Default Behaviour"
    8. In Acknowledge New Issues and Acknowledge New Comments, select the template based on theme "Service Management Auto Acknowledge" or leave it empty. This will make sure that email senders will get an instant feedback from your JIRA system, that their emails have been processed. The email will contain the issue key as a reference number.
    9. In User Recipients, select "Save to multi user picker field" and select the above created field.
    10. In Sender Field, select the "External Participants" field
    11. In Recipient Field and Copy Recipient Field, select the "External Participants" field
    12. Email Address Exclusion: enter the email address this Mail Handler is listening on (you configured it in step 2 above).
    13. In Split Regex, enter

      /From: |___.|On .wrote:|----Orig.|On .(JIRA)./
  8. Click Save to persist your Mail Handler Context.

At the end, your Mail Handler Context should look like this:

You have now prepared Email This Issue to process incoming support emails.

See more details on Mail Handlers and Service Management Integration

Configure Event Notifications

  1. Go to JETI Administration / Notifications (JIRA_BASE_URL/secure/admin/jeti/jetiNotifications.jspa)
  2. Click Add to create a new Notification Template, call it anything, e.g. ServiceManagement Notifications, make sure you select "All Matching Events" in the Event Processor field
  3. Now you are in the Notification Events page.
  4. Click Add to add an Customer Notification events to notify Customers on. For each customer notification:
    1.  specify email template you created above based on the appropriate themes
    2. specify recipients and additional email content
  5. Click Add to add an Isssue Event Notification to notify Agents or Collaborators on. For each issue event notification:
    1. Specify events as described in this tutorial. Setting up Customized Notifications
  6. Click Save to persist your settings
  7. Repeat the above steps from Step 8 to add all your events.
  8. Once completed, your Notifications will look like this:

     
  9. Go to JETI Administration / Contexts (JIRA_BASE_URL/secure/admin/jeti/jetiProjects.jspa)
  10. Click Add to add a new context with the following attributes:
    1. Project: select the project you configured your Context for (Helpdesk). You can leave Project empty to use this context for all projects.
    2. Issue Type: select the type you configured above (Request). You can leave issue type empty, to use this context for all issue types.
    3. Template: select the template you created above (Helpdesk template)
    4. Notification template: select the notification you created above (Helpdesk Notifications).
    5. External Watchers Field: select the field you created for your Mail Handler, called External Participants.
    6. Sender Name Pattern: enter a name that appears in the emails as the sender, you can leave it empty.
    7. From Email Address: enter the email address you created for your mail handler (support@mycompany.com)
  11. Here your Context should look like:

Congratulations, You are done. Your basic email support system is place and is ready to serve you.

Related documentation: