Redmine Issue Reminder - Version 0.0.1

Added by Michael Kling about 6 years ago

Update 2017-09-18:

As we are lacking Ruby Developers we con no longer maintain this plugin. But as it is open source everybody is free to continue improving/keep it compatible with currents redmine versions.

Currently https://github.com/jcppkkk/redmine_mail_reminder from Jethro Yu is the best maintained branch on github.

Original Post:

Because we didn't like to configure rake tasks for email reminders for every project needs and it also lacked some specific filters - we decided to create our own reminder plugin.

Only one cron job has to be created which handles all the remindes which are easily configurable in the redmine system by any user who owns the specific rights.

Reminders can be configured per project, they are selecting the issues which it should remind via a custom query (so you are free to select whatever conditions you want).

It is possible to send the reminder daily (define interval every 1st-every 6th), weekly (define weekday) or monthly (define day of month) to specific roles inside the project. (See also screenshot for that)

Any feedback is welcome :)

Download

You can download the plugin here: https://github.com/ascendro/redmine_issue_reminder
Installation instructions are given in the readme.

Screenshots

Replies (30)

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Terence Mill about 6 years ago

What does it remind for?
Due date or any change?
Does it collect all entries for the period and redmine all in one email or just en email per issue?
Iour users would like to configure their redminding by themself.
So it shall configurable with priority for actual user from "my Account" too.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Steven Wong about 6 years ago

Anyone who could tell me how to config the schedule task on windows and CentOS in detail?

Thanks a lot.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Michael Kling about 6 years ago

@Terence Mill:
It is sending you issue lists which are built by queries like the queries in the normal issue list (it is using the same queries, so if you want something special you have to create and save a new query.

Here you can do whatever you want, like "assigned to <<me>>" etc.

What im using in my system are the following queries:

And that are the reminder i set up:

With the rake task scheduled on 6 oclock each day it means that i will get every morning 6oclock 1 email
(it is collecting all lists together in one email and not sending you 35 different emails)
  1. My Issues today (based on each user, so the assigned to <<me>> filter is used)
  2. Recent updates
additional every monday the email contains also:
  1. My issues this week
  2. Deadline exceeded
And for specific roles only:
  1. Unassigned
  2. Unplanned

Basically you can set up whatever query you want!

@Steven Wong:
On windows: create a batch file calling cd {REDMINE_ROOT} && rake reminder:exec RAILS_ENV="production" and then use the windows scheduler to call that batch file every day.
It is possible that the rake can not be found by windows, in this case you should write the full path to rake.exe.

Jusst google for how to set up a rake task with the windows scheduler.

IssueQueries.png (34.7 KB)

IssueReminder.png (38.5 KB)

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Steven Wong about 6 years ago

Hi, Michael Kling

Thanks. I'll try.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Steven Wong about 6 years ago

I tried it and it work well. The steps as follows:

Enviroment : Winxp + Redmine 1.2.X + Mysql 5.X

1. Write a bat file such as these ########################################

echo on
cd {REDMINE_ROOT}
rake reminder:exec RAILS_ENV="production"

########################################

2. config a schedule just follow this
http://www.iopus.com/guides/winscheduler.htm

3. then start the redmine server.

Thanks.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Michael Kling about 6 years ago

That's great. I will add it to the readme.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Steven Wong about 6 years ago

Some other points

1. if I do not config the configuration.yml in production area, it will failed indeed. I'm not very sure why it happened.

2. you should set you password if you never set password in you Windows user, if not, you can not use the scheduler.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Michael Kling about 6 years ago

For the windows stuff i cant give any support sorry - but it seems that its more some issue with the scheduler not with the plugin.

That you have to set the configuration.yml or email.yml is normal, cause the plugin is using the email configuration from that. (in fact its using the redmine internal mail send routines)

I will add this 2 things in the readme. Thanks again :)

RE: Redmine Issue Reminder - Version 0.0.1 - Added by James Bong about 6 years ago

Hi Michael Kling,

I tried to install your plugin but get an error when I click on "Issue Reminder" in a project.

The log file shows:

ActionView::TemplateError (no block given) on line #14 of vendor/plugins/redmine_issue_reminder/app/views/reminders/_form.html.erb:
11:               :with => "'interval='+value +'&reminder_id=#{reminder.new_record? ? 'new' : reminder.id}'")}  %>
12:     </p>
13:     <%= render :partial => 'interval_values',
14:                :locals => { :possible_values => Reminder.interval_values_for(reminder.new_record? ? :daily : reminder.interval),
15:                             :selected_value => reminder.interval_value,
16:                             :reminder => reminder } %>
17:     <p>

    vendor/plugins/redmine_issue_reminder/app/models/reminder.rb:40:in `each_with_index'
    vendor/plugins/redmine_issue_reminder/app/models/reminder.rb:40:in `interval_values_for'
    vendor/plugins/redmine_issue_reminder/app/views/reminders/_form.html.erb:14
    vendor/plugins/redmine_issue_reminder/app/views/reminders/_form.html.erb:1
    vendor/plugins/redmine_issue_reminder/app/views/reminders/index.html.erb:42
    passenger (3.0.9) lib/phusion_passenger/rack/request_handler.rb:96:in `process_request'
    passenger (3.0.9) lib/phusion_passenger/abstract_request_handler.rb:513:in `accept_and_process_next_request'
    passenger (3.0.9) lib/phusion_passenger/abstract_request_handler.rb:274:in `main_loop'
...

Please let me know how to solve this issue. I'm using Redmine 1.2.2.

Thanks.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Michael Kling about 6 years ago

Thanks for submitting an error. I raised an issue on github but can't go into it before christmas.
I will reply here when we can reproduce and fix it.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Peter Ch almost 6 years ago

Hi, Michael Kling.

Thanks for your plug-in, it's very usefull. I want to add plugin to my redmine, but there's a problem: i added issue query and issue reminder to this query (you can see it on a screenshot). But there's no issue reminder e-mails on 6 oclock. In my production.log of redmine there're no information at all. Other e-mail notifications works fine (like when i create new issue, etc.). Where can i see some information, of what i'm doing wrong?

Thanks.

screenshot.png (14.8 KB)

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Célestin Matte about 5 years ago

Hello,

I recently worked on making this plugin compatible with redmine 2.0.
Unfortunately, there's still a small bug I can't happen to fix as I'm not an expert in Ruby on Rails. I'm really close to making it finally work, as I fixed every call to obsolete functions, and am able to send emails. The only problem left is that I can't manage to route the email's view correctly (sent emails are empty).

I let my work here with hope that someone will finish the work and make the plugin finally compatible with redmine 2.0.

Thanks,
Célestin Matte

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Michael Kling about 5 years ago

@Peter Ch:
Did you setup the cron job?

@Célestin Matte:
Wow thats awesome. Unfortunatly we dont have any ruby developers anymore and therefore nobody to take care about our modules.
We switched to 2.x this year and had to drop it out of our own systems :(

I put your code into a new redmine2.0 branch in github and added a new issue.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Al McNicoll almost 5 years ago

@Michael: Can you link to the new location so that I can follow it please? Would love to get this plugin working in 2.x, and am sure I'm not alone!

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Michael Kling almost 5 years ago

It is still under the same repository: https://github.com/ascendro/redmine_issue_reminder but under a different branch.

Thats a direct link to the branch: https://github.com/ascendro/redmine_issue_reminder/tree/redmine2.0

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Matthew Houston over 4 years ago

This looks like such a promising project... I would love to see this functionality in Redmine itself as it seems like a pretty basic need.

I have installed on 2.3.1 but no go obviously.

Completed 500 Internal Server Error in 16ms
NoMethodError (undefined method `find_all_by_project_id` for Reminder:module):

I'm following on GitHub to see if anyone can get it to work, let me know if any testing is needed.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by JayD - about 4 years ago

Matthew Houston wrote:

This looks like such a promising project... I would love to see this functionality in Redmine itself as it seems like a pretty basic need.

Absolutely. This should definitely be part of the vanilla release of redmine. I'm taking care of DevOps for multiple but international teams and literally all of them were demanding it.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Matthew Houston about 4 years ago

I've so far had to work around it. Having no rails experience, I just wrote a fairly extensive Powershell script that can be scheduled whenever and can be pointed to a custom query.

It's not the greatest solution but for our needs it allows a project manager to create a query of whatever they want, then we just quickly schedule a new task to point to it.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Jethro Yu over 3 years ago

I have forked it on https://github.com/Hopebaytech/redmine_issue_reminder and try to run it on redmine 2.5.1 now.
Please let me know it works or not.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Quan VN over 3 years ago

Great
It seems to work for me on redmine 2.3.2. The only thing I have to change is replace visibility with is_public in line 3 in reminders_helper.rb since redmine 2.3.2 has field is_public, not visibility. Thank you Yu

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Quan VN over 3 years ago

Additional notes
1. In redmine 2.3.2, the public query is marked with 1 for is_public so the whole method should be changed into
def queries_for_options(project_id)
(Query.find(:all, :conditions => ['is_public = ? AND (project_id = ? OR project_id is null)', 1, project_id])).
collect {|q| [q.name, q.id]}
end
2. So only public query is available for reminder. I am thinking if non public query should be available too?

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Jethro Yu over 3 years ago

  • Updated, use redmine's IssueQuery.visible
    1. Avoid the different column title (is_public/visible) problem
    2. User can view queries those he views in project. (should be same as the query list on sidebar)
module RemindersHelper
    def queries_for_options(project_id)
 -    (Query.find(:all, :conditions => ['visibility = ? AND (project_id = ? OR project_id is null)', 2, project_id])).
 +    # Project specific queries and global queries
 +    IssueQuery.visible.
 +      where(project_id.nil? ? ["project_id IS NULL"] : ["project_id IS NULL OR project_id = ?", project_id]).
        collect {|q| [q.name, q.id]}
end
  • Inline CSS from site setting, What You See Is What You Get.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by chris pinto about 3 years ago

Jethro,

Mind sharing the new plugin files as a whole? I will try to edit it as u said though.

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Jethro Yu about 3 years ago

chris,

I made this patch with some other changes in my first commit and updated commit

I also tried to fix things on redmine 2.5, you can take a look here: https://github.com/Hopebaytech/redmine_issue_reminder/commits/redmine2.5

And yes, you can download them as a zip file from github :)

RE: Redmine Issue Reminder - Version 0.0.1 - Added by Dmitry B about 3 years ago

Jethro Yu,
thanks for the patch
but why it does not work every day alert

1 2 (1-25/30)