Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

In JEMH Cloud, JIRA users, JIRA groups and Email addresses can be dynamically added as recipients of Issue, Ad Hoc or Post Function notifications using Velocity scripts.

The main use case of this feature is when you depend on the event's context (like the issue data) to add extra recipients. E.g.: Notify managers when the issue's priority is Critical.

It's recommended to use the standard recipients configuration (notify reporter, notify watchers, etc.) when the recipients are not conditional. 

Conditional Recipients

Conditional recipients in Issue Notifications

To add conditional recipients in notifications, go to Notifications -> Issue and edit your mapping by clicking in the Cog icon.

Under the Additional Recipients header you can find the Recipients Script field.

The text area input supports Velocity scripts. Use Ctrl+Space in the editor to view the velocity's context ($recipientUtils's methods, $context.issue, etc.).

Resolved recipients will be added as BCC in the notifications. 

JEMHCloud doesn't duplicate emails. if an email has been resolved by several configurations (static or script), the recipient will receive the notification only once.

Conditional recipients in Ad-Hoc Notifications and Post Functions

Recipients scripts can be added to AdHoc and Post Function Notifications as TO, CC or BCC. Each script resolves the recipients for each type. E.g.: A recipient the CC script resolves, will receive the email as CC.

Velocity contexts and notification mechanisms are the same in all three features (Issue, AdHoc and Post Function notifications)

Examples

The following examples can be used in Issue, Adhoc and Post Function notification:

##If issue priority is blocker and type is bug, notify JIRA user johnfixall
#if ($context.issue.fields.priority.name.textValue() == "Blocker" && $context.issue.fields.issuetype.name.textValue() == "Bug")
	$recipientUtils.addUserRecipients("johnfixall")
#end

##If issue is of project SD, notify email users devLead@mycompany.com and testLeader@mycompany.com
#if ($context.issue.fields.project.key.textValue() == "SD")
	$recipientUtils.addEmailRecipients("devLeader@mycompany.com,testLeader@mycompany.com")
#end

##If issue priority is Major, notify support level 3 group
#if ($context.issue.fields.priority.name.textValue() == "Major")
	$recipientUtils.addGroupRecipients("support-level-three")
#end

##If issue priority is Minor, notify support level 1 and level 2 groups
#if ($context.issue.fields.priority.name.textValue() == "Minor")
	$recipientUtils.addGroupRecipients("support-level-one,support-level-two")
#end

##If operation was made by CEO user or issue reporter's CEO user, notify management
#if ($context.user.key.textValue() == "ceo" || $context.issue.fields.reporter.key.textValue() == "ceo" )
	$recipientUtils.addGroupRecipients("management")
#end

Add group by script (addGroupRecipients method) requires workaround user to be set.

  • $recipientUtils.addEmailRecipients() only works if Target Audience field is Email Users or Email and JIRA Users otherwise ignored

  • $recipientUtils.addUserRecipients() only works if Target Audience field is JIRA Users or Email and JIRA Users otherwise ignored

  • $recipientUtils.addGroupRecipients() only works if the Target Audience field is JIRA Users or Email and JIRA Users otherwise ignored

Testing

Issue notifications can be tested by creating or updating Issues through JIRA user interface, JEMH Cloud's email processing or JEMH Cloud's test cases.  These actions will generate issue events JEMH Cloud listens. 

You can see these events and the processing outcome by going to JEMHC configuration -> Auditing -> Events.

After being processed, an event will have a report showing the recipients resolved, notifications sent and the problems or warnings found.  Use these reports to validate the recipients the script has resolved.  The below is an example of a Event Report taken from JEMHC>Auditing>Events.  As you can see, one of the notification recipients has "(Script)" after their address, which signifies that this recipient was added due to the use of a velocity script.

An event can be re-processed by clicking the action Run so you can tweak the script and re-run events testing the script possibilities. 

Re-running an event will resend the emails. To avoid spamming your users, use a test mail server like mailtrap or disable the mail server by going to Notifications -> Message Outbound.

 

 

  • recipientUtils.addEmailRecipients() only works if target audience is Email Users or Email and JIRA Users otherwise ignored
  • $recipientUtils.addUserRecipients() only works if target audience is JIRA Users or Email and JIRA Users otherwise ignored
  • $recipientUtils.addGroupRecipients() only works if target audience is JIRA Users or Email and JIRA Users otherwise ignored
  • No labels