Step-by-step guide

Summary

Slack is a cloud-based collaboration tool used to communicate teams. JEMHCloud supports Slack notifications from Issue Events and Post Functions. You will be able to notify your Slack Channels when JEMHC detects an issue change.

Configuring the Slack Connection

In order to send Slack notifications from Issue and Post function events, you need to set up a Slack connection first. The connection knows how to send Slack messages via Slack Rest APIs.

To create a Slack Connection:

1. Log into your Slack's Team

2. Go to JEMH Cloud → Slack Connection → Connect To Slack
   

   Image Added

3. Authorize JEMHC to be installed to Slack as an App. This allows communication from JEMHCloud to Slack
   

   Image Added

   
   
   

4. Check out new Slack Connection on the screen.

...

Once you have the connection created, you can set Slack Notification Mappings to drive Slack notifications from Issue Created/Updated/Deleted events or Slack Post Functions to drive Slack notifications from transition events.

Send Slack notifications from issue events

Like Email and SMS Notification Mapping, Slack Notification Mapping is in charge of sending Slack messages from Issue events through the Slack Connection.

Creating a Slack Notification Mapping:

1. Go to JEMH Cloud → Notifications → Slack → Create

   Image Added

2. Complete the form, select the nominated projects, select the Slack Connection you want to use and the channel that will receive Slack messages. Enter a velocity script if you want to modify the notification behaviour at runtime (more below).
   

   Image Added

3. On Submit, you should see the new Slack mapping
   

   Image Added

4. To test the mapping, create an issue in the nominated project and go to Auditing → Events

5. You should see the issue created event in the queue. When event has been processed, the configured channel in the mapping should have received an Slack message.
   

   Image Added

6. The report of the event should confirm the message was sent to a selected Slack channel (e.g.) 
   

   Image Added

7. In Auditing → Outbound Messages → Type Slack, the table should show the Slack messages sent and the cog icon should show their contents.
   

   Image Added

   
   

   Image Added

Send Slack Notifications from Post Functions

JEMHCloud allows you to send Slack notifications when Issue transitions are performed through JIRA Post Functions.

Adding the Slack Notification Post Function to workflow transition:

1. Go to right corner Cog → JIRA Administration → Issue → Workflows. Edit the workflow of the project you want to add the Post Function. Click on the transition you want to change and select the Post Functions tab. Click on Add post function
   

   Image Added

2. Select Send Slack Notification by JEMHCloud and click Add
   

   Image Added

3. Set the Slack Connection, Chanel and Velocity script if necessary. Press Add/Update
   

   Image Added

4. Move the Post Function to last position and publish the workflow draft.
   

   Image Added

5. Remember to publish the workflow change draft! 

6. To test the post function, go to an issue and perform the transition.
   

7. Post function event should appear in JEMH Cloud → Notifications → Events. The event report identifies the channel notified:
   

   Image Added

8. In Auditing → Outbound Messages, the table shows the SLACK messages sent.

...

Unable to find your desired Slack channel?

Due to limitations with Slack API, we currently only display the first 1000 channels.

If you cannot find your chosen channel, you can override this setting using the velocity script in the notification configuration:

1. Select any channel - this will get overridden.

2. Enter the following script in the velocity script editor, replacing AnotherChannelNameOrId with the channel name or channel ID:

$slackNotificationUtils.setChannel('AnotherChannelNameOrId')

...

You can find channel ID’s when accessing Slack through your Web Browser, normally under the following structure:

https://app.slack.com/client/WORKSPACE_ID/CHANNEL_ID

Filter Scripts

Both Slack Notification Mapping and Slack Post Function behaviour can be changed at runtime with a Velocity Script. The script can use the event data or be time-based to change how notifications are performed.

Change Channel

Change channel when Critical

#if ($context.issue.fields.priority.name.textValue() != 'Critical')
  $slackNotificationUtils.setChannel('AnotherChannelNameOrId') ## JEMHC looks for the channel by either name or id
#end

Restrict notifications to specific time ranges

Notify only after hours

#if (!$dateTimeUtils.betweenHours("18:00", "06:00"))
   $slackNotificationUtils.inhibitNotification() ## Slack messages are not sent during business hours **
#end

Restrict by priority

#if ($context.issue.fields.priority.name.textValue() != 'Blocker')
   $slackNotificationUtils.inhibitNotification()
#end

Related articles

...

...

...