MoodleDocs - Recent changes [en]

Language packs without maintainer

2012-05-16T06:06:03Z

← Older revision		Revision as of 06:06, 16 May 2012
Line 20:		Line 20:
	*sm Samoan		*sm Samoan
	*sr_cr_bo Serbian Cyrillic Bosnia Herzegovina		*sr_cr_bo Serbian Cyrillic Bosnia Herzegovina
−	*si Sinhala
	*to Tongan		*to Tongan
	*zu Zulu		*zu Zulu

Errors handling in web services

2012-05-16T02:57:24Z

SOAP:

← Older revision		Revision as of 02:57, 16 May 2012
(5 intermediate revisions by one user not shown)
Line 5:		Line 5:
	Exceptions are caught by the server that generate its own error format. All exceptions contain a translated message + debuginfo. The php format should be :		Exceptions are caught by the server that generate its own error format. All exceptions contain a translated message + debuginfo. The php format should be :
	<code php>		<code php>
−	~~thrown~~ new ~~class_exception_name~~('errorcode', 'component', $a, '', 'This is an untranslated debug info.' );	+	throw new exception_class_name('errorcode', 'component', $a, '', 'This is an untranslated debug info.' );
	</code>		</code>

Line 45:		Line 45:
	<code xml>		<code xml>
	SoapFault Object ( ....		SoapFault Object ( ....
−	[faultstring] => Invalid parameter value detected \| ERRORCODE: invalidparameter	+	[faultstring] => Invalid parameter value detected \| ERRORCODE: invalidparameter //exception message (errorcode also included at the end)
−	[faultcode] => Receiver	+	[faultcode] => Receiver //soap faultcode
−	[faultactor] => invalidparameter	+	[faultactor] => invalidparameter //errorcode
−	[detail] => Username already exists: testusername1	+	[detail] => Username already exists: testusername1 //debuginfo
	)		)
	</code>		</code>
Line 87:		Line 87:

	=== How to handle warning on the client side ===		=== How to handle warning on the client side ===
−	~~Parse~~ the ~~warnings~~. You should be able to implement some code logic against the returned warnings.	+	Warnings are in the return value so nothing is different from how you handle other returned info. You should be able to implement some code logic against the returned warnings.

	=== When to send a warning on the server side ===		=== When to send a warning on the server side ===
−	If something is going to be skipped or not done (WRITE operation) then it's an exception. Warnings only inform (WRITE operation) about some decisions made by the functions. Warnings must never prevents the WRITE operation to happen. It's the same for a READ operation. The results will be always returned, with or without warnings. if something prevents the results to be returned then it's an exception, not a a warning.	+	If something is going to be skipped or not done (WRITE operation) then it's an exception. Warnings only inform (WRITE operation) about some decisions made by the functions. Warnings must never prevents the WRITE operation to happen. It's the same for a READ operation. The results will be always returned, with or without warnings. if something prevents the results to be returned then it's an exception, not a warning.

	====Warnings examples====		====Warnings examples====
	* the user lastname is trimmed		* the user lastname is trimmed
	* the language for this user was not specified so $CFG->defaultlang has been used.		* the language for this user was not specified so $CFG->defaultlang has been used.
		+
		+	[[Category:Web_Services]]

How to contribute a web service function to core

2012-05-16T02:35:46Z

Integration:

← Older revision		Revision as of 02:35, 16 May 2012
Line 111:		Line 111:
	# [http://tracker.moodle.org/secure/IssueNavigator.jspa?mode=hide&requestId=13101 the most voted issues]; and then		# [http://tracker.moodle.org/secure/IssueNavigator.jspa?mode=hide&requestId=13101 the most voted issues]; and then
	# other web service functions.		# other web service functions.
		+
		+	[[Category:Web_Services]]

Errors handling in web services

2012-05-16T02:33:36Z

XML-RPC:

← Older revision		Revision as of 02:33, 16 May 2012
(12 intermediate revisions by one user not shown)
Line 11:		Line 11:

	<code xml>		<code xml>
−	<?xml version="1.0" encoding="UTF-8"?>	+	<?xml version="1.0" encoding="UTF-8" ?>
−	<EXCEPTION class="~~moodle_exception~~">	+	<EXCEPTION class="invalid_parameter_exception">
−	<ERRORCODE>~~missingcourse~~</ERRORCODE>	+	<ERRORCODE>invalidparameter</ERRORCODE>
−	<MESSAGE>~~This is a not translated message~~</MESSAGE>	+	<MESSAGE>Invalid parameter value detected</MESSAGE>
−	<DEBUGINFO>~~This is a not translated message with more detailled info~~</DEBUGINFO>	+	<DEBUGINFO>Username already exists: testusername1</DEBUGINFO>
	</EXCEPTION>		</EXCEPTION>
	</code>		</code>

−	=== ~~How to handle exception on the client side~~===	+	==== REST-JSON ====
−	* error code: ~~work in progress - MDL-32949~~	+	<code javascript>
−	* Message: ~~translated error~~ message.	+	{
−	* Debuginfo: ~~not translated detailled error message (dynamic =~~> ~~this message can change following the error)~~	+	"exception":"invalid_parameter_exception",
		+	"errorcode":"invalidparameter",
		+	"message":"Invalid parameter value detected",
		+	"debuginfo":"Username already exists: testusername1"
		+	}
		+	</code>

−	~~As debuginfo~~ is ~~only available on development mode site~~, ~~client developers~~ can ~~only~~ display a not detailled error message ~~to their~~ client.	+	==== XML-RPC ====
		+	<code xml>
		+	Array
		+	(
		+	[faultCode] => 29039061 //this is a specific faultCode to xmlrpc. As we could not return a string faultCode,
		+	we transformed the exception message key into a long. Note in some very rare case,
		+	two exceptions "could" have the same code (we don't know any of these rare cases
		+	but better to alert you if something goes weird)
		+	[faultString] => Invalid parameter value detected \| DEBUG INFO: Username already exists: testusername1 \| ERRORCODE: invalidparameter
		+	//here you can parse the message to get the errorcode in the last '\|'.
		+	)
		+	</code>
		+
		+	==== SOAP ====
		+	<code xml>
		+	SoapFault Object ( ....
		+	[faultstring] => Invalid parameter value detected \| ERRORCODE: invalidparameter
		+	[faultcode] => Receiver
		+	[faultactor] => invalidparameter
		+	[detail] => Username already exists: testusername1
		+	)
		+	</code>
		+
		+	=== How to handle exception on the client side===
		+	* error code: the string key of the exception message. The key should be specific enough to be able to implement specific client behaviour against it.
		+	* Message: translated error message. It's possible for the client to display this message to the user.
		+	* Debuginfo: not translated detailled error message (dynamic => this message can change following the error). Help the client dev to debug.

	=== When to send an exception on the server side ===		=== When to send an exception on the server side ===
		+	Everything that is going to be skipped or not done is an exception.
	* DB WRITE functions must rollback when an exception is raised. We usually throw back the exception to the server.		* DB WRITE functions must rollback when an exception is raised. We usually throw back the exception to the server.
−	* Example: the user does not have appropriate access rights to call the function)	+	* Example: the user does not have appropriate access rights to call the function.

	== Warning messages ==		== Warning messages ==
Line 60:		Line 92:
	If something is going to be skipped or not done (WRITE operation) then it's an exception. Warnings only inform (WRITE operation) about some decisions made by the functions. Warnings must never prevents the WRITE operation to happen. It's the same for a READ operation. The results will be always returned, with or without warnings. if something prevents the results to be returned then it's an exception, not a a warning.		If something is going to be skipped or not done (WRITE operation) then it's an exception. Warnings only inform (WRITE operation) about some decisions made by the functions. Warnings must never prevents the WRITE operation to happen. It's the same for a READ operation. The results will be always returned, with or without warnings. if something prevents the results to be returned then it's an exception, not a a warning.

−	====~~Example~~====	+	====Warnings examples====
	* the user lastname is trimmed		* the user lastname is trimmed
	* the language for this user was not specified so $CFG->defaultlang has been used.		* the language for this user was not specified so $CFG->defaultlang has been used.

Common unit test problems

2012-05-16T01:07:28Z

← Older revision		Revision as of 01:07, 16 May 2012
(2 intermediate revisions by one user not shown)
Line 36:		Line 36:
	==== Solution ====		==== Solution ====
	Your Database is incorrectly configured. You probably are running MySQL and need to switch to utf8_bin collation.		Your Database is incorrectly configured. You probably are running MySQL and need to switch to utf8_bin collation.
		+
		+	=== moodlelib_testcase::test_fix_utf8 ===
		+	Failed asserting that false is identical to 'aaabbb'.
		+	==== Solution ====
		+	This problem indicates buggy iconv. See [http://tracker.moodle.org/browse/MDL-33007] for discussion. So this is a real problem, to be fixed in a future integration cycle
		+
		+	=== Segfaults on Oracle ===
		+	When I was running tests on oracle I was getting phpunit sefaulting.. --[[User:Dan Poltawski\|Dan Poltawski]] 00:29, 16 May 2012 (WST)
		+	==== Solution ====
		+	Set statement_cache_size in php.ini:
		+	oci8.statement_cache_size = 0

Talk:Common unit test problems

2012-05-15T16:27:31Z

← Older revision		Revision as of 16:27, 15 May 2012
Line 1:		Line 1:
	You say that, to correct some elements, one should change collation, to use utf8_bin, but [[:en:MySQL#Command_line\|installation instructions]] say to use utf8_unicode_ci. So what should be done exactly ?		You say that, to correct some elements, one should change collation, to use utf8_bin, but [[:en:MySQL#Command_line\|installation instructions]] say to use utf8_unicode_ci. So what should be done exactly ?
	--[[User:Séverin Terrier\|Séverin Terrier]] 23:36, 15 May 2012 (WST)		--[[User:Séverin Terrier\|Séverin Terrier]] 23:36, 15 May 2012 (WST)
		+
		+	I think that the installation instructions are incorrect. Need to check with Eloy
		+	--[[User:Dan Poltawski\|Dan Poltawski]] 00:27, 16 May 2012 (WST)

Talk:Common unit test problems

2012-05-15T15:36:45Z

Question : utf8_bin or utf8_unicode_ci ?

New page

You say that, to correct some elements, one should change collation, to use utf8_bin, but [[:en:MySQL#Command_line|installation instructions]] say to use utf8_unicode_ci. So what should be done exactly ?
--[[User:Séverin Terrier|Séverin Terrier]] 23:36, 15 May 2012 (WST)

Writing PHPUnit tests

2012-05-15T13:36:50Z

← Older revision		Revision as of 13:36, 15 May 2012
(One intermediate revision by one user not shown)
Line 3:		Line 3:
	Moodle PHPUnit integration is designed to allow easy adding of new tests. At the start of each test the state is automatically reset to fresh new installation (unless explicitly told not to reset). Tests that need to modify default installation may use generators to create new courses, users, etc.		Moodle PHPUnit integration is designed to allow easy adding of new tests. At the start of each test the state is automatically reset to fresh new installation (unless explicitly told not to reset). Tests that need to modify default installation may use generators to create new courses, users, etc.

		+	=TODO=
		+	TODO: write more info here
		+
		+	=Long tests=
		+
		+	All standard test should execute as fast as possible. Tests that take a loner time to execute (>10s) or are otherwise expensive (such as querying external servers that might be flooded by all dev machines) should be execute only when PHPUNIT_LONGTEST is true. This constant can be set in phpunit.xml or directly in config.php.

	=See also=		=See also=

Errors handling in web services

2012-05-15T11:37:23Z

Format:

← Older revision		Revision as of 11:37, 15 May 2012
(One intermediate revision by one user not shown)
Line 13:		Line 13:
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<EXCEPTION class="moodle_exception">		<EXCEPTION class="moodle_exception">
−	~~<!--~~ <ERRORCODE>missingcourse</ERRORCODE~~> //It will be returned when MDL-32949 is done --~~>	+	<ERRORCODE>missingcourse</ERRORCODE>
	<MESSAGE>This is a not translated message</MESSAGE>		<MESSAGE>This is a not translated message</MESSAGE>
	<DEBUGINFO>This is a not translated message with more detailled info</DEBUGINFO>		<DEBUGINFO>This is a not translated message with more detailled info</DEBUGINFO>
Line 35:		Line 35:
	The warning format is different following the protocol. It can be JSON or XML. REST/SOAP/XMLRPC all got different XML format. However they all implement the following structure:		The warning format is different following the protocol. It can be JSON or XML. REST/SOAP/XMLRPC all got different XML format. However they all implement the following structure:
	<code php>		<code php>
−	/**	+	/**
−	* Creates a warnings external_multiple_structure	+	* Creates a warnings external_multiple_structure
−	* @return external_multiple_structure	+	*
−	* @since Moodle 2.3	+	* @return external_multiple_structure
−	*/	+	* @since Moodle 2.3
−	~~private static~~ function ~~warnings~~() {	+	*/
−	return new external_multiple_structure(	+	function external_warnings() {
−	new external_single_structure( array(	+	return new external_multiple_structure(
−	'~~element~~' => new external_value(PARAM_TEXT, '~~element~~', VALUE_OPTIONAL),	+	new external_single_structure(array(
−	'~~elementid~~' => new external_value(PARAM_INT, '~~element~~ id', VALUE_OPTIONAL),	+	'item' => new external_value(PARAM_TEXT, 'item', VALUE_OPTIONAL),
−	'warningcode' => new external_value(PARAM_ALPHANUM, 'the warning code can be used by	+	'itemid' => new external_value(PARAM_INT, 'item id', VALUE_OPTIONAL),
−	the client app to implement specific behaviour ~~(e.g. "missingcourse")~~'),	+	'warningcode' => new external_value(PARAM_ALPHANUM, 'the warning code can be used by
−	'message' => new external_value(PARAM_TEXT, 'untranslated english message to explain the warning')	+	the client app to implement specific behaviour'),
−	), 'warning'), 'list of warnings'	+	'message' => new external_value(PARAM_TEXT, 'untranslated english message to explain the warning')
−	);	+	), 'warning'), 'list of warnings', VALUE_OPTIONAL
−	}	+	);
		+	}
	</code>		</code>

Common unit test problems

2012-05-15T08:21:55Z

collatorlib_testcase::test_asort_objects_by_method:

← Older revision		Revision as of 08:21, 15 May 2012
Line 28:		Line 28:
	Collation aware sorting not supported, PHP extension "intl" is not available.		Collation aware sorting not supported, PHP extension "intl" is not available.
	==== Solution ====		==== Solution ====
−	Install php intl extension	+	Install php intl extension.
		+
		+	Note that, on Windows, this extension does not seem to be included in the installer, but you can get it by downloading the zip, and copying the right DLLs across. If you Google, there are more detailed instructions on Stack Exchange.

	=== grading_manager_testcase::test_tokenize===		=== grading_manager_testcase::test_tokenize===

Common unit test problems

2012-05-15T08:08:11Z

Unit tests are taking more than 5 mins to run:

← Older revision		Revision as of 08:08, 15 May 2012
Line 1:		Line 1:
	=== Unit tests are taking more than 5 mins to run ===		=== Unit tests are taking more than 5 mins to run ===
	This problem is under investigation. We are hoping to find the soluton. On a typical system all tests complete in under 3 mins.--[[User:Dan Poltawski\|Dan Poltawski]] 12:43, 15 May 2012 (WST)		This problem is under investigation. We are hoping to find the soluton. On a typical system all tests complete in under 3 mins.--[[User:Dan Poltawski\|Dan Poltawski]] 12:43, 15 May 2012 (WST)
		+
		+	You maybe find much better performance on psql as a workaround for now if not doing DB dependent tests.

	=== dml_testcase::test_unique_index_collation_trouble===		=== dml_testcase::test_unique_index_collation_trouble===

Common unit test problems

2012-05-15T07:43:10Z

← Older revision		Revision as of 07:43, 15 May 2012
(One intermediate revision by one user not shown)
Line 27:		Line 27:
	==== Solution ====		==== Solution ====
	Install php intl extension		Install php intl extension
		+
		+	=== grading_manager_testcase::test_tokenize===
		+	A test using UTF-8 characters has failed. Consider updating PHP and PHP's PCRE or INTL extensions (MDL-30494) Failed asserting that false is true.
		+	==== Solution ====
		+	Your Database is incorrectly configured. You probably are running MySQL and need to switch to utf8_bin collation.

Common unit test problems

2012-05-15T05:13:08Z

← Older revision		Revision as of 05:13, 15 May 2012
Line 16:		Line 16:
	"Failed to load the sample RSS file. Please check your proxy settings in Moodle. %s"		"Failed to load the sample RSS file. Please check your proxy settings in Moodle. %s"
	==== Solution ====		==== Solution ====
−	~~You~~ moodle needs network connectivity, please check proxy settings.	+	Your moodle needs network connectivity, please check proxy settings.

	=== moodlesimplepie_testcase::test_redirect ===		=== moodlesimplepie_testcase::test_redirect ===
	Failed asserting that 'cURL Error: Operation timed out after 2000 milliseconds with 0 bytes received' is null.		Failed asserting that 'cURL Error: Operation timed out after 2000 milliseconds with 0 bytes received' is null.
	==== Solution ====		==== Solution ====
−	~~You~~ moodle needs network connectivity, please check proxy settings	+	Your moodle needs network connectivity, please check proxy settings
		+
		+	=== collatorlib_testcase::test_asort_objects_by_method ===
		+	Collation aware sorting not supported, PHP extension "intl" is not available.
		+	==== Solution ====
		+	Install php intl extension

GSOC/2012

2012-05-15T05:11:03Z

Email reminders for calendar events:

← Older revision		Revision as of 05:11, 15 May 2012
Line 22:		Line 22:
	==Email reminders for calendar events==		==Email reminders for calendar events==
	:'''Student''': [http://moodle.org/user/view.php?id=1240428&course=5 Isuru Madushanka Weerarathna]		:'''Student''': [http://moodle.org/user/view.php?id=1240428&course=5 Isuru Madushanka Weerarathna]
−	:'''~~Mentor~~''': [http://moodle.org/user/view.php?id=381842&course=5 Michael de Raadt]	+	:'''Mentors''': [http://moodle.org/user/view.php?id=381842&course=5 Michael de Raadt], [http://moodle.org/user/view.php?id=955449&course=5 Rossiani Wijaya]
	:'''Specification''': [[Email reminders for calendar events]]		:'''Specification''': [[Email reminders for calendar events]]
		+
		+	See also:
		+
		+	* Tracker issue MDL-1329

	==Video/audio capture repository plugin==		==Video/audio capture repository plugin==

GSOC

2012-05-15T05:07:17Z

2012:

← Older revision		Revision as of 05:07, 15 May 2012
(One intermediate revision by one user not shown)
Line 99:		Line 99:
	==2012==		==2012==
	Overview: [[GSOC/2012]]		Overview: [[GSOC/2012]]
−	# ~~Improving~~ SCORM 2004 Support	+	# [[Improve SCORM 2004 Support]]
−	# ~~Improving~~ Plagiarism API	+	# [[Plagiarism API improvements]]
	# [[Email reminders for calendar events]]		# [[Email reminders for calendar events]]
	# [[Audio/Video Capture repository plugin]]		# [[Audio/Video Capture repository plugin]]

Common unit test problems

2012-05-15T04:43:04Z

Unit tests are taking more than 5 mins to run:

New page

=== Unit tests are taking more than 5 mins to run ===
This problem is under investigation. We are hoping to find the soluton. On a typical system all tests complete in under 3 mins.--[[User:Dan Poltawski|Dan Poltawski]] 12:43, 15 May 2012 (WST)

=== dml_testcase::test_unique_index_collation_trouble===
"Unique index is accent insensitive, this may cause problems for non-ascii languages. This is usually caused by accent insensitive default collation."
==== Solution ====
Your Database is incorrectly configured. You probably are running MySQL and need to switch to utf8_bin collation.

=== dml_testcase::test_sql_binary_equal ===
"SQL operator "=" is expected to be case sensitive Failed asserting that 1 matches expected 2."
==== Solution ====
Your Database is incorrectly configured. You probably are running MySQL and need to switch to utf8_bin collation.

=== moodlesimplepie_testcase::test_getfeed ===
"Failed to load the sample RSS file. Please check your proxy settings in Moodle. %s"
==== Solution ====
You moodle needs network connectivity, please check proxy settings.

=== moodlesimplepie_testcase::test_redirect ===
Failed asserting that 'cURL Error: Operation timed out after 2000 milliseconds with 0 bytes received' is null.
==== Solution ====
You moodle needs network connectivity, please check proxy settings

PHPUnit

2012-05-15T04:31:22Z

← Older revision		Revision as of 04:31, 15 May 2012
Line 123:		Line 123:
	* [http://blog.jetbrains.com/webide/2009/12/phpunit-support/ PHPStorm IDE]		* [http://blog.jetbrains.com/webide/2009/12/phpunit-support/ PHPStorm IDE]
	* [http://netbeans.org/kb/docs/php/phpunit.html Netbeans]		* [http://netbeans.org/kb/docs/php/phpunit.html Netbeans]
		+
		+	=Common Unit Test Problems=
		+	[[Common unit test problems]]

	[[Category:Unit testing]]		[[Category:Unit testing]]

GSOC

2012-05-15T03:38:33Z

A/V project linked

← Older revision		Revision as of 03:38, 15 May 2012
Line 102:		Line 102:
	# Improving Plagiarism API		# Improving Plagiarism API
	# [[Email reminders for calendar events]]		# [[Email reminders for calendar events]]
−	# ~~Video~~/~~audio capture~~ repository plugin	+	# [[Audio/Video Capture repository plugin]]

	==See also==		==See also==

Audio/Video Capture repository plugin

2012-05-15T00:45:33Z

← Older revision		Revision as of 00:45, 15 May 2012
Line 3:		Line 3:
	\|state = Community Bonding		\|state = Community Bonding
	\|tracker = CONTRIB-3631		\|tracker = CONTRIB-3631
−	\|discussion =	+	\|discussion = [http://moodle.org/mod/forum/discuss.php?d=202632#p883953 Forum - Post]
	\|assignee = Ankit Gupta		\|assignee = Ankit Gupta
	}}		}}

VSTU projects

2012-05-14T13:31:51Z

Question types:

← Older revision		Revision as of 13:31, 14 May 2012
Line 15:		Line 15:
	# [http://docs.moodle.org/21/en/Preg_question_type Preg question type] - regular expression question type, developed on more solid algorithmic basis than regex one. Developers: Sychev Oleg, Kolesov Dmitry.		# [http://docs.moodle.org/21/en/Preg_question_type Preg question type] - regular expression question type, developed on more solid algorithmic basis than regex one. Developers: Sychev Oleg, Kolesov Dmitry.
	# [[Auto-feedback shortanswer question\|Auto-feedback shortanswer question]] shortanswer question which could be able to detect typos and misplaced, missing or extra words and give appropriate feedback.		# [[Auto-feedback shortanswer question\|Auto-feedback shortanswer question]] shortanswer question which could be able to detect typos and misplaced, missing or extra words and give appropriate feedback.
		+
		+	===Question behaviours===
		+	# [http://docs.moodle.org/dev/Hinting_question_behaviours(VSTU) Hinting behaviours] - behaviours that would help standartise hinting from each qtype.

	===Blocks===		===Blocks===

Hinting question behaviours(VSTU)

2012-05-14T13:30:46Z

Created page with "==Behaviours== ===Student choosen hints=== [Olga please put you descriptions there] ===Teacher planning hints=== ==Questiontype interface== ===Question and question type class m..."

New page

==Behaviours==
===Student choosen hints===
[Olga please put you descriptions there]
===Teacher planning hints===
==Questiontype interface==
===Question and question type class methods===
===Hint class===

Improve SCORM 2004 Support

2012-05-14T12:26:39Z

Removing extra line break

← Older revision		Revision as of 12:26, 14 May 2012
Line 171:		Line 171:

	'''13th - 19th August''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28818 ADL Test: OB-02], [http://tracker.moodle.org/browse/MDL-28819 ADL Test: OB-03], [http://tracker.moodle.org/browse/MDL-28822 ADL Test: 0B-04], [http://tracker.moodle.org/browse/MDL-28868 ADL Test: RU-05], [http://tracker.moodle.org/browse/MDL-28906 SX-05]		'''13th - 19th August''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28818 ADL Test: OB-02], [http://tracker.moodle.org/browse/MDL-28819 ADL Test: OB-03], [http://tracker.moodle.org/browse/MDL-28822 ADL Test: 0B-04], [http://tracker.moodle.org/browse/MDL-28868 ADL Test: RU-05], [http://tracker.moodle.org/browse/MDL-28906 SX-05]
−

	= Relevant Links =		= Relevant Links =

GSOC/2012

2012-05-14T12:08:39Z

Improving SCORM 2004 Support: Updating Specification and Blog Link

← Older revision		Revision as of 12:08, 14 May 2012
Line 5:		Line 5:
	:'''Student''': [http://moodle.org/user/view.php?id=1277285&course=5 Mayank Gupta]		:'''Student''': [http://moodle.org/user/view.php?id=1277285&course=5 Mayank Gupta]
	:'''Mentor''': [http://moodle.org/user/view.php?id=21591&course=5 Dan Marsden]		:'''Mentor''': [http://moodle.org/user/view.php?id=21591&course=5 Dan Marsden]
−	:'''Specification''':	+	:'''Specification''': [[Improve_SCORM_2004_Support]]

	See also:		See also:
	* MDL-7068		* MDL-7068
−	* Developer blog [http://~~mayankgupta~~.~~beakkon~~.com/ # Mayank Gupta]	+	* Developer blog [http://www.guptamayank.com/ # Mayank Gupta]

	==Improving Plagiarism API==		==Improving Plagiarism API==

Improve SCORM 2004 Support

2012-05-14T12:05:18Z

Relevant Links: Updating GSoC 2012 Link

New page

{{Infobox Project
|name = Improve SCORM 2004 Support
|state = Community Bonding
|tracker = MDL-7068
|discussion =
|assignee = Mayank Gupta
}}
{{Moodle 2.3}}

GSOC
 '12


=Overview=
==Abstract==
This document is the specification for Improving SCORM 2004 Support in Moodle, a Google Summer Of Code ''(GSoC)'' 2012 project.
The ''goal'' of this project is to work towards achieving full SCORM 2004 4th Edition compliance in Moodle without the need of any external plugins, that is, improving the support for SCORM 2004 content packages in Moodle.

The project mentor is [http://moodle.org/user/profile.php?id=21591 Dan Marsden] and the program administrator is [http://moodle.org/user/view.php?id=381842 Michael de Raadt].

==Context==
The project will improve the SCORM 2004 support in Moodle by using the [http://docs.moodle.org/dev/SCORM_Test_Harness SCORM Test Harness]. The automated test framework will help by automating the execution of SCORM 2004 tests in Moodle and thus, will help in identify the issues with SCORM 2004 support in Moodle.
This project will also indirectly help in improving the SCORM Test Harness itself, as by getting the Test Harness into action bugs would be identified and fixed in the Test Harness.

In order for Moodle to be SCORM 2004 4th Edition compliant and pass all the 189 ADL SCORM 2004 conformance test packages, it needs to adhere to the specifications laid down by [http://www.adlnet.gov/wp-content/uploads/2011/07/SCORM_2004_4ED_v1_1_Doc_Suite.zip ADL SCORM 2004 ''4th Edition''].
The specification can be divided into three sub-specifications as -
* Content Aggregation Model '''(CAM)'''
* The Run-Time Environment '''(RTE)'''
* Sequencing and Navigation specification '''(SN)'''

===Content Aggregation Model===
The Content Aggregation Model sub-specification of SCORM 2004 4th Edition specifies how SCORM 2004 content developers should package their content so that the packages can be imported into the LMS. According to SCORM 2004 specification the content developers should package the content in a self-contained directory or a ZIP file which is also called a '''Package Interchange File (PIF)'''.

SCORM 2004 specifies that the packaged ZIP file should always contain an XML file with the name - ''' 'imsmanifest.xml' '''. This imsmanifest.xml file also called the manifest file should be located in the root of the ZIP file. The content developers have to make sure that this manifest file contains all the information the LMS would need to successfully deliver the SCORM 2004 content to the content viewers.

The manifest file divides the course into one or more parts called SCOs, which in other words represents the activity tree for the course content. The manifest file contains an XML representation of the activity tree of the package, information about how to launch each SCO, and optional metadata that would describe the course and its part.
As a LMS it is the responsibility of Moodle's "SCORM module's code" to correctly parse the manifest file, store all the required information of the package in the database.

====Current State====
The file '''/mod/scorm/datamodels/scormlib.php''' has the code that parses the manifest file.
Currently this file is not able to parse all the CAM definitions according to SCORM 2004 4th Edition Specifications.
For instance, the current code of '''scormlib.php''' is not able to parse correctly the '''ADLCP:DATA''', and '''ADLCP:MAP''' sections of the manifest file. These sections define the '''Inter-SCO Storage Data Model Extension'''; that was introduced in ADL SCORM 2004 4th Edition specification.
Other sections of the manifest file that scormlib.php fails to parse successfully will be identified and resolved during the course of the project by running the SCORM Test Harness for individual SCORM 2004 conformance packages.

===Run-Time Environment===
The Run-Time Environment (RTE) sub-specification of SCORM 2004 specification specifies how the LMS should launch the content package within itself. The RTE states that the SCORM 2004 content package should be launched within Moodle in a web browser as a new window or within a '''frameset''' in the same window. The RTE specification specifies that all the content in the SCORM 2004 package should be web deliverable and is always launched in a web browser. It also specifies that the LMS should launch one SCO at a time.

In order to allow communication between the SCORM 2004 content package more specifically the launched SCO of the content package and the LMS; the LMS should provide an '''ECMAScript''' (JavaScript) API through which the SCO can communicate with it. All communication between the SCO and the LMS can take place through this JavaScript API only, that is, the content package can by no means communicate with the LMS through form posts, database access (read/write), web services or any other mechanism.
As a SCO can communicate only through the JavaScript API, the LMS provides the JavaScript object of the API at a specific location within the browsers' DOM. This API object has the special name of ''' 'API_1484_11' ''' for SCORM 2004.
It is the responsibility of the content/SCO to locate this API object and then use it for all the communications it needs to do with the LMS. RTE specifies that only the SCO can initiate the communication as the LMS acts as a passive entity which is simply responding to the API calls made by the SCO.

The API provides a set of eight functions that permit the exchange of data with the LMS. These functions are -

{| class="nicetable" border="1" cellpadding="5" cellspacing="0" align="center"
|-
! Function
! Return Type
! Remarks
|-
| Initialize( “” )
| bool
| it indicates to the LMS that the content would like to begin a communication session.
|-
| Terminate( “” )
| bool
| it indicates to the LMS that the content has finished communicating
|-
| GetValue( element : CMIElement )
| string
| it allows the SCO/content to data from the LMS
|-
| SetValue( element : CMIElement, value : string)
| string
| it allows the SCO/content to persist data to the LMS.
|-
| Commit( “” )
| bool
| it is used by the SCO/content to signal the LMS that a significant chuck of data has been saved and that the LMS should ensure the data is properly persisted
|-
| GetLastError()
| CMIErrorCode
| it allows to determing if the last SCORM API call caused an error
|-
| GetErrorString( errorCode : CMIErrorCode )
| string
| it return a textual description of what the passed error code means
|-
| GetDiagnostic( errocCode : CMIErrorCode )
| string
| it returns detailed information about the prior error that can be useful in detecting the problem.
|}

The Computer Managed Instruction or '''CMI''' data model provides a list of data elements which can be read and written using the API. Each data model element has its own meaning.

Every SCO in a content package has its own set of run-time data. These data model elements have different values for different SCOs within a content package.
Before SCORM 2004 4th edition the RTE data model definitions came into existence these data model elements could not be shared across SCOs of the same or different content package.
When the content user or learner starts a new attempt on a SCO, the data model element's values are reset to the default values at the start of the new attempt. These data models have different default values and can be of either '''read-only''' or both read and '''write''' type.

Some examples SCORM 2004 RTE data model elements include the '''cmi.completion_status''' element - that saves the status of the SCO (completed or incomplete), '''cmi.success_status''' (passed or failed), the score of the learner, a bookmark to track the learner’s location, and the total amount of time the learner spent in the SCO.

However, apart from the non-sharable data model elements defined before, the SCORM 2004 4th Edition RTE Data Model definitions define the
'''adl.data''' data model elements that provide the unique ability to share sets of data across the SCOs.

====Current State====
The file '''/mod/scorm/datamodels/scorm_13.js.php''' has the code to deal with the data model elements that a SCO would require.
This code needs to be extended to support the data models defined by the SCORM 2004 4th Edition Run-Time Envirnoment Data Model definition. These data model elements mainly include adl.data elements - Inter-SCO Storage Data Model Extension.
Some progress has already been made on the tracker issue MDL-28805 - ADL TEST: Data Model Implementation (DMI).
While trying to fix the mentioned bug, a number of related issues that needed to be resolved before the bug MDL-28805 could be closed were identified. These bugs were - MDL-30666, MDL-30576, MDL-30577, MDL-30578, MDL-30579, MDL-30645.
As mentioned above, during the course of the project the data model code would be extended to support SCORM 2004 4th Edition Run-Time Environment Data Model definitions and other '' 'buggy areas' '' would be identified by running the SCORM Test Harness for SCORM 2004 Conformance packages issues would be reported and patches will be provided.

===Sequencing And Navigation===

The Sequencing and Navigation sub-specification of SCORM 2004 4th Edition specification allows content developers to '''override''' the default navigation of SCOs and enable them to govern how the content user/learner is allowed to navigate between various SCOs in the content package and also how the progress data is '''rolled up''' to the course level of the content package.

The content developers lay down the sequencing rules in the imsmanifest.xml file or the manifest file, in the root directory of the PIF. These rules in-turn determine which '''navigational controls''' should the LMS provide to the content user/learner, that is, whether or not a navigable table of contents '''(TOC)''' should be provided to the learner or just the previous/next buttons should be provided to the learner to navigate from one SCO to another in a linear sequence of SCOs.
By specifying sequencing and navigation rules in the manifest file the content developer can also specify that certain conditions like some SCOs/activities must be completed before the learner can navigate to the some other SCO/activity.
The content developer by adhering to the SCORM 2004 Sequence and Navigation specification can also apply a gradient weight to some parts or activities of the content package, that is, if some higher weighted activities when completed by the learner would add more to his total score than when he completes a relatively lower weighted activity. Not only this, the Sequencing and Navigation specifications can allow the content developer to randomly select a different subset of SCOs each time a new attempt is made.
The SN specification also powers the content developer to forcibly take the learner to initial SCO (that would generally have some instructions).

Every activity of a SCORM 2004 content package has a '''tracking data''' and a '''sequencing definition''' associated with it. The tracking data has the information about the current state of the activity that is, the score of the learner, the status, etc. The sequencing definition is the set of rules that defines which activity should follow next, that is, which activity should be presented to the learner after he completes the activity depending upon the tracking data of the activity.

The sequencing definition model rules can be subdivided as -

:'''''Sequencing Control Modes''''' – these define the type of navigation allowed to the learner, that is navigation through the TOC or linear navigation via previous/next buttons.
:'''''Constrain Choice Controls''''' – Restrict the activities that the user may select from the table of contents.
:'''''Sequencing Rules''''' – Specify if-then conditions that determine which activities are available for delivery and which activity should be delivered next.
:'''''Limit Conditions''''' – Provide limits on the number of times activities can be attempted.
:'''''Rollup Rules''''' – Specify if-then conditions that determine how status is rolled up to clusters throughout the activity tree.
:'''''Rollup Controls''''' – Determine which activities participate in status rollup and how their status is weighted in relation to other activities.
:'''''Rollup Consideration Controls''''' – Provide more precise control over status rollup than do the rollup controls.
:'''''Objectives''''' – Provide a way to track the status of individual learning objectives and share this status across activities. Objectives are often overloaded and used as variables to control sequencing actions.
:'''''Selection Controls''''' – Provide a way to specify that only a random subset of the available activities should be delivered.
:'''''Randomization Controls''''' - Shuffle the order of the activities to be delivered.
:'''''Delivery Controls''''' – Allow for non-communicative content to be delivered and sequenced.
:'''''Completion Threshold Controls''''' – Allow the tracking of completion percentage. This was introduced in the SCORM 2004 4th Edition specification.
:'''''Navigation Controls''''' - Control which navigational UI elements should be presented by the LMS.

====Current State====
The code that currently implements Sequencing and Navigation specification of ADL SCORM 2004 specification is in the file '''/mod/scorm/datamodels/sequencinglib.php'''.

The SCORM module currently supports '''activity restriction''', that is, if the content developer has restricted some activities to not to be navigable directly by selecting from the table of contents, the TOC does not allow the learner to do so. Though, the TOC is correctly rendered, there are issues like when the initial SCO/activity is complete and it triggers the continue event, the next SCO is not launched, rather the same initial SCO is launched again.
In some cases the SCO uses '''adl.nav.request''' to navigate to a different location, this also causes the same issue of the SCO being launched again.
These are just a couple of the many issues that are currently there in the SCORM module to support SCORM 2004 Sequencing and Navigation specification specification.

The bug that holds the next SCO from being launched will be the first issue that would be fixed as the part of the project to improve SCORM 2004 support in Moodle, because, this bug will prevent other SCORM 2004 test packages to load successfuly and thus, would not allow the SCORM 2004 conformance packages to run and test successfully.
A probable fix for the issue would be to store the structure so that code can continue but learner cannot use continue, TOC, links, etc.
The above can be implemented by shifting the URLs of the SCO to the id attribute of the spans HTML tags and then making JavaScript to fetch the ids and use them as URLs.

Work is already being done to rewrite the function '''scorm_get_toc''' - MDL-32835.

The SCORM Test Harness will help in identifying other Sequencing and Navigation issues in the SCORM module by helping to run the SCORM 2004 conformance test packages automatically.

= Schedule of Deliverables =
'''May 31st - 5th June''': Fix SN bug that prevents SCOs from loading, and potentially- [http://tracker.moodle.org/browse/MDL-28741 ADL Test: CM-02], [http://tracker.moodle.org/browse/MDL-28743 ADL Test: CM-03], and [http://tracker.moodle.org/browse/MDL-28802 ADL Test: DDM].

'''6th - 17th June''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28805 ADL Test: DMI], [http://tracker.moodle.org/browse/MDL-28804 ADL Test: DMB], [http://tracker.moodle.org/browse/MDL-28745 ADL Test: CM-04], [http://tracker.moodle.org/browse/MDL-28926 ADL Test: T-01]

'''18th - 27th June''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28772 ADL Test: CO-01], [http://tracker.moodle.org/browse/MDL-28773 ADL Test: CO-02], [http://tracker.moodle.org/browse/MDL-28775 ADL Test: CO-03], [http://tracker.moodle.org/browse/MDL-28795 ADL Test: CT-01]

'''27th June - 8th July''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28806 ADL Test: MS-01], [http://tracker.moodle.org/browse/MDL-28807 MS-02], [http://tracker.moodle.org/browse/MDL-28808 MS-03], [http://tracker.moodle.org/browse/MDL-28814 OB-01], [http://tracker.moodle.org/browse/MDL-28796 CT-02]

'''9th - 15th July''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28854 ADL Test: RU-01], [http://tracker.moodle.org/browse/MDL-28858 ADL Test: RU-02], [http://tracker.moodle.org/browse/MDL-28860 ADL Test: RU-03], [http://tracker.moodle.org/browse/MDL-28862 ADL Test: RU-04]

''This will be the midterm evaluation target - A detailed report on the then status of SCORM 2004 support in Moodle, mentioning all improvements and results of the closed issues to the Moodle Community.''

'''16th July - 22nd July''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28902 ADL Test: SX-02], [http://tracker.moodle.org/browse/MDL-28903 ADL Test: SX-03], [http://tracker.moodle.org/browse/MDL-28904 ADL Test: SX-04], [http://tracker.moodle.org/browse/MDL-28749 CM-05]

'''23rd July - 1st August''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28750 ADL Test: CM-06], [http://tracker.moodle.org/browse/MDL-28751 ADL Test: CM-07], [http://tracker.moodle.org/browse/MDL-28779 ADL Test: CO-05], [http://tracker.moodle.org/browse/MDL-28781 ADL Test: CO-06], [http://tracker.moodle.org/browse/MDL-28782 ADL Test: CO-07]

'''2nd - 12th August''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28797 ADL Test: CT-03], [http://tracker.moodle.org/browse/MDL-28798 ADL Test: CT-04], [http://tracker.moodle.org/browse/MDL-28799 ADL Test: CT-05], [http://tracker.moodle.org/browse/MDL-28757 CM-08], [http://tracker.moodle.org/browse/MDL-28758 ADL Test: CM-09]

'''13th - 19th August''': Fix SCORM 2004 bugs, potentially- [http://tracker.moodle.org/browse/MDL-28818 ADL Test: OB-02], [http://tracker.moodle.org/browse/MDL-28819 ADL Test: OB-03], [http://tracker.moodle.org/browse/MDL-28822 ADL Test: 0B-04], [http://tracker.moodle.org/browse/MDL-28868 ADL Test: RU-05], [http://tracker.moodle.org/browse/MDL-28906 SX-05]

= Relevant Links =
*[http://docs.moodle.org/dev/SCORM_Test_Harness SCORM Test Harness]
*[http://docs.moodle.org/en/SCORM_FAQ SCORM FAQ]
*[http://www.adlnet.gov/capabilities/scorm/scorm-2004-4th ADL SCORM 2004 4th Edition]
*[http://docs.moodle.org/dev/GSOC/2012 GSoC 2012 - Moodle]

== Tracker ==
* [http://tracker.moodle.org/browse/MDL-7608 META: SCORM 2004 compliance + issues]