JCNE Jira Custom Notification Extension Documentation

Navigation

-Getting started

-Send custom e-mail notification

-Support and troubleshooting

Getting started

Overview

Jira Custom Notification Extension (JCNE) is a Jira app that introduces a single yet powerful post function allowing to send customized e-mail messages during a workflow transition.

Installation

Permission required

Remember that in order to carry out the steps described below and install JCNE you have to be a Jira administrator.

From Jira

1. Click the Administration cog icon and select Manage apps
2. Click Find new apps
3. Search for JCNE Jira Custom Notification Extension
4. Click the Install button
5.Click the Accept & Install button

From Atlassian Marketplace

1. Go to JCNE Jira Custom Notification Extension page on the Atlassian Marketplace
2. Click the Get it now button
3. Go to Jira, click the Administration cog icon, and select Manage apps
4. Click Manage apps
5. Click the Upload app link, select the file downloaded in step 2 and click Upload

Workflow configuration

Permission required

Remember that in order to carry out the steps described below and install JCNE you have to be a Jira administrator.

In order to configure a Jira workflow using post functions, validators, and conditions introduced by JCWE, follow the steps below:

1. Click the Administration cog icon and select Issues
2. Click Workflows in the sidebar menu
3. Click the Edit link in the Actions column of the workflow you want to configure
4. Select a workflow transition
5. Click the Post functions tab
6. Click the Add post function
7. Select [JCNE] Send custom email notification and click the Add button
8. Fill in the configuration and click the Add button
9. Publish the workflow

Next steps

Wondering what to do now? You can explore the rest of the documentation to find out what JCNE has to offer and take advantage of it. However, if you want to hop into action right away, just do it! JCNE is straightforward and user-friendly to let you enhance your processes quickly. If it happens that you need our assistance on any step of your journey with JCNE, just get in touch through our support portal or write a message at support@mintyminds.com.

Send custom e-mail notification

1. Define the subject of the e-mail message in the Subject field (e.g. “This is the subject of my e-mail”)
2. Activate the Exclude prefix option to remove the prefix added by Jira from the subject
3. Define the content of the e-mail message in the Body field (e.g. “This is something that I want to tell you about”)
4. Activate the Add comment option to add a comment to the transitioned issue with the subject and body of the e-mail sent
5. Activate the Set custom sender option to change the e-mail address and the name used as a sender of the e-mail message (if this is not set, the e-mail will be sent according to the Outgoing Mail Jira settings)
5a. Set the address of the sender in the From address field
5b. Set the name of the sender in the From name field
6. Activate Set e-mail to, Set e-mail cc, or Set e-mail bcc options (at least one is required). Define to whom the e-mail will be sent
6a. Select a Jira user group in the Group field if you want to send the e-mail to all users in a group
6b. Select a project role in the Role field if you want to send the e-mail to all users with a certain role in the project of the issue being transitioned
6c. Select users in the Users field if you want to send the e-mail to single users
6d. Select a User Picker custom field in the User picker field to send the e-mail to the user set in a certain field on the issue being transitioned
6e. Provide e-mail addresses in the Addresses field to which the e-mail will be sent
6f. Select a text custom field in the Addresses Text CF field to send the e-mail to the address set in a certain text field on the issue being transitioned
6g. Activate the Project Lead option to send the e-mail message to the user set as a project lead in the project of the issue being transitioned
6h. Activate the Components Lead option to send the e-mail message to the user set as a component lead of the component set on the issue being transitioned
7. Activate the JQL condition option and define the JQL query that has to be met by the issue in order to execute the post function (e.g. “type = Bug and Priority = Blocker”)
8. Activate the Executor condition option if you want the post function to be executed only if the user is or isn’t in a certain Jira user group or project role
8a.Select if The executor has to be or can’t be a member of a certain Jira user group or project role
-Select a Jira user group in the Group field if Group was set in the member of a field
-Select a project role in the Project role field if Project role was set in the member of a field

Custom sender

The email address set in the From address field when defining custom sender data may not work for every email service provider.

Support and troubleshooting

Support

If it happens that you come across a problem or have a question regarding JCNE, don’t hesitate and reach out to us through our support portal.

The support portal hands you the following types of requests to categorize your needs:
-Defect for reporting problems, bugs and other malicious behaviors
-New feature for requesting improvements and new functionalities
-IT Help for all other general questions about installation, licensing or configuration

Working hours

Minty Minds support operates every weekday from 9:00AM - 5:00PM PST. Our support crew will answer you within 24 hours.

Troubleshooting

Before you decide to contact our support due to a malfunction found in our add-on, we encourage you to do the following in order to conduct basic analysis:
-Make sure you are using the latest version of the add-on. If not, please update JCNE
-Enter the Safe Mode in Jira (for more information see Disabling and enabling apps) and enable JCNE only. Try to reproduce the defect. If the problem no longer exists, try to enable other apps one by one, testing JCNE each time. Finally, you should be able to find the app that is not compatible with JCNE and causes the malfunction

Test environment

It is highly recommended to test the Jira apps (or their updated versions) on a test environment prior to doing it on the production environment. Also testing the apps with Safe Mode should be performed on a test environment.

Reporting bugs

Finding a bug in a software application is always a disappointing experience. We do our best to keep our apps thoroughly tested, but if it happens that you encounter a bug, we encourage you to raise a defect ticket in our support portal. If you want to help our support crew solve your problem quickly, provide the following information:
-Detailed reproduction steps so that our engineers can duplicate the defect in the test environment
-Screenshots or video files presenting the problems as evidence
-Log files from Jira. There are two ways to get the log files:
-Copy from the Jira Home Directory: JIRA_HOME\log\atlassian-jira.log
-Generate the support zip. For more information see Create a support zip
-Information about your Jira and JCNE versions

Supported versions

Our support may refuse to process your request if either the version of your Jira reached its EOL date or JCNE version is not the latest available.