Adding New Reminders

You can add a new reminder to currently displayed issue in 3 ways:

• By using 'r', keyboard shortcut
• By selecting "Add New Reminder"
• By pressing "Add New Reminder" link in the Reminders right issue panel

All of these options display "Add New Reminder" dialog shown below.

Image Removed

...

You have to select at least one reminder target, enter a summary information and a reminder date. Reminder date should be at least 5 minutes ahead of your time. Summary could be maximum 50 characters long and description could be maximum 150 characters long. If you enter multiple targets all of them will receive notification. If a user matches more than one target, he will receive notification only once. You cannot use rich text in summary and description fields, they all need to be in free text format. For security reasons HTML content is also escaped and will be displayed as plain text.

Each time a reminder is send a comment may also be created depending on add-on settings. Even if you delete the reminder you can check issue comments to see when a reminder is send.

Global Reminders

Global reminders are sent before issue deadline. These reminders are send to all users watching the issue, reporter and assignee of the issue. Reminders are send before configured amount of time before actual due date of the issue. You can configure how many hours before issue deadline a reminder will be send.You could completely disable reminders if you want from the plugin configurations page. It is off by default.

Issue Reminder List

All active and past reminders of an issue are displayed on the “Reminders” right of an issue. Active reminders are shown with a yellow post-it, and completed reminders are shown with a light blue post-it with a check mark on it.

Image Removed

You can also add new reminders or delete, edit existing reminders depending on the  permission you have. For every reminder following information is displayed:

• Reminder’s recipient: For  reminders with multiple recipient “Multiple Recipient” is displayed and if you hover on it, all recipients will be displayed in a tooltip. If recipient is a single user, hovering over it will show further details about the user.
• Reminder’s trigger time: The date on which the notification email will be sent or for expired notifications the date on which the reminder email is send. 
• Reminder’s summary: If you hover on summary information, description of the reminder is also displayed as a tooltip.

Reminders Menu

Reminder list shown on the right hand side of an issue also host shortcut actions for the plugin. Pressing the arrow button next to "Add New Reminder" button opens the menu shown in the below screenshot.

Image Removed

You can quickly create a reminder for Tomorrow, or Next Week. These actions opens the reminder dialog but auto fills reminder due date. "My Reminders" action opens "My Reminders Page" explained below. Issues with My Reminders opens Issue Navigator with a JQL query which shows all issues with reminders created by you. A very similarly named action "Issues with Reminders for Me" also opens issue navigator with JQL but this time it shows all issues with Reminders whose recipient is you.

Deleting Reminders

If you do not have administrator rights you can only delete your own reminders. Project administrators could delete reminders in their own projects and JIRA administrators could delete all reminders. If you do not want to receive notification from a reminder just tell the reminder owner to remove you from reminder targets. If you delete an active reminder notification will not be sent.  Deleting a past reminder will not have any effect other than removing data from the database. Since an already delivered notification has nearly no overhead on the system you generally do not need to delete them.

Image Removed

Editing Reminders

If you are owner of the reminder you can edit it. Editing a reminder is completely the same with creating a new reminder. The same reminder dialog is opened with previously entered information and you can change all attributes of the reminder. 

My Reminders Page

You can see list of all reminders created by you using My Reminder Page. You can edit or delete reminders like you did in issue page. In active reminders are filtered out by default, just check "Include Inactive Reminders" checkbox to display list of inactive reminders. To open my reminders page click on the down arrow next to "Add New Reminder" action and select "My Reminders" menu item from the list. 

Image Removed

Viewing Issues with Reminders

You can use JQL to query which issues has a reminder, either active or completed. There are 4 JQL functions and all of them starts with “issuesWithReminder” prefix:

• isuesWithReminder(“filterOutCompleted”): This is the most basic of all JQL functions. It just returns all issues with reminders. It takes one optional parameter to filter out issues with only completed reminders (default false).

Following queries returns all issues which has at least reminder (active or completed).

issue in issuesWithReminder() issue in issuesWithReminder(“false”)

Following query returns all issues which has at least one active reminder.

issue in issuesWithReminder("true")

• issuesWithReminderOwnedBy(“username”, “filterOutCompleted”): This query returns issues which are owned (set up by) given username. It takes an additional optional parameter to filter out issues with only completed reminders (default false).

Following query returns all issues which has at least one reminder set up by user with username “ataoguz”

issue in issuesWithReminderOwnedBy("ataoguz", "false")

• issuesWithReminderForUser(“username”, “filterOutCompleted”): This query returns issues which has reminders set up for the given username. It takes an additional optional parameter to filter out issues with only completed reminders (default false).

Following query returns all issues which has at least one reminder set up for user with username “adaoguz”

issue in issuesWithReminderForUser("adaoguz", "false")

• issuesWithReminderForEmail(“email”, “filterOutCompleted”): This query returns issues which has reminders set up for the given email address. It takes an additional optional parameter to filter out issues with only completed reminders (default false).

Following query returns all issues which has at least one reminder set up for email address “externaluser@client.com”

issue in issuesWithReminderForUser("externaluser@client.com", "false")

• issuesWithReminderForRole(“rolename”, “filterOutCompleted”): This query returns issues which has reminders set up for the given project role. It takes an additional optional parameter to filter out issues with only completed reminders (default false). If you need to filter reminders for only a specific project add another JQL clause to filter projects as shown in the following example, without it query returns results from all projects.

Following query returns all issues which has at least one active reminder set up for project role “deployment-team” in ERP project.

issue in issuesWithReminderForRole("deployment-team", "true") AND project = "ERP"

• issuesWithReminderForGroup(“cm”, “filterOutCompleted”): This query returns issues which has reminders set up for user group. It takes an additional optional parameter to filter out issues with only completed reminders (default false).

Following query returns all issues which has at least one active reminder set up for cm(Configuration Management) group.

issue in issuesWithReminderForGroup("cm", "true")

Plugin Template Configuration

You can change default email template used by the plugin from the settings. You can use variables from reminder itself or issue to add information to email body or subject. List of available variables are also available inside plugins template configuration page. Click on the question mark icon next to template to display it. Templates are Velocity templates, you can use any Velocity keyword inside the template. If you want to return to default template, just delete everything and save as empty, it will automatically revert to default template.

Image Removed

FQA

...