report_customsql
Maintained by Tim Hunt, Mahmoud Kassaei
This report plugin allows Administrators to set up arbitrary database queries to act as ad-hoc reports. Reports can be of two types, either run on demand, or scheduled to run automatically. Other users with the right capability can go in and see a list of queries that they have access to. Results can be viewed on-screen or downloaded as CSV.
2138 sites
79 fans

This report, created by The Open University, lets Administrators set up arbitrary SQL select queries that anyone with the appropriate permissions can then run. Reports can be set to be runnable on-demand, or automatically run weekly or monthly.

The results are displayed as a fairly plain HTML table, and can also be downloaded as CSV.

The idea is that this lets you quicly set up ad-hoc reports, without having to create a whole new admin report plugin.

### Contributors

Mahmoud Kassaei: Developer

### Awards

• Sat, 17 Mar 2018, 5:14 AM
I have finally done a 3.2+ compatible version.
• Wed, 4 Apr 2018, 7:05 AM
Hi, Tim. I noticed that the last update stripped away the report name from the email report. They all show up as "Query" now. Was that intentional, or should I do a bug report?
• Wed, 4 Apr 2018, 5:36 PM
I don't think that was an intentional change. A but report would be good. A patch would be even better, if you can do one
• Thu, 5 Apr 2018, 5:22 AM
Unfortunately, I don't have the skills to help you out with that, Tim.

I've submitted a bug report. I hope I did it right. I think I've only ever done one before.
https://tracker.moodle.org/browse/CONTRIB-7238
• Thu, 19 Apr 2018, 1:49 AM

I've been looking for information about the "Export csv report to path / directory" functionnality but couldn't find any.
What kind of path is expected? A local path from the server root? Where can I export my file?
The contextual help (in Portuguese) didn't seem to be filled. Maybe I can help with that once I understand the feature.
Thanks
• Thu, 19 Apr 2018, 11:48 PM
It is a path on the local server. Here is how the setting is used in the code https://github.com/moodleou/moodle-report_customsql/blob/master/locallib.php#L670. (That could be a file path that is a mount of a network disc, or similar.)
• Sat, 21 Apr 2018, 3:00 AM
Thank you very much for the help
• Wed, 20 Jun 2018, 2:57 AM
I have started to work with this plugin, which I found to be incredibly useful (thank you to the developers).

However, I have had to make some small modifications on my version to get it working the way I need and I want to share my feedback.

In the locallib.php file, I found that the subject line for the emails that get sent is not currently pulling the query name (display name) which it is coded to do. I modified these lines in mine by changing "report_customsql_plain_text_report_name($report->displayname)" in the code to "report_customsql_plain_text_report_name($report)" since the "report_customsql_plain_text_report_name()" function looks at the \$report object as a whole and then returns the query name.

• Wed, 20 Jun 2018, 9:03 PM
Ah! We just foudn this bug ourselves last week, and our fix, which is the same as yours, is just going through testing.
• Thu, 21 Jun 2018, 1:35 AM
Glad to hear that it was found.

I'm currently looking deeper into the code, and I am looking at some enhancements to meet my needs (maybe something you would be interested in). One is to have a flag to determine if emails are sent out or not if the result set is empty (helps with sending alerts).

The other is to add an hourly option to the schedule to assist with hourly scheduled reports. This for me is useful when writing queries that will be used as alerts to specific users (mostly for teachers). I'm still working out the logic for this one.
• Fri, 29 Jun 2018, 3:12 PM
Why have I an error near 'Add_Discussion_Forum_Essentiels('%DCP98', '%Forum des Essentiels%', 123) LIMIT 0' at line 1 Add_Discussion_Forum_Essentiels('%DCP98', '%Forum des Essentiels%', 123) LIMIT 0, 2 [array ]. My line contains only Add_Discussion_Forum_Essentiels('%DCP98', '%Forum des Essentiels%', 123). Why adding LIMIT to my line ???
• Wed, 4 Jul 2018, 9:39 PM
A couple of questions about changing run time of scheduled reports

For reference, all my ad-hoc scheduled tasks run at 10 minutes after every hour and all reports have the "Scheduled, Daily" option.

Question 1 - if a report is set to "Scheduled, daily" and it fails to run for some reason at, say, 7:10am, how would I "reset" it so that scheduled tasks can run it again later the same day?

Question 2 - what is the latest time I can edit a report, and change the time, so that it is still run? For example, if I edit a scheduled report that was scheduled to run at 7:10am and save it at 7:08am, will it be run at 7:10am?

Just wondering for debugging purposes. Thanks again for a great plugin that, quite frankly, my group could not do without.

Richard
• Wed, 4 Jul 2018, 10:30 PM
Reports run when cron triggers the scheduled task. That is unlikely to be exactly on the hour.

I am afraid that the only way to find out exactly how it works is to read the code starting at https://github.com/moodleou/moodle-report_customsql/blob/master/classes/task/run_reports.php. (It is not particularly complicated.)
• Wed, 26 Sep 2018, 3:25 PM
Hi is it possible to add a extra roll to report_customsql?
• Wed, 26 Sep 2018, 4:19 PM
Well, technically you need to ask 'Is it possible to add extra capabilities ...'. The only way to do that is to edit the code. Specifically you would need to add them to this list: https://github.com/moodleou/moodle-report_customsql/blob/master/locallib.php#L221

You also need to remember that these reports live in the System context, and only a few roles are assigned in that context. (E.g. Teacher role only exists inside a particular course, and these reports are outside all courses.)