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. 

Beginning with RemindMe version 1.0 a new feature is available: Users can now add individual reminders to any JIRA issue they want to be reminded about.


Content

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

 

Individual reminders for JIRA Issues

General Information

This feature allows a user to receive individual reminders for every single JIRA issue he wants to be reminded about. Obviously he needs to have access (i.e. permissions to see it) to this issue. This feature may be combined with the Global Reminder Option mentioned earlier on this page.

Individual reminder configuration

As this reminder applies only to a single JIRA issue it is necessary to be configured on each JIRA issue individually. In order to set a reminder navigate to the 'More Actions' menu of the corresponding JIRA Issue and select 'RemindMe'.

In the following dialogue the date of the reminder will be specified. If there is already a reminder configured for this issue and the currently active user, then the date will already be inserted.

After the form has been submitted and the reminder has been activated it will be displayed on the 'view issue screen'. The aforementioned dialogue can also be accessed by clicking the RemindMe Date link on this screen.

In order to remove a reminder on any issue the reminder configuration dialogue should simply be left blank.

Global reminder option referring to the Due Date of an issue

General Information

RemindMe also provides you with a global option which, when activated, will set a reminder for all of your issues. You will then 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 am (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)

Global reminder configuration

Activate or deactivate the global reminder

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

 

Definition of global reminder offset 

By default, the time set for global 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 global 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 receiving.

Technical Background

The global 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 global 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 global reminder not to work correctly.

Give us feedback about RemindMe

In the reminder configuration dialogue you will find a link to provide us with valuable feedback. That may include feature requests, issues or just general feedback. Please make use of that. Alternatively you could also use the Customer Portal to do that. Thanks for your time!

  • No labels