Child pages
  • Installation Guide
Skip to end of metadata
Go to start of metadata

Go2Group JIRA Reminder Plugin Installation Guide

Installation Steps

Step 1: Create a custom notification template

  1. Copy velocity templates for the email layout to the following directories (3 files are named issueinactive.vm).
    templates/html/issueinactive.vm to <JIRA-INSTALL>/atlassian-jira/WEB-INF/classes/templates/email/html
    templates/text/issueinactive.vm to <JIRA-INSTALL>/atlassian-jira/WEB-INF/classes/templates/email/text
    templates/subject/issueinactive.vm to <JIRA-INSTALL>/atlassian-jira/WEB-INF/classes/templates/email/subject
    
  2. Edit the <JIRA_INSTALL>/atlassian-jira/WEB-INF/classes/email-template-id-mappings.xml file to add in a new mapping.
    Ensure that the name of the template matches the file name above.
    <templatemapping id="10000">
    <name>Issue Not Updated</name>
    <template>issueinactive.vm</template>
    <templatetype>issueevent</templatetype>
    </templatemapping>
    

    Change the id if the id=10000 already exists.

  3. Restart JIRA.

Step 2: Create a reminder custom event

  1. Navigate to Administration -> Advanced -> Events to create a new event.
  2. Select the template you have just created in the above step.
  3. Take note about event id for the next step.
  4. Click Edit Event and get eventTypeId from the URL.

Step 3: Install Go2Group JIRA Reminder Plugin

  • Plug Go2Group JIRA Reminder Plugin (g2greminder-0.1.jar) to your JIRA. 

Step 4: Create a reminder service

  1. Navigate to Administration -> Advanced -> Services to create new service.

    Field Name

    Description

    Service name:

    Name of the service

    Class:

    com.go2group.jira.plugin.g2greminder.ReminderService

  2. Configure the following properties in service setting screen.

    Field Name

    Description

    Event ID:

    ID of the event has been created in step 2

    Inactive Period:

    If issue is not updated in this period notification emails will be sent (syntax ex: 1h, 1d, 1w)

Step 5: Activate logging (optional)

In case you want to enable logging from Go2Group JIRA Reminder plugin, add the following lines to <JIRA-INSTALL>/atlassian-jira/WEB-INF/classes/log4j.properties file.

log4j.logger.com.go2group.jira.plugin.g2greminder= INFO, console, filelog
log4j.additivity.com.go2group.jira.plugin.g2greminder= false




Congratulation your reminder has been configured !(thumbs up)



Installation Guide