Versions Compared

Key

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

This page covers how change in Jira issues result in email notifications that consume your JEMHC plan message capacity plan.

Table of Content Zone
Table of Contents

Jira Events

How JEMHC gets data from Jira, when is it stored

...

Issue event data sent by Jira

When changes are made to your Jira issues, they trigger webhooks (JSON data) to our JEMHC app. JEMHC will store be sent by Jira to JEMHC. These webhooks contain information about the changes that have happened.

Once JEMHC has received the webhook, the event data is then securely queued for processing. The app takes the queued data, performs some processing on it, and then stores this data for processing whenunder the following conditions:a) a

  • A valid license is present (

...

...

  • once a subscription is active, cancelling it and starting a new trial will not work). To determine the app’s current license status, go to Jira settings > Apps > Manage apps and expand the JEMHC entry.

  • A Notification Mapping for the related project (or for all projects) is configured in the app. This can be determined by navigating to JEMHC > Notifications. For example, here is an email mapping:

...

Why Jira still sends all your issue data to us when no JEMHC license is present

Due to long standing open issues on the Jira platform, regardless of your license state, if the JEMHC app is still installed, we receive JEMHC receives ALL webhooks for ALL projects, forever. If you have unlicensed JEMHC and no longer wish your data to be sent to us, you should uninstall the JEMHC app in addition to unlicensingunsubscribing.

...

Email

...

notification mappings

The JEMHC > Notifications > Email mappings are where the fine detail of ‘how’ recipients are resolved, how the mail is sent, and attachment control is.

There are quite a few fields, some key ones are listed below:

...

Field

...

Value

...

Enabled

...

ticked

...

Notification Mapping must be enabled for any notifications to work

...

Issue Created

...

A template

...

when selected, notifications for this kind of event use this template (no template means no notification

...

Issue Updated

...

A template

...

As above

...

Issue Deleted

...

A template

...

As above

...

Only Send Notifications When A Comment Is Present

...

off by default

...

A way to limit issue update notifications, to only those containing comments.

...

Projects

...

Project(s)

...

Projects must be selected, or ‘all’ projects selected in to scope notification mappings

...

Recipient Type

...

BCC

...

Default is BCC to reduce message volume (recipients with identical delivered email content will be bcc’d in groups). If this is set to TO, each recipient gets a mail, this can have quite an impact on your Plan message volume capacity depending on how many people are involved on your issues.

...

JQL whitelist

...

its possible to further filter notifications based on a jql query, eg filter by issueType, priority,etc.

...

Sender…

...

The series of fields here relate to the sender of the mail. If you change the sender address, it is on you to validate the smtp account is valid for those addresses.

...

Audience

...

This series of fields controls ‘who’ is to be notified. The more recipient types as involved, the more ‘different’ content will be sent, and message volume used, as bcc delivery is not possible. Typically, we use the fields below:

...

Target Audience

...

Email and Jira Users

...

Audience Address Custom Fields

...

Sender Email Address (255 char limited text)

Email User Participants (unlimited text)

...

These fields enable JEMHC to notify email only users, who have no access to Jira or the Portal.

...

Notify Reporter

...

Notify Assignee

...

Additional recipients (script)

...

Advanced, allows scripted addition of recipients

...

Participant Email Address

...

For debug use (will impact you plan, as well as fill your inbox) add this address as bcc to all sent mail.

...

Attachments

...

Attachments use data, these options can be used to limit what is included/sent. Some attachments can be too large for your mailserver, you need to pick appropriate values, typically a max email size of 25MB.

It is not expected that email notifications contain huge email attachments, JEMHC Plan Capacities are geared to general usage!

many settings for notification mappings. Here are some of the key ones:

  • Event template selection - controls which of the 3 main event types are to be notified for

    • Issue created

    • Issue updated

    • Issue deleted

  • Project selection - choose one or more projects that the mapping applies to. Can be set to apply for all projects.

  • Recipient type - determines whether emails are set to recipients as BCC to reduce message usage, or as TO, which means each recipient gets a separate notification.

  • Audience - controls who is notified of the events

    • Standard issue fields such as Reporter, Assignee etc.

    • Custom fields (text and user types)

Scenarios

This scenario will show simple Issue creation by a Jira user/portal user without attachments/images. To review other scenarios with different events, please refer to Scenario examples.

...

Jira sends a Webhook sent to JEMHC, where it will be stored if the license is valid and there is a Project Mapping for the related project (or all). The [1] int he in the screenshot below indicates the number of webhook events we received/merged which is how JEMHC will ‘batch’ multiple events in a minute window together to reduce email volume, and maximize Plan allocation usage.

...

The Report will indicate who was notified, here the '@ppltest2019.com is along with the outbound sender mailbox (From) address.:

...

A restricted view of the mail is also available, so you can see ‘what’ content was sent (and see it differ between different recipient notifications):

...

The received mail would look appear as below, many common images (include the PluginPeople Plugin People logo bottom right, are referred via our CDN, so cost nothing in terms of data. If you were to examine the source of the sent mail, the small image likely present relates to the user avatar image, which is inlined in the mail.

...