Page tree

We have finally moved our support portal to the cloud, which includes this documentation as well.
All documentations here are therefore no longer up to date.
Please follow the link for the latest documentation: https://communardo.atlassian.net/wiki/spaces/remindme/overview

Skip to end of metadata
Go to start of metadata

 

Introduction

By default in JIRA users can configure filters by themselves. These filters may be subscribed to by email. With this function, every user can be informed about upcoming issue due-dates. Unfortunately this function is somewhat difficult for the user to understand. RemindMe makes creating reminders easier for the user. This Plugin allows the user to be automatically informed of an upcoming deadline. Users can activate or deactivate this feature individually but only for all of their issues. Each user can set the time intervals for when they receive reminders of approaching deadlines. 


Content

This documentation refers to the current version 0.9 of the plugin, for other versions see

 

General Information

As with the current release, you only have a global option which, when activated, will set a reminder for all of your issues. You will than be reminded by email about all your issues that reach their due-date. The email will only be sent once per day and shall arrive until 5 pm (the time might vary depending on the setting of your JIRA server). It will contain all issues that reach their due-date. Only issues meeting the following requirements will be considered for the reminder:

  • you have to be the creator of the issue OR the issue has to be assigned to you (so watchers of issues are ignored)
  • AND the issue must have set the JIRA standard field "due-date" to a valid date
  • AND the date set for the due-date field must be X days after the reminder is fired, where X is the amount of days set in the reminder configuration (see below for details)

 

Reminder Configuration

Activate or deactivate the reminder

To activate the reminder navigate to the user menu (the menu that has your name on it) and select the option "RemindMe Settings". In the dialog that appears tick the checkbox next to "Enable Reminder" and click the "Submit" button. To deactivate the feature just repeat this steps but remove the tick from the checkbox. By default the reminder is disabled for each user.

 

Definition of reminder offset 

By default, the time set for reminders is one day before the due-date of an issue. You can change the time interval on the same dialog that is used to activate or deactivate the reminder (see above). Just change the value next to "Offset (in Days)" to any positive integer. This value determines the number of days that you want to be reminded before issues reach their due-date.

Please note that the above described offset is applied to all reminders the current user is recieving.

 

Technical Background

The reminder functionality is based on JIRA standard functionality, namely filters and subscriptions. So when you activate the reminder a filter and a subscription are created which reflect the reminder settings. The filter and the subscription are removed if you disable the reminder. They are replaced when you edit the reminder.

You can edit this filter directly. Please be aware that manually changing the filter might cause the reminder not to work correctly.

  • No labels