Versions Compared

Key

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

Problem

In certain situations some users needs to be informed As a project manager or another user with a specific role in the project, you must notify other users by email about new issues or changes in the issue fields by the project manager or other users with specific roles in the project. Also. In addition, these emails are not to shouldn’t be sent automatically sent because not all the changes or issues need new issues or changes require an email notification.

Our Power Actions for Jira app offers you a very simple solution to build You can use Power Actions™ to create and send emails to all or certain project members at a click of a button.This solution presents one of many that the Simple Issue Language Reference and Power Actions for Jira can implement.

You can simply let your imagination run free ...

Solution

In order to To solve this issue you will have to problem, use a Power  Power Actions™ custom field that builds creates an email via based on a template, and sends it to its selected recipients.

Step 1: Create a new Power Actions™ Custom Field

The first step consists in creating a new Power Actions™ custom filed, as follows:

  1. Go to the Administration page.

  2. In

this page go to
  1. the Issue section

.
  • Here you will find a link named Custom Fields; you should click on it.

  • Add a new custom field from the button in the right top of the screen ("Add Custom Field").

  • Choose
    1. , click Custom Fields.

    2. Click the Add Custom Field button in the upper-right corner to add a new custom field.

    3. Select the Power Actions™ Custom Field option

    and press
    1. . Click Next.

    Name this newly created
    1. Rename the new custom field

    : "
    1. to Email Issue

    "
    1. .

    Choose
    1. Selectyourapplicable issue types and

    applicable
    1. context

    in order
    1. to view the new

    created
    1. custom field only on certain issues and projects

    - as you desire
    1. . By default, the custom field is visible in global context.

    2. Click Finish.

    Step 2: Configure your Power Actions™ Custom Field

    Configure
    1. To configure the Email Issue custom field

    by doing the following:
  • Choose the cog iconImage Removed at right of the screen for your "Email Issue" custom field. This can be done by going to the Custom Fields page.

  • Click the Configure link.

  • Now we'll need to create a button that will trigger the email sending action.

  • Click on the Edit Buttons link. You will find it on
    1. , select the cog icon on the right.

    2. Go to the Custom Fields page to find your Email Issue custom field.

    3. Click Configure.

    4. To create a button that triggers the email sending action, go to the Buttonssection at the bottom of the page

    in
    1. . Click the

    section named
    1. Edit Buttons link.

    2. Click Add New Power Actions™

    by creating a Button Text called: "
    1. and enter Send Email

    ". Press the Add button.At the end of this operation you'll see 5
    1. as the button name. Click Add.

    2. Five links for this button

    in
    1. are now displayed on the right of the

    screen
    1. page.

    1. The first three

    of them
    1. are the

    SIL
    1. SIL™ scripts that

    controls
    1. control it. They are:

      • The

    first script, named
      • Condition Script

    ,
      • . It contains the condition for the button visibility. The default value is visible

    , so if you want all
      • (the user

    to
      • can see and

    action
      • click this button

    you can let the default script
      • ).

      • The

    second Script, named
      • Screen Script

    ,
      • . It allows you to determine if the

    send
      • email sending action requires additional data.

      • The

    third Script , named
      • Action Script

    ,
      • . It sends the email you

    'll
      • want to the specified email addresses.

    Step 3: Configure the Power Actions™ Screen Script

    In order to To send the email you will need to , configure the Power Actions™ Scripts.As we said previously, the

    Info

    The Condition Script can be

    configure in order

    configured to prevent certain users to send the emails. For more information

    please use

    , go to the Condition Script page.
    The Screen Script is used to

    show

    display a message

    on the screen in order

    to confirm the email sending action. This is a security measure to prevent an accidental click

    on

    of this button.

    To edit this the script, click the Screen Script link from on the Configure Email Issue page. Add Then enter the following code:

    Screen Script

    Code Block
    string[] ret;
    ret = BA_createInput("Message", "You are about to send a email message to all members of this project.", true);
    return ret;

    This code will show displays a read-only message in the screen.

    Step 4: Configure the Power Actions™ Script

    The Action Script is the one that sends the email to the desired selected users.

    To edit the Action Script, click the Script link from on the Configure Email Issue page and  add . Then enter the following code:

    Action Script
    Code Block
    string[] to = projectMembers(project);
    string[] cc;
    string subject = "JIRA Email Issue: " + summary;
    string template = "template.tpl";
    string language = "en_US";
    print(attachments);
    if (sendEmail(userEmailAddress(currentUser()), to, cc, subject, template, language, attachments))
    {
     return "The email has been sent succesfuly";
    }
    else
    {
     return "An error occured when sending the email.";
    } 

    This code sends a template email to all the project members including the current user. For more information about on sending an email using SIL™ please read , go to the sendEmail page.Because we used in

    Tip

    Create and rename to template.tpl the email template from the previous code

    a email template we'll need

    to

    create and use this template named: template.tpl.

    use it again in the following steps.

    Step 5: Build the email template

    After the installation of the plugin, in the "Administration" menuplugin installation, a new option will appear named "Kepler General Parameters" option is displayed.

    Go there to the option and select "the katl-commons" plugin from the Select plugin list.

    A configuration option named "Email Template Directory" depicts the directory where  the indicates the folder where the templates are keptstored. The directory path is relative to the jira.home.dir/kepler.

    The rest remaining part of the email configuration is extracted from the standard JIRA configuration (Administration->Mail Servers->SMTP Mail Server)Jira configuration. You can find this on Administration > Mail Servers > SMTP Mail Server.

    You can create a new template in this folder using your desired preferred text editor. You can To add certain issue field values in to the template by using , use the $field$ notation, where field is the field name of the field you want to put in enter into the text. Here is an example:

    Email Template
    Code Block
    Hello $recipient$,
     
    This is a test template sent from $assignee$'s issue $key$. The summary for this issue is: $summary$.
    This issue has the following fields:
    
     Type : $type$
     Priority : $priority$
     Labels : $labels$
     Status : $status$
     Resolution : $resolution$
    
     $key$ is described as follows: 
     $description$
     
    This issue was created on $created$ and updated on $updated$. It's due date is: $dueDate$. The assignee is $assignee$ and the reporter is: $reporter$.
    
    Best regards,
    $reporter$
    
    This email was automaticaly generated by the JIRA Blitz-Action plugin:
    https://marketplace.atlassian.com/plugins/com.keplerrominfo.jira.plugins.blitz-actions
    or
    http://jira-plugins.kepler-rominfo.com. 
    Please do not reply.
    Info

    Email Templates

    You can consult theEmail Templates page for further information. Also consult the Mail Configuration pageFor more information, go to Email Templates and Mail Configuration.

    Test

    You can now test this your custom field by going .

    Go to the issues you have selected in the first step of this recipe. The Issue screen will have Theissue view now displays the Send Email button, like this:

    Image Removed

    After you click the button you'll need to .

    Image Added

    Click the Send Email button and confirm your email:.

    Image RemovedImage Added

    Click the Execute button and the email will be sent.That's all. You just saved 100 US dollars, so for sure you can eat at least a chocolate bar to send the email.

    Table of Contents

    Table of Contents