Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 15

...

This feature should not be confused with Ad hoc Post-function notifications fired in an issue workflow, or Issue Event notifications fired in response to an issue event.

Info

Quick start

  1. As a system administrator go to an issue view and use the keyboard shortcut g + @

  2. The JEMH Ad-Hoc Notification dialogue should now be displayed

  3. On the Comment tab, enter the default notification subject and comment content

  4. Go to the Settings tab and under Save Settings select Remember As Global

Enabling ad hoc notifications

The feature is disabled by default. In order to use the feature, it needs to be enabled and access granted to users.  A Jira system admin can do this via JEMH > Features.

  1. Go to JEMH by pressing full stop on the keyboard to open Jira's Operations box, and typing "jemh" and pressing Enter.

    Image Modified



  2. JEMH will appear. Open the Features tab and click the edit icon. Enable the feature and then press submit.

...

Granting users permission to use Ad Hoc Notifications

The ability to use Ad Hoc notifications is configurable through default global settings, or can be granted on a per-project basis.  The ability to modify Global settings requires a Jira administrator, the ability to modify Project settings requires either a Project Admin or a JIRA administrator.  Access to the JEMH Permissions section is found through the JIRA Project Administration section:

Image RemovedImage Added

The JEMH Permissions screen has two sections, the Project Settings and the Global Settings.  Editing ability is through the pen icon in each case, which is only possible with the Project Administrator privilege (for Project Settings) and JIRA Administrator (for Global Settings).  By default, all projects defer to the Global Settings for security.  To switch to Project Specific settings, just click the Use Project Settings button.

...

Through the comment screen, two kinds of notification can be sent:

  1. Custom Content, which is straight forward text

  2. Template Sets - pre-defined messages or "canned responses".  When Template Sets are selected, the resulting content can be edited before sending.

Note

Changes made to custom Template Sets while in the Ad Hoc Notification window are not saved back to the database.  The changes only apply to the current open session of the Ad Hoc Notification window.

...

The Advanced editor was previously the only editor available. Whilst it lacks the controls found in a text editor, it is a good choice for velocity-heavy templates as it allows a rendering of a preview by pressing the blue button below it.

Configuration Source (now)

Ad Hoc Notification settings can be set at a global level or per-project. This shows where the current settings are being taken from.

...

Configuration Source (future)

This setting allows the modification of where this project gets its configuration from.  Note that if you are changing from a Global global source to a Project specific project-based source you will want to make sure that you set Save Remember As to Project. Below is an example, of the project setting being (1) selected, (2) saved, and (3) shown to apply.

image-20240628-101811.pngImage Removed

KISS Mode

The Ad Hoc pop-up has two modes; Simple and Full.  Simple mode removes some of the more advanced tabs and settings in order to streamline the experience for end-users.  Full mode displays all available settings, which can be useful for power users who want more control.

Example view of Simple Mode

Example view of Full Mode

Image Removed
Image Added

Image Removed
Image Added

Show All Custom Fields

Sets whether custom fields of all types are listed as choices under the To, Cc and Bcc tabs.  When this setting is enabled, custom fields of all types are listed - note that no guarantees can be made that a type of custom field is compatible with the Ad Hoc Notification feature.  When this setting is disabled, only the known compatible custom field types are listed (text, user and group).  Default for this setting is disabled.

...

Setting a From address and saving the configuration using the ‘Settings’ tab will save the address as part of the Ad-hoc configuration. To use this to set a Project specific From address please:

  1. Set the desired From address

    Image Modified
  2. Set the ‘Config source (future)’ to ‘Project’ and save the Settings as ‘Project’

    Image Modified
  3. When the popup is re-opened, the From address field will already be set to the Project Specific address.

Issue Update

This tab controls if/how the outgoing message is appended to the issue, and other event related items;

...

Setting

Description

Add Content As a comment to issue

If checked, adds a 'quoted' comment to the issue indicating who it was sent to.

Comment Security Level

So as to avoid unnecessary notifications, visibility of the comment can be set to retain the information but hide for clarity / privacy.

Send Comment Event

When the comment is added, an event can be fired (causing email notifications) or not.

Immediate Delivery

Whilst possible, pushing the mail queue is synchronous with the user interaction, i.e. checking this will result in the send operation hanging until the mail queue has been flushed. Not recommended to be defaulted.

Pre-defining custom notification content

...

Filter by label
event listener jemh issue notification
showLabelsfalse
max5
spacesJEMHshowSpacefalse
sortmodified
typeshowSpacepagefalse
reversetruelabels
typepage
cqllabel in ( "template" , "notification" , "adhoc" ) and space = "JEMH"
labelsevent listener jemh issue notification