Details

Description

New feature we are contributing. This may need tidying up a little; either way we wanted to release this to get it out there.

Description:

Kineo has developed a generic Moodle report module, which can be added to an existing Moodle site to give detailed user reporting for courses with SCORM modules. It allows administrators to load report filters, schedule reports to be run at regular intervals and emailed to administrators, and export report data as Microsoft Excel format.
There are five different types of report filter, which can be combined in any order. Whenever a filter is created or edited the report is automatically saved. The category, course and unit filters are mutually exclusive - if a category filter is added to the report, it will not be possible to add a course or unit filter and vice versa.
? User filter
? Category filter
? Course filter
? Unit filter
? Date filter
Please see the attached screenshot for an example report generated by the module. Please note the module is very flexible and can generate a wide variety of SCORM related reports using the filtering system.

Sven Laux
added a comment - 03/Jul/09 7:34 PM These are the actual files that make up the report. The previous file was a screenshot. Apologies - first time user.
Installation instructions:
The kineo folder should be dropped into course/report/ folder of a Moodle installation v1.9+.
The cron job should be hourly, on the hour. The URL is:
[moodle installation path] /course/report/kineo/cron.php
Some database tables need setting up for this module to work. The data is in db/kineo_tables.sql
Please get in touch if you have any questions.
Best regards
Sven

I've installed the custom reports module and it all seemed to go ok (The tables have been created, the cron job is running and I was prompted to update in the notifications area), but I can't find how to access the reports. Where should they appear on the moodle menus?

Mike Woods
added a comment - 24/Aug/09 12:32 AM Hi Sven/Niall,
I've installed the custom reports module and it all seemed to go ok (The tables have been created, the cron job is running and I was prompted to update in the notifications area), but I can't find how to access the reports. Where should they appear on the moodle menus?
Mike

@Mike: click on 'Reports' link in (any) course admin block. there will be a link to 'Kineo Report' in there. note: in case you didnt already, you also need to import db/kineo_tables.sql into mysql database.

Chad Outten
added a comment - 24/Aug/09 11:27 AM - edited @Mike: click on 'Reports' link in (any) course admin block. there will be a link to 'Kineo Report' in there. note: in case you didnt already, you also need to import db/kineo_tables.sql into mysql database.

i copied the kineo folder to C:\moodle\course\report\kineo, imported the sql and run notification, but cant find the reports.. even after the notification, nothing happened, like moodle didnt add anything. Have i done something wrong..? Please let me know.

ivan
added a comment - 24/Aug/09 2:22 PM Hi,
i copied the kineo folder to C:\moodle\course\report\kineo, imported the sql and run notification, but cant find the reports.. even after the notification, nothing happened, like moodle didnt add anything. Have i done something wrong..? Please let me know.
Thank you

Mike Woods
added a comment - 26/Aug/09 12:24 AM Chad - I thought that should be where it appeared, but there is nothing there. I did create the tables and have confirmed that they are in the moodle database. There are no records in the tables.
Ivan - that's exactly the situation I'm in, although mine is a Linux installation, so the files are in /var/www/moodle/course/report/kineo in my case.
Mike

im glad im not the only one with this issue.. since there was nobody with solution yet, where can we get an answer or reasonable advice..? I really would like to use this report in my moodle, but it seems that the issue is not resolved.

ivan
added a comment - 26/Aug/09 2:31 PM Hi Mike,
im glad im not the only one with this issue.. since there was nobody with solution yet, where can we get an answer or reasonable advice..? I really would like to use this report in my moodle, but it seems that the issue is not resolved.
Ivan

I'm not sure. I think the "owner" of the reporting module is Sven, but I don't know if he is watching this post for new comments. I think I'll leave it a while to see if he responds, then try emailing him direct (his email address is in his profile).

Mike Woods
added a comment - 26/Aug/09 4:04 PM Hi Ivan,
I'm not sure. I think the "owner" of the reporting module is Sven, but I don't know if he is watching this post for new comments. I think I'll leave it a while to see if he responds, then try emailing him direct (his email address is in his profile).
Mike

Hi,
I followed your instructions.. extracted to report folder, set permissions, created tables, run notification- but nothing happened, like moodle doesnt add anything.. even under the reports i dont see kineo. Ataching screenshot just for you to check...
Please advice.

ivan
added a comment - 26/Aug/09 4:51 PM Hi,
I followed your instructions.. extracted to report folder, set permissions, created tables, run notification- but nothing happened, like moodle doesnt add anything.. even under the reports i dont see kineo. Ataching screenshot just for you to check...
Please advice.

yeah i did restart windows server - which restarts mysql as well.. the same story. When i run notification, nothing happened... Maybe is not made for win, or its for different version... Im running win2003, moodle 1.9.5, mysql 4.0
Let me know your thoughts on this one. Thank you.

ivan
added a comment - 28/Aug/09 2:38 PM Hi Chad,
yeah i did restart windows server - which restarts mysql as well.. the same story. When i run notification, nothing happened... Maybe is not made for win, or its for different version... Im running win2003, moodle 1.9.5, mysql 4.0
Let me know your thoughts on this one. Thank you.
Ivan

thanks for the screenshot and the detailed exlpanation- and thanks, Chad for the detailed steps.

If you are following the steps Chad mentions (it looks like you are) then the only difference is that you are running this on Windows. We haven't tested this modules on a Windows environment so it may well not work. We'll include this in our next testing cycle and will see what we can do.

In the meantime we have been working on various improvements, incl. turning this module into a proper admin report, introducing summary rows etc. We're planning to release the update over the coming weeks.

Will let you know when it's there. In the meantime I'd be keen to find out whether this works for you on a Linux system. Are you able to ty this?

Sven Laux
added a comment - 09/Sep/09 6:06 PM Hi Ivan,
thanks for the screenshot and the detailed exlpanation- and thanks, Chad for the detailed steps.
If you are following the steps Chad mentions (it looks like you are) then the only difference is that you are running this on Windows. We haven't tested this modules on a Windows environment so it may well not work. We'll include this in our next testing cycle and will see what we can do.
In the meantime we have been working on various improvements, incl. turning this module into a proper admin report, introducing summary rows etc. We're planning to release the update over the coming weeks.
Will let you know when it's there. In the meantime I'd be keen to find out whether this works for you on a Linux system. Are you able to ty this?
Thanks,
Sven

Mike Woods
added a comment - 09/Sep/09 8:48 PM Chad - I've now tried all of the steps in your earlier post (including the CHMOD, which was the one I had missed) and the Kineo Reports item is still not present in Reports.
Sven - I'm running Moodle on Linux (Ubuntu Server) and having the same problems as Ivan. I'd be happy to experiment as it's a test system!
Mike

Sven Laux
added a comment - 09/Sep/09 9:08 PM Hi,
please note: the Kineo report does not display under reports in the admin menu on the 'root adming menu' (yet) - this is a change we are addressing in the new version.
For now, please takethe following steps to access the module:
navigate into any Moodle course
select 'reports' from the course-level admin menu
select 'Kineo report' from the top of the list
Hope this helps. As mentioned, this is much improved in the next version.
I have also uploaded a new screenshot showing where the report can eb accessed from.
Sven

thank you for your reply. Unfortunately im not running Linux, since i dont feel confortable administering/running Linux- i dont have any experience. Ill be looking forward hearing from you regarding progress made with the Kineo reports. Please let me know if i can be of any help- any kind of testing or translating.

ivan
added a comment - 09/Sep/09 9:26 PM Hi Sven,
thank you for your reply. Unfortunately im not running Linux, since i dont feel confortable administering/running Linux- i dont have any experience. Ill be looking forward hearing from you regarding progress made with the Kineo reports. Please let me know if i can be of any help- any kind of testing or translating.
Regards
Ivan

I've found the reports now. As you guessed, I was looking on the main reports list, rather than in a course. The reports are working fine, and are going to be very useful, so thanks for making them available.

Mike Woods
added a comment - 11/Sep/09 7:57 PM Hi Sven,
I've found the reports now. As you guessed, I was looking on the main reports list, rather than in a course. The reports are working fine, and are going to be very useful, so thanks for making them available.
Mike

Dan Marsden
added a comment - 23/Sep/09 7:03 PM wow! - this is the first I've heard of this! - SCORM reporting in Moodle at the moment is really crappy! - great to see someone has put some time into improving it a bit!
any chance you have a 2.0 version of the report?

I haven't actually installed it yet, but after having a quick look at the code posted in the zip here are a couple of comments:

all the calls to require_capability are incorrect and won't work eg:
require_capability('View custom SCORM report', $context);
it should be something like:
require_capability('gradereport/kineo:view', $context);

it also includes it's own PHPMailer class instead of Moodle's internal libs - it should use email_to_user() from moodlelib.php - which means it will use the settings set by the site admin - eg smtp server - or fall back to use php mailer if smtp not set etc.

also it uses a lot of sql style get_records calls when not needed eg:
$sql = "SELECT * FROM kineo_filters WHERE kineo_fil_id = " .$fid;

if ($current_reports = get_records_sql($sql)) {

this should really use something like:
if ($current_reports = get_records('kineo_filters', 'kineo_fil_id', $fid)) {

where possible, avoiding the sql style calls is always best, as it means that the sql is more likely to be cross db compatible.

there's also a hook you can use that triggers cron inside grade reports
you need to create a file called lib.php inside the report directory and inside that file create a function called
"grade_report_XXX_cron()" - replacing XXX with the folder name that your report is in (eg "kineo_SCORM_report")

Dan Marsden
added a comment - 24/Sep/09 6:42 AM really glad to see this!
I haven't actually installed it yet, but after having a quick look at the code posted in the zip here are a couple of comments:
all the calls to require_capability are incorrect and won't work eg:
require_capability('View custom SCORM report', $context);
it should be something like:
require_capability('gradereport/kineo:view', $context);
it also includes it's own PHPMailer class instead of Moodle's internal libs - it should use email_to_user() from moodlelib.php - which means it will use the settings set by the site admin - eg smtp server - or fall back to use php mailer if smtp not set etc.
also it uses a lot of sql style get_records calls when not needed eg:
$sql = "SELECT * FROM kineo_filters WHERE kineo_fil_id = " .$fid;
if ($current_reports = get_records_sql($sql)) {
this should really use something like:
if ($current_reports = get_records('kineo_filters', 'kineo_fil_id', $fid)) {
and this:
$sql = "DELETE FROM kineo_filters WHERE kineo_fil_id=" . $fid;
execute_sql($sql, false);
should be:
delete_records('kineo_filters', 'kineo_fil_id', $id);
where possible, avoiding the sql style calls is always best, as it means that the sql is more likely to be cross db compatible.
there's also a hook you can use that triggers cron inside grade reports
you need to create a file called lib.php inside the report directory and inside that file create a function called
"grade_report_XXX_cron()" - replacing XXX with the folder name that your report is in (eg "kineo_SCORM_report")
hope that's useful!

just wanted to check if these changes will somehow help me to to run Kineo on Windows platform. Is there a Kineo fix for windows? From previous conversations, it seems that it doesnt work under Wwindoes Moodle.

ivan
added a comment - 24/Sep/09 1:54 PM Hi Dan,
just wanted to check if these changes will somehow help me to to run Kineo on Windows platform. Is there a Kineo fix for windows? From previous conversations, it seems that it doesnt work under Wwindoes Moodle.
Thank you
Ivan

Dan Marsden
added a comment - 24/Sep/09 2:05 PM Hi Ivan,
it's hard to know without testing it (I still haven't installed it yet) - but make sure you have debugging and display errors turned on, - if you get any specific errors, make sure you post them here!

The most likely reason for why the report does not run on some platforms is that we are currently using PHP mysql functions instead of the inbuilt Moodle library or ADODB functions. This is something we have learnt since and we have put this on the roadmap for version 2.0 of this module.

This means: the reporting module will currently only work with MySQL. Maybe this explains why this doesn't currently work for you, Ivan. Is there a way you can use MySql and confirm this assumption?

Also, I believe this module currently requires the mysql libraries and does not work correctly with the mysqli functions.

Sven Laux
added a comment - 15/Oct/09 5:52 PM Hi,
just an update to everyone who is using this module.
The most likely reason for why the report does not run on some platforms is that we are currently using PHP mysql functions instead of the inbuilt Moodle library or ADODB functions. This is something we have learnt since and we have put this on the roadmap for version 2.0 of this module.
This means: the reporting module will currently only work with MySQL. Maybe this explains why this doesn't currently work for you, Ivan. Is there a way you can use MySql and confirm this assumption?
Also, I believe this module currently requires the mysql libraries and does not work correctly with the mysqli functions.
I hope this helps!
Sven

thank you for your reply. Im using MySql 4.1 (,Windows XP, Moodle 1.9.5). For testing purposes i installed Moodle on my spare server and tried the Kineo module in there. I can see it in a course reports now, however im getting following screen (attached pdf file Kineo report). Not sure why, or what to do with it. Tried to create new report, but nothing hapens. Please review the attached file and let me know if there are certain adjustments needed in database or Modle itself.

ivan
added a comment - 15/Oct/09 7:24 PM Hi Sven,
thank you for your reply. Im using MySql 4.1 (,Windows XP, Moodle 1.9.5). For testing purposes i installed Moodle on my spare server and tried the Kineo module in there. I can see it in a course reports now, however im getting following screen (attached pdf file Kineo report). Not sure why, or what to do with it. Tried to create new report, but nothing hapens. Please review the attached file and let me know if there are certain adjustments needed in database or Modle itself.
Thank you

We couldn't get access to the reports either. (This may be an incorrect statement:)We go directly to SCORM items, not wrapping them in moodle courses, so there was no course admin menu to click on reports from.

In looking into it, it didn't seem that the kineo report generator was requiring a course in the URL, so we found that the report generator URL is /course/report/kineo/index.php and we just built a custom blobk that only shows for our admins that links to this relative URL, called eLearning Reports.

Jim Feniello
added a comment - 29/Oct/09 9:50 PM We couldn't get access to the reports either. (This may be an incorrect statement:)We go directly to SCORM items, not wrapping them in moodle courses, so there was no course admin menu to click on reports from.
In looking into it, it didn't seem that the kineo report generator was requiring a course in the URL, so we found that the report generator URL is /course/report/kineo/index.php and we just built a custom blobk that only shows for our admins that links to this relative URL, called eLearning Reports.
-jim
motionplan.com

Jason Heckman
added a comment - 30/Oct/09 4:35 AM - edited Rather than coding an additional block, we just added to the site admin block, and added permissions to the link, only users authorized to view capabilities/mod/scorm:viewreport can see it.
Clarifying the install process that worked for us.
Using Chad's method above:
Extract 'kineo_SCORM_report.zip' to moodlesiteroot/course/report
Rename directory to 'kineo'
Change directory & file permissions in 'moodlesiteroot/course/report/kineo' and all subfolders to 0755
Change directory permissions in 'moodlesiteroot/course/report/kineo/reports' directory to 0777
Go to phpmyadmin
Import moodlesiteroot/course/report/kineo/db/kineo_tables.sql
Run moodle notifications page
NEXT:
Here is where we needed to allow kineo to be a custom link for SCORM report authorized users only.
Browse to moodlesiteroot/admin/report and create a folder called 'kineo'
Create a file called 'settings.php'
The content of 'settings.php' should appear as follows:
<?php // $Id$
$ADMIN->add('reports', new admin_externalpage('kineoreport', 'eLearning Reports', "$CFG->wwwroot/course/report/kineo/index.php",'mod/scorm:viewreport'));
?>
In the code you see a line that says 'eLearning Reports' ... edit this to fit your desired link name in the site admin/reports block.
Save and upload your file, refresh the admin view and your link should work nicely.
Then, Chad's instructions are continued below:
Add report
Choose filter(s)
Add email address to send report
Schedule report.
Include cron job = moodlesiteroot/course/report/kineo/cron.php
eg. 0/30 **** wget -q -O /dev/null http://www.yourmoodle.com/course/report/kineo/cron.php
Godspeed!
-Jason
motionplan.com

MJ
added a comment - 12/Mar/10 1:48 PM I was able to do all steps but the last part.
Add report
Choose filter(s)
Add email address to send report
Schedule report.
Include cron job = moodlesiteroot/course/report/kineo/cron.php
Where do I go to add a report?
When I go to my site and under the create a custom report no options appear?
Please help.

That's not a capability! There are no setup scripts for the database. There are no 'require logins' on any page, some of the database queries use fields that don't seem to exist and it can't seem to make its mind up if its a gradebook report or a course report.

Howard Miller
added a comment - 23/Dec/10 7:09 PM Hmmm... unless I am missing something, this isn't going to work (properly). In the first few lines of index.php...
$context = get_context_instance(CONTEXT_SYSTEM);
require_capability('Overview custom SCORM report', $context);
That's not a capability! There are no setup scripts for the database. There are no 'require logins' on any page, some of the database queries use fields that don't seem to exist and it can't seem to make its mind up if its a gradebook report or a course report.
Apart from that it's great

I would really like to try this plugin, but I'm a little lost in the installation instructions.

I'm running Moodle in a hosted environment; could someone post instructions for if you're running cPanel (or work with me to get it installed and I can post cPanel instructions for the rest of the community)?

Judy Unrein
added a comment - 11/Apr/11 3:06 AM I would really like to try this plugin, but I'm a little lost in the installation instructions.
I'm running Moodle in a hosted environment; could someone post instructions for if you're running cPanel (or work with me to get it installed and I can post cPanel instructions for the rest of the community)?
Many thanks...

Judy Unrein
added a comment - 12/Apr/11 6:33 AM Hi, Mark! I am not finding a document with instructions in the ZIP file. I am using instructions posted earlier on this thread.
I just realized what to do where I was getting stuck, so I'll continue and post back here if I need further help. Thank you so much!

Just a quick note to those interested in SCORM reporting.... thanks to a GSOC project Moodle 2.2 contains a rewrite of the reporting code and now allows pluggable reports like the quiz. (see MDL-27256)

The same report is still there, but the student is working on an interactions report (which needs testing if anyone has the time - see MDL-28277)

Dan Marsden
added a comment - 05/Aug/11 6:53 AM Just a quick note to those interested in SCORM reporting.... thanks to a GSOC project Moodle 2.2 contains a rewrite of the reporting code and now allows pluggable reports like the quiz. (see MDL-27256 )
The same report is still there, but the student is working on an interactions report (which needs testing if anyone has the time - see MDL-28277 )

Paul Stanyer
added a comment - 16/Sep/11 9:10 PM This is the latest version of the kineo SCORM reporting module.
We have fixed many issues with the original module, and it now has support for various activity types.