SCORM reporting improvements: Difference between revisions
No edit summary |
|||
Line 1: | Line 1: | ||
{{Infobox Project | {{Infobox Project | ||
|name = SCORM reporting improvements | |name = SCORM reporting improvements | ||
|state = | |state = Completed | ||
|tracker = MDL-27256 | |tracker = MDL-27256 | ||
|discussion = [http://moodle.org/mod/forum/discuss.php?d=174610 SCORM reporting improvements] | |discussion = [http://moodle.org/mod/forum/discuss.php?d=174610 SCORM reporting improvements] | ||
Line 11: | Line 11: | ||
</span> | </span> | ||
== Introduction == | == Introduction == | ||
This is a GSOC 2011 Project.The objective is improving the reporting of quiz elements for SCORM. Whenever a quiz style SCORM object is uploaded to Moodle , it passes back certain information to Moodle. Presently there is no way of reporting details of this push. This project is an attempt to counter the same. | This is a GSOC 2011 Project.The objective is improving the reporting of quiz elements for SCORM. Whenever a quiz style SCORM object is uploaded to Moodle , it passes back certain information to Moodle. Presently there is no way of reporting details of this push. This project is an attempt to counter the same. | ||
Line 17: | Line 16: | ||
==Project Details == | ==Project Details == | ||
=== Description === | === Description === | ||
The reporting in SCORM for quiz style questions is very limited. Some SCORM objects don't even pass the information back to Moodle, but | The reporting in SCORM for quiz style questions is very limited. Some SCORM objects don't even pass the information back to Moodle, but whenever they do in the standard way, we should provide a way to view these responses in a clearer manner. Teachers should be able to see clear reports stating not only the final result of the quiz, but also the details about every data element that SCO pushes back to Moodle. This an integral and important part that has been missing from the reporting. | ||
Thus objective of this project is basically to provide a standard GUI and export capabilities for the above situation. | Thus objective of this project is basically to provide a standard GUI and export capabilities for the above situation. | ||
In this project we will try to develop an plug-gable model for SCORM reporting, something similar to what quiz module presently support. This will not only improve present SCORM reporting capabilities of MOODLE but also allow users to easily write custom reporting plugins of there which can be simply uploaded and used. | In this project we will try to develop an plug-gable model for SCORM reporting, something similar to what quiz module presently support. This will not only improve present SCORM reporting capabilities of MOODLE but also allow users to easily write custom reporting plugins of there which can be simply uploaded and used. | ||
Line 26: | Line 25: | ||
* [https://docs.moodle.org/en/Development:SCORM_reporting_improvements#Core_Plugin_Container Core Plugin Container] | * [https://docs.moodle.org/en/Development:SCORM_reporting_improvements#Core_Plugin_Container Core Plugin Container] | ||
* [https://docs.moodle.org/en/Development:SCORM_reporting_improvements#Basic_Reporting_Plugin Basic Reporting Plugin] | * [https://docs.moodle.org/en/Development:SCORM_reporting_improvements#Basic_Reporting_Plugin Basic Reporting Plugin] | ||
* [https://docs.moodle.org/en/Development:SCORM_reporting_improvements# | * [https://docs.moodle.org/en/Development:SCORM_reporting_improvements#Interaction_Reporting_Plugin Interaction Reporting Plugin] | ||
==== Plugin Structure ==== | ==== Plugin Structure ==== | ||
Line 33: | Line 32: | ||
Compulsory | Compulsory | ||
* Report.php | * Report.php | ||
* lang/xx/scormreport_pluginname.php | |||
Optional | Optional | ||
* Version.php | * Version.php | ||
Line 39: | Line 39: | ||
* db/upgrade.php | * db/upgrade.php | ||
* db/access.php | * db/access.php | ||
* lang | |||
Report.php must extend the default reporting class "scorm_default_report" and the extended class must implement the method "display($scorm, $cm, $course, $download)", which should handle the core reporting feature. | |||
Some conventions that must be followed:- | |||
* Name of the extended class should be scorm_pluginname_report | |||
* scorm_pluginname_report must implement the function | |||
{code} | |||
function display($scorm, $cm, $course, $download) {} | |||
{code} | |||
* Each plugin must define the string "pluginname" in the lang files. | |||
==== Core Plugin Container ==== | ==== Core Plugin Container ==== | ||
Line 47: | Line 56: | ||
This plugin will basically a replication of the current moodle reporting converted to a plugin structure with few basic improvement.This is one of the very basic plugin and is to be included in the core along with the container. | This plugin will basically a replication of the current moodle reporting converted to a plugin structure with few basic improvement.This is one of the very basic plugin and is to be included in the core along with the container. | ||
==== | ==== Interaction Reporting Plugin ==== | ||
The interaction reporting plugin is designed to handle the display of some basic scorm data elements representing the student's response to questions and whether the response was correct or not. Something like the "responses" report for Quiz at present. | |||
=== Milestones === | === Milestones === | ||
{| class="nicetable" | {| class="nicetable" | ||
Line 68: | Line 77: | ||
|- | |- | ||
| Design the layout of the Plugin Container | | Design the layout of the Plugin Container | ||
| | | Completed | ||
|- | |- | ||
| Code the Plugin Container | | Code the Plugin Container | ||
| | | Completed | ||
|- | |- | ||
| Plan the layout for default plugins | | Plan the layout for default plugins | ||
| | | Completed | ||
|- | |- | ||
| Code the Default plugins | | Code the Default plugins | ||
| | | Completed | ||
|- | |- | ||
| Design the layout Additional plugin | | Design the layout Additional plugin | ||
| | | Completed | ||
|- | |- | ||
| Code the plugins | | Code the plugins | ||
| | | Completed | ||
|- | |- | ||
| | | Test the plugins | ||
| | | Completed | ||
|- | |- | ||
| Integrate all plugins | | Integrate all plugins | ||
| | | Completed | ||
|- | |- | ||
| Test Everything | | Test Everything | ||
| | | Completed | ||
|- | |- | ||
| Clean and optimize all codes. | | Clean and optimize all codes. | ||
| | | Completed | ||
|- | |- | ||
| Test Everything | | Test Everything | ||
| | | Completed | ||
|- | |- | ||
| Document Everything | | Document Everything | ||
Line 123: | Line 132: | ||
=== The Road ahead === | |||
I have plans to include two more SCORM report plugins in future:- | |||
* [http://tracker.moodle.org/browse/MDL-29745 Graph Based Reports] | |||
* [http://tracker.moodle.org/browse/MDL-30128 Trends Analysis Reports] | |||
Al-tough I am not sure if and when these will land in core, but I do hope it can be in time for MOODLE 2.3 | |||
[[Category:SCORM]] | [[Category:SCORM]] |
Revision as of 07:20, 2 December 2011
SCORM reporting improvements | |
---|---|
Project state | Completed |
Tracker issue | MDL-27256 |
Discussion | SCORM reporting improvements |
Assignee | Ankit Agarwal |
GSOC '11
Introduction
This is a GSOC 2011 Project.The objective is improving the reporting of quiz elements for SCORM. Whenever a quiz style SCORM object is uploaded to Moodle , it passes back certain information to Moodle. Presently there is no way of reporting details of this push. This project is an attempt to counter the same.
Project Details
Description
The reporting in SCORM for quiz style questions is very limited. Some SCORM objects don't even pass the information back to Moodle, but whenever they do in the standard way, we should provide a way to view these responses in a clearer manner. Teachers should be able to see clear reports stating not only the final result of the quiz, but also the details about every data element that SCO pushes back to Moodle. This an integral and important part that has been missing from the reporting. Thus objective of this project is basically to provide a standard GUI and export capabilities for the above situation. In this project we will try to develop an plug-gable model for SCORM reporting, something similar to what quiz module presently support. This will not only improve present SCORM reporting capabilities of MOODLE but also allow users to easily write custom reporting plugins of there which can be simply uploaded and used.
Module Architecture (Constant State of Change)
The module will consist of following sub-modules:-
Plugin Structure
Each plugin is allowed to have following files and folders:
Compulsory
- Report.php
- lang/xx/scormreport_pluginname.php
Optional
- Version.php
- db/install.php
- db/install.xml
- db/upgrade.php
- db/access.php
Report.php must extend the default reporting class "scorm_default_report" and the extended class must implement the method "display($scorm, $cm, $course, $download)", which should handle the core reporting feature.
Some conventions that must be followed:-
- Name of the extended class should be scorm_pluginname_report
- scorm_pluginname_report must implement the function
{code}
function display($scorm, $cm, $course, $download) {}
{code}
- Each plugin must define the string "pluginname" in the lang files.
Core Plugin Container
This Sub-Module will act as the core of SCORM reporting providing a basic platform on which other custom reporting plugin can be built. It is basically like a board on which other plugins can be "plugged" to start working.
Basic Reporting Plugin
This plugin will basically a replication of the current moodle reporting converted to a plugin structure with few basic improvement.This is one of the very basic plugin and is to be included in the core along with the container.
Interaction Reporting Plugin
The interaction reporting plugin is designed to handle the display of some basic scorm data elements representing the student's response to questions and whether the response was correct or not. Something like the "responses" report for Quiz at present.
Milestones
Milestone | Status |
---|---|
Background Study | Completed |
Case Study | Completed |
Recreate the case and study. | Completed |
Separate User Reporting to a Generic file. | Completed |
Design the layout of the Plugin Container | Completed |
Code the Plugin Container | Completed |
Plan the layout for default plugins | Completed |
Code the Default plugins | Completed |
Design the layout Additional plugin | Completed |
Code the plugins | Completed |
Test the plugins | Completed |
Integrate all plugins | Completed |
Test Everything | Completed |
Clean and optimize all codes. | Completed |
Test Everything | Completed |
Document Everything | To Be Done |
Relevant Links
For more information please visit the following links:
- Introduction To SCORM-Rustic Software
- Introduction To SCORM- ADL Video Series
- SCORM 1.2 Documentaion
- ADL Initiative - Youtube Channel
- SCORM FAQ
- GSoC 2011 - Moodle
Tracker
Discussions
- Making sense of SCORM
- Scorm reports - Retrieving feedback
- New version of the Detailed responses report plugin for Moodle 1.6 beta
- SCORM reporting improvements
The Road ahead
I have plans to include two more SCORM report plugins in future:-
Al-tough I am not sure if and when these will land in core, but I do hope it can be in time for MOODLE 2.3