MoodleDocs - User contributions [en]

Managing plagiarism prevention

2021-02-28T20:36:44Z

Danmarsden: /* Fully supported plugins */ Urkund renamed to Ouriginal

{{Plagiarism prevention}}
==Enabling plagiarism prevention==

To make use of plagiarism prevention, the feature must be enabled by an administrator by checking the enable plagiarism plugins box in ''Administration > Site administration > [[Advanced features]]''.

[[File:Enableplagiarism.png]]

==Plagiarism prevention plugins==

An administrator then needs to install and configure one or more plagiarism prevention plugins in ''Administration > Site administration > Plugins > Plagiarism prevention > Plagiarism settings''. Possible plugins include:

=== Fully supported plugins ===
These are plugins that support plagiarism detection within the Moodle Assignment, Workshop and Forum activities.
*[[Plagiarism Prevention Compilatio|Compilatio]] - Commercial tool requires paid subscription
*[[Plagiarism Prevention Turnitin|Turnitin]] - Commercial tool requires paid subscription
*[[Plagiarism Prevention Ouriginal|Ouriginal]] - Previously called Urkund - Commercial tool requires paid subscription
* [https://moodle.org/plugins/plagiarism_unicheck Unicheck] - Commercial tool requires paid subscription

=== Partially supported plugins ===
These are plugins that currently only support the Moodle Assignment activity.
* [https://moodle.org/plugins/plagiarism_copycheck CopyCheck] - Commercial tool requires paid subscription
* [https://moodle.org/plugins/plagiarism_plagiarisma PLAGIARISMA] - Commercial tool requires paid subscription
* [https://moodle.org/plugins/plagiarism_plagscan PlagScan] - Commercial tool requires paid subscription
* [https://moodle.org/plugins/plagiarism_vericite Vericite] - Commercial tool requires paid subscription

== Other tools for managing plagiarism ==
*[[Acknowledge plagiarism statement access rule]] - A plugin by the Open University lets you require students to agree to a statement about not plagiarising before starting a quiz.
*[https://moodle.org/plugins/view.php?plugin=quizaccess_safeexambrowser Safe Exam Browser quiz access rule] - Provides Safe Exam Browser 2.0 integration for Moodle.
*[[Essay (auto-grade) question type]] - An additional essay question type that can use a glossary of common errors to detect plagiarized phrases.

[[Category:Site administration]]
[[de:Plagiatsuche-Plugins verwalten]]
[[es:Gestionando prevención de plagio]]

Plagiarism Prevention URKUND

2021-02-28T20:35:58Z

Danmarsden: Redirected page to Plagiarism Prevention Ouriginal

#REDIRECT [[Plagiarism_Prevention_Ouriginal]]

Plagiarism Prevention URKUND Settings

2021-02-28T20:35:08Z

Danmarsden: Redirected page to Plagiarism Prevention Ouriginal Settings

#REDIRECT [[Plagiarism_Prevention_Ouriginal_Settings]]

Plagiarism Prevention Using URKUND

2021-02-28T20:34:17Z

Danmarsden: renamed to Ouriginal

#REDIRECT [[Plagiarism_Prevention_Using_Ouriginal]]

Plagiarism Prevention Using Ouriginal

2021-02-28T20:32:53Z

Danmarsden: Created page with "{{Plagiarism prevention}} The Ouriginal Plagiarism Plugin currently supports the assignment, forum and quiz activities. ==Creating a Moodle Assignment== #Turn editing on insi..."

{{Plagiarism prevention}}
The Ouriginal Plagiarism Plugin currently supports the assignment, forum and quiz activities.

==Creating a Moodle Assignment==
#Turn editing on inside your course: https://docs.moodle.org/en/Turn_editing_on
#in the drop lists provided select either the “upload a single file” or “Advanced uploading of files” assignment types. For more information on the generic settings of this page please see: https://docs.moodle.org/en/Assignment_settings
# Configure Ouriginal settings for this assignment using the receiver address provided by Ouriginal and setting other options as required and save the assignment.

[[File:UrkundAssignmentSettings.png]]

==Viewing the Ouriginal generated reports==
After a student has uploaded a file to Moodle, the file is passed to Ouriginal behind the scenes and
it can take some time before a report is available.
# click on the link to view submitted assignments [[File:ViewSubmittedAssignments.png]]
# on the submissions page all the students are listed – beside each file is the response from Ouriginal

[[File:UrkundSubmissions.png]]

Plagiarism Prevention Ouriginal Settings

2021-02-28T20:31:00Z

Danmarsden: Created page with "{{Plagiarism prevention}} ==Activation of your Ouriginal Account== # obtain a Ouriginal Subscription from [http://ouriginal.com ouriginal.com] ==Installation of the plugin ==..."

{{Plagiarism prevention}}
==Activation of your Ouriginal Account==
# obtain a Ouriginal Subscription from [http://ouriginal.com ouriginal.com]

==Installation of the plugin ==
=== Installation using Git ===
from the root of your install:
git clone git://github.com/danmarsden/moodle-plagiarism_urkund.git plagiarism/urkund
then add plagairism/urkund to your .gitignore
Visit the Admin > Notifications page in Moodle to trigger the upgrade scripts
=== Installation using a Zip file ===
Download the zip:
https://github.com/danmarsden/moodle-plagiarism_urkund/zipball/master
or the tar.gz:
https://github.com/danmarsden/moodle-plagiarism_urkund/tarball/master

Then Extract these files into a new folder under /plagiarism/urkund and visit the Admin > Notifications page in Moodle to trigger the upgrade scripts

=== Installation failed due to unprocessed data ===
This error may occur when you try to upgrade to a version of the Ouriginal plugin that uses the new Moodle events API - it occurs when your installation contains unprocessed events related to the old API. If we ignored these events and upgraded then it is possible that some previously submitted files will not be sent to Ouriginal for processing.

This is most likely to have occurred if a user has submitted an assignment since the last time your scheduled task process was run.

There was also a recent issue related to group-based assignments that could cause a backlog of events - you may want to apply [https://github.com/danmarsden/moodle-plagiarism_urkund/issues/44 this fix] to your old version of the code to address this. Alternatively use [https://github.com/danmarsden/moodle-plagiarism_urkund/archive/3fe13052eb368faf2bfcb9ccf81aff21263192a7.zip this link] to download an complete version of the Ouriginal plugin that includes the fix related to the backlog of events.

You can see a list of the queued events in your database by running the following sql query(eventdata is [https://github.com/danmarsden/moodle-plagiarism_urkund/blob/310b498a9e6fcf9e757c0f925878121a78381e95/urkund_debug.php#L171 base64 encoded and serialized]):
SELECT qh.id, qh.status, qh.timemodified, eq.eventdata, eq.stackdump, eq.userid, eh.eventname,
eh.component, eh.handlerfile, eh.handlerfunction
FROM mdl_events_queue_handlers qh
JOIN mdl_events_queue eq ON eq.id = qh.queuedeventid
JOIN mdl_events_handlers eh ON eh.id = qh.handlerid
WHERE (eh.eventname = 'assessable_file_uploaded' or eh.eventname = 'assessable_content_uploaded' or eh.eventname = 'assessable_submitted')

To clear these events normally, you should revert the Ouriginal code to using an earlier version, place the site into maintenance mode (to prevent any other submissions from occurring) run the cron process (sometimes multiple calls are required) until the above sql returns no results. If you have an event in the list with a high "qh.status" value it is possible that this event is causing the queue to block. You could relatively safely try deleting any records with a qh.status higher than 5 and then run cron multiple times until the queue is cleared, and then try to upgrade to the new version of the Ouriginal plugin.

If you are not concerned about these events and it does not matter if these submissions do not get posted to Ouriginal for processing you can run the following SQL command to clear the queue and allow the upgrade to continue.
DELETE FROM mdl_events_queue_handlers WHERE handlerid IN (SELECT id FROM mdl_events_handlers WHERE component = 'plagiarism_urkund')

==Global Configuration of Ouriginal==
# Go to ''Admin > Advanced Features'' find the setting “Enable plagiarism plugins” - make sure the box is ticked.[[File:Enableplagiarism.png]]
# Go to ''Admin > Plugins > Plagiarism Prevention > Ouriginal''
## Tick the box "Use Ouriginal"
## Enter your Ouriginal UIS username
## Enter your Ouriginal UIS password
## Set the Student Disclosure statement. - this is displayed to all students on the upload screen to notify them that the URKUND system is in use. [[File:Urkundsettings.png]]
# in the page ''Admin > Modules > Activities > Ouriginal'' click on the tab "Ouriginal Defaults"
## Configure the default settings to be used inside a Moodle module when creating/editing a new module. [[File:Urkunddefaults.png]]

==Advanced Configuration==
The ability to enable/disable Ouriginal within a Moodle module such as an assignment is managed using a capability that is by default given to all managers and editing teachers on the site.
If you want to force all assignments on your site to use Ouriginal and prevent your teachers from changing these settings you can set the defaults above and then remove the capability “moodle/plagiarism_urkund:enable” from your teacher roles.

You can also use this capability to selectively allow certain teachers to use Ouriginal by setting the default above “Enable Ouriginal” to “No” - and giving the capabiltiy “moodle/plagiarism_urkund:enable” only to the teachers you want to be able to use Ouriginal

Plagiarism Prevention Ouriginal

2021-02-28T20:28:54Z

Danmarsden: Urkund renamed as Ouriginal.

{{Plagiarism prevention}}
Ouriginal (previously called Urkund) is a commercial plagiarism prevention tool [https://ouriginal.com ouriginal.com] It was developed in Sweden and is now used widely internationally.

*[[Plagiarism Prevention Ouriginal Settings|Ouriginal Installation and Settings]]
*[[Plagiarism Prevention Using Ouriginal|Using Ouriginal]]

==See also==
*[https://ouriginal.com/guides-tutorials/ Ouriginal documentation]

Plagiarism Prevention URKUND

2021-02-26T02:15:05Z

Danmarsden: remove broken link to old plugin.

{{Plagiarism prevention}}
URKUND is a commercial Plagiarism Prevention tool [http://www.urkund.com www.urkund.com] It was developed in Sweden and is now used widely in Europe and other countries.

*[[Plagiarism Prevention URKUND Settings|URKUND Installation and Settings]]
*[[Plagiarism Prevention Using URKUND|Using URKUND]]

==See also==
*[http://www.urkund.com/en/support URKUND documentation]

Blackboard migration

2019-09-30T01:43:34Z

Danmarsden: /* Standard Blackboard */ update link to reteach code

''This page requires updating. Please help if you are familiar with Blackboard to Moodle transition.''
{{Installing Moodle}}
==Blackboard systems==

The way Blackboard and WebCT named their products is confusing!

For the purpose of migration to Moodle, Blackboard can be categorised into 3 different systems, each with a different migration procedure.
* CE 4.0/CE 4.1 (rebranded WebCT)
* Standard Blackboard (5.5, 6, 7, 8, 9, 9.1)
* Vista3/Vista4/Vista8 and CE 6/CE 8 (rebranded WebCT)

==CE 4.0/CE 4.1==
CE 4.0, 4.1(rebranded WebCT) can use the webctimport tool with the "IMS Content Migration Utility" here:
https://docs.moodle.org/en/WebCT_migration - This tool has not been updated to work with 2.x, you must use it in a 1.9 site, backup the courses and restore the 1.9 Moodle backups on a Moodle 2.1 site (1.9 backups are not supported in 2.x)

==Standard Blackboard==
* Moodle 1.9 (NOT SUPPORTED IN 2.x YET) has a restore function built into the standard backup/restore process which will restore Blackboard Archive/Export files with mixed results
* An Alternative solution is to use the LSU converter here: http://moodleconverter.lsu.edu/ (code available here: https://xythos.lsu.edu/users/pcali1/moodlecct/index.html) see discussion here: http://moodle.org/mod/forum/discuss.php?d=147948#p647029 - This produces 1.9 Moodle backups which can be restored in 2.1(2.0 does not support restoring 1.9 backups)
** Note: Archive/Export files from Windows-based Blackboard servers are not handled correctly by MoodleConverter (see discussion here: http://moodle.org/mod/forum/discuss.php?d=147348) but the archives can be reformatted with minimal effort (more details will soon be posted or linked here, but the essence of the process is to unzip the archive file, rename certain files with Blackboard-encoded file names, and then zip the archive file on a Linux-style [forward-slash] file system)
* A new LSU Converter is available here: https://xythos.lsu.edu/users/rrusso/cct2.zip see discussion here: http://moodle.org/mod/forum/discuss.php?d=147948#p647029 - This produces 1.9 Moodle backups which can be restored in 2.1(2.0 does not support restoring 1.9 backups)
* The most up-to-date LSU converter is available at https://github.com/adamzap/reteach. This is a Python package that must be installed on a server or desktop administered by the user. Windows support is not provided.

==Moodle Course Restore==

From Moodle 1.5- 1.9,(Not yet supported in 2.0) Moodle's "course restore" facility can import courses from Blackboard 5.5 and 6.0 -- you have to use the 'export' facility in BB to get the files in the correct format from BB. For question pools, there is a dedicated import facility in the Quiz Module.

There's a screen-by-screen walk-through by Matt Campbell - he says:

:: We recently migrated about 200 courses from Blackboard 6 to Moodle 1.5+, and I made a [http://instructor.metrotech.org/~mcampbell/Converting%20Blackboard%20to%20Moodle.ppt PowerPoint] for this routine. I've been asked to make a Captivate just on the import routine and will work on that.

For the above to work, you will need to have the XSLT and Sablotron extensions.

Some question types are not supported by Moodle directly -- see below for contrib question types that add that support.

For Moodle 1.4.x [http://moodle.org/mod/forum/discuss.php?d=32049 Blackboard content conversion tool] is available. It was designed to migrate Blackboard 6.1 to Moodle 1.4+ - it may be possible to make it work with other versions.

According to Michael Penney in the forum discussion [http://moodle.org/mod/forum/discuss.php?d=1565 Migrating 10000 students from Blackboard to Moodle?]

:''"It works pretty well with a couple of caveats:''

:''1) It doesn't import all Blackboard question types: at CSU H, we wrote an essay question type and a 'rendered match' question type and a BB pool importer, we'd like to work with SF and others to get our qtype importer into theirs.''

:''2) SF's tool is designed to make you think about your course when you import it and redesign it. That is a nice idea, however it can be pretty time consuming when you have hundreds of documents in a course (<rant>Blackboard's poor content development tools encourage what I call the 'datadump' course format, instead of delivering information in an effective elearning tool like Moodle's lesson, with BB folks tend to post hundreds of office documents and then massive quizzes about them</rant>).''"

===Example Migration of One Test Course===
'''by [[User:Jeffrey Silverman|Jeff Silverman]], The Johns Hopkins University'''
''(Note: I am a novice Moodler. This is a description of what I did to move a single exported BlackBoard course to my out-of-the-box Moodle test installation. I had a number of questions about the process and I hope this example helps answer them for someone else.)''

====When====
This test procedure was performed during the week of 20-Aug-2007

====Versions====
* Moodle 1.8
* BlackBoard 7.1 "basic" (unconfirmed)

====Procedure====
# Export course content from Bb. This step was done by someone else! I do not know how to do this, what options were chosen, etc. I do know that I got a .zip file that I think is a "Course Archive".
# Import course into Moodle. (Needs to be done by a user with the necessary privileges. I have only one user in my Moodle installation, the "Admin" user, and he (she?) is the "Site Administrator").
## Create new course
## Go to "Restore" under the course administrative tools
## Choose a file to upload; upload the Bb .zip file
## Choose "Restore" (in the Action column) -- in another page or two you will get to say to restore this as a "New Course"

====Questions====
Some of my questions were as follows:

# Do you have to create a new course?
## Aparent answer: YES. Personally, I found this very counter-intuitive, as "importing a course" or "restore from backup" or other similar administrative tasks seem to me to be on a level outside a specific course. For example, having the "Restore" feature only available in the admin tools for a particular course makes it seem like the restoration will only work for that course -- but that is not true. You can use any course's "Restore" link in the admin tools and choose "Create a New Course" mid-way through the retoration procedure. But creating a new course from backup that has nothing to do with the course in which one has clicked the "Restore" link is, like I said, counter-intuitive. And, to top it off, I could find no mention of this until I had already clicked on "Restore". Looks like I need to add some information to the "administrative tools" or "backup/restore" docs, hm? :)
# Is there a specific "Bb-to-Moodle" conversion tool?
## Answer: NO. Unlike the WebCT-to-Moodle conversion, [[http://moodle.org/mod/data/view.php?d=13&rid=94 which requires a specific add-on]], Bb conversion is now built in.
# What format does the Bb export have to be in?
##The Bb "export" should be an ''archive'' of the Bb course, rather than an export; otherwise you can't restore the course because it it missing a name (and possibly other fields).
# What versions of Bb and Moodle will this work for?
# There is a tool floating around called "[[http://moodle.org/mod/forum/discuss.php?d=32049 Blackboard Content Conversion Tool (CCT)]]" that sounds useful for converting Bb to Moodle. Do I need it?
## Answer: NO. Actually, I had a bunch of questions about that tool, too, but ultimately I did not need it.
### Does the CCT run on the server where Bb is running?
### Does it interact, somehow, directly with the Bb instance?
### Or does it run on the Moodle server and do the import from Bb into Moodle?

==Vista CE 6/CE 8==
Vista3/Vista4/Vista8 and CE 6/CE 8 unfortunately encrypt their backup files and there isn't currently any open source method to convert the full courses yourself.
* Learning Modules can be exported as IMS packages by going to Learning Modules and choosing Export in Bb Vista. However, Moodle does not recognize these via it's standard Resource > Add an IMS Package feature. The Bb Vista manifest must first be converted. [http://moodle.org/mod/forum/discuss.php?d=152587 John Tutchins has written an IMS converter] for this purpose in PHP.

* Bb Vista IMS packages might be importable using the [http://moodle.org/mod/data/view.php?d=13&rid=94 WebCT CE 4 Import].
* Files for each course can be extracted as a zip then placed inside the new course, however they require manual re-linking (Another option would be to move to a digital repository, such as Equella, which can move the files from CE8 to Equella, and add links to the files into the Moodle courses) See videos on moving files here: Part 1 (files): [http://www.youtube.com/watch?v=-XX5beOLKKA] Part 2: [http://www.youtube.com/watch?v=pWIFPVgKcb4]
* Quiz questions can be exported as IMS packages by going to Assessments in Bb Vista. They can also be extracted with Respondus and you can create an IMS QTI file to import into Moodle.
**If you use Respondus version 4 or later (download 30 day free demo here: [http://www.respondus.com/download/respondus.shtml], you can retrieve the quizzes and publish to Moodle directly from Respondus if the Moodle server has the "Respondus Web Service Extension for Moodle" (download here: [http://www.respondus.com/download/moodleserver.shtml]. See a video on how to do this here: [http://www.youtube.com/watch?v=VXG3BeyBQAI&feature=related] and here: [http://mygermanclass.blip.tv/file/3428598/]
* Newer versions have some useful Database views inside the Blackboard database that allow retrieving of some of the information. It's really easy to get course names/users/enrolments and grades directly out using the DB Views "RPT_PERSON", "RPT_MEMBER","RPT_LEARNING_CONTEXT" and "RPT_GRADEBOOK"
doing it manually also gives you the forced opportunity for your lecturers/staff to clean things up a bit and learn a bit more about the differences between Blackboard and Moodle
*Assignments can be set up manually, copied/pasted. Migrating assignments video: [http://www.youtube.com/watch?v=LwW778nF4iE&feature=related]
*Migrating a discussion topic video: [http://www.youtube.com/watch?v=EUlNASbGhww&feature=related]

==See also==
*[http://moodle.org/mod/data/view.php?d=19&rid=2531 Final 2009 Report of the University of North Carolina LMS Evaluation Committee] describing the results of an evaluative comparison of Moodle with the University’s current Blackboard system (Vista)
*[http://oscmoodlereport.wordpress.com The Open Source Collaborative: Moodle Assessment Report] This report is the accumulation of two years of experimentation and evaluation of Moodle by the North Carolina Community Colleges System.
*[http://www.move2moo.com/Webct-Moodle-Converter.aspx Blackboard CE8/Vista8 to Moodle 2 content conversion tool (Commercial)] This website provides a free preview of a Blackboard course conversion, good to get some ideas on where/how to move content.
*[http://moodle.org/mod/data/view.php?d=19&rid=2606 The Whole Kit and Caboodle on Moodle] presentation introducing Moodle and sharing experiences of migrating from Blackboard
*[http://moodle.org/mod/data/view.php?d=19&rid=2620 An LMS By Any Other Name...] presentation helping transition Blackboard users to Moodle terms
*[http://jsweetin.wordpress.com/resources/ Blackboard to Moodle resources] including a Blackboard 7.3 to Moodle 1.8 Cross-Reference
*[https://docs.moodle.org/en/Import_questions#Blackboard Import_questions: Blackboard format]
*[http://its2.unc.edu/tl/tli/bFree/ bFree - Blackboard™ Course Content Extractor] - extract selected content from Blackboard Archive/Export files into a local filesystem, allowing them to be cleaned, manipulated, zipped, and uploaded for use in Moodle. This does not create course objects but does transfer the documents and descriptions into a Moodle course's Files for creating resources. This is useful for those faculty who will be reorganizing their courses or for complex courses which don't convert well.

===Using Moodle forum discussions:===
*[http://moodle.org/mod/forum/discuss.php?d=78521 Migrate a course from Blackboard to Moodle]
*[http://moodle.org/mod/forum/discuss.php?d=92477 Moodle 1.9 Blackboard Import - contains some troubleshooting]
*[http://moodle.org/mod/forum/discuss.php?d=48666 If you are having problems with Blackboard to Moodle read this]
*[http://moodle.org/mod/forum/discuss.php?d=117876 Examview (Blackboard) Quiz Plugin]
*[http://moodle.org/mod/forum/discuss.php?d=48666 Blackboard archive file name conversion] A thread which contains information on hexified Blackboard archive file names (BB archiving converts filenames to hex when they contain spaces)

[[es:Migración desde Blackboard]]

Antivirus plugins

2019-03-27T21:36:11Z

Danmarsden: improve title of discussion - it started with a request about nodes, but evolved into just running clamdscan on the webserver instead of clamscan

{{Security}}
An administrator can enable and configure virus scanners for use on uploaded files via ''Site administration > Plugins > Antivirus plugins > Manage antivirus plugins''.

ClamAV antivirus is available as a standard plugin. It's likely that more antivirus plugins will be available in future from the [https://moodle.org/plugins/ Moodle plugins directory].

==ClamAV antivirus==

To make use of ClamAV antivirus, ClamAV® should be installed on your server. See http://www.clamav.net for more information.

== See also ==

* RHEL/CentOS and [https://en.wikipedia.org/wiki/Security-Enhanced_Linux SELinux]: https://moodle.org/mod/forum/discuss.php?d=316066
* RHEL/CentOS and [https://access.redhat.com/blogs/766093/posts/1976243 PrivateTmp]: https://moodle.org/mod/forum/discuss.php?d=364706
* Improve performance by using ClamDScan https://moodle.org/mod/forum/discuss.php?d=382731

[[Category:Site administration]]

[[eu:Antibirusa]]
[[de:Antivirus]]
[[es:Plugins antivirus]]

Configuration file

2019-01-27T21:50:07Z

Danmarsden: /* Changing default theme directory location */

{{Installing Moodle}}
The name for Moodle's configuration file is config.php. The file is located in the moodle directory. It is not included in the Moodle download packages and is created by the installation process from the template file config-dist.php (which is included in Moodle packages).

==config-dist.php==
Although the installation process creates the config.php file for you, there may be times when you want to do this yourself. A sample config file, called config-dist.php, is shipped with Moodle.

To get started simply copy config-dist.php to config.php, then edit config.php with you favourite editor. The file is very well commented. The important options (which you must supply) are all nearer the top. Other less common options are further down.

==Setting $CFG->wwwroot correctly==
This setting must be a fixed URL (a string constant) that points to your site. Do not try to set this with any PHP code that can generate a variable URL. This is not supported, can cause strange problems and will stop command line scripts working completely. If your site is accessed from different IP addresses this should be done with a split DNS, see [[Masquerading]]

==Enabling password salting==

See [[Password salting]].

==Including passwords in backups==

Hashed user passwords are no longer saved in backup files containing user data.

If you really need passwords to be saved (in the rare case of restoring a [[Backup of user data|backup with user data]] to a different site), the following line may be added to config.php:

$CFG->includeuserpasswordsinbackup = true;

Note regarding restoring Moodle 2.5 backups to sites with old PHP versions:

Because bcrypt is not supported in PHP versions below 5.3.7, course backups made using the $CFG->includeuserpasswordsinbackup setting on a site using PHP version 5.3.7+ that are subsequently restored to a site with PHP version < 5.3.7 will require a password reset.

==Changing default block layout for new courses==

See [[Block layout]].

==Adding extra theme directory location==
It is possible to add an extra themes directory stored outside of $CFG->dirroot. This local directory does not have to be accessible from internet. Themes placed in the directory specified by these variables will then be available for selection using the theme selector.

For example, should you wish to place extra themes in a subdirectory called 'my_moodle_themes', your config.php might look like this:
<pre>
$CFG->wwwroot = 'http://my.moodle.site.edu';
$CFG->dirroot = '/var/www/my.moodle.site.edu/public_html';
$CFG->themedir = $CFG->dirroot . '/my_moodle_themes';
</pre>

==Disabling update notifications==

See [[Notifications]].

==Enabling debugging==

See [[Debugging]].

==Forcing the value of admin settings==

As explained in config-dist.php, it is possible to specify normal admin settings here, the point is that they can not be changed through the standard admin settings pages any more. Just set the value in config.php like:

<code php>
$CFG->showuseridentity = 'email,idnumber,username';
</code>

==See also==

* Using Moodle [http://moodle.org/mod/forum/discuss.php?d=137889 Moodle Salting] forum discussion

[[de:Konfigurationsdatei]]
[[es:config.php]]
[[fr:Fichier de configuration]]
[[ja:設定ファイル]]

SCORM FAQ

2018-09-05T23:28:23Z

Danmarsden: /* Supported Versions */ fix links to rustici.

{{SCORM}}
==What is SCORM?==

SCORM was developed as a result of collaboration in the public and private sectors. The President of the United States, Bill Clinton issued an Executive Order that created an agency (ADL) to oversee the standard for developing and distributing online learning. All Federal agencies are mandated to use programs that meet those standards. SCORM is one result of that order.

There's a really simple "What is SCORM" introduction here: http://moodle.org/mod/forum/discuss.php?d=3757#p18828

A slightly more detailed introduction here: http://www.rusticisoftware.com/resources/whatisscorm/What%20Is%20SCORM.ht

==Should I make my Moodle courses as SCORM or use Moodle's features?==
It depends how you intend to use it. If you are planning on exporting and using in another LMS then SCORM would make this easier. If you want something shiny, then a SCORM package can fit the bill. However, reporting and grading work better in Moodle and for many educators the standard features do the job perfectly and do not require learning a new program. There is a useful form post discussing the pros and cons of SCORM in Moodle here: http://moodle.org/mod/forum/discuss.php?d=200242

==SCORM Information==

Advanced Distributed Learning (ADL) is the organization that wrote the SCORM standard. You can download documentation and samples form ADL's Web site. Documentation for SCORM 1.2 in several languages is available [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2%2fDocumentation%20Suite%20(SCORM%201.2)&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} here].

Philip Hutchison provides an AS3 and JavaScript wrapper, as well as a sample package:
http://pipwerks.com/downloads/

==SCORM Package Contents==

A SCORM package must contains in the root of zip a file named imsmanifest.xml which defines SCORM course structure, resource location and many other things. Other files used in the package, such as HTML files, XML files, multimedia files, and JavaScript for the SCORM API must be listed in this file. The LMS parses the manifest, and provides the files listed there to the content package during runtime.

==AICC Package Contents==

An AICC package is defined by several files (from 4 to 7) with defined extensions as follows:

* CRS - Course Description file (mandatory)
* AU - Assignable Unit file (mandatory)
* DES - Descriptor file (mandatory)
* CST - Course Structure file (mandatory)
* ORE - Objective Relationship file (optional)
* PRE - Prerequisites file (optional)
* CMP - Completition Requirements file (optional)

==Basic Troubleshooting==

* Make sure you are running Moodle 2.1 or higher, a large number of SCORM related bugs are present in previous versions.
*Make sure you (and your users) have JavaScript enabled. SCORM requires JavaScript.
* Make sure your SCORM object is SCORM compliant - check it in an external SCORM player like [https://docs.moodle.org/en/Tools_for_creating_SCORM_content#Reload Reload] to see if it works there.
* Upload a copy of your SCORM object to a [http://en.wikipedia.org/wiki/File_hosting_service File Hosting Service] and post a message asking for help in the forums, linking to your SCORM object explaining exactly what you expect to happen, and what is happening instead.
* Read Dan Marsden's blog post [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle here] (Maintainer of SCORM Module in Moodle)

==Does Moodle Generate SCORM Content?==

Moodle '''does not''' generate scorm content. Moodle presents the content in SCORM packages to learners, and saves data from learner interactions with the SCORM package.

==Can I add a password for access to my SCORM package?==
No, although there is a tracker request for this: MDL-46403 As a workaround you could add your SCORM package using the single activity course format - see [[Course formats]] - and add an enrolment key to the course.

==Supported Versions==

* SCORM 1.2 is supported in Moodle 2.1(or higher) and passes all the tests in the ADL Conformance test suite 1.2.7 for SCORM 1.2. The best place for information on SCORM 1.2 conformance is the [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Previous%20Versions/SCORM%201.2/Conformance%20Test%20Suite%20(SCORM%201.2)/SCORM_1.2_ConformanceReq.pdf SCORM Comformance Requirements documentation (PDF 3.4MB)].

* SCORM 2004 is not supported in Moodle. Parts of the API have been implemented, but others such as Navigation and Sequencing have not. Development on native SCORM 2004 support in Moodle [https://moodle.org/mod/forum/discuss.php?d=227906 has stopped]. If you require a fully certified SCORM 2004 Player in Moodle, [https://rusticisoftware.com Rustici Software] have a [https://moodle.org/plugins/mod_scormcloud Moodle plugin] which connects to their commercial [https://rusticisoftware.com/products/scorm-cloud SCORM Cloud] service turning Moodle into a fully compliant SCORM 2004 LMS.

* AICC objects are supported in Moodle 2.1 and higher.

* Tin Can is supported with a number of 3rd party plugins such as [https://moodle.org/plugins/logstore_xapi logstore xAPI] (allows reporting logging data to an external LRS) and [https://moodle.org/plugins/mod_tincanlaunch mod_tincanlaunch] (allows launching tin can content packages within Moodle.

==Asking for Help in the SCORM Forum==

When trying to engage the community to help with a problem you are facing, you will get a better response if you follow a few simple guidelines:
* Always start your report with '''version information''' - preferably the information displayed on the Admin -> Environment panel eg. http://localhost/moodle/admin/environment.php where http://localhost/moodle is your particular prefix. With this it will be clear how you are running your Moodle instance, on what platform, and at which version. This will quickly expose issues where a simple upgrade will solve your problem.
* Be prepared to '''provide the SCORM package''' that illustrates your problem - if you don't then it will be very difficult for anyone offering assistance to recreate your situation - a real barrier to help.
* '''Screenshots''' are very helpful. Provide a screenshot of all error messages, and any instance where something seems to go wrong in the interface.
* Nonstandard themes can introduce SCORM issues. Be sure to tell us '''what theme you're using'''.
* If you have admin privileges, and have access to a localhost install or other place where real-time users won't be disturbed, be sure to turn on debugging. Navigate to '''Site Administration > Development > Debugging''' and set '''Debug messages: Developer''' and '''Display debug messages: Yes'''. Access the SCORM content. If there are errors printed to the page, include them in your forum post.
* Use [https://developers.google.com/chrome-developer-tools/docs/console Chrome's JavaScript Console] or [https://developer.mozilla.org/en-US/docs/Tools/Web_Console Firebug's JavaScript console] to check that there are no JavaScript errors on the page when the content loads.
* Run your problematic SCORM package through '''API debugging''' (see below) and include the text of that API log with your post. That way we can see right away if the right function calls are not taking place.
* If you're using a content development suite which publishes to SCORM, such as Articulate, Captivate, Lectora, LessonBuilder, Udutu, or some other product, then include that in your post. Every authoring software has its ticks, and if you've run into one, it's likely that someone else has also dealt with it, and will recognize it. However, please keep in mind that '''this is a place to get help with Moodle issues, not help with your SCORM package authoring suite'''.

==Debugging ==

# Debugging settings are located at Settings > Site Administration > Plugins > Activities > Scorm.
# Check the checkbox for '''Activate API debug...'''
# Set the api mask. You can use the mask to enable debugging under certain conditions. For example, if you are logged in using the admin user (username admin) you can set the api mask to: <cite>admin.*</cite> Users not logged in as admin will not see the debugging log. The "Default" api mask is <cite>.*</cite>

==What does the debugging log mean?==

The SCO commonly sends the following communications through the API:

* '''LMSInitialize();''' opens the connection between the SCO and Moodle
* '''LMSGetValue( 'valuename' );''' gets a value from Moodle
* '''LMSSetValue( 'valuename' , 'value' );''' sends a value to Moodle
* '''LMSCommit();''' saves values sent to Moodle via LMSSetValue() and should be called after every LMSSetValue()
* '''LMSFinish()''' saves values sent to Moodle and closes the connection between the SCO And Moodle

Red lines in the debugging log means there was an error in the communication through the API.

If LMSInitialize() fails, returns an error, then no subsequent values sent to Moodle will be saved.

Click through the entire SCORM package. Then access the scorm report for your attempt, and compare the saved values in the debugging log with Moodle's report of the attempt. If the values set in the debug log do not match the values saved to Moodle, then there may be a problem with Moodle. Otherwise it's likely to be an issue with the SCO or the SCORM activity settings not giving you the functionality you need.

==SCORM and the Gradebook==
Please see [https://docs.moodle.org/en/SCORM_FAQ#My_SCORM_Module_doesn.27t_function_properly FAQ:My SCORM Module doesn't function properly] and [https://docs.moodle.org/en/SCORM_FAQ#Handling_of_Multiple_Attempts FAQ:Handling of Multiple Attempts]

Some SCORM packages report both cmi.core.lesson_status and cmi.core.score.raw. Others report only cmi.core.lesson_status, or only cmi.core.score.raw. The '''Grading Method''' setting for SCORM objects is meant to account for that.

If you have the '''Grading Method''' set to '''Highest grade''', '''Average grade''', or '''Sum grade''', and your learning object does not report a score, only, cmi.core.lesson_status, then there will be no numerical score to pass to the gradebook.

If your SCOs do not report cmi.core.score.raw, then the best '''Grading Method''' setting is '''Learning Objects'''. This reports either a 1 or a 0 as a score for each learning object. The gradebook value for that SCORM activity is the percent of scos in the package for which learners got a 1.

On the other hand, if your SCOs do not report a lesson_status, then select one of the score-based '''Grading Method''' options, such as '''Highest grade''', '''Average grade''', or '''Sum grade''', and not '''Learning Objects'''.

If you do not know what your SCOs are reporting to the LMS, then run them through to completion with debugging on.

Much of the way SCORM objects are graded is controlled inside the SCORM Authoring process before it is packaged for use in an LMS like Moodle - make sure all your grading settings are set correctly.

==SCORM Administration Options==

See [[SCORM settings]]

==Common Solutions==

===Difficulty Displaying a SCORM Package===
If you have difficulty displaying a SCORM, try loading the SCORM in [http://www.reload.ac.uk Reload] and re-saving it, then save the folder as a .zip package and try again.

===Character Display Errors===
When you notice there is a problem displaying characters correctly, it could be a misconfiguration of your server. Make sure that both httpd.conf (when using Apache) and php.ini are set to DefaultCharacterset = utf8 or switch the sending of a default character set off.

===slash arguments warning when I add/update SCORM objects in my course===
Some web servers don't support a function called '''slash arguments''' and so Moodle allows you to turn it off, but SCORM packages require '''slash arguments''' to be enabled on the web server in order to work properly.

See [[Using slash arguments]] for more details.

===SCORM doesn't work on Godaddy Host===
Godaddy hosts give a 404 file not found error - this is because by default they do not allow slash arguments which SCORM requires. The best way to test this is to visit http://yourmoodlesite/admin/tool/health/index.php - but the fix involves adding a php.ini or php5.ini file with the following text:
AcceptPathInfo
cgi.fix_pathinfo=1

===My Flash-Based Content Loads, then Stalls===
This issue is most commonly associated with zlib compression. Classic presentation is that the base HTML file and SWF are loaded into the SCORM player, but the SWF is not able to load any audio or video assets, and therefore stalls. You can watch the loading of SWFs and assets using Chrome's Developer Tools or other.

Check your site's zlib compression settings as an admin by loading up the Server > phpinfo page. zlib compression is not a Moodle setting but a server setting, so you'll need a server admin to disable it. Be sure to Purge All Caches, and clear browser caches, before confirming the change.

===Zlib warning when I add/update SCORM objects in my course===
Zlib is a php compression setting made in a websites PHP configuration - unfortunately some browsers don't handle this well (especially Internet Explorer 6) Some webhosts enable this setting, but it will likely cause issues for your users when they attempt to view/use the SCORM object. You will need to contact your server administrator to turn this off. The setting to change in php configuration is "zlib.output_compression"

===Incorrect file package - missing imsmanifest.xml or AICC structure===
This means that Moodle cannot find a file called imsmanifest.xml inside the SCORM object. Reasons for this could be:
* imsmanifest.xml needs to be immediately inside the scorm directory, NOT inside a directory inside of that. So if the zipped scorm package is package.zip, the unzipped package directory should contain immediately inside of it the imsmanifest.xml. This is a common mistake and normally occurs when a SCORM author creates a package themselves and then selects that folder to compress. This places the content folder inside of another folder, The imsmanifest.xml is there, but it is 2 directories deep. To avoid this problem when zipping scorm content into a package, go INSIDE of the exported scorm folder, select all files inside, and compress them while all are selected. The resultant compressed directory has the imsmanifest.xml file in the first directory, immediately available to the moodle scorm loading process.
* when using linux based systems the filename imsmanifest.xml must be all in lowercase not IMSmanifest.xml or Imsmanifest.XML
* The SCORM authoring tool Articulate sometimes fails to create the imsmanifest.xml -Try exporting the package again and see if the manifest is generated.
* The SCORM authoring tool Articulate Presenter will publish packages where the imsmanifest.xml file is in the correct place, but there are several lines of white space in the manifest file if you do not fill out the Reporting and Tracking Options in Articulate Presenter for Keywords and LMS Description. Moodle will give a "Manifest not found" error when encountering this. To fix this problem select the Reporting and Tracking Options in the Articulate Presenter publish dialog and fill in the LMS Description and Keywords.

===File not found error===
You have this error if the scorm package is created in moodle, and the scorm menu loads, but inside of the viewing area for the scorm content, you get a page with a 404 file not found error, usually showing the current Moodle theme.

What this means is that one of the files listed in the imsmanifest.xml is not in the scorm package or not in the correct directory.

Download and unzip the package, open up imsmanifest.xml. At the bottom of the xml file, below any metadata, you'll find a place where organizations and resources for those organizations are designated:

<code xml>

<organizations default="TOC1">
<organization identifier="TOC1">
<title>SCORM Test</title>
<item identifier="I_SCO0" identifierref="SCO0">
<title>Library Quiz</title>
<adlcp:masteryscore>0</adlcp:masteryscore>
</item>
</organization>
</organizations>
<resources>
<resource identifier="SCO0" type="webcontent" adlcp:scormtype="sco" href="scorm.html">
<file href="scorm.html"/>
<dependency identifierref="ALLRESOURCES" />
</resource>
<resource identifier="ALLRESOURCES" type="webcontent" adlcp:scormtype="asset">
<file href="scorm.html" />
<file href="scorm.js" />
<file href="swfobject.js" />
<file href="scorm.swf" />
<file href="scormwrapper.js" />
</resource>
</resources>
</manifest>
</code>

In this xml, we have a single organization, and in that organization is a single resource, a single sco. There are 5 files necessary for that resource to work correctly. The scorm.html file is loaded first. It loads 3 external js files and a swf.

What you need to do now is go to the directory containing imsmanifest.xml, and check that all of those listed files are available at the correct path from imsmanfiest.xml, as listed in imsmanifest.xml. If any one of those files is missing (especially the html file or the swf), or if the paths in imsmanifest.xml are incorrect, then it's very likely that the scorm object won't be able to load at all.

Sometimes the files aren't missing, but are simply misnamed in the manifest, or placed in the wrong directory. You can fix this by moving the files to the correct places, or updating their names so that the imsmanifest and the actual file names match up. In the case of a misnamed file, change the manifest rather than the actual file names, since the the files also reference one another in other places!

===Unzip issues===
If you get a blank page after filling in the title, description, and selecting a large SCORM file, it's likely you haven't installed the PHP-zip lib which is required for Moodle 2.x for more info see [[admin/environment/php_extension/zip]]

===Clear an Attempt===
To clear attempts by a student:

# Go to the SCORM activity and select the link "View reports for x users"
# Select the attempt or attempts you want to clear using the checkbox
# Select Delete in the drop-down box at the bottom of the page

===Handling of Multiple Attempts===
SCORM is designed to allow a learner to exit and return at a later date to the same point they left from. This means that each time they enter the SCORM they are using the same single attempt. Some SCORM packages are intelligent about handling re-entry, many are not. What this means is that if the learner re-enters an existing attempt, if the SCORM content does not have internal logic to avoid overwriting cmi.core.lesson_status and cmi.core.score.raw, they can be overwritten by a lower score, confusing the learner.

When a SCORM sets the cmi.core.lesson_status value to 'completed', 'passed' or 'failed' then Moodle allows the user to create a new attempt by adding a '''Start new attempt''' checkbox to the entry page. If cmi.core.lesson_status is set to 'incomplete', 'browsed' or 'notattempted' the learner can only re-enter the existing attempt. If you are using the setting 'Student skip content structure page', this checkbox will never be shown to the user.

Moodle provides a range of settings to allow this to be controlled, some of these settings are hidden by default as advanced options.
* Number of attempts
:This allows the teacher to set how many SCORM attempts the learner may create - this is not how many times a learner can re-enter a SCORM attempt.
* Attempts grading
:This allows the teacher to set how multiple SCORM attempts(not re-entries) are graded. It is important to note that a 'failed' cmi.core_lesson_status allows a new attempt to be generated but the attempts grading setting "last completed attempt" only includes 'completed' and 'passed' values in it's calculations.
* Display attempt status
:This displays a users SCORM attempts and how their final grade is calculated on the SCORM entry page and the My Moodle page for the learner.
* Force completed
:This is a setting that can be used to force a SCORM package to report a 'completed' cmi.core.lesson_status if it doesn't currently set the value.
* Force new attempt
:This hides the '''Start new attempt''' checkbox and will force a new attempt if the previous attempt has cmi.core.lesson_status value to 'completed', 'passed' or 'failed' (disabling "review mode")- this setting can also be used to make sure a new attempt is generated when the 'Student skip content structure page' setting is used.
* Lock after final attempt
:This prevents access to the SCORM after the total number of attempts have been used - if this is not set the learner can re-enter their last attempt (in review mode) and potentially change/overwrite their score each time depending on how the SCORM package supports multiple re-entries.

===Reducing Load Time with Captivate===
* Modify the percent that must be downloaded before the content starts to play. In Captivate 4, there's a setting in: Preferences / Project / Start and End / Preload. Reduce that to 50%.
* If you use audio in your Cp file (as background or element attachment), try to put a gap of 0,1 second at the beginning of each element including audio on your slides. If you don't do that, Cp merge all the audio files in one big audio file it need to download before playing the project. This problem have been report many times from the Cp community.

===Moodle changes cmi.core.lesson_status from "completed" or "passed" to "failed"===
Many SCORM authorware suites generate a masteryscore node in the imsmanifest.xml by default. This node is not necessary to the XML file. But when it is there, the SCORM standard designates specific behaviour with regard to the value set there.

This can also be controlled in Moodle using the setting "Mastery score overrides status" If this setting is enabled and a mastery score is provided within your package, when LMSFinish is called and a raw score has been set, if the raw score is lower than the mastery score, the lesson status will be overridden and set to "failed"

Here's what is in the scorm standard, on page 35 of 155 in SCORM_1.2_ConformanceReq.pdf, numbered page 2-19 ([http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201%2e2%2fDocumentation%20Suite%20%28SCORM%201%2e2%29&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View=%7b4D6DFFDE%2d3CFC%2d4DD9%2dA21A%2d4B687728824A%7d SCORM Version 1.2 Conformance Requirements Version 1.2]):
<blockquote>
If the value for this element is not set to “incomplete” by the SCO, then the LMS shall re-evaluate and change the value based on the following:<ul>
<li>If there is no mastery score in the Manifest, and the SCO sets a score (cmi.core.score.raw) and the lesson_status (cmi.core.lesson_status) then the LMS shall not override the SCO determined status.</li>
<li>If there is a mastery score in the Manifest, the LMS can change the status to either passed or failed depending on the student's score (cmi.core.score.raw) compared to the mastery score.</li>
<li>If the student is taking the SCO for no-credit, (cmi.core.credit = “no-credit”) there is no change to the lesson_status, with one exception. If the lesson_mode (cmi.core.lesson_mode) is "browse", the lesson_status may change to "browsed" even if the cmi.core.credit is set to no-credit.</li>
</ul>
</blockquote>
This can result in some functionality you don't intend. You can fix the problem by removing the mastery score node from your imsmanifest.xml file or by adjusting the Moodle setting "Mastery score overrides status". You may also want to find out what options you have, within your authorware suite, for the writing of that node into the manifest file, and change your authoring process accordingly.

The Rustici SCORM Cloud default operating behaviour for masteryscore is different from Moodle's default operating behaviour - you can see a little bit of the history around the way Rustici handle this here: http://scorm.com/blog/2010/09/anatomy-of-scorm-minutiae-mistake/

===Player Look 'n Feel===
You should be able to adjust height and width settings for the SCORM player window '''so long as''' your theme is based on/not too much of an aberration from one of the standard themes which ship with Moodle 2.

If your site or course theme isn't closely based on one of the standard M2 themes, then it's possible that your theme CSS is overriding local height and width settings for the SCORM player. Have a Web developer (or a Moodle Partner) examine how your theme is interacting with the player layout, and make changes to your theme as needed.

'''Why can't I just change it locally?''' You can change height and width per individual SCORM package, and you can set defaults for these local height and width values ( [[SCORM Admin Options]] ). Other things, such as colors, shading, borders, backgrounds, are controlled by CSS, just like everything else on the site.

=== Courselab 2.4 ===
If you receive a " found more than one record!" error when trying to run your SCORM 1.2 package check the imsmanifest.xml file of your SCORM package and ensure that the values for <organization identifier> and <item identifier> are unique. To change the <organization identifier>, in Courselab, go to File > Course Runtime Settings. The dialog says 'Course identification in LMS' but changing the Identifier field is what sets the <organization identifier>. (see MDL-38060 for more information)

=== SCORM results deleted after package update ===

When uploading a SCORM package over a previous one, if the item identifier in the manifest file is different to the one being overwritten then the tracking data for that SCORM package in Moodle is deleted.

Ensure the item identifier is the same for the new SCORM resource

===Problems with responsiveness===

Sometimes SCORMs fail on responsiveness or the ability to scroll on mobile devices

*Moodle uses iFrames for deploying SCORM. https://community.adaptlearning.org/mod/forum/discuss.php?d=180#p863
*There can be some problems with this as they are not responsive in iOS https://community.adaptlearning.org/mod/forum/discuss.php?d=1446#p6687
*There are some potential work arounds.
#Totara has a new window. #https://community.adaptlearning.org/mod/forum/discuss.php?d=851#p3968
#This comment https://community.adaptlearning.org/mod/forum/discuss.php?d=787#p3661
#Solutions for Adapt: https://github.com/adaptlearning/adapt_framework/issues/210
*The tracker:
#https://tracker.moodle.org/browse/MDL-47500 problems with pages.
#https://tracker.moodle.org/browse/MDL-46563
#https://tracker.moodle.org/browse/MDL-50401
*Why iFrames fail with iOS, one person's view: https://community.adaptlearning.org/mod/forum/discuss.php?d=926#p4714

This seems to be a problem that lies between the browsers (eg faults in iOS) the creation of the SCORM package and the LMS (in this case the iFrames in Moodle).

One quite comprehensive idea for a work around is here: https://community.adaptlearning.org/mod/forum/discuss.php?d=180 but there is really no evidence at the moment of a nicer solution.

==See also==

* [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle SCORM doesn't work] blog post from developer Dan Marsden
* [http://danmarsden.com/blog/2009/05/23/scorm-2004-in-moodle/ SCORM 2004 in Moodle] blog post from developer Dan Marsden
* [https://moodle.org/mod/forum/discuss.php?d=276324 Identifiers to change with updated SCORM module]

Forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=3757 Simple introduction to SCORM]
*[http://moodle.org/mod/forum/discuss.php?d=207964 Updating an Object]

==Any further questions?==

Please post in the [http://moodle.org/mod/forum/view.php?id=1951 SCORM forum] on moodle.org.

[[Category:FAQ]]
[[de:Lernpaket FAQ]]

Universal Office Converter (unoconv)

2018-02-11T05:04:06Z

Danmarsden: /* Installing unoconv on Windows */ correct ghostscript version and ad details not to use non CLI versions.

{{Document converters}}
==What is unoconv?==

"unoconv" is a command line program that is used to convert between different office document file formats. It uses an instance of [http://libreoffice.org LibreOffice] to do the conversion and is used by the [[Assignment activity]] to convert documents to pdf so that they can be annotated. If unoconv is not installed - the only impact is that the assignment activities will only allow annotations when students upload a pdf document.

The steps required to install unoconv are different depending on the operating system that you have installed Moodle on.

== Installing unoconv on Linux ==
The required version of unoconv is at least 0.7. Depending on your flavour of linux, this may be available in your package manager and you can install it directly with:

===Ubuntu 16.04 LTS===

<pre>
apt-get install unoconv
</pre>

If your package manager contains an older version of the package, you will have to find a newer version and install it manually ([https://packages.debian.org/stretch/unoconv Debian Testing]). Unoconv itself is just a python script, so it has few dependencies.

Potential problems:
* On some systems the apache user home directory is set to a non existent folder. This can cause unoconv to fail. There are 2 solutions to this - one is to make a (writable) home directory for the apache user (like /home/www-data). The other is to run a unoconv listener (described below) as another user other than the apache user (someone with a valid, writable home directory).
* If you are still running 14.04LTS then unoconv won't work as shipped. This might not be the most efficient route but it worked by first installing unoconv (version 0.6) from the package manager as above. You will then need to grab unoconv 0.7 from Github (https://github.com/dagwieers/unoconv), then upgrade to the latest libreoffice using the PPA (https://launchpad.net/~libreoffice/+archive/ubuntu/ppa). Point moodle at the Github version of unoconv. You need to modify the Python unoconv file by changing 'python' in the first line to 'python3'. You also need to change the permissions on the directory /var/www so that the user www-data can write to it (www-data needs to write to its home directory which it cannot do by default).
On Debian Stable, the cleanest method to install [https://packages.debian.org/jessie-backports/unoconv unoconv] is using Jessie-backports. First, enable backports repo line in /etc/apt/sources.list:
<pre>
#### Jessie-backports ####
deb http://ftp.debian.org/debian jessie-backports main
</pre>

Then, update and install unoconv from jessie-backports:
<pre>
apt-get update
apt-get install -t jessie-backports unoconv
</pre>

The package will bring all necessary dependencies for you.

===Ubuntu 14.04 LTS===

1) Navigate to opt directory
<pre>
cd /opt
</pre>

2) Download unoconv
<pre>
sudo wget https://raw.githubusercontent.com/dagwieers/unoconv/master/unoconv
</pre>

3) Modify the Python unoconv file by changing 'python' in the first line to 'python3'
<pre>
sudo nano /opt/unoconv
</pre> 
eg. <pre>#!/usr/bin/env python3</pre>

4) Make unoconv executable
<pre>
sudo chmod ugo+x /opt/unoconv
</pre>

5) Add LibreOffice PPA to your system and install the latest version
<pre>
sudo add-apt-repository ppa:libreoffice/ppa
sudo apt-get update
sudo apt-get install libreoffice
</pre>

6) Change permissions so apache can write to its home directory
<pre>
sudo chown www-data /var/www
</pre>

7) From your browser navigate to
''Site administration > Server > System paths'' and add the path to unoconv 
/opt/unoconv
*Note: if you would like to preserve the default path add a symbolic link to /usr/bin:
<pre>
sudo ln -s /opt/unoconv /usr/bin/
</pre>

8) Navigate to
''Site administration > Plugins > Activity modules > Assignment > Feedback plugins > Annotate PDF > Test unoconv path'' 
You should see: 
"The unoconv path appears to be properly configured." 
*Download the converted pdf test file. (if the PDF fails to load ensure that www-data can write to its home directory: /var/www)

===CentOS / RedHat===
Just before you start, you might like to consider installing the latest [http://www.tecmint.com/install-libreoffice-on-rhel-centos-fedora-debian-ubuntu-linux-mint/ LibreOffice 5.2] directly from RPM packages, that are not part of the distribution you are using.
As of nov-2016, CentOS and RedHat 7.2 comes with OpenOffice 4.3 . so if you are not interested in using this version and would like to install latest 5.2 independent LibreOffice 5.2 , please remove any openoffice packages you might have on your OS by issuing:
<pre>
yum remove openoffice* libreoffice*
</pre>
And then follow the install instructions [http://www.tecmint.com/install-libreoffice-on-rhel-centos-fedora-debian-ubuntu-linux-mint/ LibreOffice 5.2]. It is recommended to chose your localized libreoffice version for better document conversions. and also please skip the following "yum install openoffice* ..." command.
<pre>
yum install openoffice* openoffice-pyuno
git clone https://github.com/dagwieers/unoconv.git
# copy
cp unoconv/unoconv /usr/bin
# or link unoconv to /usr/bin
ln -s unoconv/unoconv /usr/bin/unoconv
</pre>
Note: depends on what version you are installing, openoffice or libreoffice, make sure you installed the *-pyuno package. (the headless package is already compiled into the core)

Make sure it is properly configured:
http://your-moodle/admin/search.php?query=unoconv

Production servers should consider running unoconv in listener mode, see [[Installing_unoconv#Run_a_unoconv_listener]] or follow directions bellow
<pre>
vi /etc/systemd/system/unoconv.service
</pre>
And then copy and paste the following configuration into it:
<pre>
[Unit]
Description=Unoconv listener for document conversions
Documentation=https://github.com/dagwieers/unoconv
After=network.target remote-fs.target nss-lookup.target

[Service]
Type=simple
Environment="UNO_PATH=/usr/lib64/libreoffice/program"
ExecStart=/usr/bin/unoconv --listener

[Install]
WantedBy=multi-user.target
</pre>
And then enable and start the above service
<pre>
systemctl enable unoconv.service
systemctl start unoconv.service
</pre>
If your selinux is enable yous should set
<pre>
#setsebool -P httpd_execmem on
</pre>
== Installing unoconv on OS X ==
Download and install LibreOffice for Mac. Unfortunately - newer versions of LibreOffice are not currently compatible with unoconv for mac and you will have to install LibreOffice 4.2 (Direct download link - https://downloadarchive.documentfoundation.org/libreoffice/old/4.2.5.2/mac/x86_64/LibreOffice_4.2.5.2_MacOS_x86-64.dmg).

Get the latest version of the unoconv python script. One way to do this is with http://brew.sh/ brew.
<pre>
brew install unoconv
</pre>

If you haven't done it already - install ghostscript. One way to install ghostscript is also with http://brew.sh/ brew
<pre>
brew install ghostscript
</pre>

Set the paths to unoconv and ghostscript in Moodle (''Site administration > Server > System paths''). If you used brew, they will both be installed to /usr/local/bin.

LibreOffice needs write access to the current users home directory to create some temporary files. When unoconv is run as the webserver user (_www) it does not normally have this permission.

There are some ways to get around this - one way is just to give the "_www" user write access to /Library/WebServer.

Another solution is to convince LibreOffice that this users home directory is somewhere else. This can be done by inserting this code into the top of the unoconv python script.
Code to insert:
<pre>
# Set home to a writable folder.
os.environ['HOME'] = '/tmp/'
</pre>

This needs to be inserted at line 36 immediately after the line "exitcode = 0"

== Installing unoconv on Windows ==
Download and install LibreOffice for windows.

Download the latest version of the unoconv script from https://github.com/dagwieers/unoconv/releases (download the zip version).

From the downloaded zip file - extract the one file "unoconv-0.7\unoconv" (no file extension). This is the unoconv script - none of the other files in the package are required.

Rename the downloaded script to C:\unoconv\unoconv.py

Create a batch file C:\unoconv\unoconv.bat with these contents:

<pre>
@"C:\Program Files\LibreOffice 5\program\python.exe" c:\unoconv\unoconv.py %*
</pre>

Set paths in Moodle.

Login as admin and go to ''Site administration > Server > System paths''

Set pathtogs setting to your ghostscript installation binary, (C:\gs\bin\gswin32c.exe)
(Do not use gswin32.exe or gswin64.exe, these are not command line programs - use gswin32c.exe or gswin64c.exe)

Set pathtounoconv to the batch file created above (C:\unoconv\unoconv.bat)

Test ghostscript and unoconv are working correctly in the admin test pages "Site administration > Plugins > Activity modules > Assignment > Feedback plugins > Annotate PDF".

== Run a unoconv listener ==
Unoconv utilises a client/server process when converting documents. By default, when there is no running server process - each time unoconv runs it will start a server process, send its request and shut down the server process when the request is complete. The drawback of this mode is that if 2 requests are submitted simultaneously - this can cause the first request to shutdown the server process when the second request is still in progress - and the second conversion request fails. A more robust way to configure unoconv is to start a server process at boot time, and/or run a script to monitor it and restart it if it crashes.

To start a unoconv listener at boot time - you need a start up script. Different operating systems and Linux distributions use different startup scripts - but here are some examples of startup scripts for different systems.

[[mod/assign/feedback/editpdf/testunoconv/upstart | Upstart script for Ubuntu based systems]]

[[mod/assign/feedback/editpdf/testunoconv/launchd | Launchd script for OS X]]

[[mod/assign/feedback/editpdf/testunoconv/initd | Init script for Debian]]

[[mod/assign/feedback/editpdf/testunoconv/initdcentos6 | Init script for CentOS/RedHat 6.x]]

[[mod/assign/feedback/editpdf/testunoconv/systemd | SystemD service script for CentOS/RedHat 7.x]]

== Offload processing to a different server ==
Processing office documents can put increased load on your webserver, which may impact on the responsiveness of your site. If you are installing unoconv on a large site you may want to consider running unoconv on a server that is not also serving web requests.

How to do this:

Install unoconv on each webservers and the remote server following the installation instructions above.

Make sure unoconv is started at boot time on the remote server with the "--listener" argument and is monitored and restarted if it exits (see Debian init script for an example of how to do this).

Open the firewall port 2002 between the moodle webservers and the machine running unoconv.

Share the moodle data root between the webservers and the machine running unoconv. This folder must be mounted at the same path on all servers.

Install a wrapper for unoconv on the webservers that forwards the requests to the remote server. Example:
<pre>
#!/bin/bash
# Wrapper script for unoconv to forward processing.
# Install to /usr/bin/unoconv-remote with 755 permissions
/usr/bin/unoconv --server=<ip of remote server> "$@"
</pre>

Configure the path to unoconv in the Moodle admin settings to point to this wrapper script.

==Additional resources==

[https://github.com/dagwieers/unoconv GitHub dagwieers/unoconv] has additional information on installation of unoconv and troubleshooting tips.

==Troubleshooting==
* [http://webnetkit.com/soffice-bin-using-100-cpu-moodle/ soffice.bin using 100% of CPU MOODLE]

==See also==

* [https://moodle.org/mod/forum/discuss.php?d=335310 Is the unoconv installation a security risk?] forum discussion

[[Category:Site administration]]
[[Category:Assignment]]

[[es:Universal Office Converter (unoconv)]]
[[de:Universal Office Konverter]]

report/security/report security check preventexecpath

2017-09-11T06:54:10Z

Danmarsden:

Some administration options allow setting the path to executable files on the web server such as du, aspell, ghostscript and others. This can potentially cause a security risk. You can prevent administrators from changing these paths by adding the following setting to your config.php file:

<code php>
$CFG->preventexecpath = true;
</code>
You should also explicitly set the relevant paths in your config.php file such as:
<code php>
$CFG->pathtodu = 'PATH';
$CFG->pathtounoconv = 'PATH';
$CFG->aspellpath = 'PATH';
</code>

report/security/report security check preventexecpath

2017-09-11T06:53:27Z

Danmarsden: formatting

Moodle administrators are able to define the path to a number of executable files hosted
Some administration options allow setting the path to executable files on the web server such as du, aspell, ghostscript and others. This can potentially cause a security risk. You can prevent adminstrators from changing these paths by adding the following setting to your config.php file:

<code php>
$CFG->preventexecpath = true;
</code>
You should also explicitly set the relevant paths in your config.php file such as:
<code php>
$CFG->pathtodu = 'PATH';
$CFG->pathtounoconv = 'PATH';
$CFG->aspellpath = 'PATH';
</code>

report/security/report security check preventexecpath

2017-09-11T06:50:54Z

Danmarsden: add some info about preventexecpath

Moodle administrators are able to define the path to a number of executable files hosted
Some administration options allow setting the path to executable files on the web server such as du, aspell, ghostscript and others. This can potentially cause a security risk. You can prevent adminstrators from changing these paths by adding the following setting to your config.php file:

$CFG->preventexecpath = true;

You should also explicitly set the relevant paths in your config.php file such as:
$CFG->pathtodu
$CFG->pathtounoconv
$CFG->aspellpath

Face-to-face module

2017-05-31T02:45:28Z

Danmarsden: update tracker link, maintainer.

{{Facetoface}}
{{Infobox plugin
|type = Activity module
|entry = https://moodle.org/plugins/pluginversions.php?plugin=mod_facetoface
|tracker = https://github.com/catalyst/moodle-mod_facetoface/issues
|discussion = http://moodle.org/mod/forum/view.php?id=7136
|maintainer = Catalyst IT
|float = right
}}

Face-to-face activities are used to keep track of in-person trainings which require advance booking.

Each activity is offered in one or more identical sessions. These sessions can be given over multiple days.

Reminder messages are sent to users and their managers a few days before the session is scheduled to start. Confirmation messages are sent when users sign-up for a session or cancel.
[[Image:Face2Face example activity.png|center|frame|Example of a Face-to-Face activity, a hands on lab]]

== See also ==

* [http://tracker.moodle.org/browse/CONTRIB-334 Patch to enable linking] to [[Certificate module|Certificate]] contributed module.

[[es:Módulo Cara-a-cara]]

SCORM FAQ

2017-01-08T22:48:02Z

Danmarsden: /* Handling of Multiple Attempts */

{{SCORM}}
==What is SCORM?==

SCORM was developed as a result of collaboration in the public and private sectors. The President of the United States, Bill Clinton issued an Executive Order that created an agency (ADL) to oversee the standard for developing and distributing online learning. All Federal agencies are mandated to use programs that meet those standards. SCORM is one result of that order.

There's a really simple "What is SCORM" introduction here: http://moodle.org/mod/forum/discuss.php?d=3757#p18828

A slightly more detailed introduction here: http://www.rusticisoftware.com/resources/whatisscorm/What%20Is%20SCORM.ht

==Should I make my Moodle courses as SCORM or use Moodle's features?==
It depends how you intend to use it. If you are planning on exporting and using in another LMS then SCORM would make this easier. If you want something shiny, then a SCORM package can fit the bill. However, reporting and grading work better in Moodle and for many educators the standard features do the job perfectly and do not require learning a new program. There is a useful form post discussing the pros and cons of SCORM in Moodle here: http://moodle.org/mod/forum/discuss.php?d=200242

==SCORM Information==

Advanced Distributed Learning (ADL) is the organization that wrote the SCORM standard. You can download documentation and samples form ADL's Web site. Documentation for SCORM 1.2 in several languages is available [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2%2fDocumentation%20Suite%20(SCORM%201.2)&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} here].

Philip Hutchison provides an AS3 and JavaScript wrapper, as well as a sample package:
http://pipwerks.com/downloads/

==SCORM Package Contents==

A SCORM package must contains in the root of zip a file named imsmanifest.xml which defines SCORM course structure, resource location and many other things. Other files used in the package, such as HTML files, XML files, multimedia files, and JavaScript for the SCORM API must be listed in this file. The LMS parses the manifest, and provides the files listed there to the content package during runtime.

==AICC Package Contents==

An AICC package is defined by several files (from 4 to 7) with defined extensions as follows:

* CRS - Course Description file (mandatory)
* AU - Assignable Unit file (mandatory)
* DES - Descriptor file (mandatory)
* CST - Course Structure file (mandatory)
* ORE - Objective Relationship file (optional)
* PRE - Prerequisites file (optional)
* CMP - Completition Requirements file (optional)

==Basic Troubleshooting==

* Make sure you are running Moodle 2.1 or higher, a large number of SCORM related bugs are present in previous versions.
*Make sure you (and your users) have JavaScript enabled. SCORM requires JavaScript.
* Make sure your SCORM object is SCORM compliant - check it in an external SCORM player like [https://docs.moodle.org/en/Tools_for_creating_SCORM_content#Reload Reload] to see if it works there.
* Upload a copy of your SCORM object to a [http://en.wikipedia.org/wiki/File_hosting_service File Hosting Service] and post a message asking for help in the forums, linking to your SCORM object explaining exactly what you expect to happen, and what is happening instead.
* Read Dan Marsden's blog post [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle here] (Maintainer of SCORM Module in Moodle)

==Does Moodle Generate SCORM Content?==

Moodle '''does not''' generate scorm content. Moodle presents the content in SCORM packages to learners, and saves data from learner interactions with the SCORM package.

==Can I add a password for access to my SCORM package?==
No, although there is a tracker request for this: MDL-46403 As a workaround you could add your SCORM package using the single activity course format - see [[Course formats]] - and add an enrolment key to the course.

==Supported Versions==

* SCORM 1.2 is supported in Moodle 2.1(or higher) and passes all the tests in the ADL Conformance test suite 1.2.7 for SCORM 1.2. The best place for information on SCORM 1.2 conformance is the [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Previous%20Versions/SCORM%201.2/Conformance%20Test%20Suite%20(SCORM%201.2)/SCORM_1.2_ConformanceReq.pdf SCORM Comformance Requirements documentation (PDF 3.4MB)].

* SCORM 2004 is not supported in Moodle. Parts of the API have been implemented, but others such as Navigation and Sequencing have not. Development on native SCORM 2004 support in Moodle [https://moodle.org/mod/forum/discuss.php?d=227906 has stopped]. If you require a fully certified SCORM 2004 Player in Moodle, [http://www.scorm.com Rustici Software] have a [https://moodle.org/plugins/mod_scormcloud Moodle plugin] which connects to their commercial [http://www.scorm.com/scorm-solved/scorm-cloud/ SCORM Cloud] service turning Moodle into a fully compliant SCORM 2004 LMS.

* AICC objects are supported in Moodle 2.1 and higher.

* Tin Can is supported with a number of 3rd party plugins such as [https://moodle.org/plugins/logstore_xapi logstore xAPI] (allows reporting logging data to an external LRS) and [https://moodle.org/plugins/mod_tincanlaunch mod_tincanlaunch] (allows launching tin can content packages within Moodle.

==Asking for Help in the SCORM Forum==

When trying to engage the community to help with a problem you are facing, you will get a better response if you follow a few simple guidelines:
* Always start your report with '''version information''' - preferably the information displayed on the Admin -> Environment panel eg. http://localhost/moodle/admin/environment.php where http://localhost/moodle is your particular prefix. With this it will be clear how you are running your Moodle instance, on what platform, and at which version. This will quickly expose issues where a simple upgrade will solve your problem.
* Be prepared to '''provide the SCORM package''' that illustrates your problem - if you don't then it will be very difficult for anyone offering assistance to recreate your situation - a real barrier to help.
* '''Screenshots''' are very helpful. Provide a screenshot of all error messages, and any instance where something seems to go wrong in the interface.
* Nonstandard themes can introduce SCORM issues. Be sure to tell us '''what theme you're using'''.
* If you have admin privileges, and have access to a localhost install or other place where real-time users won't be disturbed, be sure to turn on debugging. Navigate to '''Site Administration > Development > Debugging''' and set '''Debug messages: Developer''' and '''Display debug messages: Yes'''. Access the SCORM content. If there are errors printed to the page, include them in your forum post.
* Use [https://developers.google.com/chrome-developer-tools/docs/console Chrome's JavaScript Console] or [https://developer.mozilla.org/en-US/docs/Tools/Web_Console Firebug's JavaScript console] to check that there are no JavaScript errors on the page when the content loads.
* Run your problematic SCORM package through '''API debugging''' (see below) and include the text of that API log with your post. That way we can see right away if the right function calls are not taking place.
* If you're using a content development suite which publishes to SCORM, such as Articulate, Captivate, Lectora, LessonBuilder, Udutu, or some other product, then include that in your post. Every authoring software has its ticks, and if you've run into one, it's likely that someone else has also dealt with it, and will recognize it. However, please keep in mind that '''this is a place to get help with Moodle issues, not help with your SCORM package authoring suite'''.

==Debugging ==

# Debugging settings are located at Settings > Site Administration > Plugins > Activities > Scorm.
# Check the checkbox for '''Activate API debug...'''
# Set the api mask. You can use the mask to enable debugging under certain conditions. For example, if you are logged in using the admin user (username admin) you can set the api mask to: <cite>admin.*</cite> Users not logged in as admin will not see the debugging log. The "Default" api mask is <cite>.*</cite>

==What does the debugging log mean?==

The SCO commonly sends the following communications through the API:

* '''LMSInitialize();''' opens the connection between the SCO and Moodle
* '''LMSGetValue( 'valuename' );''' gets a value from Moodle
* '''LMSSetValue( 'valuename' , 'value' );''' sends a value to Moodle
* '''LMSCommit();''' saves values sent to Moodle via LMSSetValue() and should be called after every LMSSetValue()
* '''LMSFinish()''' saves values sent to Moodle and closes the connection between the SCO And Moodle

Red lines in the debugging log means there was an error in the communication through the API.

If LMSInitialize() fails, returns an error, then no subsequent values sent to Moodle will be saved.

Click through the entire SCORM package. Then access the scorm report for your attempt, and compare the saved values in the debugging log with Moodle's report of the attempt. If the values set in the debug log do not match the values saved to Moodle, then there may be a problem with Moodle. Otherwise it's likely to be an issue with the SCO or the SCORM activity settings not giving you the functionality you need.

==SCORM and the Gradebook==
Please see [https://docs.moodle.org/en/SCORM_FAQ#My_SCORM_Module_doesn.27t_function_properly FAQ:My SCORM Module doesn't function properly] and [https://docs.moodle.org/en/SCORM_FAQ#Handling_of_Multiple_Attempts FAQ:Handling of Multiple Attempts]

Some SCORM packages report both cmi.core.lesson_status and cmi.core.score.raw. Others report only cmi.core.lesson_status, or only cmi.core.score.raw. The '''Grading Method''' setting for SCORM objects is meant to account for that.

If you have the '''Grading Method''' set to '''Highest grade''', '''Average grade''', or '''Sum grade''', and your learning object does not report a score, only, cmi.core.lesson_status, then there will be no numerical score to pass to the gradebook.

If your SCOs do not report cmi.core.score.raw, then the best '''Grading Method''' setting is '''Learning Objects'''. This reports either a 1 or a 0 as a score for each learning object. The gradebook value for that SCORM activity is the percent of scos in the package for which learners got a 1.

On the other hand, if your SCOs do not report a lesson_status, then select one of the score-based '''Grading Method''' options, such as '''Highest grade''', '''Average grade''', or '''Sum grade''', and not '''Learning Objects'''.

If you do not know what your SCOs are reporting to the LMS, then run them through to completion with debugging on.

Much of the way SCORM objects are graded is controlled inside the SCORM Authoring process before it is packaged for use in an LMS like Moodle - make sure all your grading settings are set correctly.

==SCORM Administration Options==

See [[SCORM settings]]

==Common Solutions==

===Difficulty Displaying a SCORM Package===
If you have difficulty displaying a SCORM, try loading the SCORM in [http://www.reload.ac.uk Reload] and re-saving it, then save the folder as a .zip package and try again.

===Character Display Errors===
When you notice there is a problem displaying characters correctly, it could be a misconfiguration of your server. Make sure that both httpd.conf (when using Apache) and php.ini are set to DefaultCharacterset = utf8 or switch the sending of a default character set off.

===slash arguments warning when I add/update SCORM objects in my course===
Some web servers don't support a function called '''slash arguments''' and so Moodle allows you to turn it off, but SCORM packages require '''slash arguments''' to be enabled on the web server in order to work properly.

See [[Using slash arguments]] for more details.

===SCORM doesn't work on Godaddy Host===
Godaddy hosts give a 404 file not found error - this is because by default they do not allow slash arguments which SCORM requires. The best way to test this is to visit http://yourmoodlesite/admin/tool/health/index.php - but the fix involves adding a php.ini or php5.ini file with the following text:
AcceptPathInfo
cgi.fix_pathinfo=1

===My Flash-Based Content Loads, then Stalls===
This issue is most commonly associated with zlib compression. Classic presentation is that the base HTML file and SWF are loaded into the SCORM player, but the SWF is not able to load any audio or video assets, and therefore stalls. You can watch the loading of SWFs and assets using Chrome's Developer Tools or other.

Check your site's zlib compression settings as an admin by loading up the Server > phpinfo page. zlib compression is not a Moodle setting but a server setting, so you'll need a server admin to disable it. Be sure to Purge All Caches, and clear browser caches, before confirming the change.

===Zlib warning when I add/update SCORM objects in my course===
Zlib is a php compression setting made in a websites PHP configuration - unfortunately some browsers don't handle this well (especially Internet Explorer 6) Some webhosts enable this setting, but it will likely cause issues for your users when they attempt to view/use the SCORM object. You will need to contact your server administrator to turn this off. The setting to change in php configuration is "zlib.output_compression"

===Incorrect file package - missing imsmanifest.xml or AICC structure===
This means that Moodle cannot find a file called imsmanifest.xml inside the SCORM object. Reasons for this could be:
* imsmanifest.xml needs to be immediately inside the scorm directory, NOT inside a directory inside of that. So if the zipped scorm package is package.zip, the unzipped package directory should contain immediately inside of it the imsmanifest.xml. This is a common mistake and normally occurs when a SCORM author creates a package themselves and then selects that folder to compress. This places the content folder inside of another folder, The imsmanifest.xml is there, but it is 2 directories deep. To avoid this problem when zipping scorm content into a package, go INSIDE of the exported scorm folder, select all files inside, and compress them while all are selected. The resultant compressed directory has the imsmanifest.xml file in the first directory, immediately available to the moodle scorm loading process.
* when using linux based systems the filename imsmanifest.xml must be all in lowercase not IMSmanifest.xml or Imsmanifest.XML
* The SCORM authoring tool Articulate sometimes fails to create the imsmanifest.xml -Try exporting the package again and see if the manifest is generated.
* The SCORM authoring tool Articulate Presenter will publish packages where the imsmanifest.xml file is in the correct place, but there are several lines of white space in the manifest file if you do not fill out the Reporting and Tracking Options in Articulate Presenter for Keywords and LMS Description. Moodle will give a "Manifest not found" error when encountering this. To fix this problem select the Reporting and Tracking Options in the Articulate Presenter publish dialog and fill in the LMS Description and Keywords.

===File not found error===
You have this error if the scorm package is created in moodle, and the scorm menu loads, but inside of the viewing area for the scorm content, you get a page with a 404 file not found error, usually showing the current Moodle theme.

What this means is that one of the files listed in the imsmanifest.xml is not in the scorm package or not in the correct directory.

Download and unzip the package, open up imsmanifest.xml. At the bottom of the xml file, below any metadata, you'll find a place where organizations and resources for those organizations are designated:

<code xml>

<organizations default="TOC1">
<organization identifier="TOC1">
<title>SCORM Test</title>
<item identifier="I_SCO0" identifierref="SCO0">
<title>Library Quiz</title>
<adlcp:masteryscore>0</adlcp:masteryscore>
</item>
</organization>
</organizations>
<resources>
<resource identifier="SCO0" type="webcontent" adlcp:scormtype="sco" href="scorm.html">
<file href="scorm.html"/>
<dependency identifierref="ALLRESOURCES" />
</resource>
<resource identifier="ALLRESOURCES" type="webcontent" adlcp:scormtype="asset">
<file href="scorm.html" />
<file href="scorm.js" />
<file href="swfobject.js" />
<file href="scorm.swf" />
<file href="scormwrapper.js" />
</resource>
</resources>
</manifest>
</code>

In this xml, we have a single organization, and in that organization is a single resource, a single sco. There are 5 files necessary for that resource to work correctly. The scorm.html file is loaded first. It loads 3 external js files and a swf.

What you need to do now is go to the directory containing imsmanifest.xml, and check that all of those listed files are available at the correct path from imsmanfiest.xml, as listed in imsmanifest.xml. If any one of those files is missing (especially the html file or the swf), or if the paths in imsmanifest.xml are incorrect, then it's very likely that the scorm object won't be able to load at all.

Sometimes the files aren't missing, but are simply misnamed in the manifest, or placed in the wrong directory. You can fix this by moving the files to the correct places, or updating their names so that the imsmanifest and the actual file names match up. In the case of a misnamed file, change the manifest rather than the actual file names, since the the files also reference one another in other places!

===Unzip issues===
If you get a blank page after filling in the title, description, and selecting a large SCORM file, it's likely you haven't installed the PHP-zip lib which is required for Moodle 2.x for more info see [[admin/environment/php_extension/zip]]

===Clear an Attempt===
To clear attempts by a student:

# Go to the SCORM activity and select the link "View reports for x users"
# Select the attempt or attempts you want to clear using the checkbox
# Select Delete in the drop-down box at the bottom of the page

===Handling of Multiple Attempts===
SCORM is designed to allow a learner to exit and return at a later date to the same point they left from. This means that each time they enter the SCORM they are using the same single attempt. Some SCORM packages are intelligent about handling re-entry, many are not. What this means is that if the learner re-enters an existing attempt, if the SCORM content does not have internal logic to avoid overwriting cmi.core.lesson_status and cmi.core.score.raw, they can be overwritten by a lower score, confusing the learner.

When a SCORM sets the cmi.core.lesson_status value to 'completed', 'passed' or 'failed' then Moodle allows the user to create a new attempt by adding a '''Start new attempt''' checkbox to the entry page. If cmi.core.lesson_status is set to 'incomplete', 'browsed' or 'notattempted' the learner can only re-enter the existing attempt. If you are using the setting 'Student skip content structure page', this checkbox will never be shown to the user.

Moodle provides a range of settings to allow this to be controlled, some of these settings are hidden by default as advanced options.
* Number of attempts
:This allows the teacher to set how many SCORM attempts the learner may create - this is not how many times a learner can re-enter a SCORM attempt.
* Attempts grading
:This allows the teacher to set how multiple SCORM attempts(not re-entries) are graded. It is important to note that a 'failed' cmi.core_lesson_status allows a new attempt to be generated but the attempts grading setting "last completed attempt" only includes 'completed' and 'passed' values in it's calculations.
* Display attempt status
:This displays a users SCORM attempts and how their final grade is calculated on the SCORM entry page and the My Moodle page for the learner.
* Force completed
:This is a setting that can be used to force a SCORM package to report a 'completed' cmi.core.lesson_status if it doesn't currently set the value.
* Force new attempt
:This hides the '''Start new attempt''' checkbox and will force a new attempt if the previous attempt has cmi.core.lesson_status value to 'completed', 'passed' or 'failed' (disabling "review mode")- this setting can also be used to make sure a new attempt is generated when the 'Student skip content structure page' setting is used.
* Lock after final attempt
:This prevents access to the SCORM after the total number of attempts have been used - if this is not set the learner can re-enter their last attempt (in review mode) and potentially change/overwrite their score each time depending on how the SCORM package supports multiple re-entries.

===Reducing Load Time with Captivate===
* Modify the percent that must be downloaded before the content starts to play. In Captivate 4, there's a setting in: Preferences / Project / Start and End / Preload. Reduce that to 50%.
* If you use audio in your Cp file (as background or element attachment), try to put a gap of 0,1 second at the beginning of each element including audio on your slides. If you don't do that, Cp merge all the audio files in one big audio file it need to download before playing the project. This problem have been report many times from the Cp community.

===Moodle changes cmi.core.lesson_status from "completed" or "passed" to "failed"===
Many SCORM authorware suites generate a masteryscore node in the imsmanifest.xml by default. This node is not necessary to the XML file. But when it is there, the SCORM standard designates specific behaviour with regard to the value set there.

This can also be controlled in Moodle using the setting "Mastery score overrides status" If this setting is enabled and a mastery score is provided within your package, when LMSFinish is called and a raw score has been set, if the raw score is lower than the mastery score, the lesson status will be overridden and set to "failed"

Here's what is in the scorm standard, on page 35 of 155 in SCORM_1.2_ConformanceReq.pdf, numbered page 2-19 ([http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201%2e2%2fDocumentation%20Suite%20%28SCORM%201%2e2%29&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View=%7b4D6DFFDE%2d3CFC%2d4DD9%2dA21A%2d4B687728824A%7d SCORM Version 1.2 Conformance Requirements Version 1.2]):
<blockquote>
If the value for this element is not set to “incomplete” by the SCO, then the LMS shall re-evaluate and change the value based on the following:<ul>
<li>If there is no mastery score in the Manifest, and the SCO sets a score (cmi.core.score.raw) and the lesson_status (cmi.core.lesson_status) then the LMS shall not override the SCO determined status.</li>
<li>If there is a mastery score in the Manifest, the LMS can change the status to either passed or failed depending on the student's score (cmi.core.score.raw) compared to the mastery score.</li>
<li>If the student is taking the SCO for no-credit, (cmi.core.credit = “no-credit”) there is no change to the lesson_status, with one exception. If the lesson_mode (cmi.core.lesson_mode) is "browse", the lesson_status may change to "browsed" even if the cmi.core.credit is set to no-credit.</li>
</ul>
</blockquote>
This can result in some functionality you don't intend. You can fix the problem by removing the mastery score node from your imsmanifest.xml file or by adjusting the Moodle setting "Mastery score overrides status". You may also want to find out what options you have, within your authorware suite, for the writing of that node into the manifest file, and change your authoring process accordingly.

The Rustici SCORM Cloud default operating behaviour for masteryscore is different from Moodle's default operating behaviour - you can see a little bit of the history around the way Rustici handle this here: http://scorm.com/blog/2010/09/anatomy-of-scorm-minutiae-mistake/

===Player Look 'n Feel===
You should be able to adjust height and width settings for the SCORM player window '''so long as''' your theme is based on/not too much of an aberration from one of the standard themes which ship with Moodle 2.

If your site or course theme isn't closely based on one of the standard M2 themes, then it's possible that your theme CSS is overriding local height and width settings for the SCORM player. Have a Web developer (or a Moodle Partner) examine how your theme is interacting with the player layout, and make changes to your theme as needed.

'''Why can't I just change it locally?''' You can change height and width per individual SCORM package, and you can set defaults for these local height and width values ( [[SCORM Admin Options]] ). Other things, such as colors, shading, borders, backgrounds, are controlled by CSS, just like everything else on the site.

=== Courselab 2.4 ===
If you receive a " found more than one record!" error when trying to run your SCORM 1.2 package check the imsmanifest.xml file of your SCORM package and ensure that the values for <organization identifier> and <item identifier> are unique. To change the <organization identifier>, in Courselab, go to File > Course Runtime Settings. The dialog says 'Course identification in LMS' but changing the Identifier field is what sets the <organization identifier>. (see MDL-38060 for more information)

=== SCORM results deleted after package update ===

When uploading a SCORM package over a previous one, if the item identifier in the manifest file is different to the one being overwritten then the tracking data for that SCORM package in Moodle is deleted.

Ensure the item identifier is the same for the new SCORM resource

===Problems with responsiveness===

Sometimes SCORMs fail on responsiveness or the ability to scroll on mobile devices

*Moodle uses iFrames for deploying SCORM. https://community.adaptlearning.org/mod/forum/discuss.php?d=180#p863
*There can be some problems with this as they are not responsive in iOS https://community.adaptlearning.org/mod/forum/discuss.php?d=1446#p6687
*There are some potential work arounds.
#Totara has a new window. #https://community.adaptlearning.org/mod/forum/discuss.php?d=851#p3968
#This comment https://community.adaptlearning.org/mod/forum/discuss.php?d=787#p3661
#Solutions for Adapt: https://github.com/adaptlearning/adapt_framework/issues/210
*The tracker:
#https://tracker.moodle.org/browse/MDL-47500 problems with pages.
#https://tracker.moodle.org/browse/MDL-46563
#https://tracker.moodle.org/browse/MDL-50401
*Why iFrames fail with iOS, one person's view: https://community.adaptlearning.org/mod/forum/discuss.php?d=926#p4714

This seems to be a problem that lies between the browsers (eg faults in iOS) the creation of the SCORM package and the LMS (in this case the iFrames in Moodle).

One quite comprehensive idea for a work around is here: https://community.adaptlearning.org/mod/forum/discuss.php?d=180 but there is really no evidence at the moment of a nicer solution.

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?id=1951 SCORM forum]
* [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle SCORM doesn't work] blog post from developer Dan Marsden
* [http://danmarsden.com/blog/2009/05/23/scorm-2004-in-moodle/ SCORM 2004 in Moodle] blog post from developer Dan Marsden
* [https://moodle.org/mod/forum/discuss.php?d=276324 Identifiers to change with updated SCORM module]
* [https://docs.moodle.org/dev/SCORM_schema Internal SCORM Schema]
* The official standard: [http://www.adlnet.gov/Technologies/scorm/default.aspx Advanced Distributed Learning - SCORM]

Online resources
* [http://www.scormcourse.com/ SCORMCourse.com] serves the SCORM and ADL community as an educational resource for SCORM technology.
* [http://www.eduworks.com/index.php/Publications/Learning-Object-Tutorial.html Learning Object Tutorial]
* [http://elearningweekly.wordpress.com/2007/04/12/tutorial-build-scorm-compatible-lesson-templates-for-your-lms/ Tutorial: Build SCORM-Compatible Lesson Templates for Your LMS]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=3757 Simple introduction to SCORM]
*[http://moodle.org/mod/forum/discuss.php?d=57059 Are there any sugestions for scorm authoring with Microsoft word / or any other easy (maybe free) scorm authoring tool?]
*[http://moodle.org/mod/forum/discuss.php?d=95946 Is SCORM worth it?]
*[http://moodle.org/mod/forum/discuss.php?d=207964 Updating an Object]

[[Category:FAQ]]
[[de:Lernpaket FAQ]]

SCORM FAQ

2017-01-08T22:46:05Z

Danmarsden: /* Handling of Multiple Attempts */ add comment about force new attempt disabling review mode.

{{SCORM}}
==What is SCORM?==

SCORM was developed as a result of collaboration in the public and private sectors. The President of the United States, Bill Clinton issued an Executive Order that created an agency (ADL) to oversee the standard for developing and distributing online learning. All Federal agencies are mandated to use programs that meet those standards. SCORM is one result of that order.

There's a really simple "What is SCORM" introduction here: http://moodle.org/mod/forum/discuss.php?d=3757#p18828

A slightly more detailed introduction here: http://www.rusticisoftware.com/resources/whatisscorm/What%20Is%20SCORM.ht

==Should I make my Moodle courses as SCORM or use Moodle's features?==
It depends how you intend to use it. If you are planning on exporting and using in another LMS then SCORM would make this easier. If you want something shiny, then a SCORM package can fit the bill. However, reporting and grading work better in Moodle and for many educators the standard features do the job perfectly and do not require learning a new program. There is a useful form post discussing the pros and cons of SCORM in Moodle here: http://moodle.org/mod/forum/discuss.php?d=200242

==SCORM Information==

Advanced Distributed Learning (ADL) is the organization that wrote the SCORM standard. You can download documentation and samples form ADL's Web site. Documentation for SCORM 1.2 in several languages is available [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2%2fDocumentation%20Suite%20(SCORM%201.2)&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} here].

Philip Hutchison provides an AS3 and JavaScript wrapper, as well as a sample package:
http://pipwerks.com/downloads/

==SCORM Package Contents==

A SCORM package must contains in the root of zip a file named imsmanifest.xml which defines SCORM course structure, resource location and many other things. Other files used in the package, such as HTML files, XML files, multimedia files, and JavaScript for the SCORM API must be listed in this file. The LMS parses the manifest, and provides the files listed there to the content package during runtime.

==AICC Package Contents==

An AICC package is defined by several files (from 4 to 7) with defined extensions as follows:

* CRS - Course Description file (mandatory)
* AU - Assignable Unit file (mandatory)
* DES - Descriptor file (mandatory)
* CST - Course Structure file (mandatory)
* ORE - Objective Relationship file (optional)
* PRE - Prerequisites file (optional)
* CMP - Completition Requirements file (optional)

==Basic Troubleshooting==

* Make sure you are running Moodle 2.1 or higher, a large number of SCORM related bugs are present in previous versions.
*Make sure you (and your users) have JavaScript enabled. SCORM requires JavaScript.
* Make sure your SCORM object is SCORM compliant - check it in an external SCORM player like [https://docs.moodle.org/en/Tools_for_creating_SCORM_content#Reload Reload] to see if it works there.
* Upload a copy of your SCORM object to a [http://en.wikipedia.org/wiki/File_hosting_service File Hosting Service] and post a message asking for help in the forums, linking to your SCORM object explaining exactly what you expect to happen, and what is happening instead.
* Read Dan Marsden's blog post [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle here] (Maintainer of SCORM Module in Moodle)

==Does Moodle Generate SCORM Content?==

Moodle '''does not''' generate scorm content. Moodle presents the content in SCORM packages to learners, and saves data from learner interactions with the SCORM package.

==Can I add a password for access to my SCORM package?==
No, although there is a tracker request for this: MDL-46403 As a workaround you could add your SCORM package using the single activity course format - see [[Course formats]] - and add an enrolment key to the course.

==Supported Versions==

* SCORM 1.2 is supported in Moodle 2.1(or higher) and passes all the tests in the ADL Conformance test suite 1.2.7 for SCORM 1.2. The best place for information on SCORM 1.2 conformance is the [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Previous%20Versions/SCORM%201.2/Conformance%20Test%20Suite%20(SCORM%201.2)/SCORM_1.2_ConformanceReq.pdf SCORM Comformance Requirements documentation (PDF 3.4MB)].

* SCORM 2004 is not supported in Moodle. Parts of the API have been implemented, but others such as Navigation and Sequencing have not. Development on native SCORM 2004 support in Moodle [https://moodle.org/mod/forum/discuss.php?d=227906 has stopped]. If you require a fully certified SCORM 2004 Player in Moodle, [http://www.scorm.com Rustici Software] have a [https://moodle.org/plugins/mod_scormcloud Moodle plugin] which connects to their commercial [http://www.scorm.com/scorm-solved/scorm-cloud/ SCORM Cloud] service turning Moodle into a fully compliant SCORM 2004 LMS.

* AICC objects are supported in Moodle 2.1 and higher.

* Tin Can is supported with a number of 3rd party plugins such as [https://moodle.org/plugins/logstore_xapi logstore xAPI] (allows reporting logging data to an external LRS) and [https://moodle.org/plugins/mod_tincanlaunch mod_tincanlaunch] (allows launching tin can content packages within Moodle.

==Asking for Help in the SCORM Forum==

When trying to engage the community to help with a problem you are facing, you will get a better response if you follow a few simple guidelines:
* Always start your report with '''version information''' - preferably the information displayed on the Admin -> Environment panel eg. http://localhost/moodle/admin/environment.php where http://localhost/moodle is your particular prefix. With this it will be clear how you are running your Moodle instance, on what platform, and at which version. This will quickly expose issues where a simple upgrade will solve your problem.
* Be prepared to '''provide the SCORM package''' that illustrates your problem - if you don't then it will be very difficult for anyone offering assistance to recreate your situation - a real barrier to help.
* '''Screenshots''' are very helpful. Provide a screenshot of all error messages, and any instance where something seems to go wrong in the interface.
* Nonstandard themes can introduce SCORM issues. Be sure to tell us '''what theme you're using'''.
* If you have admin privileges, and have access to a localhost install or other place where real-time users won't be disturbed, be sure to turn on debugging. Navigate to '''Site Administration > Development > Debugging''' and set '''Debug messages: Developer''' and '''Display debug messages: Yes'''. Access the SCORM content. If there are errors printed to the page, include them in your forum post.
* Use [https://developers.google.com/chrome-developer-tools/docs/console Chrome's JavaScript Console] or [https://developer.mozilla.org/en-US/docs/Tools/Web_Console Firebug's JavaScript console] to check that there are no JavaScript errors on the page when the content loads.
* Run your problematic SCORM package through '''API debugging''' (see below) and include the text of that API log with your post. That way we can see right away if the right function calls are not taking place.
* If you're using a content development suite which publishes to SCORM, such as Articulate, Captivate, Lectora, LessonBuilder, Udutu, or some other product, then include that in your post. Every authoring software has its ticks, and if you've run into one, it's likely that someone else has also dealt with it, and will recognize it. However, please keep in mind that '''this is a place to get help with Moodle issues, not help with your SCORM package authoring suite'''.

==Debugging ==

# Debugging settings are located at Settings > Site Administration > Plugins > Activities > Scorm.
# Check the checkbox for '''Activate API debug...'''
# Set the api mask. You can use the mask to enable debugging under certain conditions. For example, if you are logged in using the admin user (username admin) you can set the api mask to: <cite>admin.*</cite> Users not logged in as admin will not see the debugging log. The "Default" api mask is <cite>.*</cite>

==What does the debugging log mean?==

The SCO commonly sends the following communications through the API:

* '''LMSInitialize();''' opens the connection between the SCO and Moodle
* '''LMSGetValue( 'valuename' );''' gets a value from Moodle
* '''LMSSetValue( 'valuename' , 'value' );''' sends a value to Moodle
* '''LMSCommit();''' saves values sent to Moodle via LMSSetValue() and should be called after every LMSSetValue()
* '''LMSFinish()''' saves values sent to Moodle and closes the connection between the SCO And Moodle

Red lines in the debugging log means there was an error in the communication through the API.

If LMSInitialize() fails, returns an error, then no subsequent values sent to Moodle will be saved.

Click through the entire SCORM package. Then access the scorm report for your attempt, and compare the saved values in the debugging log with Moodle's report of the attempt. If the values set in the debug log do not match the values saved to Moodle, then there may be a problem with Moodle. Otherwise it's likely to be an issue with the SCO or the SCORM activity settings not giving you the functionality you need.

==SCORM and the Gradebook==
Please see [https://docs.moodle.org/en/SCORM_FAQ#My_SCORM_Module_doesn.27t_function_properly FAQ:My SCORM Module doesn't function properly] and [https://docs.moodle.org/en/SCORM_FAQ#Handling_of_Multiple_Attempts FAQ:Handling of Multiple Attempts]

Some SCORM packages report both cmi.core.lesson_status and cmi.core.score.raw. Others report only cmi.core.lesson_status, or only cmi.core.score.raw. The '''Grading Method''' setting for SCORM objects is meant to account for that.

If you have the '''Grading Method''' set to '''Highest grade''', '''Average grade''', or '''Sum grade''', and your learning object does not report a score, only, cmi.core.lesson_status, then there will be no numerical score to pass to the gradebook.

If your SCOs do not report cmi.core.score.raw, then the best '''Grading Method''' setting is '''Learning Objects'''. This reports either a 1 or a 0 as a score for each learning object. The gradebook value for that SCORM activity is the percent of scos in the package for which learners got a 1.

On the other hand, if your SCOs do not report a lesson_status, then select one of the score-based '''Grading Method''' options, such as '''Highest grade''', '''Average grade''', or '''Sum grade''', and not '''Learning Objects'''.

If you do not know what your SCOs are reporting to the LMS, then run them through to completion with debugging on.

Much of the way SCORM objects are graded is controlled inside the SCORM Authoring process before it is packaged for use in an LMS like Moodle - make sure all your grading settings are set correctly.

==SCORM Administration Options==

See [[SCORM settings]]

==Common Solutions==

===Difficulty Displaying a SCORM Package===
If you have difficulty displaying a SCORM, try loading the SCORM in [http://www.reload.ac.uk Reload] and re-saving it, then save the folder as a .zip package and try again.

===Character Display Errors===
When you notice there is a problem displaying characters correctly, it could be a misconfiguration of your server. Make sure that both httpd.conf (when using Apache) and php.ini are set to DefaultCharacterset = utf8 or switch the sending of a default character set off.

===slash arguments warning when I add/update SCORM objects in my course===
Some web servers don't support a function called '''slash arguments''' and so Moodle allows you to turn it off, but SCORM packages require '''slash arguments''' to be enabled on the web server in order to work properly.

See [[Using slash arguments]] for more details.

===SCORM doesn't work on Godaddy Host===
Godaddy hosts give a 404 file not found error - this is because by default they do not allow slash arguments which SCORM requires. The best way to test this is to visit http://yourmoodlesite/admin/tool/health/index.php - but the fix involves adding a php.ini or php5.ini file with the following text:
AcceptPathInfo
cgi.fix_pathinfo=1

===My Flash-Based Content Loads, then Stalls===
This issue is most commonly associated with zlib compression. Classic presentation is that the base HTML file and SWF are loaded into the SCORM player, but the SWF is not able to load any audio or video assets, and therefore stalls. You can watch the loading of SWFs and assets using Chrome's Developer Tools or other.

Check your site's zlib compression settings as an admin by loading up the Server > phpinfo page. zlib compression is not a Moodle setting but a server setting, so you'll need a server admin to disable it. Be sure to Purge All Caches, and clear browser caches, before confirming the change.

===Zlib warning when I add/update SCORM objects in my course===
Zlib is a php compression setting made in a websites PHP configuration - unfortunately some browsers don't handle this well (especially Internet Explorer 6) Some webhosts enable this setting, but it will likely cause issues for your users when they attempt to view/use the SCORM object. You will need to contact your server administrator to turn this off. The setting to change in php configuration is "zlib.output_compression"

===Incorrect file package - missing imsmanifest.xml or AICC structure===
This means that Moodle cannot find a file called imsmanifest.xml inside the SCORM object. Reasons for this could be:
* imsmanifest.xml needs to be immediately inside the scorm directory, NOT inside a directory inside of that. So if the zipped scorm package is package.zip, the unzipped package directory should contain immediately inside of it the imsmanifest.xml. This is a common mistake and normally occurs when a SCORM author creates a package themselves and then selects that folder to compress. This places the content folder inside of another folder, The imsmanifest.xml is there, but it is 2 directories deep. To avoid this problem when zipping scorm content into a package, go INSIDE of the exported scorm folder, select all files inside, and compress them while all are selected. The resultant compressed directory has the imsmanifest.xml file in the first directory, immediately available to the moodle scorm loading process.
* when using linux based systems the filename imsmanifest.xml must be all in lowercase not IMSmanifest.xml or Imsmanifest.XML
* The SCORM authoring tool Articulate sometimes fails to create the imsmanifest.xml -Try exporting the package again and see if the manifest is generated.
* The SCORM authoring tool Articulate Presenter will publish packages where the imsmanifest.xml file is in the correct place, but there are several lines of white space in the manifest file if you do not fill out the Reporting and Tracking Options in Articulate Presenter for Keywords and LMS Description. Moodle will give a "Manifest not found" error when encountering this. To fix this problem select the Reporting and Tracking Options in the Articulate Presenter publish dialog and fill in the LMS Description and Keywords.

===File not found error===
You have this error if the scorm package is created in moodle, and the scorm menu loads, but inside of the viewing area for the scorm content, you get a page with a 404 file not found error, usually showing the current Moodle theme.

What this means is that one of the files listed in the imsmanifest.xml is not in the scorm package or not in the correct directory.

Download and unzip the package, open up imsmanifest.xml. At the bottom of the xml file, below any metadata, you'll find a place where organizations and resources for those organizations are designated:

<code xml>

<organizations default="TOC1">
<organization identifier="TOC1">
<title>SCORM Test</title>
<item identifier="I_SCO0" identifierref="SCO0">
<title>Library Quiz</title>
<adlcp:masteryscore>0</adlcp:masteryscore>
</item>
</organization>
</organizations>
<resources>
<resource identifier="SCO0" type="webcontent" adlcp:scormtype="sco" href="scorm.html">
<file href="scorm.html"/>
<dependency identifierref="ALLRESOURCES" />
</resource>
<resource identifier="ALLRESOURCES" type="webcontent" adlcp:scormtype="asset">
<file href="scorm.html" />
<file href="scorm.js" />
<file href="swfobject.js" />
<file href="scorm.swf" />
<file href="scormwrapper.js" />
</resource>
</resources>
</manifest>
</code>

In this xml, we have a single organization, and in that organization is a single resource, a single sco. There are 5 files necessary for that resource to work correctly. The scorm.html file is loaded first. It loads 3 external js files and a swf.

What you need to do now is go to the directory containing imsmanifest.xml, and check that all of those listed files are available at the correct path from imsmanfiest.xml, as listed in imsmanifest.xml. If any one of those files is missing (especially the html file or the swf), or if the paths in imsmanifest.xml are incorrect, then it's very likely that the scorm object won't be able to load at all.

Sometimes the files aren't missing, but are simply misnamed in the manifest, or placed in the wrong directory. You can fix this by moving the files to the correct places, or updating their names so that the imsmanifest and the actual file names match up. In the case of a misnamed file, change the manifest rather than the actual file names, since the the files also reference one another in other places!

===Unzip issues===
If you get a blank page after filling in the title, description, and selecting a large SCORM file, it's likely you haven't installed the PHP-zip lib which is required for Moodle 2.x for more info see [[admin/environment/php_extension/zip]]

===Clear an Attempt===
To clear attempts by a student:

# Go to the SCORM activity and select the link "View reports for x users"
# Select the attempt or attempts you want to clear using the checkbox
# Select Delete in the drop-down box at the bottom of the page

===Handling of Multiple Attempts===
SCORM is designed to allow a learner to exit and return at a later date to the same point they left from. This means that each time they enter the SCORM they are using the same single attempt. Some SCORM packages are intelligent about handling re-entry, many are not. What this means is that if the learner re-enters an existing attempt, if the SCORM content does not have internal logic to avoid overwriting cmi.core.lesson_status and cmi.core.score.raw, they can be overwritten by a lower score, confusing the learner.

When a SCORM sets the cmi.core.lesson_status value to 'completed', 'passed' or 'failed' then Moodle allows the user to create a new attempt by adding a '''Start new attempt''' checkbox to the entry page. If cmi.core.lesson_status is set to 'incomplete', 'browsed' or 'notattempted' the learner can only re-enter the existing attempt. If you are using the setting 'Student skip content structure page', this checkbox will never be shown to the user.

Moodle provides a range of settings to allow this to be controlled, some of these settings are hidden by default as advanced options.
* Number of attempts
:This allows the teacher to set how many SCORM attempts the learner may create - this is not how many times a learner can re-enter a SCORM attempt.
* Attempts grading
:This allows the teacher to set how multiple SCORM attempts(not re-entries) are graded. It is important to note that a 'failed' cmi.core_lesson_status allows a new attempt to be generated but the attempts grading setting "last completed attempt" only includes 'completed' and 'passed' values in it's calculations.
* Display attempt status
:This displays a users SCORM attempts and how their final grade is calculated on the SCORM entry page and the My Moodle page for the learner.
* Force completed
:This is a setting that can be used to force a SCORM package to report a 'completed' cmi.core.lesson_status if it doesn't currently set the value.
* Force new attempt
:This hides the '''Start new attempt''' checkbox and will force a new attempt if the previous attempt has cmi.core.lesson_status value to 'completed', 'passed' or 'failed' (disabling "review mode")- this setting can also be used to make sure a new attempt is generated when the 'Student skip content structure page' setting is used.
* Lock after final attempt
:This prevents access to the SCORM after the total number of attempts have been used - if this is not set the learner can re-enter their last attempt and potentially change/overwrite their score each time depending on how the SCORM package supports multiple re-entries.

===Reducing Load Time with Captivate===
* Modify the percent that must be downloaded before the content starts to play. In Captivate 4, there's a setting in: Preferences / Project / Start and End / Preload. Reduce that to 50%.
* If you use audio in your Cp file (as background or element attachment), try to put a gap of 0,1 second at the beginning of each element including audio on your slides. If you don't do that, Cp merge all the audio files in one big audio file it need to download before playing the project. This problem have been report many times from the Cp community.

===Moodle changes cmi.core.lesson_status from "completed" or "passed" to "failed"===
Many SCORM authorware suites generate a masteryscore node in the imsmanifest.xml by default. This node is not necessary to the XML file. But when it is there, the SCORM standard designates specific behaviour with regard to the value set there.

This can also be controlled in Moodle using the setting "Mastery score overrides status" If this setting is enabled and a mastery score is provided within your package, when LMSFinish is called and a raw score has been set, if the raw score is lower than the mastery score, the lesson status will be overridden and set to "failed"

Here's what is in the scorm standard, on page 35 of 155 in SCORM_1.2_ConformanceReq.pdf, numbered page 2-19 ([http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201%2e2%2fDocumentation%20Suite%20%28SCORM%201%2e2%29&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View=%7b4D6DFFDE%2d3CFC%2d4DD9%2dA21A%2d4B687728824A%7d SCORM Version 1.2 Conformance Requirements Version 1.2]):
<blockquote>
If the value for this element is not set to “incomplete” by the SCO, then the LMS shall re-evaluate and change the value based on the following:<ul>
<li>If there is no mastery score in the Manifest, and the SCO sets a score (cmi.core.score.raw) and the lesson_status (cmi.core.lesson_status) then the LMS shall not override the SCO determined status.</li>
<li>If there is a mastery score in the Manifest, the LMS can change the status to either passed or failed depending on the student's score (cmi.core.score.raw) compared to the mastery score.</li>
<li>If the student is taking the SCO for no-credit, (cmi.core.credit = “no-credit”) there is no change to the lesson_status, with one exception. If the lesson_mode (cmi.core.lesson_mode) is "browse", the lesson_status may change to "browsed" even if the cmi.core.credit is set to no-credit.</li>
</ul>
</blockquote>
This can result in some functionality you don't intend. You can fix the problem by removing the mastery score node from your imsmanifest.xml file or by adjusting the Moodle setting "Mastery score overrides status". You may also want to find out what options you have, within your authorware suite, for the writing of that node into the manifest file, and change your authoring process accordingly.

The Rustici SCORM Cloud default operating behaviour for masteryscore is different from Moodle's default operating behaviour - you can see a little bit of the history around the way Rustici handle this here: http://scorm.com/blog/2010/09/anatomy-of-scorm-minutiae-mistake/

===Player Look 'n Feel===
You should be able to adjust height and width settings for the SCORM player window '''so long as''' your theme is based on/not too much of an aberration from one of the standard themes which ship with Moodle 2.

If your site or course theme isn't closely based on one of the standard M2 themes, then it's possible that your theme CSS is overriding local height and width settings for the SCORM player. Have a Web developer (or a Moodle Partner) examine how your theme is interacting with the player layout, and make changes to your theme as needed.

'''Why can't I just change it locally?''' You can change height and width per individual SCORM package, and you can set defaults for these local height and width values ( [[SCORM Admin Options]] ). Other things, such as colors, shading, borders, backgrounds, are controlled by CSS, just like everything else on the site.

=== Courselab 2.4 ===
If you receive a " found more than one record!" error when trying to run your SCORM 1.2 package check the imsmanifest.xml file of your SCORM package and ensure that the values for <organization identifier> and <item identifier> are unique. To change the <organization identifier>, in Courselab, go to File > Course Runtime Settings. The dialog says 'Course identification in LMS' but changing the Identifier field is what sets the <organization identifier>. (see MDL-38060 for more information)

=== SCORM results deleted after package update ===

When uploading a SCORM package over a previous one, if the item identifier in the manifest file is different to the one being overwritten then the tracking data for that SCORM package in Moodle is deleted.

Ensure the item identifier is the same for the new SCORM resource

===Problems with responsiveness===

Sometimes SCORMs fail on responsiveness or the ability to scroll on mobile devices

*Moodle uses iFrames for deploying SCORM. https://community.adaptlearning.org/mod/forum/discuss.php?d=180#p863
*There can be some problems with this as they are not responsive in iOS https://community.adaptlearning.org/mod/forum/discuss.php?d=1446#p6687
*There are some potential work arounds.
#Totara has a new window. #https://community.adaptlearning.org/mod/forum/discuss.php?d=851#p3968
#This comment https://community.adaptlearning.org/mod/forum/discuss.php?d=787#p3661
#Solutions for Adapt: https://github.com/adaptlearning/adapt_framework/issues/210
*The tracker:
#https://tracker.moodle.org/browse/MDL-47500 problems with pages.
#https://tracker.moodle.org/browse/MDL-46563
#https://tracker.moodle.org/browse/MDL-50401
*Why iFrames fail with iOS, one person's view: https://community.adaptlearning.org/mod/forum/discuss.php?d=926#p4714

This seems to be a problem that lies between the browsers (eg faults in iOS) the creation of the SCORM package and the LMS (in this case the iFrames in Moodle).

One quite comprehensive idea for a work around is here: https://community.adaptlearning.org/mod/forum/discuss.php?d=180 but there is really no evidence at the moment of a nicer solution.

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?id=1951 SCORM forum]
* [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle SCORM doesn't work] blog post from developer Dan Marsden
* [http://danmarsden.com/blog/2009/05/23/scorm-2004-in-moodle/ SCORM 2004 in Moodle] blog post from developer Dan Marsden
* [https://moodle.org/mod/forum/discuss.php?d=276324 Identifiers to change with updated SCORM module]
* [https://docs.moodle.org/dev/SCORM_schema Internal SCORM Schema]
* The official standard: [http://www.adlnet.gov/Technologies/scorm/default.aspx Advanced Distributed Learning - SCORM]

Online resources
* [http://www.scormcourse.com/ SCORMCourse.com] serves the SCORM and ADL community as an educational resource for SCORM technology.
* [http://www.eduworks.com/index.php/Publications/Learning-Object-Tutorial.html Learning Object Tutorial]
* [http://elearningweekly.wordpress.com/2007/04/12/tutorial-build-scorm-compatible-lesson-templates-for-your-lms/ Tutorial: Build SCORM-Compatible Lesson Templates for Your LMS]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=3757 Simple introduction to SCORM]
*[http://moodle.org/mod/forum/discuss.php?d=57059 Are there any sugestions for scorm authoring with Microsoft word / or any other easy (maybe free) scorm authoring tool?]
*[http://moodle.org/mod/forum/discuss.php?d=95946 Is SCORM worth it?]
*[http://moodle.org/mod/forum/discuss.php?d=207964 Updating an Object]

[[Category:FAQ]]
[[de:Lernpaket FAQ]]

SCORM FAQ

2016-11-07T20:11:47Z

Danmarsden: /* Supported Versions */ improve details around tin can support.

{{SCORM}}
==What is SCORM?==

SCORM was developed as a result of collaboration in the public and private sectors. The President of the United States, Bill Clinton issued an Executive Order that created an agency (ADL) to oversee the standard for developing and distributing online learning. All Federal agencies are mandated to use programs that meet those standards. SCORM is one result of that order.

There's a really simple "What is SCORM" introduction here: http://moodle.org/mod/forum/discuss.php?d=3757#p18828

A slightly more detailed introduction here: http://www.rusticisoftware.com/resources/whatisscorm/What%20Is%20SCORM.ht

==Should I make my Moodle courses as SCORM or use Moodle's features?==
It depends how you intend to use it. If you are planning on exporting and using in another LMS then SCORM would make this easier. If you want something shiny, then a SCORM package can fit the bill. However, reporting and grading work better in Moodle and for many educators the standard features do the job perfectly and do not require learning a new program. There is a useful form post discussing the pros and cons of SCORM in Moodle here: http://moodle.org/mod/forum/discuss.php?d=200242

==SCORM Information==

Advanced Distributed Learning (ADL) is the organization that wrote the SCORM standard. You can download documentation and samples form ADL's Web site. Documentation for SCORM 1.2 in several languages is available [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2%2fDocumentation%20Suite%20(SCORM%201.2)&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} here].

Philip Hutchison provides an AS3 and JavaScript wrapper, as well as a sample package:
http://pipwerks.com/downloads/

==SCORM Package Contents==

A SCORM package must contains in the root of zip a file named imsmanifest.xml which defines SCORM course structure, resource location and many other things. Other files used in the package, such as HTML files, XML files, multimedia files, and JavaScript for the SCORM API must be listed in this file. The LMS parses the manifest, and provides the files listed there to the content package during runtime.

==AICC Package Contents==

An AICC package is defined by several files (from 4 to 7) with defined extensions as follows:

* CRS - Course Description file (mandatory)
* AU - Assignable Unit file (mandatory)
* DES - Descriptor file (mandatory)
* CST - Course Structure file (mandatory)
* ORE - Objective Relationship file (optional)
* PRE - Prerequisites file (optional)
* CMP - Completition Requirements file (optional)

==Basic Troubleshooting==

* Make sure you are running Moodle 2.1 or higher, a large number of SCORM related bugs are present in previous versions.
*Make sure you (and your users) have JavaScript enabled. SCORM requires JavaScript.
* Make sure your SCORM object is SCORM compliant - check it in an external SCORM player like [https://docs.moodle.org/en/Tools_for_creating_SCORM_content#Reload Reload] to see if it works there.
* Upload a copy of your SCORM object to a [http://en.wikipedia.org/wiki/File_hosting_service File Hosting Service] and post a message asking for help in the forums, linking to your SCORM object explaining exactly what you expect to happen, and what is happening instead.
* Read Dan Marsden's blog post [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle here] (Maintainer of SCORM Module in Moodle)

==Does Moodle Generate SCORM Content?==

Moodle '''does not''' generate scorm content. Moodle presents the content in SCORM packages to learners, and saves data from learner interactions with the SCORM package.

==Can I add a password for access to my SCORM package?==
No, although there is a tracker request for this: MDL-46403 As a workaround you could add your SCORM package using the single activity course format - see [[Course formats]] - and add an enrolment key to the course.

==Supported Versions==

* SCORM 1.2 is supported in Moodle 2.1(or higher) and passes all the tests in the ADL Conformance test suite 1.2.7 for SCORM 1.2. The best place for information on SCORM 1.2 conformance is the [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Previous%20Versions/SCORM%201.2/Conformance%20Test%20Suite%20(SCORM%201.2)/SCORM_1.2_ConformanceReq.pdf SCORM Comformance Requirements documentation (PDF 3.4MB)].

* SCORM 2004 is not supported in Moodle. Parts of the API have been implemented, but others such as Navigation and Sequencing have not. Development on native SCORM 2004 support in Moodle [https://moodle.org/mod/forum/discuss.php?d=227906 has stopped]. If you require a fully certified SCORM 2004 Player in Moodle, [http://www.scorm.com Rustici Software] have a [https://moodle.org/plugins/mod_scormcloud Moodle plugin] which connects to their commercial [http://www.scorm.com/scorm-solved/scorm-cloud/ SCORM Cloud] service turning Moodle into a fully compliant SCORM 2004 LMS.

* AICC objects are supported in Moodle 2.1 and higher.

* Tin Can is supported with a number of 3rd party plugins such as [https://moodle.org/plugins/logstore_xapi logstore xAPI] (allows reporting logging data to an external LRS) and [https://moodle.org/plugins/mod_tincanlaunch mod_tincanlaunch] (allows launching tin can content packages within Moodle.

==Asking for Help in the SCORM Forum==

When trying to engage the community to help with a problem you are facing, you will get a better response if you follow a few simple guidelines:
* Always start your report with '''version information''' - preferably the information displayed on the Admin -> Environment panel eg. http://localhost/moodle/admin/environment.php where http://localhost/moodle is your particular prefix. With this it will be clear how you are running your Moodle instance, on what platform, and at which version. This will quickly expose issues where a simple upgrade will solve your problem.
* Be prepared to '''provide the SCORM package''' that illustrates your problem - if you don't then it will be very difficult for anyone offering assistance to recreate your situation - a real barrier to help.
* '''Screenshots''' are very helpful. Provide a screenshot of all error messages, and any instance where something seems to go wrong in the interface.
* Nonstandard themes can introduce SCORM issues. Be sure to tell us '''what theme you're using'''.
* If you have admin privileges, and have access to a localhost install or other place where real-time users won't be disturbed, be sure to turn on debugging. Navigate to '''Site Administration > Development > Debugging''' and set '''Debug messages: Developer''' and '''Display debug messages: Yes'''. Access the SCORM content. If there are errors printed to the page, include them in your forum post.
* Use [https://developers.google.com/chrome-developer-tools/docs/console Chrome's JavaScript Console] or [https://developer.mozilla.org/en-US/docs/Tools/Web_Console Firebug's JavaScript console] to check that there are no JavaScript errors on the page when the content loads.
* Run your problematic SCORM package through '''API debugging''' (see below) and include the text of that API log with your post. That way we can see right away if the right function calls are not taking place.
* If you're using a content development suite which publishes to SCORM, such as Articulate, Captivate, Lectora, LessonBuilder, Udutu, or some other product, then include that in your post. Every authoring software has its ticks, and if you've run into one, it's likely that someone else has also dealt with it, and will recognize it. However, please keep in mind that '''this is a place to get help with Moodle issues, not help with your SCORM package authoring suite'''.

==Debugging ==

# Debugging settings are located at Settings > Site Administration > Plugins > Activities > Scorm.
# Check the checkbox for '''Activate API debug...'''
# Set the api mask. You can use the mask to enable debugging under certain conditions. For example, if you are logged in using the admin user (username admin) you can set the api mask to: <cite>admin.*</cite> Users not logged in as admin will not see the debugging log. The "Default" api mask is <cite>.*</cite>

==What does the debugging log mean?==

The SCO commonly sends the following communications through the API:

* '''LMSInitialize();''' opens the connection between the SCO and Moodle
* '''LMSGetValue( 'valuename' );''' gets a value from Moodle
* '''LMSSetValue( 'valuename' , 'value' );''' sends a value to Moodle
* '''LMSCommit();''' saves values sent to Moodle via LMSSetValue() and should be called after every LMSSetValue()
* '''LMSFinish()''' saves values sent to Moodle and closes the connection between the SCO And Moodle

Red lines in the debugging log means there was an error in the communication through the API.

If LMSInitialize() fails, returns an error, then no subsequent values sent to Moodle will be saved.

Click through the entire SCORM package. Then access the scorm report for your attempt, and compare the saved values in the debugging log with Moodle's report of the attempt. If the values set in the debug log do not match the values saved to Moodle, then there may be a problem with Moodle. Otherwise it's likely to be an issue with the SCO or the SCORM activity settings not giving you the functionality you need.

==SCORM and the Gradebook==
Please see [https://docs.moodle.org/en/SCORM_FAQ#My_SCORM_Module_doesn.27t_function_properly FAQ:My SCORM Module doesn't function properly] and [https://docs.moodle.org/en/SCORM_FAQ#Handling_of_Multiple_Attempts FAQ:Handling of Multiple Attempts]

Some SCORM packages report both cmi.core.lesson_status and cmi.core.score.raw. Others report only cmi.core.lesson_status, or only cmi.core.score.raw. The '''Grading Method''' setting for SCORM objects is meant to account for that.

If you have the '''Grading Method''' set to '''Highest grade''', '''Average grade''', or '''Sum grade''', and your learning object does not report a score, only, cmi.core.lesson_status, then there will be no numerical score to pass to the gradebook.

If your SCOs do not report cmi.core.score.raw, then the best '''Grading Method''' setting is '''Learning Objects'''. This reports either a 1 or a 0 as a score for each learning object. The gradebook value for that SCORM activity is the percent of scos in the package for which learners got a 1.

On the other hand, if your SCOs do not report a lesson_status, then select one of the score-based '''Grading Method''' options, such as '''Highest grade''', '''Average grade''', or '''Sum grade''', and not '''Learning Objects'''.

If you do not know what your SCOs are reporting to the LMS, then run them through to completion with debugging on.

Much of the way SCORM objects are graded is controlled inside the SCORM Authoring process before it is packaged for use in an LMS like Moodle - make sure all your grading settings are set correctly.

==SCORM Administration Options==

See [[SCORM settings]]

==Common Solutions==

===Difficulty Displaying a SCORM Package===
If you have difficulty displaying a SCORM, try loading the SCORM in [http://www.reload.ac.uk Reload] and re-saving it, then save the folder as a .zip package and try again.

===Character Display Errors===
When you notice there is a problem displaying characters correctly, it could be a misconfiguration of your server. Make sure that both httpd.conf (when using Apache) and php.ini are set to DefaultCharacterset = utf8 or switch the sending of a default character set off.

===slash arguments warning when I add/update SCORM objects in my course===
Some web servers don't support a function called '''slash arguments''' and so Moodle allows you to turn it off, but SCORM packages require '''slash arguments''' to be enabled on the web server in order to work properly.

See [[Using slash arguments]] for more details.

===SCORM doesn't work on Godaddy Host===
Godaddy hosts give a 404 file not found error - this is because by default they do not allow slash arguments which SCORM requires. The best way to test this is to visit http://yourmoodlesite/admin/tool/health/index.php - but the fix involves adding a php.ini or php5.ini file with the following text:
AcceptPathInfo
cgi.fix_pathinfo=1

===My Flash-Based Content Loads, then Stalls===
This issue is most commonly associated with zlib compression. Classic presentation is that the base HTML file and SWF are loaded into the SCORM player, but the SWF is not able to load any audio or video assets, and therefore stalls. You can watch the loading of SWFs and assets using Chrome's Developer Tools or other.

Check your site's zlib compression settings as an admin by loading up the Server > phpinfo page. zlib compression is not a Moodle setting but a server setting, so you'll need a server admin to disable it. Be sure to Purge All Caches, and clear browser caches, before confirming the change.

===Zlib warning when I add/update SCORM objects in my course===
Zlib is a php compression setting made in a websites PHP configuration - unfortunately some browsers don't handle this well (especially Internet Explorer 6) Some webhosts enable this setting, but it will likely cause issues for your users when they attempt to view/use the SCORM object. You will need to contact your server administrator to turn this off. The setting to change in php configuration is "zlib.output_compression"

===Incorrect file package - missing imsmanifest.xml or AICC structure===
This means that Moodle cannot find a file called imsmanifest.xml inside the SCORM object. Reasons for this could be:
* imsmanifest.xml needs to be immediately inside the scorm directory, NOT inside a directory inside of that. So if the zipped scorm package is package.zip, the unzipped package directory should contain immediately inside of it the imsmanifest.xml. This is a common mistake and normally occurs when a SCORM author creates a package themselves and then selects that folder to compress. This places the content folder inside of another folder, The imsmanifest.xml is there, but it is 2 directories deep. To avoid this problem when zipping scorm content into a package, go INSIDE of the exported scorm folder, select all files inside, and compress them while all are selected. The resultant compressed directory has the imsmanifest.xml file in the first directory, immediately available to the moodle scorm loading process.
* when using linux based systems the filename imsmanifest.xml must be all in lowercase not IMSmanifest.xml or Imsmanifest.XML
* The SCORM authoring tool Articulate sometimes fails to create the imsmanifest.xml -Try exporting the package again and see if the manifest is generated.
* The SCORM authoring tool Articulate Presenter will publish packages where the imsmanifest.xml file is in the correct place, but there are several lines of white space in the manifest file if you do not fill out the Reporting and Tracking Options in Articulate Presenter for Keywords and LMS Description. Moodle will give a "Manifest not found" error when encountering this. To fix this problem select the Reporting and Tracking Options in the Articulate Presenter publish dialog and fill in the LMS Description and Keywords.

===File not found error===
You have this error if the scorm package is created in moodle, and the scorm menu loads, but inside of the viewing area for the scorm content, you get a page with a 404 file not found error, usually showing the current Moodle theme.

What this means is that one of the files listed in the imsmanifest.xml is not in the scorm package or not in the correct directory.

Download and unzip the package, open up imsmanifest.xml. At the bottom of the xml file, below any metadata, you'll find a place where organizations and resources for those organizations are designated:

<code xml>

<organizations default="TOC1">
<organization identifier="TOC1">
<title>SCORM Test</title>
<item identifier="I_SCO0" identifierref="SCO0">
<title>Library Quiz</title>
<adlcp:masteryscore>0</adlcp:masteryscore>
</item>
</organization>
</organizations>
<resources>
<resource identifier="SCO0" type="webcontent" adlcp:scormtype="sco" href="scorm.html">
<file href="scorm.html"/>
<dependency identifierref="ALLRESOURCES" />
</resource>
<resource identifier="ALLRESOURCES" type="webcontent" adlcp:scormtype="asset">
<file href="scorm.html" />
<file href="scorm.js" />
<file href="swfobject.js" />
<file href="scorm.swf" />
<file href="scormwrapper.js" />
</resource>
</resources>
</manifest>
</code>

In this xml, we have a single organization, and in that organization is a single resource, a single sco. There are 5 files necessary for that resource to work correctly. The scorm.html file is loaded first. It loads 3 external js files and a swf.

What you need to do now is go to the directory containing imsmanifest.xml, and check that all of those listed files are available at the correct path from imsmanfiest.xml, as listed in imsmanifest.xml. If any one of those files is missing (especially the html file or the swf), or if the paths in imsmanifest.xml are incorrect, then it's very likely that the scorm object won't be able to load at all.

Sometimes the files aren't missing, but are simply misnamed in the manifest, or placed in the wrong directory. You can fix this by moving the files to the correct places, or updating their names so that the imsmanifest and the actual file names match up. In the case of a misnamed file, change the manifest rather than the actual file names, since the the files also reference one another in other places!

===Unzip issues===
If you get a blank page after filling in the title, description, and selecting a large SCORM file, it's likely you haven't installed the PHP-zip lib which is required for Moodle 2.x for more info see [[admin/environment/php_extension/zip]]

===Clear an Attempt===
To clear attempts by a student:

# Go to the SCORM activity and select the link "View reports for x users"
# Select the attempt or attempts you want to clear using the checkbox
# Select Delete in the drop-down box at the bottom of the page

===Handling of Multiple Attempts===
SCORM is designed to allow a learner to exit and return at a later date to the same point they left from. This means that each time they enter the SCORM they are using the same single attempt. Some SCORM packages are intelligent about handling re-entry, many are not. What this means is that if the learner re-enters an existing attempt, if the SCORM content does not have internal logic to avoid overwriting cmi.core.lesson_status and cmi.core.score.raw, they can be overwritten by a lower score, confusing the learner.

When a SCORM sets the cmi.core.lesson_status value to 'completed', 'passed' or 'failed' then Moodle allows the user to create a new attempt by adding a '''Start new attempt''' checkbox to the entry page. If cmi.core.lesson_status is set to 'incomplete', 'browsed' or 'notattempted' the learner can only re-enter the existing attempt. If you are using the setting 'Student skip content structure page', this checkbox will never be shown to the user.

Moodle provides a range of settings to allow this to be controlled, some of these settings are hidden by default as advanced options.
* Number of attempts
:This allows the teacher to set how many SCORM attempts the learner may create - this is not how many times a learner can re-enter a SCORM attempt.
* Attempts grading
:This allows the teacher to set how multiple SCORM attempts(not re-entries) are graded. It is important to note that a 'failed' cmi.core_lesson_status allows a new attempt to be generated but the attempts grading setting "last completed attempt" only includes 'completed' and 'passed' values in it's calculations.
* Display attempt status
:This displays a users SCORM attempts and how their final grade is calculated on the SCORM entry page and the My Moodle page for the learner.
* Force completed
:This is a setting that can be used to force a SCORM package to report a 'completed' cmi.core.lesson_status if it doesn't currently set the value.
* Force new attempt
:This hides the '''Start new attempt''' checkbox and will force a new attempt if the previous attempt has cmi.core.lesson_status value to 'completed', 'passed' or 'failed' - this setting can also be used to make sure a new attempt is generated when the 'Student skip content structure page' setting is used.
* Lock after final attempt
:This prevents access to the SCORM after the total number of attempts have been used - if this is not set the learner can re-enter their last attempt and potentially change/overwrite their score each time depending on how the SCORM package supports multiple re-entries.

===Reducing Load Time with Captivate===
* Modify the percent that must be downloaded before the content starts to play. In Captivate 4, there's a setting in: Preferences / Project / Start and End / Preload. Reduce that to 50%.
* If you use audio in your Cp file (as background or element attachment), try to put a gap of 0,1 second at the beginning of each element including audio on your slides. If you don't do that, Cp merge all the audio files in one big audio file it need to download before playing the project. This problem have been report many times from the Cp community.

===Moodle changes cmi.core.lesson_status from "completed" or "passed" to "failed"===
Many SCORM authorware suites generate a masteryscore node in the imsmanifest.xml by default. This node is not necessary to the XML file. But when it is there, the SCORM standard designates specific behaviour with regard to the value set there.

This can also be controlled in Moodle using the setting "Mastery score overrides status" If this setting is enabled and a mastery score is provided within your package, when LMSFinish is called and a raw score has been set, if the raw score is lower than the mastery score, the lesson status will be overridden and set to "failed"

Here's what is in the scorm standard, on page 35 of 155 in SCORM_1.2_ConformanceReq.pdf, numbered page 2-19 ([http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201%2e2%2fDocumentation%20Suite%20%28SCORM%201%2e2%29&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View=%7b4D6DFFDE%2d3CFC%2d4DD9%2dA21A%2d4B687728824A%7d SCORM Version 1.2 Conformance Requirements Version 1.2]):
<blockquote>
If the value for this element is not set to “incomplete” by the SCO, then the LMS shall re-evaluate and change the value based on the following:<ul>
<li>If there is no mastery score in the Manifest, and the SCO sets a score (cmi.core.score.raw) and the lesson_status (cmi.core.lesson_status) then the LMS shall not override the SCO determined status.</li>
<li>If there is a mastery score in the Manifest, the LMS can change the status to either passed or failed depending on the student's score (cmi.core.score.raw) compared to the mastery score.</li>
<li>If the student is taking the SCO for no-credit, (cmi.core.credit = “no-credit”) there is no change to the lesson_status, with one exception. If the lesson_mode (cmi.core.lesson_mode) is "browse", the lesson_status may change to "browsed" even if the cmi.core.credit is set to no-credit.</li>
</ul>
</blockquote>
This can result in some functionality you don't intend. You can fix the problem by removing the mastery score node from your imsmanifest.xml file or by adjusting the Moodle setting "Mastery score overrides status". You may also want to find out what options you have, within your authorware suite, for the writing of that node into the manifest file, and change your authoring process accordingly.

The Rustici SCORM Cloud default operating behaviour for masteryscore is different from Moodle's default operating behaviour - you can see a little bit of the history around the way Rustici handle this here: http://scorm.com/blog/2010/09/anatomy-of-scorm-minutiae-mistake/

===Player Look 'n Feel===
You should be able to adjust height and width settings for the SCORM player window '''so long as''' your theme is based on/not too much of an aberration from one of the standard themes which ship with Moodle 2.

If your site or course theme isn't closely based on one of the standard M2 themes, then it's possible that your theme CSS is overriding local height and width settings for the SCORM player. Have a Web developer (or a Moodle Partner) examine how your theme is interacting with the player layout, and make changes to your theme as needed.

'''Why can't I just change it locally?''' You can change height and width per individual SCORM package, and you can set defaults for these local height and width values ( [[SCORM Admin Options]] ). Other things, such as colors, shading, borders, backgrounds, are controlled by CSS, just like everything else on the site.

=== Courselab 2.4 ===
If you receive a " found more than one record!" error when trying to run your SCORM 1.2 package check the imsmanifest.xml file of your SCORM package and ensure that the values for <organization identifier> and <item identifier> are unique. To change the <organization identifier>, in Courselab, go to File > Course Runtime Settings. The dialog says 'Course identification in LMS' but changing the Identifier field is what sets the <organization identifier>. (see MDL-38060 for more information)

=== SCORM results deleted after package update ===

When uploading a SCORM package over a previous one, if the item identifier in the manifest file is different to the one being overwritten then the tracking data for that SCORM package in Moodle is deleted.

Ensure the item identifier is the same for the new SCORM resource

===Problems with responsiveness===

Sometimes SCORMs fail on responsiveness or the ability to scroll on mobile devices

*Moodle uses iFrames for deploying SCORM. https://community.adaptlearning.org/mod/forum/discuss.php?d=180#p863
*There can be some problems with this as they are not responsive in iOS https://community.adaptlearning.org/mod/forum/discuss.php?d=1446#p6687
*There are some potential work arounds.
#Totara has a new window. #https://community.adaptlearning.org/mod/forum/discuss.php?d=851#p3968
#This comment https://community.adaptlearning.org/mod/forum/discuss.php?d=787#p3661
#Solutions for Adapt: https://github.com/adaptlearning/adapt_framework/issues/210
*The tracker:
#https://tracker.moodle.org/browse/MDL-47500 problems with pages.
#https://tracker.moodle.org/browse/MDL-46563
#https://tracker.moodle.org/browse/MDL-50401
*Why iFrames fail with iOS, one person's view: https://community.adaptlearning.org/mod/forum/discuss.php?d=926#p4714

This seems to be a problem that lies between the browsers (eg faults in iOS) the creation of the SCORM package and the LMS (in this case the iFrames in Moodle).

One quite comprehensive idea for a work around is here: https://community.adaptlearning.org/mod/forum/discuss.php?d=180 but there is really no evidence at the moment of a nicer solution.

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?id=1951 SCORM forum]
* [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle SCORM doesn't work] blog post from developer Dan Marsden
* [http://danmarsden.com/blog/2009/05/23/scorm-2004-in-moodle/ SCORM 2004 in Moodle] blog post from developer Dan Marsden
* [https://moodle.org/mod/forum/discuss.php?d=276324 Identifiers to change with updated SCORM module]
* [https://docs.moodle.org/dev/SCORM_schema Internal SCORM Schema]
* The official standard: [http://www.adlnet.gov/Technologies/scorm/default.aspx Advanced Distributed Learning - SCORM]

Online resources
* [http://www.scormcourse.com/ SCORMCourse.com] serves the SCORM and ADL community as an educational resource for SCORM technology.
* [http://www.eduworks.com/index.php/Publications/Learning-Object-Tutorial.html Learning Object Tutorial]
* [http://elearningweekly.wordpress.com/2007/04/12/tutorial-build-scorm-compatible-lesson-templates-for-your-lms/ Tutorial: Build SCORM-Compatible Lesson Templates for Your LMS]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=3757 Simple introduction to SCORM]
*[http://moodle.org/mod/forum/discuss.php?d=57059 Are there any sugestions for scorm authoring with Microsoft word / or any other easy (maybe free) scorm authoring tool?]
*[http://moodle.org/mod/forum/discuss.php?d=95946 Is SCORM worth it?]
*[http://moodle.org/mod/forum/discuss.php?d=207964 Updating an Object]

[[Category:FAQ]]
[[de:Lernpaket FAQ]]

SCORM FAQ

2016-11-07T20:05:50Z

Danmarsden: /* Supported Versions */ fix link to scorm cloud plugin

{{SCORM}}
==What is SCORM?==

SCORM was developed as a result of collaboration in the public and private sectors. The President of the United States, Bill Clinton issued an Executive Order that created an agency (ADL) to oversee the standard for developing and distributing online learning. All Federal agencies are mandated to use programs that meet those standards. SCORM is one result of that order.

There's a really simple "What is SCORM" introduction here: http://moodle.org/mod/forum/discuss.php?d=3757#p18828

A slightly more detailed introduction here: http://www.rusticisoftware.com/resources/whatisscorm/What%20Is%20SCORM.ht

==Should I make my Moodle courses as SCORM or use Moodle's features?==
It depends how you intend to use it. If you are planning on exporting and using in another LMS then SCORM would make this easier. If you want something shiny, then a SCORM package can fit the bill. However, reporting and grading work better in Moodle and for many educators the standard features do the job perfectly and do not require learning a new program. There is a useful form post discussing the pros and cons of SCORM in Moodle here: http://moodle.org/mod/forum/discuss.php?d=200242

==SCORM Information==

Advanced Distributed Learning (ADL) is the organization that wrote the SCORM standard. You can download documentation and samples form ADL's Web site. Documentation for SCORM 1.2 in several languages is available [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2%2fDocumentation%20Suite%20(SCORM%201.2)&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} here].

Philip Hutchison provides an AS3 and JavaScript wrapper, as well as a sample package:
http://pipwerks.com/downloads/

==SCORM Package Contents==

A SCORM package must contains in the root of zip a file named imsmanifest.xml which defines SCORM course structure, resource location and many other things. Other files used in the package, such as HTML files, XML files, multimedia files, and JavaScript for the SCORM API must be listed in this file. The LMS parses the manifest, and provides the files listed there to the content package during runtime.

==AICC Package Contents==

An AICC package is defined by several files (from 4 to 7) with defined extensions as follows:

* CRS - Course Description file (mandatory)
* AU - Assignable Unit file (mandatory)
* DES - Descriptor file (mandatory)
* CST - Course Structure file (mandatory)
* ORE - Objective Relationship file (optional)
* PRE - Prerequisites file (optional)
* CMP - Completition Requirements file (optional)

==Basic Troubleshooting==

* Make sure you are running Moodle 2.1 or higher, a large number of SCORM related bugs are present in previous versions.
*Make sure you (and your users) have JavaScript enabled. SCORM requires JavaScript.
* Make sure your SCORM object is SCORM compliant - check it in an external SCORM player like [https://docs.moodle.org/en/Tools_for_creating_SCORM_content#Reload Reload] to see if it works there.
* Upload a copy of your SCORM object to a [http://en.wikipedia.org/wiki/File_hosting_service File Hosting Service] and post a message asking for help in the forums, linking to your SCORM object explaining exactly what you expect to happen, and what is happening instead.
* Read Dan Marsden's blog post [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle here] (Maintainer of SCORM Module in Moodle)

==Does Moodle Generate SCORM Content?==

Moodle '''does not''' generate scorm content. Moodle presents the content in SCORM packages to learners, and saves data from learner interactions with the SCORM package.

==Can I add a password for access to my SCORM package?==
No, although there is a tracker request for this: MDL-46403 As a workaround you could add your SCORM package using the single activity course format - see [[Course formats]] - and add an enrolment key to the course.

==Supported Versions==

* SCORM 1.2 is supported in Moodle 2.1(or higher) and passes all the tests in the ADL Conformance test suite 1.2.7 for SCORM 1.2. The best place for information on SCORM 1.2 conformance is the [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Previous%20Versions/SCORM%201.2/Conformance%20Test%20Suite%20(SCORM%201.2)/SCORM_1.2_ConformanceReq.pdf SCORM Comformance Requirements documentation (PDF 3.4MB)].

* SCORM 2004 is not supported in Moodle. Parts of the API have been implemented, but others such as Navigation and Sequencing have not. Development on native SCORM 2004 support in Moodle [https://moodle.org/mod/forum/discuss.php?d=227906 has stopped]. If you require a fully certified SCORM 2004 Player in Moodle, [http://www.scorm.com Rustici Software] have a [https://moodle.org/plugins/mod_scormcloud Moodle plugin] which connects to their commercial [http://www.scorm.com/scorm-solved/scorm-cloud/ SCORM Cloud] service turning Moodle into a fully compliant SCORM 2004 LMS.

* AICC objects are supported in Moodle 2.1 and higher.

* Moodle does not support Tin Can at this stage.

==Asking for Help in the SCORM Forum==

When trying to engage the community to help with a problem you are facing, you will get a better response if you follow a few simple guidelines:
* Always start your report with '''version information''' - preferably the information displayed on the Admin -> Environment panel eg. http://localhost/moodle/admin/environment.php where http://localhost/moodle is your particular prefix. With this it will be clear how you are running your Moodle instance, on what platform, and at which version. This will quickly expose issues where a simple upgrade will solve your problem.
* Be prepared to '''provide the SCORM package''' that illustrates your problem - if you don't then it will be very difficult for anyone offering assistance to recreate your situation - a real barrier to help.
* '''Screenshots''' are very helpful. Provide a screenshot of all error messages, and any instance where something seems to go wrong in the interface.
* Nonstandard themes can introduce SCORM issues. Be sure to tell us '''what theme you're using'''.
* If you have admin privileges, and have access to a localhost install or other place where real-time users won't be disturbed, be sure to turn on debugging. Navigate to '''Site Administration > Development > Debugging''' and set '''Debug messages: Developer''' and '''Display debug messages: Yes'''. Access the SCORM content. If there are errors printed to the page, include them in your forum post.
* Use [https://developers.google.com/chrome-developer-tools/docs/console Chrome's JavaScript Console] or [https://developer.mozilla.org/en-US/docs/Tools/Web_Console Firebug's JavaScript console] to check that there are no JavaScript errors on the page when the content loads.
* Run your problematic SCORM package through '''API debugging''' (see below) and include the text of that API log with your post. That way we can see right away if the right function calls are not taking place.
* If you're using a content development suite which publishes to SCORM, such as Articulate, Captivate, Lectora, LessonBuilder, Udutu, or some other product, then include that in your post. Every authoring software has its ticks, and if you've run into one, it's likely that someone else has also dealt with it, and will recognize it. However, please keep in mind that '''this is a place to get help with Moodle issues, not help with your SCORM package authoring suite'''.

==Debugging ==

# Debugging settings are located at Settings > Site Administration > Plugins > Activities > Scorm.
# Check the checkbox for '''Activate API debug...'''
# Set the api mask. You can use the mask to enable debugging under certain conditions. For example, if you are logged in using the admin user (username admin) you can set the api mask to: <cite>admin.*</cite> Users not logged in as admin will not see the debugging log. The "Default" api mask is <cite>.*</cite>

==What does the debugging log mean?==

The SCO commonly sends the following communications through the API:

* '''LMSInitialize();''' opens the connection between the SCO and Moodle
* '''LMSGetValue( 'valuename' );''' gets a value from Moodle
* '''LMSSetValue( 'valuename' , 'value' );''' sends a value to Moodle
* '''LMSCommit();''' saves values sent to Moodle via LMSSetValue() and should be called after every LMSSetValue()
* '''LMSFinish()''' saves values sent to Moodle and closes the connection between the SCO And Moodle

Red lines in the debugging log means there was an error in the communication through the API.

If LMSInitialize() fails, returns an error, then no subsequent values sent to Moodle will be saved.

Click through the entire SCORM package. Then access the scorm report for your attempt, and compare the saved values in the debugging log with Moodle's report of the attempt. If the values set in the debug log do not match the values saved to Moodle, then there may be a problem with Moodle. Otherwise it's likely to be an issue with the SCO or the SCORM activity settings not giving you the functionality you need.

==SCORM and the Gradebook==
Please see [https://docs.moodle.org/en/SCORM_FAQ#My_SCORM_Module_doesn.27t_function_properly FAQ:My SCORM Module doesn't function properly] and [https://docs.moodle.org/en/SCORM_FAQ#Handling_of_Multiple_Attempts FAQ:Handling of Multiple Attempts]

Some SCORM packages report both cmi.core.lesson_status and cmi.core.score.raw. Others report only cmi.core.lesson_status, or only cmi.core.score.raw. The '''Grading Method''' setting for SCORM objects is meant to account for that.

If you have the '''Grading Method''' set to '''Highest grade''', '''Average grade''', or '''Sum grade''', and your learning object does not report a score, only, cmi.core.lesson_status, then there will be no numerical score to pass to the gradebook.

If your SCOs do not report cmi.core.score.raw, then the best '''Grading Method''' setting is '''Learning Objects'''. This reports either a 1 or a 0 as a score for each learning object. The gradebook value for that SCORM activity is the percent of scos in the package for which learners got a 1.

On the other hand, if your SCOs do not report a lesson_status, then select one of the score-based '''Grading Method''' options, such as '''Highest grade''', '''Average grade''', or '''Sum grade''', and not '''Learning Objects'''.

If you do not know what your SCOs are reporting to the LMS, then run them through to completion with debugging on.

Much of the way SCORM objects are graded is controlled inside the SCORM Authoring process before it is packaged for use in an LMS like Moodle - make sure all your grading settings are set correctly.

==SCORM Administration Options==

See [[SCORM settings]]

==Common Solutions==

===Difficulty Displaying a SCORM Package===
If you have difficulty displaying a SCORM, try loading the SCORM in [http://www.reload.ac.uk Reload] and re-saving it, then save the folder as a .zip package and try again.

===Character Display Errors===
When you notice there is a problem displaying characters correctly, it could be a misconfiguration of your server. Make sure that both httpd.conf (when using Apache) and php.ini are set to DefaultCharacterset = utf8 or switch the sending of a default character set off.

===slash arguments warning when I add/update SCORM objects in my course===
Some web servers don't support a function called '''slash arguments''' and so Moodle allows you to turn it off, but SCORM packages require '''slash arguments''' to be enabled on the web server in order to work properly.

See [[Using slash arguments]] for more details.

===SCORM doesn't work on Godaddy Host===
Godaddy hosts give a 404 file not found error - this is because by default they do not allow slash arguments which SCORM requires. The best way to test this is to visit http://yourmoodlesite/admin/tool/health/index.php - but the fix involves adding a php.ini or php5.ini file with the following text:
AcceptPathInfo
cgi.fix_pathinfo=1

===My Flash-Based Content Loads, then Stalls===
This issue is most commonly associated with zlib compression. Classic presentation is that the base HTML file and SWF are loaded into the SCORM player, but the SWF is not able to load any audio or video assets, and therefore stalls. You can watch the loading of SWFs and assets using Chrome's Developer Tools or other.

Check your site's zlib compression settings as an admin by loading up the Server > phpinfo page. zlib compression is not a Moodle setting but a server setting, so you'll need a server admin to disable it. Be sure to Purge All Caches, and clear browser caches, before confirming the change.

===Zlib warning when I add/update SCORM objects in my course===
Zlib is a php compression setting made in a websites PHP configuration - unfortunately some browsers don't handle this well (especially Internet Explorer 6) Some webhosts enable this setting, but it will likely cause issues for your users when they attempt to view/use the SCORM object. You will need to contact your server administrator to turn this off. The setting to change in php configuration is "zlib.output_compression"

===Incorrect file package - missing imsmanifest.xml or AICC structure===
This means that Moodle cannot find a file called imsmanifest.xml inside the SCORM object. Reasons for this could be:
* imsmanifest.xml needs to be immediately inside the scorm directory, NOT inside a directory inside of that. So if the zipped scorm package is package.zip, the unzipped package directory should contain immediately inside of it the imsmanifest.xml. This is a common mistake and normally occurs when a SCORM author creates a package themselves and then selects that folder to compress. This places the content folder inside of another folder, The imsmanifest.xml is there, but it is 2 directories deep. To avoid this problem when zipping scorm content into a package, go INSIDE of the exported scorm folder, select all files inside, and compress them while all are selected. The resultant compressed directory has the imsmanifest.xml file in the first directory, immediately available to the moodle scorm loading process.
* when using linux based systems the filename imsmanifest.xml must be all in lowercase not IMSmanifest.xml or Imsmanifest.XML
* The SCORM authoring tool Articulate sometimes fails to create the imsmanifest.xml -Try exporting the package again and see if the manifest is generated.
* The SCORM authoring tool Articulate Presenter will publish packages where the imsmanifest.xml file is in the correct place, but there are several lines of white space in the manifest file if you do not fill out the Reporting and Tracking Options in Articulate Presenter for Keywords and LMS Description. Moodle will give a "Manifest not found" error when encountering this. To fix this problem select the Reporting and Tracking Options in the Articulate Presenter publish dialog and fill in the LMS Description and Keywords.

===File not found error===
You have this error if the scorm package is created in moodle, and the scorm menu loads, but inside of the viewing area for the scorm content, you get a page with a 404 file not found error, usually showing the current Moodle theme.

What this means is that one of the files listed in the imsmanifest.xml is not in the scorm package or not in the correct directory.

Download and unzip the package, open up imsmanifest.xml. At the bottom of the xml file, below any metadata, you'll find a place where organizations and resources for those organizations are designated:

<code xml>

<organizations default="TOC1">
<organization identifier="TOC1">
<title>SCORM Test</title>
<item identifier="I_SCO0" identifierref="SCO0">
<title>Library Quiz</title>
<adlcp:masteryscore>0</adlcp:masteryscore>
</item>
</organization>
</organizations>
<resources>
<resource identifier="SCO0" type="webcontent" adlcp:scormtype="sco" href="scorm.html">
<file href="scorm.html"/>
<dependency identifierref="ALLRESOURCES" />
</resource>
<resource identifier="ALLRESOURCES" type="webcontent" adlcp:scormtype="asset">
<file href="scorm.html" />
<file href="scorm.js" />
<file href="swfobject.js" />
<file href="scorm.swf" />
<file href="scormwrapper.js" />
</resource>
</resources>
</manifest>
</code>

In this xml, we have a single organization, and in that organization is a single resource, a single sco. There are 5 files necessary for that resource to work correctly. The scorm.html file is loaded first. It loads 3 external js files and a swf.

What you need to do now is go to the directory containing imsmanifest.xml, and check that all of those listed files are available at the correct path from imsmanfiest.xml, as listed in imsmanifest.xml. If any one of those files is missing (especially the html file or the swf), or if the paths in imsmanifest.xml are incorrect, then it's very likely that the scorm object won't be able to load at all.

Sometimes the files aren't missing, but are simply misnamed in the manifest, or placed in the wrong directory. You can fix this by moving the files to the correct places, or updating their names so that the imsmanifest and the actual file names match up. In the case of a misnamed file, change the manifest rather than the actual file names, since the the files also reference one another in other places!

===Unzip issues===
If you get a blank page after filling in the title, description, and selecting a large SCORM file, it's likely you haven't installed the PHP-zip lib which is required for Moodle 2.x for more info see [[admin/environment/php_extension/zip]]

===Clear an Attempt===
To clear attempts by a student:

# Go to the SCORM activity and select the link "View reports for x users"
# Select the attempt or attempts you want to clear using the checkbox
# Select Delete in the drop-down box at the bottom of the page

===Handling of Multiple Attempts===
SCORM is designed to allow a learner to exit and return at a later date to the same point they left from. This means that each time they enter the SCORM they are using the same single attempt. Some SCORM packages are intelligent about handling re-entry, many are not. What this means is that if the learner re-enters an existing attempt, if the SCORM content does not have internal logic to avoid overwriting cmi.core.lesson_status and cmi.core.score.raw, they can be overwritten by a lower score, confusing the learner.

When a SCORM sets the cmi.core.lesson_status value to 'completed', 'passed' or 'failed' then Moodle allows the user to create a new attempt by adding a '''Start new attempt''' checkbox to the entry page. If cmi.core.lesson_status is set to 'incomplete', 'browsed' or 'notattempted' the learner can only re-enter the existing attempt. If you are using the setting 'Student skip content structure page', this checkbox will never be shown to the user.

Moodle provides a range of settings to allow this to be controlled, some of these settings are hidden by default as advanced options.
* Number of attempts
:This allows the teacher to set how many SCORM attempts the learner may create - this is not how many times a learner can re-enter a SCORM attempt.
* Attempts grading
:This allows the teacher to set how multiple SCORM attempts(not re-entries) are graded. It is important to note that a 'failed' cmi.core_lesson_status allows a new attempt to be generated but the attempts grading setting "last completed attempt" only includes 'completed' and 'passed' values in it's calculations.
* Display attempt status
:This displays a users SCORM attempts and how their final grade is calculated on the SCORM entry page and the My Moodle page for the learner.
* Force completed
:This is a setting that can be used to force a SCORM package to report a 'completed' cmi.core.lesson_status if it doesn't currently set the value.
* Force new attempt
:This hides the '''Start new attempt''' checkbox and will force a new attempt if the previous attempt has cmi.core.lesson_status value to 'completed', 'passed' or 'failed' - this setting can also be used to make sure a new attempt is generated when the 'Student skip content structure page' setting is used.
* Lock after final attempt
:This prevents access to the SCORM after the total number of attempts have been used - if this is not set the learner can re-enter their last attempt and potentially change/overwrite their score each time depending on how the SCORM package supports multiple re-entries.

===Reducing Load Time with Captivate===
* Modify the percent that must be downloaded before the content starts to play. In Captivate 4, there's a setting in: Preferences / Project / Start and End / Preload. Reduce that to 50%.
* If you use audio in your Cp file (as background or element attachment), try to put a gap of 0,1 second at the beginning of each element including audio on your slides. If you don't do that, Cp merge all the audio files in one big audio file it need to download before playing the project. This problem have been report many times from the Cp community.

===Moodle changes cmi.core.lesson_status from "completed" or "passed" to "failed"===
Many SCORM authorware suites generate a masteryscore node in the imsmanifest.xml by default. This node is not necessary to the XML file. But when it is there, the SCORM standard designates specific behaviour with regard to the value set there.

This can also be controlled in Moodle using the setting "Mastery score overrides status" If this setting is enabled and a mastery score is provided within your package, when LMSFinish is called and a raw score has been set, if the raw score is lower than the mastery score, the lesson status will be overridden and set to "failed"

Here's what is in the scorm standard, on page 35 of 155 in SCORM_1.2_ConformanceReq.pdf, numbered page 2-19 ([http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201%2e2%2fDocumentation%20Suite%20%28SCORM%201%2e2%29&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View=%7b4D6DFFDE%2d3CFC%2d4DD9%2dA21A%2d4B687728824A%7d SCORM Version 1.2 Conformance Requirements Version 1.2]):
<blockquote>
If the value for this element is not set to “incomplete” by the SCO, then the LMS shall re-evaluate and change the value based on the following:<ul>
<li>If there is no mastery score in the Manifest, and the SCO sets a score (cmi.core.score.raw) and the lesson_status (cmi.core.lesson_status) then the LMS shall not override the SCO determined status.</li>
<li>If there is a mastery score in the Manifest, the LMS can change the status to either passed or failed depending on the student's score (cmi.core.score.raw) compared to the mastery score.</li>
<li>If the student is taking the SCO for no-credit, (cmi.core.credit = “no-credit”) there is no change to the lesson_status, with one exception. If the lesson_mode (cmi.core.lesson_mode) is "browse", the lesson_status may change to "browsed" even if the cmi.core.credit is set to no-credit.</li>
</ul>
</blockquote>
This can result in some functionality you don't intend. You can fix the problem by removing the mastery score node from your imsmanifest.xml file or by adjusting the Moodle setting "Mastery score overrides status". You may also want to find out what options you have, within your authorware suite, for the writing of that node into the manifest file, and change your authoring process accordingly.

The Rustici SCORM Cloud default operating behaviour for masteryscore is different from Moodle's default operating behaviour - you can see a little bit of the history around the way Rustici handle this here: http://scorm.com/blog/2010/09/anatomy-of-scorm-minutiae-mistake/

===Player Look 'n Feel===
You should be able to adjust height and width settings for the SCORM player window '''so long as''' your theme is based on/not too much of an aberration from one of the standard themes which ship with Moodle 2.

If your site or course theme isn't closely based on one of the standard M2 themes, then it's possible that your theme CSS is overriding local height and width settings for the SCORM player. Have a Web developer (or a Moodle Partner) examine how your theme is interacting with the player layout, and make changes to your theme as needed.

'''Why can't I just change it locally?''' You can change height and width per individual SCORM package, and you can set defaults for these local height and width values ( [[SCORM Admin Options]] ). Other things, such as colors, shading, borders, backgrounds, are controlled by CSS, just like everything else on the site.

=== Courselab 2.4 ===
If you receive a " found more than one record!" error when trying to run your SCORM 1.2 package check the imsmanifest.xml file of your SCORM package and ensure that the values for <organization identifier> and <item identifier> are unique. To change the <organization identifier>, in Courselab, go to File > Course Runtime Settings. The dialog says 'Course identification in LMS' but changing the Identifier field is what sets the <organization identifier>. (see MDL-38060 for more information)

=== SCORM results deleted after package update ===

When uploading a SCORM package over a previous one, if the item identifier in the manifest file is different to the one being overwritten then the tracking data for that SCORM package in Moodle is deleted.

Ensure the item identifier is the same for the new SCORM resource

===Problems with responsiveness===

Sometimes SCORMs fail on responsiveness or the ability to scroll on mobile devices

*Moodle uses iFrames for deploying SCORM. https://community.adaptlearning.org/mod/forum/discuss.php?d=180#p863
*There can be some problems with this as they are not responsive in iOS https://community.adaptlearning.org/mod/forum/discuss.php?d=1446#p6687
*There are some potential work arounds.
#Totara has a new window. #https://community.adaptlearning.org/mod/forum/discuss.php?d=851#p3968
#This comment https://community.adaptlearning.org/mod/forum/discuss.php?d=787#p3661
#Solutions for Adapt: https://github.com/adaptlearning/adapt_framework/issues/210
*The tracker:
#https://tracker.moodle.org/browse/MDL-47500 problems with pages.
#https://tracker.moodle.org/browse/MDL-46563
#https://tracker.moodle.org/browse/MDL-50401
*Why iFrames fail with iOS, one person's view: https://community.adaptlearning.org/mod/forum/discuss.php?d=926#p4714

This seems to be a problem that lies between the browsers (eg faults in iOS) the creation of the SCORM package and the LMS (in this case the iFrames in Moodle).

One quite comprehensive idea for a work around is here: https://community.adaptlearning.org/mod/forum/discuss.php?d=180 but there is really no evidence at the moment of a nicer solution.

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?id=1951 SCORM forum]
* [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle SCORM doesn't work] blog post from developer Dan Marsden
* [http://danmarsden.com/blog/2009/05/23/scorm-2004-in-moodle/ SCORM 2004 in Moodle] blog post from developer Dan Marsden
* [https://moodle.org/mod/forum/discuss.php?d=276324 Identifiers to change with updated SCORM module]
* [https://docs.moodle.org/dev/SCORM_schema Internal SCORM Schema]
* The official standard: [http://www.adlnet.gov/Technologies/scorm/default.aspx Advanced Distributed Learning - SCORM]

Online resources
* [http://www.scormcourse.com/ SCORMCourse.com] serves the SCORM and ADL community as an educational resource for SCORM technology.
* [http://www.eduworks.com/index.php/Publications/Learning-Object-Tutorial.html Learning Object Tutorial]
* [http://elearningweekly.wordpress.com/2007/04/12/tutorial-build-scorm-compatible-lesson-templates-for-your-lms/ Tutorial: Build SCORM-Compatible Lesson Templates for Your LMS]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=3757 Simple introduction to SCORM]
*[http://moodle.org/mod/forum/discuss.php?d=57059 Are there any sugestions for scorm authoring with Microsoft word / or any other easy (maybe free) scorm authoring tool?]
*[http://moodle.org/mod/forum/discuss.php?d=95946 Is SCORM worth it?]
*[http://moodle.org/mod/forum/discuss.php?d=207964 Updating an Object]

[[Category:FAQ]]
[[de:Lernpaket FAQ]]

SCORM settings

2016-11-06T20:51:34Z

Danmarsden: /* Other Important Settings */ add details of actual limit on data when in standards mode off.

{{SCORM}}
==Adding a SCORM package==

First - make sure you have created a course (see: [[Adding_a_new_course#Adding_a_course|Adding_a_course]])

Quick method: (''Note - does not work with versions of Internet Explorer earlier than IE10'')
# Click the 'Turn editing on' button at the top right of the course page
# Drag and drop the SCORM package zip file onto the course section where you'd like it to appear
# Answer 'Add a SCORM package' to the popup dialogue asking what you want to do with the zip file then click the upload button
# If necessary, edit the title of the file by clicking the pencil icon, or edit other options (see below) by clicking the editing icon

Note: It is currently not yet possible to add AICC packages using the quick method.

Longer method:
# Click the 'Turn editing on' button at the top right of the course page
# Click the 'Add an activity or resource' link in the section you wish to add your SCORM package, then in the activity chooser, select SCORM package then click the Add button (or select 'SCORM package' from the 'Add an activity' dropdown menu)
# Enter a name and a description (which may be required or optional according to the admin settings)
# Either drag and drop a SCORM package zip file into the box with an arrow or click the Add button to open the [[File picker]] menu in order to choose a file from your computer or a repository
# Select display and other options as required (see below)
# Click the button 'Save and display' at the bottom of the page

You can edit or update the SCORM package later by clicking on the edit icon (usually a hand/pen) or by clicking on its name and then ''Settings > SCORM/AICC administration > Edit settings''.

Note: Moodle '''does not''' generate SCORM content. Moodle presents the content in SCORM packages to learners, and saves data from learner interactions with the SCORM package. See [[Tools for creating SCORM content]]

==Course settings==

===General===
{|
|[[File:scormgeneralsettings.png|thumb|430px|General settings expanded by default]]
|}
====Name====
Whatever you type here will form the link learners click on to access the SCORM package, so it is helpful to give it a name that suggests its purpose.
====Description====
Add a description of your SCORM activity here. Click "Show editing tools" to display the rich text editor, and drag the bottom right of the text box out to expand it.
====Display description on the course page====
If this box is ticked, the description will appear on the course page just below the name of the SCORM activity.

===Package===
This setting determines which SCORM package is used by this SCORM activity. Drag and drop or click the icon top left to upload your SCORM package. (Note that you must not unzip the package before upload.)The default (1) is to be able to upload a file. If your admin has added additional options in ''Site administration>Plugins>Activity modules>SCORM package'' then these will be available in a dropdown menu. (2)
{|
|[[File:scormpackage.png|thumb|443px|Package settings expanded by default]]
|}

====Alias/Shortcut====
If you access your SCORM package from a repository (such as [[File system repository]] or [[Private files]]) you can choose to create an alias/shortcut to it and then set an update frequency to set how often Moodle should check to see if there is an updated zip. (See [[Working with files]] for more information on setting an alias/shortcut.)

====Selecting an imsmanifest.xml====

It it possible to select the imsmanifest.xml file and have it as an alias/shortcut. To do this, you need to have created a [[File system repository]] and, when configuring it, allowed relative files. Extract your SCORM package into a folder there. When clicking on the Add button to add your SCORM package, select the file system repository folder with your SCORM package and browse for and select the imsmanfest.xml file, ensuring you the option to create an alias/shortcut to the file. Save and display. (Note this method is only currently supported by the File system repository.)

For more information with screenshots, see Dan Marsden's [http://danmarsden.com/blog/2013/09/24/managing-scorm-content-in-moodle-2-6/ blog post on Managing SCORM content]

Note: The settings (''Type'', ''URL'' and ''Auto-update frequency'') are only available when configured globally. See '''Admin settings''' below.

===Appearance===
(These settings are collapsed by default)
{|
|[[File:26scormappearance.png|thumb|450px|Appearance settings expanded]]
|}

====Display package====
Choose from current or new window. Note that if you choose a new window, students need to ensure pop ups are enabled.
====Display course structure on entry page====
If this is enabled then the table of contents of the package will be displayed when the students clicks to access the package.
====Show Navigation====
This setting determines whether the navigation buttons are shown or not.
#No -they are hidden
#Under content - they are displayed underneath the SCORM package
#Floating - the navigation buttons are floating (with options to choose the position from the left and top)

====Display attempt status====
You can choose whether to display a summary of the student's attempts on the entry page, on their [[Dashboard]] page or both. This setting is helpful when debugging grading issues - working out why a user got a certain grade.

''The following settings become visible when "Show more" is clicked:''

====Width====
Stage size width as a css value, either % or pixels. Default is 100%. You can change to a different percentage by putting a % symbol after the number (ex. 80%). You can also set to a pixels value by entering a number higher than 100 (ex. 800).
====Height====
Stage size height as a css value, either % or pixels. Default is 500 pixels. You can change to a percentage by putting a % symbol after the number (ex. 80%). You can also set to a pixels value by entering a number higher than 100 (ex. 800).

====Options====
There is a series of check boxes for:Allow the window to be resized ad scrolled, displaying directory links, location bar, menu bar, toolbar and/or status.
*'''Student skip content structure page''' - never, first access, always
*'''Disable preview mode''' - If this option is set to Yes, the Preview button in the view page of a SCORM/AICC Package activity will be hidden. The student can choose to preview (browse mode) the activity or attempt it in the normal mode. When a Learning Object is completed in preview (browse) mode, it's marked with browsed icon
*'''Display course structure in player'''

===Availability===
(These settings are collapsed by default.)
{|
|[[File:scormavailability25.png|thumb|470px|Availability settings expanded]]
|}
Choose here the dates you wish the SCORM package to be available to students.

===Grade===
(These settings are collapsed by default)
{|
|[[File:scormgrading.png|thumb|339px|Grade settings expanded]]
|}

====Grading method====
** Learning Objects - This mode shows the number of completed/passed Learning Objects for the activity. The max value is the number of Package's Learning Objects. ''Tip:'' If your SCORM package does report cmi.core.lesson_status, and does not report cmi.core.score.raw, then you should use this setting.
** Highest grade - The grade page will display the highest score obtained by users in all passed Learning Objects. ''Tip:'' If your SCORM package does report cmi.core.score.raw, and does not report cmi.core.lesson_status, then you should use this setting, Average grade, or Sum grade.
** Average grade - If you choose this mode Moodle will calculate the average of all scores.
**Sum grade - With this mode all the scores will be added.
====Maximum grade====
Not applicable if Grading Method is Learning objects. Usual setting is 100. If your SCO 's high score is something other than 100, you should adjust this value appropriately. When grading Method is one of the score settings, then the gradebook grade is package score divided by this number.

===Attempts management===
(These settings are collapsed by default.)
{|
|[[File:scormattempts.png|thumb|416px|Attempts management screen expanded]]
|}
====Number of attempts====
Defines the number of attempts permitted to users. It works only with SCORM 1.2 and AICC packages. SCORM2004 has its own max attempts definition.
** The option to start a new attempt is provided by a checkbox above the '''Enter''' button on the content structure page, so be sure you're providing access to that page if you want to allow more than one attempt.
** An attempt is not complete until the cmi.core.lesson_status for the attempt is set to either 'completed' or 'passed'. After that, the '''Start new attempt''' checkbox is available to the learner.
====Attempts grading====
When you permit multiple attempts for students, you can choose how to record the result in gradebook by first, last, average or highest settings.
* '''Display attempt status''' - If enabled, scores and grades for attempts are displayed on the SCORM outline page. This setting makes the block display more info to the user on the entry page to the SCORM and in the course overview block - if you turn it off it will display less info. This setting is helpful when debugging grading issues - working out why a user got a certain grade.

====Force new attempt====
If this is enabled then every time the student accesses the package, it will count as a new attempt.
====Lock after final attempt====
If this is enabled then once a student has used up all their attempts, they can no longer access the SCORM package.

===Compatibility settings===
(These settings are collapsed by default.)
{|
|[[File:scormcompat.png|thumb|273px|Compatibility settings expanded]]
|}
====Auto-Continue====
For SCORM packages that contain multiple learning objects (or SCO's) and Auto-continue is set to Yes, when a Learning Object calls the "close communication" method the next available object is launched automatically.If it is set to No, the users must use the navigation provided to continue to the next object. Many SCORM packages only contain a single learning object (or SCO) so this setting does not apply.
:''TIP:'' If your package contains multiple branches Auto-Continue will only move from one object to the next within the same topic.

====Force completed====
If this is enabled then the status of the current attempt is set to "complete". Note that this only applies to SCORM 1.2 packages and is useful if the SCORM package does not handle revisiting an attempt correctly, in review or browse mode, or otherwise incorrectly issues the completion status.

====Auto commit====
Some SCORM packages don't explicitly call Commit() regularly for whatever reason so progress is not stored in the database. This patch will Commit() the data from the SCORM package 60 seconds after the values are set, unless the package Commit()s sooner.

====Mastery score overrides status====
{{New features}}If this setting is enabled and a mastery score is provided within your package, when LMSFinish is called and a raw score has been set, if the raw score is lower than the mastery score, the lesson status will be overridden and set to "failed". More information on this behaviour is available in the [[SCORM_FAQ#Moodle_changes_cmi.core.lesson_status_from_.22completed.22_or_.22passed.22_to_.22failed.22|SCORM FAQ:Moodle changes cmi.core.lesson_status from completed or passed to failed]]

===Common module settings===

{{New features}}Group mode and groupings settings are available for SCORM packages in Moodle 3.1 onwards. This means that

* A SCORM package can be restricted to a particular [[Groupings|grouping]]
* SCORM reports may be filtered by group
[[File:scorm reports visible groups.png|thumb|SCORM report filtering by group]]
See [[Common module settings]] for more information.

===Restrict access===

These settings will be available if [[Conditional activities]] are enabled.

===Activity completion settings===

If this has been enabled for the course, then SCORM completion may be set based on minimum score or status (e.g. "Passed").

[[File:scormscore1.png]]

===Save settings===

As in most activities there are 3 save button choices. '''Cancel''', '''Save and return to course''' and '''Save changes''' buttons. The Save changes button will take the teacher back to the SCORM "stage" page.

==Site administration settings==

These options are available to the site admin via ''Site administration > Plugins > Activity Modules > SCORM Package''.

===Default Value Settings===
Many of the settings available in the SCORM Package administration simply set the default value for the SCORM activity module setup options provided within courses. Edit these settings to save yourself time when adding large numbers of packages, or to establish a standard for presentation across the site.

===Other Important Settings===
The following options provided which '''do not''' simply set a default value for the SCORM activity editing page view.
; Auto-update frequency
If not using a standard SCORM package uploaded using the filepicker and the SCORM package is hosted outside your Moodle installation the option to auto-update the package will be available - you can elect to have the package updated on every entry to the package or daily via the Moodle cron.
;Synchronization time

;Enable SCORM 1.2 standard mode
:If this setting is disabled, then it will be possible to exceed the allowed amount of stored data for SCORM 1.2 packages. Many SCORM packages go over the 4096 characters limit and while SCORM 2004 allows a higher number of characters, it is not supported. This setting will mean users can allow their 1.2 packages to store more data. When disabled it extends the items restricted to 256 and 4096 by the SCORM 1.2 spec to 64000 (the highest value allowed in the SCORM 2004 spec)
;Enable external package type
:If selected, presents a text field to paste a URL to a remote imsmanifest.xml (in an unzipped remote SCORM package), as well as the file picker option provided by default. Note that the content is played from the designated location, and not unpacked into the Moodle file system. So if the base url is different from your moodle url then browser security will block cross-domain communcation and no grades/tracking information will be passed back to Moodle.
;Enable downloaded package type
:If selected, presents a text field to paste a URL to a remote package.zip SCORM package. Package is downloaded and unzipped into the Moodle file system.
;Enable IMS package type
:Enables a package to be selected from within an IMS repository
;Force users to enable JavaScript
:Since the SCORM API uses JavaScript to save data to Moodle, this is a great idea!
;Activate API debug and tracing (set the capture mask with apidebugmask)
:Turns on debugging for SCORM activities. In Moodle 2 you no longer have to also turn on debugging in the developer options.
;API debug capture mask
:.* will debug for admin user only: You can use the mask to enable debugging under certain conditions. For example, if you are logged in using the admin user (username admin) you can set the api mask to: '''admin.*''' Users not logged in as admin will not see the debugging log. The "Default" api mask is '''.*''' which translates roughly to '''everybody'''.
;Enable direct AICC url
:Makes it easier to connect to externally hosted AICC content as the teacher doesn't have to create an AICC package and is able to link directly to the external AICC url.
;Enable external AICC HACP
:The SCORM activity can also support external AICC HACP Communication where the AICC package is hosted on an external content providers site and passes back http requests directly from the external server instead of within the users web browser session - this is disabled by default.
;AICC pass numeric user id

; Protect package downloads.
:This is disabled by default, meaning packages can always be downloaded (eg for offline mobile use.) If this is enabled then only users with the capability course:manageactivities can download the package.

==See also==

* [[:dev:SCORM_schema |SCORM Schema]] for developers

[[de:Lernpaket konfigurieren]]
[[fr:Ajouter/modifier un SCORM]]
[[ja:SCORMを追加/編集する]]
[[es:Configuraciones del SCORM]]

SCORM FAQ

2016-08-03T22:11:16Z

Danmarsden: /* Moodle changes cmi.core.lesson_status from "completed" or "passed" to "failed" */

{{SCORM}}
==What is SCORM?==

SCORM was developed as a result of collaboration in the public and private sectors. The President of the United States, Bill Clinton issued an Executive Order that created an agency (ADL) to oversee the standard for developing and distributing online learning. All Federal agencies are mandated to use programs that meet those standards. SCORM is one result of that order.

There's a really simple "What is SCORM" introduction here: http://moodle.org/mod/forum/discuss.php?d=3757#p18828

A slightly more detailed introduction here: http://www.rusticisoftware.com/resources/whatisscorm/What%20Is%20SCORM.ht

==Should I make my Moodle courses as SCORM or use Moodle's features?==
It depends how you intend to use it. If you are planning on exporting and using in another LMS then SCORM would make this easier. If you want something shiny, then a SCORM package can fit the bill. However, reporting and grading work better in Moodle and for many educators the standard features do the job perfectly and do not require learning a new program. There is a useful form post discussing the pros and cons of SCORM in Moodle here: http://moodle.org/mod/forum/discuss.php?d=200242

==SCORM Information==

Advanced Distributed Learning (ADL) is the organization that wrote the SCORM standard. You can download documentation and samples form ADL's Web site. Documentation for SCORM 1.2 in several languages is available [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2%2fDocumentation%20Suite%20(SCORM%201.2)&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} here].

Philip Hutchison provides an AS3 and JavaScript wrapper, as well as a sample package:
http://pipwerks.com/downloads/

==SCORM Package Contents==

A SCORM package must contains in the root of zip a file named imsmanifest.xml which defines SCORM course structure, resource location and many other things. Other files used in the package, such as HTML files, XML files, multimedia files, and JavaScript for the SCORM API must be listed in this file. The LMS parses the manifest, and provides the files listed there to the content package during runtime.

==AICC Package Contents==

An AICC package is defined by several files (from 4 to 7) with defined extensions as follows:

* CRS - Course Description file (mandatory)
* AU - Assignable Unit file (mandatory)
* DES - Descriptor file (mandatory)
* CST - Course Structure file (mandatory)
* ORE - Objective Relationship file (optional)
* PRE - Prerequisites file (optional)
* CMP - Completition Requirements file (optional)

==Basic Troubleshooting==

* Make sure you are running Moodle 2.1 or higher, a large number of SCORM related bugs are present in previous versions.
*Make sure you (and your users) have JavaScript enabled. SCORM requires JavaScript.
* Make sure your SCORM object is SCORM compliant - check it in an external SCORM player like [https://docs.moodle.org/en/Tools_for_creating_SCORM_content#Reload Reload] to see if it works there.
* Upload a copy of your SCORM object to a [http://en.wikipedia.org/wiki/File_hosting_service File Hosting Service] and post a message asking for help in the forums, linking to your SCORM object explaining exactly what you expect to happen, and what is happening instead.
* Read Dan Marsden's blog post [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle here] (Maintainer of SCORM Module in Moodle)

==Does Moodle Generate SCORM Content?==

Moodle '''does not''' generate scorm content. Moodle presents the content in SCORM packages to learners, and saves data from learner interactions with the SCORM package.

==Can I add a password for access to my SCORM package?==
No, although there is a tracker request for this: MDL-46403 As a workaround you could add your SCORM package using the single activity course format - see [[Course formats]] - and add an enrolment key to the course.

==Supported Versions==

* SCORM 1.2 is supported in Moodle 2.1(or higher) and passes all the tests in the ADL Conformance test suite 1.2.7 for SCORM 1.2. The best place for information on SCORM 1.2 conformance is the [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Previous%20Versions/SCORM%201.2/Conformance%20Test%20Suite%20(SCORM%201.2)/SCORM_1.2_ConformanceReq.pdf SCORM Comformance Requirements documentation (PDF 3.4MB)].

* SCORM 2004 is not supported in Moodle. Parts of the API have been implemented, but others such as Navigation and Sequencing have not. Development on native SCORM 2004 support in Moodle [https://moodle.org/mod/forum/discuss.php?d=227906 has stopped]. If you require a fully certified SCORM 2004 Player in Moodle, [http://www.scorm.com Rustici Software] have a [http://support.scorm.com/entries/20394726-scorm-cloud-moodle-module Moodle plugin] which connects to their commercial [http://www.scorm.com/scorm-solved/scorm-cloud/ SCORM Cloud] service turning Moodle into a fully compliant SCORM 2004 LMS.

* AICC objects are supported in Moodle 2.1 and higher.

* Moodle does not support Tin Can at this stage.

==Asking for Help in the SCORM Forum==

When trying to engage the community to help with a problem you are facing, you will get a better response if you follow a few simple guidelines:
* Always start your report with '''version information''' - preferably the information displayed on the Admin -> Environment panel eg. http://localhost/moodle/admin/environment.php where http://localhost/moodle is your particular prefix. With this it will be clear how you are running your Moodle instance, on what platform, and at which version. This will quickly expose issues where a simple upgrade will solve your problem.
* Be prepared to '''provide the SCORM package''' that illustrates your problem - if you don't then it will be very difficult for anyone offering assistance to recreate your situation - a real barrier to help.
* '''Screenshots''' are very helpful. Provide a screenshot of all error messages, and any instance where something seems to go wrong in the interface.
* Nonstandard themes can introduce SCORM issues. Be sure to tell us '''what theme you're using'''.
* If you have admin privileges, and have access to a localhost install or other place where real-time users won't be disturbed, be sure to turn on debugging. Navigate to '''Site Administration > Development > Debugging''' and set '''Debug messages: Developer''' and '''Display debug messages: Yes'''. Access the SCORM content. If there are errors printed to the page, include them in your forum post.
* Use [https://developers.google.com/chrome-developer-tools/docs/console Chrome's JavaScript Console] or [https://developer.mozilla.org/en-US/docs/Tools/Web_Console Firebug's JavaScript console] to check that there are no JavaScript errors on the page when the content loads.
* Run your problematic SCORM package through '''API debugging''' (see below) and include the text of that API log with your post. That way we can see right away if the right function calls are not taking place.
* If you're using a content development suite which publishes to SCORM, such as Articulate, Captivate, Lectora, LessonBuilder, Udutu, or some other product, then include that in your post. Every authoring software has its ticks, and if you've run into one, it's likely that someone else has also dealt with it, and will recognize it. However, please keep in mind that '''this is a place to get help with Moodle issues, not help with your SCORM package authoring suite'''.

==Debugging ==

# Debugging settings are located at Settings > Site Administration > Plugins > Activities > Scorm.
# Check the checkbox for '''Activate API debug...'''
# Set the api mask. You can use the mask to enable debugging under certain conditions. For example, if you are logged in using the admin user (username admin) you can set the api mask to: <cite>admin.*</cite> Users not logged in as admin will not see the debugging log. The "Default" api mask is <cite>.*</cite>

==What does the debugging log mean?==

The SCO commonly sends the following communications through the API:

* '''LMSInitialize();''' opens the connection between the SCO and Moodle
* '''LMSGetValue( 'valuename' );''' gets a value from Moodle
* '''LMSSetValue( 'valuename' , 'value' );''' sends a value to Moodle
* '''LMSCommit();''' saves values sent to Moodle via LMSSetValue() and should be called after every LMSSetValue()
* '''LMSFinish()''' saves values sent to Moodle and closes the connection between the SCO And Moodle

Red lines in the debugging log means there was an error in the communication through the API.

If LMSInitialize() fails, returns an error, then no subsequent values sent to Moodle will be saved.

Click through the entire SCORM package. Then access the scorm report for your attempt, and compare the saved values in the debugging log with Moodle's report of the attempt. If the values set in the debug log do not match the values saved to Moodle, then there may be a problem with Moodle. Otherwise it's likely to be an issue with the SCO or the SCORM activity settings not giving you the functionality you need.

==SCORM and the Gradebook==
Please see [https://docs.moodle.org/en/SCORM_FAQ#My_SCORM_Module_doesn.27t_function_properly FAQ:My SCORM Module doesn't function properly] and [https://docs.moodle.org/en/SCORM_FAQ#Handling_of_Multiple_Attempts FAQ:Handling of Multiple Attempts]

Some SCORM packages report both cmi.core.lesson_status and cmi.core.score.raw. Others report only cmi.core.lesson_status, or only cmi.core.score.raw. The '''Grading Method''' setting for SCORM objects is meant to account for that.

If you have the '''Grading Method''' set to '''Highest grade''', '''Average grade''', or '''Sum grade''', and your learning object does not report a score, only, cmi.core.lesson_status, then there will be no numerical score to pass to the gradebook.

If your SCOs do not report cmi.core.score.raw, then the best '''Grading Method''' setting is '''Learning Objects'''. This reports either a 1 or a 0 as a score for each learning object. The gradebook value for that SCORM activity is the percent of scos in the package for which learners got a 1.

On the other hand, if your SCOs do not report a lesson_status, then select one of the score-based '''Grading Method''' options, such as '''Highest grade''', '''Average grade''', or '''Sum grade''', and not '''Learning Objects'''.

If you do not know what your SCOs are reporting to the LMS, then run them through to completion with debugging on.

Much of the way SCORM objects are graded is controlled inside the SCORM Authoring process before it is packaged for use in an LMS like Moodle - make sure all your grading settings are set correctly.

==SCORM Administration Options==

See [[SCORM settings]]

==Common Solutions==

===Difficulty Displaying a SCORM Package===
If you have difficulty displaying a SCORM, try loading the SCORM in [http://www.reload.ac.uk Reload] and re-saving it, then save the folder as a .zip package and try again.

===Character Display Errors===
When you notice there is a problem displaying characters correctly, it could be a misconfiguration of your server. Make sure that both httpd.conf (when using Apache) and php.ini are set to DefaultCharacterset = utf8 or switch the sending of a default character set off.

===slash arguments warning when I add/update SCORM objects in my course===
Some web servers don't support a function called '''slash arguments''' and so Moodle allows you to turn it off, but SCORM packages require '''slash arguments''' to be enabled on the web server in order to work properly.

See [[Using slash arguments]] for more details.

===SCORM doesn't work on Godaddy Host===
Godaddy hosts give a 404 file not found error - this is because by default they do not allow slash arguments which SCORM requires. The best way to test this is to visit http://yourmoodlesite/admin/tool/health/index.php - but the fix involves adding a php.ini or php5.ini file with the following text:
AcceptPathInfo
cgi.fix_pathinfo=1

===My Flash-Based Content Loads, then Stalls===
This issue is most commonly associated with zlib compression. Classic presentation is that the base HTML file and SWF are loaded into the SCORM player, but the SWF is not able to load any audio or video assets, and therefore stalls. You can watch the loading of SWFs and assets using Chrome's Developer Tools or other.

Check your site's zlib compression settings as an admin by loading up the Server > phpinfo page. zlib compression is not a Moodle setting but a server setting, so you'll need a server admin to disable it. Be sure to Purge All Caches, and clear browser caches, before confirming the change.

===Zlib warning when I add/update SCORM objects in my course===
Zlib is a php compression setting made in a websites PHP configuration - unfortunately some browsers don't handle this well (especially Internet Explorer 6) Some webhosts enable this setting, but it will likely cause issues for your users when they attempt to view/use the SCORM object. You will need to contact your server administrator to turn this off. The setting to change in php configuration is "zlib.output_compression"

===Incorrect file package - missing imsmanifest.xml or AICC structure===
This means that Moodle cannot find a file called imsmanifest.xml inside the SCORM object. Reasons for this could be:
* imsmanifest.xml needs to be immediately inside the scorm directory, NOT inside a directory inside of that. So if the zipped scorm package is package.zip, the unzipped package directory should contain immediately inside of it the imsmanifest.xml. This is a common mistake and normally occurs when a SCORM author creates a package themselves and then selects that folder to compress. This places the content folder inside of another folder, The imsmanifest.xml is there, but it is 2 directories deep. To avoid this problem when zipping scorm content into a package, go INSIDE of the exported scorm folder, select all files inside, and compress them while all are selected. The resultant compressed directory has the imsmanifest.xml file in the first directory, immediately available to the moodle scorm loading process.
* when using linux based systems the filename imsmanifest.xml must be all in lowercase not IMSmanifest.xml or Imsmanifest.XML
* The SCORM authoring tool Articulate sometimes fails to create the imsmanifest.xml -Try exporting the package again and see if the manifest is generated.
* The SCORM authoring tool Articulate Presenter will publish packages where the imsmanifest.xml file is in the correct place, but there are several lines of white space in the manifest file if you do not fill out the Reporting and Tracking Options in Articulate Presenter for Keywords and LMS Description. Moodle will give a "Manifest not found" error when encountering this. To fix this problem select the Reporting and Tracking Options in the Articulate Presenter publish dialog and fill in the LMS Description and Keywords.

===File not found error===
You have this error if the scorm package is created in moodle, and the scorm menu loads, but inside of the viewing area for the scorm content, you get a page with a 404 file not found error, usually showing the current Moodle theme.

What this means is that one of the files listed in the imsmanifest.xml is not in the scorm package or not in the correct directory.

Download and unzip the package, open up imsmanifest.xml. At the bottom of the xml file, below any metadata, you'll find a place where organizations and resources for those organizations are designated:

<code xml>

<organizations default="TOC1">
<organization identifier="TOC1">
<title>SCORM Test</title>
<item identifier="I_SCO0" identifierref="SCO0">
<title>Library Quiz</title>
<adlcp:masteryscore>0</adlcp:masteryscore>
</item>
</organization>
</organizations>
<resources>
<resource identifier="SCO0" type="webcontent" adlcp:scormtype="sco" href="scorm.html">
<file href="scorm.html"/>
<dependency identifierref="ALLRESOURCES" />
</resource>
<resource identifier="ALLRESOURCES" type="webcontent" adlcp:scormtype="asset">
<file href="scorm.html" />
<file href="scorm.js" />
<file href="swfobject.js" />
<file href="scorm.swf" />
<file href="scormwrapper.js" />
</resource>
</resources>
</manifest>
</code>

In this xml, we have a single organization, and in that organization is a single resource, a single sco. There are 5 files necessary for that resource to work correctly. The scorm.html file is loaded first. It loads 3 external js files and a swf.

What you need to do now is go to the directory containing imsmanifest.xml, and check that all of those listed files are available at the correct path from imsmanfiest.xml, as listed in imsmanifest.xml. If any one of those files is missing (especially the html file or the swf), or if the paths in imsmanifest.xml are incorrect, then it's very likely that the scorm object won't be able to load at all.

Sometimes the files aren't missing, but are simply misnamed in the manifest, or placed in the wrong directory. You can fix this by moving the files to the correct places, or updating their names so that the imsmanifest and the actual file names match up. In the case of a misnamed file, change the manifest rather than the actual file names, since the the files also reference one another in other places!

===Unzip issues===
If you get a blank page after filling in the title, description, and selecting a large SCORM file, it's likely you haven't installed the PHP-zip lib which is required for Moodle 2.x for more info see [[admin/environment/php_extension/zip]]

===Clear an Attempt===
To clear attempts by a student:

# Go to the SCORM activity and select the link "View reports for x users"
# Select the attempt or attempts you want to clear using the checkbox
# Select Delete in the drop-down box at the bottom of the page

===Handling of Multiple Attempts===
SCORM is designed to allow a learner to exit and return at a later date to the same point they left from. This means that each time they enter the SCORM they are using the same single attempt. Some SCORM packages are intelligent about handling re-entry, many are not. What this means is that if the learner re-enters an existing attempt, if the SCORM content does not have internal logic to avoid overwriting cmi.core.lesson_status and cmi.core.score.raw, they can be overwritten by a lower score, confusing the learner.

When a SCORM sets the cmi.core.lesson_status value to 'completed', 'passed' or 'failed' then Moodle allows the user to create a new attempt by adding a '''Start new attempt''' checkbox to the entry page. If cmi.core.lesson_status is set to 'incomplete', 'browsed' or 'notattempted' the learner can only re-enter the existing attempt. If you are using the setting 'Student skip content structure page', this checkbox will never be shown to the user.

Moodle provides a range of settings to allow this to be controlled, some of these settings are hidden by default as advanced options.
* Number of attempts
:This allows the teacher to set how many SCORM attempts the learner may create - this is not how many times a learner can re-enter a SCORM attempt.
* Attempts grading
:This allows the teacher to set how multiple SCORM attempts(not re-entries) are graded. It is important to note that a 'failed' cmi.core_lesson_status allows a new attempt to be generated but the attempts grading setting "last completed attempt" only includes 'completed' and 'passed' values in it's calculations.
* Display attempt status
:This displays a users SCORM attempts and how their final grade is calculated on the SCORM entry page and the My Moodle page for the learner.
* Force completed
:This is a setting that can be used to force a SCORM package to report a 'completed' cmi.core.lesson_status if it doesn't currently set the value.
* Force new attempt
:This hides the '''Start new attempt''' checkbox and will force a new attempt if the previous attempt has cmi.core.lesson_status value to 'completed', 'passed' or 'failed' - this setting can also be used to make sure a new attempt is generated when the 'Student skip content structure page' setting is used.
* Lock after final attempt
:This prevents access to the SCORM after the total number of attempts have been used - if this is not set the learner can re-enter their last attempt and potentially change/overwrite their score each time depending on how the SCORM package supports multiple re-entries.

===Reducing Load Time with Captivate===
* Modify the percent that must be downloaded before the content starts to play. In Captivate 4, there's a setting in: Preferences / Project / Start and End / Preload. Reduce that to 50%.
* If you use audio in your Cp file (as background or element attachment), try to put a gap of 0,1 second at the beginning of each element including audio on your slides. If you don't do that, Cp merge all the audio files in one big audio file it need to download before playing the project. This problem have been report many times from the Cp community.

===Moodle changes cmi.core.lesson_status from "completed" or "passed" to "failed"===
Many SCORM authorware suites generate a masteryscore node in the imsmanifest.xml by default. This node is not necessary to the XML file. But when it is there, the SCORM standard designates specific behaviour with regard to the value set there.

This can also be controlled in Moodle using the setting "Mastery score overrides status" If this setting is enabled and a mastery score is provided within your package, when LMSFinish is called and a raw score has been set, if the raw score is lower than the mastery score, the lesson status will be overridden and set to "failed"

Here's what is in the scorm standard, on page 35 of 155 in SCORM_1.2_ConformanceReq.pdf, numbered page 2-19 ([http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201%2e2%2fDocumentation%20Suite%20%28SCORM%201%2e2%29&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View=%7b4D6DFFDE%2d3CFC%2d4DD9%2dA21A%2d4B687728824A%7d SCORM Version 1.2 Conformance Requirements Version 1.2]):
<blockquote>
If the value for this element is not set to “incomplete” by the SCO, then the LMS shall re-evaluate and change the value based on the following:<ul>
<li>If there is no mastery score in the Manifest, and the SCO sets a score (cmi.core.score.raw) and the lesson_status (cmi.core.lesson_status) then the LMS shall not override the SCO determined status.</li>
<li>If there is a mastery score in the Manifest, the LMS can change the status to either passed or failed depending on the student's score (cmi.core.score.raw) compared to the mastery score.</li>
<li>If the student is taking the SCO for no-credit, (cmi.core.credit = “no-credit”) there is no change to the lesson_status, with one exception. If the lesson_mode (cmi.core.lesson_mode) is "browse", the lesson_status may change to "browsed" even if the cmi.core.credit is set to no-credit.</li>
</ul>
</blockquote>
This can result in some functionality you don't intend. You can fix the problem by removing the mastery score node from your imsmanifest.xml file or by adjusting the Moodle setting "Mastery score overrides status". You may also want to find out what options you have, within your authorware suite, for the writing of that node into the manifest file, and change your authoring process accordingly.

The Rustici SCORM Cloud default operating behaviour for masteryscore is different from Moodle's default operating behaviour - you can see a little bit of the history around the way Rustici handle this here: http://scorm.com/blog/2010/09/anatomy-of-scorm-minutiae-mistake/

===Player Look 'n Feel===
You should be able to adjust height and width settings for the SCORM player window '''so long as''' your theme is based on/not too much of an aberration from one of the standard themes which ship with Moodle 2.

If your site or course theme isn't closely based on one of the standard M2 themes, then it's possible that your theme CSS is overriding local height and width settings for the SCORM player. Have a Web developer (or a Moodle Partner) examine how your theme is interacting with the player layout, and make changes to your theme as needed.

'''Why can't I just change it locally?''' You can change height and width per individual SCORM package, and you can set defaults for these local height and width values ( [[SCORM Admin Options]] ). Other things, such as colors, shading, borders, backgrounds, are controlled by CSS, just like everything else on the site.

=== Courselab 2.4 ===
If you receive a " found more than one record!" error when trying to run your SCORM 1.2 package check the imsmanifest.xml file of your SCORM package and ensure that the values for <organization identifier> and <item identifier> are unique. To change the <organization identifier>, in Courselab, go to File > Course Runtime Settings. The dialog says 'Course identification in LMS' but changing the Identifier field is what sets the <organization identifier>. (see MDL-38060 for more information)

=== SCORM results deleted after package update ===

When uploading a SCORM package over a previous one, if the item identifier in the manifest file is different to the one being overwritten then the tracking data for that SCORM package in Moodle is deleted.

Ensure the item identifier is the same for the new SCORM resource

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?id=1951 SCORM forum]
* [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle SCORM doesn't work] blog post from developer Dan Marsden
* [http://danmarsden.com/blog/2009/05/23/scorm-2004-in-moodle/ SCORM 2004 in Moodle] blog post from developer Dan Marsden
* [https://moodle.org/mod/forum/discuss.php?d=276324 Identifiers to change with updated SCORM module]
* [https://docs.moodle.org/dev/SCORM_schema Internal SCORM Schema]
* The official standard: [http://www.adlnet.gov/Technologies/scorm/default.aspx Advanced Distributed Learning - SCORM]

Online resources
* [http://www.scormcourse.com/ SCORMCourse.com] serves the SCORM and ADL community as an educational resource for SCORM technology.
* [http://www.eduworks.com/index.php/Publications/Learning-Object-Tutorial.html Learning Object Tutorial]
* [http://elearningweekly.wordpress.com/2007/04/12/tutorial-build-scorm-compatible-lesson-templates-for-your-lms/ Tutorial: Build SCORM-Compatible Lesson Templates for Your LMS]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=3757 Simple introduction to SCORM]
*[http://moodle.org/mod/forum/discuss.php?d=57059 Are there any sugestions for scorm authoring with Microsoft word / or any other easy (maybe free) scorm authoring tool?]
*[http://moodle.org/mod/forum/discuss.php?d=95946 Is SCORM worth it?]
*[http://moodle.org/mod/forum/discuss.php?d=207964 Updating an Object]

[[Category:FAQ]]
[[de:Lernpaket FAQ]]

SCORM settings

2016-08-03T22:09:08Z

Danmarsden: /* Compatibility settings */ add details about mastery score(3.1) and auto commit(2.8)

{{SCORM}}
==Adding a SCORM package==

First - make sure you have created a course (see: [[Adding_a_new_course#Adding_a_course|Adding_a_course]])

Quick method: (''Note - does not work with versions of Internet Explorer earlier than IE10'')
# Click the 'Turn editing on' button at the top right of the course page
# Drag and drop the SCORM package zip file onto the course section where you'd like it to appear
# Answer 'Add a SCORM package' to the popup dialogue asking what you want to do with the zip file then click the upload button
# If necessary, edit the title of the file by clicking the pencil icon, or edit other options (see below) by clicking the editing icon

Note: It is currently not yet possible to add AICC packages using the quick method.

Longer method:
# Click the 'Turn editing on' button at the top right of the course page
# Click the 'Add an activity or resource' link in the section you wish to add your SCORM package, then in the activity chooser, select SCORM package then click the Add button (or select 'SCORM package' from the 'Add an activity' dropdown menu)
# Enter a name and a description (which may be required or optional according to the admin settings)
# Either drag and drop a SCORM package zip file into the box with an arrow or click the Add button to open the [[File picker]] menu in order to choose a file from your computer or a repository
# Select display and other options as required (see below)
# Click the button 'Save and display' at the bottom of the page

You can edit or update the SCORM package later by clicking on the edit icon (usually a hand/pen) or by clicking on its name and then ''Settings > SCORM/AICC administration > Edit settings''.

Note: Moodle '''does not''' generate SCORM content. Moodle presents the content in SCORM packages to learners, and saves data from learner interactions with the SCORM package. See [[Tools for creating SCORM content]]

==Course settings==

===General===
{|
|[[File:scormgeneralsettings.png|thumb|430px|General settings expanded by default]]
|}
====Name====
Whatever you type here will form the link learners click on to access the SCORM package, so it is helpful to give it a name that suggests its purpose.
====Description====
Add a description of your SCORM activity here. Click "Show editing tools" to display the rich text editor, and drag the bottom right of the text box out to expand it.
====Display description on the course page====
If this box is ticked, the description will appear on the course page just below the name of the SCORM activity.

===Package===
This setting determines which SCORM package is used by this SCORM activity. Drag and drop or click the icon top left to upload your SCORM package. (Note that you must not unzip the package before upload.)The default (1) is to be able to upload a file. If your admin has added additional options in ''Site administration>Plugins>Activity modules>SCORM package'' then these will be available in a dropdown menu. (2)
{|
|[[File:scormpackage.png|thumb|443px|Package settings expanded by default]]
|}

====Alias/Shortcut====
If you access your SCORM package from a repository (such as [[File system repository]] or [[Private files]]) you can choose to create an alias/shortcut to it and then set an update frequency to set how often Moodle should check to see if there is an updated zip. (See [[Working with files]] for more information on setting an alias/shortcut.)

====Selecting an imsmanifest.xml====

It it possible to select the imsmanifest.xml file and have it as an alias/shortcut. To do this, you need to have created a [[File system repository]] and, when configuring it, allowed relative files. Extract your SCORM package into a folder there. When clicking on the Add button to add your SCORM package, select the file system repository folder with your SCORM package and browse for and select the imsmanfest.xml file, ensuring you the option to create an alias/shortcut to the file. Save and display. (Note this method is only currently supported by the File system repository.)

For more information with screenshots, see Dan Marsden's [http://danmarsden.com/blog/2013/09/24/managing-scorm-content-in-moodle-2-6/ blog post on Managing SCORM content]

Note: The settings (''Type'', ''URL'' and ''Auto-update frequency'') are only available when configured globally. See '''Admin settings''' below.

===Appearance===
(These settings are collapsed by default)
{|
|[[File:26scormappearance.png|thumb|450px|Appearance settings expanded]]
|}

====Display package====
Choose from current or new window. Note that if you choose a new window, students need to ensure pop ups are enabled.
====Display course structure on entry page====
If this is enabled then the table of contents of the package will be displayed when the students clicks to access the package.
====Show Navigation====
This setting determines whether the navigation buttons are shown or not.
#No -they are hidden
#Under content - they are displayed underneath the SCORM package
#Floating - the navigation buttons are floating (with options to choose the position from the left and top)

====Display attempt status====
You can choose whether to display a summary of the student's attempts on the entry page, on their [[Dashboard]] page or both. This setting is helpful when debugging grading issues - working out why a user got a certain grade.

''The following settings become visible when "Show more" is clicked:''

====Width====
Stage size width as a css value, either % or pixels. Default is 100%. You can change to a different percentage by putting a % symbol after the number (ex. 80%). You can also set to a pixels value by entering a number higher than 100 (ex. 800).
====Height====
Stage size height as a css value, either % or pixels. Default is 500 pixels. You can change to a percentage by putting a % symbol after the number (ex. 80%). You can also set to a pixels value by entering a number higher than 100 (ex. 800).

====Options====
There is a series of check boxes for:Allow the window to be resized ad scrolled, displaying directory links, location bar, menu bar, toolbar and/or status.
*'''Student skip content structure page''' - never, first access, always
*'''Disable preview mode''' - If this option is set to Yes, the Preview button in the view page of a SCORM/AICC Package activity will be hidden. The student can choose to preview (browse mode) the activity or attempt it in the normal mode. When a Learning Object is completed in preview (browse) mode, it's marked with browsed icon
*'''Display course structure in player'''

===Availability===
(These settings are collapsed by default.)
{|
|[[File:scormavailability25.png|thumb|470px|Availability settings expanded]]
|}
Choose here the dates you wish the SCORM package to be available to students.

===Grade===
(These settings are collapsed by default)
{|
|[[File:scormgrading.png|thumb|339px|Grade settings expanded]]
|}

====Grading method====
** Learning Objects - This mode shows the number of completed/passed Learning Objects for the activity. The max value is the number of Package's Learning Objects. ''Tip:'' If your SCORM package does report cmi.core.lesson_status, and does not report cmi.core.score.raw, then you should use this setting.
** Highest grade - The grade page will display the highest score obtained by users in all passed Learning Objects. ''Tip:'' If your SCORM package does report cmi.core.score.raw, and does not report cmi.core.lesson_status, then you should use this setting, Average grade, or Sum grade.
** Average grade - If you choose this mode Moodle will calculate the average of all scores.
**Sum grade - With this mode all the scores will be added.
====Maximum grade====
Not applicable if Grading Method is Learning objects. Usual setting is 100. If your SCO 's high score is something other than 100, you should adjust this value appropriately. When grading Method is one of the score settings, then the gradebook grade is package score divided by this number.

===Attempts management===
(These settings are collapsed by default.)
{|
|[[File:scormattempts.png|thumb|416px|Attempts management screen expanded]]
|}
====Number of attempts====
Defines the number of attempts permitted to users. It works only with SCORM 1.2 and AICC packages. SCORM2004 has its own max attempts definition.
** The option to start a new attempt is provided by a checkbox above the '''Enter''' button on the content structure page, so be sure you're providing access to that page if you want to allow more than one attempt.
** An attempt is not complete until the cmi.core.lesson_status for the attempt is set to either 'completed' or 'passed'. After that, the '''Start new attempt''' checkbox is available to the learner.
====Attempts grading====
When you permit multiple attempts for students, you can choose how to record the result in gradebook by first, last, average or highest settings.
* '''Display attempt status''' - If enabled, scores and grades for attempts are displayed on the SCORM outline page. This setting makes the block display more info to the user on the entry page to the SCORM and in the course overview block - if you turn it off it will display less info. This setting is helpful when debugging grading issues - working out why a user got a certain grade.

====Force new attempt====
If this is enabled then every time the student accesses the package, it will count as a new attempt.
====Lock after final attempt====
If this is enabled then once a student has used up all their attempts, they can no longer access the SCORM package.

===Compatibility settings===
(These settings are collapsed by default.)
{|
|[[File:scormcompat.png|thumb|273px|Compatibility settings expanded]]
|}
====Auto-Continue====
For SCORM packages that contain multiple learning objects (or SCO's) and Auto-continue is set to Yes, when a Learning Object calls the "close communication" method the next available object is launched automatically.If it is set to No, the users must use the navigation provided to continue to the next object. Many SCORM packages only contain a single learning object (or SCO) so this setting does not apply.
:''TIP:'' If your package contains multiple branches Auto-Continue will only move from one object to the next within the same topic.

====Force completed====
If this is enabled then the status of the current attempt is set to "complete". Note that this only applies to SCORM 1.2 packages and is useful if the SCORM package does not handle revisiting an attempt correctly, in review or browse mode, or otherwise incorrectly issues the completion status.

====Auto commit====
Some SCORM packages don't explicitly call Commit() regularly for whatever reason so progress is not stored in the database. This patch will Commit() the data from the SCORM package 60 seconds after the values are set, unless the package Commit()s sooner.

====Mastery score overrides status====
{{New features}}If this setting is enabled and a mastery score is provided within your package, when LMSFinish is called and a raw score has been set, if the raw score is lower than the mastery score, the lesson status will be overridden and set to "failed". More information on this behaviour is available in the [[SCORM_FAQ#Moodle_changes_cmi.core.lesson_status_from_.22completed.22_or_.22passed.22_to_.22failed.22|SCORM FAQ:Moodle changes cmi.core.lesson_status from completed or passed to failed]]

===Common module settings===

{{New features}}Group mode and groupings settings are available for SCORM packages in Moodle 3.1 onwards. This means that

* A SCORM package can be restricted to a particular [[Groupings|grouping]]
* SCORM reports may be filtered by group
[[File:scorm reports visible groups.png|thumb|SCORM report filtering by group]]
See [[Common module settings]] for more information.

===Restrict access===

These settings will be available if [[Conditional activities]] are enabled.

===Activity completion settings===

If this has been enabled for the course, then SCORM completion may be set based on minimum score or status (e.g. "Passed").

[[File:scormscore1.png]]

===Save settings===

As in most activities there are 3 save button choices. '''Cancel''', '''Save and return to course''' and '''Save changes''' buttons. The Save changes button will take the teacher back to the SCORM "stage" page.

==Site administration settings==

These options are available to the site admin via ''Site administration > Plugins > Activity Modules > SCORM Package''.

===Default Value Settings===
Many of the settings available in the SCORM Package administration simply set the default value for the SCORM activity module setup options provided within courses. Edit these settings to save yourself time when adding large numbers of packages, or to establish a standard for presentation across the site.

===Other Important Settings===
The following options provided which '''do not''' simply set a default value for the SCORM activity editing page view.
; Auto-update frequency
If not using a standard SCORM package uploaded using the filepicker and the SCORM package is hosted outside your Moodle installation the option to auto-update the package will be available - you can elect to have the package updated on every entry to the package or daily via the Moodle cron.
;Synchronization time

;Enable SCORM 1.2 standard mode
:If this setting is disabled, then it will be possible to exceed the allowed amount of stored data for SCORM 1.2 packages. Many SCORM packages go over the 4096 characters limit and while SCORM 2004 allows a higher number of characters, it is not supported. This setting will mean users can allow their 1.2 packages to store more data.
;Enable external package type
:If selected, presents a text field to paste a URL to a remote imsmanifest.xml (in an unzipped remote SCORM package), as well as the file picker option provided by default. Note that the content is played from the designated location, and not unpacked into the Moodle file system. So if the base url is different from your moodle url then browser security will block cross-domain communcation and no grades/tracking information will be passed back to Moodle.
;Enable downloaded package type
:If selected, presents a text field to paste a URL to a remote package.zip SCORM package. Package is downloaded and unzipped into the Moodle file system.
;Enable IMS package type
:Enables a package to be selected from within an IMS repository
;Force users to enable JavaScript
:Since the SCORM API uses JavaScript to save data to Moodle, this is a great idea!
;Activate API debug and tracing (set the capture mask with apidebugmask)
:Turns on debugging for SCORM activities. In Moodle 2 you no longer have to also turn on debugging in the developer options.
;API debug capture mask
:.* will debug for admin user only: You can use the mask to enable debugging under certain conditions. For example, if you are logged in using the admin user (username admin) you can set the api mask to: '''admin.*''' Users not logged in as admin will not see the debugging log. The "Default" api mask is '''.*''' which translates roughly to '''everybody'''.
;Enable direct AICC url
:Makes it easier to connect to externally hosted AICC content as the teacher doesn't have to create an AICC package and is able to link directly to the external AICC url.
;Enable external AICC HACP
:The SCORM activity can also support external AICC HACP Communication where the AICC package is hosted on an external content providers site and passes back http requests directly from the external server instead of within the users web browser session - this is disabled by default.
;AICC pass numeric user id

; Protect package downloads.
:This is disabled by default, meaning packages can always be downloaded (eg for offline mobile use.) If this is enabled then only users with the capability course:manageactivities can download the package.
==See also==

* [[:dev:SCORM_schema |SCORM Schema]] for developers

[[de:Lernpaket konfigurieren]]
[[fr:Ajouter/modifier un SCORM]]
[[ja:SCORMを追加/編集する]]
[[es:Configuraciones del SCORM]]

SCORM FAQ

2016-08-03T21:57:23Z

Danmarsden: /* Moodle changes cmi.core.lesson_status from "completed" or "passed" to "failed" */ update with info on masteryoverride setting.

{{SCORM}}
==What is SCORM?==

SCORM was developed as a result of collaboration in the public and private sectors. The President of the United States, Bill Clinton issued an Executive Order that created an agency (ADL) to oversee the standard for developing and distributing online learning. All Federal agencies are mandated to use programs that meet those standards. SCORM is one result of that order.

There's a really simple "What is SCORM" introduction here: http://moodle.org/mod/forum/discuss.php?d=3757#p18828

A slightly more detailed introduction here: http://www.rusticisoftware.com/resources/whatisscorm/What%20Is%20SCORM.ht

==Should I make my Moodle courses as SCORM or use Moodle's features?==
It depends how you intend to use it. If you are planning on exporting and using in another LMS then SCORM would make this easier. If you want something shiny, then a SCORM package can fit the bill. However, reporting and grading work better in Moodle and for many educators the standard features do the job perfectly and do not require learning a new program. There is a useful form post discussing the pros and cons of SCORM in Moodle here: http://moodle.org/mod/forum/discuss.php?d=200242

==SCORM Information==

Advanced Distributed Learning (ADL) is the organization that wrote the SCORM standard. You can download documentation and samples form ADL's Web site. Documentation for SCORM 1.2 in several languages is available [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2%2fDocumentation%20Suite%20(SCORM%201.2)&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} here].

Philip Hutchison provides an AS3 and JavaScript wrapper, as well as a sample package:
http://pipwerks.com/downloads/

==SCORM Package Contents==

A SCORM package must contains in the root of zip a file named imsmanifest.xml which defines SCORM course structure, resource location and many other things. Other files used in the package, such as HTML files, XML files, multimedia files, and JavaScript for the SCORM API must be listed in this file. The LMS parses the manifest, and provides the files listed there to the content package during runtime.

==AICC Package Contents==

An AICC package is defined by several files (from 4 to 7) with defined extensions as follows:

* CRS - Course Description file (mandatory)
* AU - Assignable Unit file (mandatory)
* DES - Descriptor file (mandatory)
* CST - Course Structure file (mandatory)
* ORE - Objective Relationship file (optional)
* PRE - Prerequisites file (optional)
* CMP - Completition Requirements file (optional)

==Basic Troubleshooting==

* Make sure you are running Moodle 2.1 or higher, a large number of SCORM related bugs are present in previous versions.
*Make sure you (and your users) have JavaScript enabled. SCORM requires JavaScript.
* Make sure your SCORM object is SCORM compliant - check it in an external SCORM player like [https://docs.moodle.org/en/Tools_for_creating_SCORM_content#Reload Reload] to see if it works there.
* Upload a copy of your SCORM object to a [http://en.wikipedia.org/wiki/File_hosting_service File Hosting Service] and post a message asking for help in the forums, linking to your SCORM object explaining exactly what you expect to happen, and what is happening instead.
* Read Dan Marsden's blog post [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle here] (Maintainer of SCORM Module in Moodle)

==Does Moodle Generate SCORM Content?==

Moodle '''does not''' generate scorm content. Moodle presents the content in SCORM packages to learners, and saves data from learner interactions with the SCORM package.

==Can I add a password for access to my SCORM package?==
No, although there is a tracker request for this: MDL-46403 As a workaround you could add your SCORM package using the single activity course format - see [[Course formats]] - and add an enrolment key to the course.

==Supported Versions==

* SCORM 1.2 is supported in Moodle 2.1(or higher) and passes all the tests in the ADL Conformance test suite 1.2.7 for SCORM 1.2. The best place for information on SCORM 1.2 conformance is the [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Previous%20Versions/SCORM%201.2/Conformance%20Test%20Suite%20(SCORM%201.2)/SCORM_1.2_ConformanceReq.pdf SCORM Comformance Requirements documentation (PDF 3.4MB)].

* SCORM 2004 is not supported in Moodle. Parts of the API have been implemented, but others such as Navigation and Sequencing have not. Development on native SCORM 2004 support in Moodle [https://moodle.org/mod/forum/discuss.php?d=227906 has stopped]. If you require a fully certified SCORM 2004 Player in Moodle, [http://www.scorm.com Rustici Software] have a [http://support.scorm.com/entries/20394726-scorm-cloud-moodle-module Moodle plugin] which connects to their commercial [http://www.scorm.com/scorm-solved/scorm-cloud/ SCORM Cloud] service turning Moodle into a fully compliant SCORM 2004 LMS.

* AICC objects are supported in Moodle 2.1 and higher.

* Moodle does not support Tin Can at this stage.

==Asking for Help in the SCORM Forum==

When trying to engage the community to help with a problem you are facing, you will get a better response if you follow a few simple guidelines:
* Always start your report with '''version information''' - preferably the information displayed on the Admin -> Environment panel eg. http://localhost/moodle/admin/environment.php where http://localhost/moodle is your particular prefix. With this it will be clear how you are running your Moodle instance, on what platform, and at which version. This will quickly expose issues where a simple upgrade will solve your problem.
* Be prepared to '''provide the SCORM package''' that illustrates your problem - if you don't then it will be very difficult for anyone offering assistance to recreate your situation - a real barrier to help.
* '''Screenshots''' are very helpful. Provide a screenshot of all error messages, and any instance where something seems to go wrong in the interface.
* Nonstandard themes can introduce SCORM issues. Be sure to tell us '''what theme you're using'''.
* If you have admin privileges, and have access to a localhost install or other place where real-time users won't be disturbed, be sure to turn on debugging. Navigate to '''Site Administration > Development > Debugging''' and set '''Debug messages: Developer''' and '''Display debug messages: Yes'''. Access the SCORM content. If there are errors printed to the page, include them in your forum post.
* Use [https://developers.google.com/chrome-developer-tools/docs/console Chrome's JavaScript Console] or [https://developer.mozilla.org/en-US/docs/Tools/Web_Console Firebug's JavaScript console] to check that there are no JavaScript errors on the page when the content loads.
* Run your problematic SCORM package through '''API debugging''' (see below) and include the text of that API log with your post. That way we can see right away if the right function calls are not taking place.
* If you're using a content development suite which publishes to SCORM, such as Articulate, Captivate, Lectora, LessonBuilder, Udutu, or some other product, then include that in your post. Every authoring software has its ticks, and if you've run into one, it's likely that someone else has also dealt with it, and will recognize it. However, please keep in mind that '''this is a place to get help with Moodle issues, not help with your SCORM package authoring suite'''.

==Debugging ==

# Debugging settings are located at Settings > Site Administration > Plugins > Activities > Scorm.
# Check the checkbox for '''Activate API debug...'''
# Set the api mask. You can use the mask to enable debugging under certain conditions. For example, if you are logged in using the admin user (username admin) you can set the api mask to: <cite>admin.*</cite> Users not logged in as admin will not see the debugging log. The "Default" api mask is <cite>.*</cite>

==What does the debugging log mean?==

The SCO commonly sends the following communications through the API:

* '''LMSInitialize();''' opens the connection between the SCO and Moodle
* '''LMSGetValue( 'valuename' );''' gets a value from Moodle
* '''LMSSetValue( 'valuename' , 'value' );''' sends a value to Moodle
* '''LMSCommit();''' saves values sent to Moodle via LMSSetValue() and should be called after every LMSSetValue()
* '''LMSFinish()''' saves values sent to Moodle and closes the connection between the SCO And Moodle

Red lines in the debugging log means there was an error in the communication through the API.

If LMSInitialize() fails, returns an error, then no subsequent values sent to Moodle will be saved.

Click through the entire SCORM package. Then access the scorm report for your attempt, and compare the saved values in the debugging log with Moodle's report of the attempt. If the values set in the debug log do not match the values saved to Moodle, then there may be a problem with Moodle. Otherwise it's likely to be an issue with the SCO or the SCORM activity settings not giving you the functionality you need.

==SCORM and the Gradebook==
Please see [https://docs.moodle.org/en/SCORM_FAQ#My_SCORM_Module_doesn.27t_function_properly FAQ:My SCORM Module doesn't function properly] and [https://docs.moodle.org/en/SCORM_FAQ#Handling_of_Multiple_Attempts FAQ:Handling of Multiple Attempts]

Some SCORM packages report both cmi.core.lesson_status and cmi.core.score.raw. Others report only cmi.core.lesson_status, or only cmi.core.score.raw. The '''Grading Method''' setting for SCORM objects is meant to account for that.

If you have the '''Grading Method''' set to '''Highest grade''', '''Average grade''', or '''Sum grade''', and your learning object does not report a score, only, cmi.core.lesson_status, then there will be no numerical score to pass to the gradebook.

If your SCOs do not report cmi.core.score.raw, then the best '''Grading Method''' setting is '''Learning Objects'''. This reports either a 1 or a 0 as a score for each learning object. The gradebook value for that SCORM activity is the percent of scos in the package for which learners got a 1.

On the other hand, if your SCOs do not report a lesson_status, then select one of the score-based '''Grading Method''' options, such as '''Highest grade''', '''Average grade''', or '''Sum grade''', and not '''Learning Objects'''.

If you do not know what your SCOs are reporting to the LMS, then run them through to completion with debugging on.

Much of the way SCORM objects are graded is controlled inside the SCORM Authoring process before it is packaged for use in an LMS like Moodle - make sure all your grading settings are set correctly.

==SCORM Administration Options==

See [[SCORM settings]]

==Common Solutions==

===Difficulty Displaying a SCORM Package===
If you have difficulty displaying a SCORM, try loading the SCORM in [http://www.reload.ac.uk Reload] and re-saving it, then save the folder as a .zip package and try again.

===Character Display Errors===
When you notice there is a problem displaying characters correctly, it could be a misconfiguration of your server. Make sure that both httpd.conf (when using Apache) and php.ini are set to DefaultCharacterset = utf8 or switch the sending of a default character set off.

===slash arguments warning when I add/update SCORM objects in my course===
Some web servers don't support a function called '''slash arguments''' and so Moodle allows you to turn it off, but SCORM packages require '''slash arguments''' to be enabled on the web server in order to work properly.

See [[Using slash arguments]] for more details.

===SCORM doesn't work on Godaddy Host===
Godaddy hosts give a 404 file not found error - this is because by default they do not allow slash arguments which SCORM requires. The best way to test this is to visit http://yourmoodlesite/admin/tool/health/index.php - but the fix involves adding a php.ini or php5.ini file with the following text:
AcceptPathInfo
cgi.fix_pathinfo=1

===My Flash-Based Content Loads, then Stalls===
This issue is most commonly associated with zlib compression. Classic presentation is that the base HTML file and SWF are loaded into the SCORM player, but the SWF is not able to load any audio or video assets, and therefore stalls. You can watch the loading of SWFs and assets using Chrome's Developer Tools or other.

Check your site's zlib compression settings as an admin by loading up the Server > phpinfo page. zlib compression is not a Moodle setting but a server setting, so you'll need a server admin to disable it. Be sure to Purge All Caches, and clear browser caches, before confirming the change.

===Zlib warning when I add/update SCORM objects in my course===
Zlib is a php compression setting made in a websites PHP configuration - unfortunately some browsers don't handle this well (especially Internet Explorer 6) Some webhosts enable this setting, but it will likely cause issues for your users when they attempt to view/use the SCORM object. You will need to contact your server administrator to turn this off. The setting to change in php configuration is "zlib.output_compression"

===Incorrect file package - missing imsmanifest.xml or AICC structure===
This means that Moodle cannot find a file called imsmanifest.xml inside the SCORM object. Reasons for this could be:
* imsmanifest.xml needs to be immediately inside the scorm directory, NOT inside a directory inside of that. So if the zipped scorm package is package.zip, the unzipped package directory should contain immediately inside of it the imsmanifest.xml. This is a common mistake and normally occurs when a SCORM author creates a package themselves and then selects that folder to compress. This places the content folder inside of another folder, The imsmanifest.xml is there, but it is 2 directories deep. To avoid this problem when zipping scorm content into a package, go INSIDE of the exported scorm folder, select all files inside, and compress them while all are selected. The resultant compressed directory has the imsmanifest.xml file in the first directory, immediately available to the moodle scorm loading process.
* when using linux based systems the filename imsmanifest.xml must be all in lowercase not IMSmanifest.xml or Imsmanifest.XML
* The SCORM authoring tool Articulate sometimes fails to create the imsmanifest.xml -Try exporting the package again and see if the manifest is generated.
* The SCORM authoring tool Articulate Presenter will publish packages where the imsmanifest.xml file is in the correct place, but there are several lines of white space in the manifest file if you do not fill out the Reporting and Tracking Options in Articulate Presenter for Keywords and LMS Description. Moodle will give a "Manifest not found" error when encountering this. To fix this problem select the Reporting and Tracking Options in the Articulate Presenter publish dialog and fill in the LMS Description and Keywords.

===File not found error===
You have this error if the scorm package is created in moodle, and the scorm menu loads, but inside of the viewing area for the scorm content, you get a page with a 404 file not found error, usually showing the current Moodle theme.

What this means is that one of the files listed in the imsmanifest.xml is not in the scorm package or not in the correct directory.

Download and unzip the package, open up imsmanifest.xml. At the bottom of the xml file, below any metadata, you'll find a place where organizations and resources for those organizations are designated:

<code xml>

<organizations default="TOC1">
<organization identifier="TOC1">
<title>SCORM Test</title>
<item identifier="I_SCO0" identifierref="SCO0">
<title>Library Quiz</title>
<adlcp:masteryscore>0</adlcp:masteryscore>
</item>
</organization>
</organizations>
<resources>
<resource identifier="SCO0" type="webcontent" adlcp:scormtype="sco" href="scorm.html">
<file href="scorm.html"/>
<dependency identifierref="ALLRESOURCES" />
</resource>
<resource identifier="ALLRESOURCES" type="webcontent" adlcp:scormtype="asset">
<file href="scorm.html" />
<file href="scorm.js" />
<file href="swfobject.js" />
<file href="scorm.swf" />
<file href="scormwrapper.js" />
</resource>
</resources>
</manifest>
</code>

In this xml, we have a single organization, and in that organization is a single resource, a single sco. There are 5 files necessary for that resource to work correctly. The scorm.html file is loaded first. It loads 3 external js files and a swf.

What you need to do now is go to the directory containing imsmanifest.xml, and check that all of those listed files are available at the correct path from imsmanfiest.xml, as listed in imsmanifest.xml. If any one of those files is missing (especially the html file or the swf), or if the paths in imsmanifest.xml are incorrect, then it's very likely that the scorm object won't be able to load at all.

Sometimes the files aren't missing, but are simply misnamed in the manifest, or placed in the wrong directory. You can fix this by moving the files to the correct places, or updating their names so that the imsmanifest and the actual file names match up. In the case of a misnamed file, change the manifest rather than the actual file names, since the the files also reference one another in other places!

===Unzip issues===
If you get a blank page after filling in the title, description, and selecting a large SCORM file, it's likely you haven't installed the PHP-zip lib which is required for Moodle 2.x for more info see [[admin/environment/php_extension/zip]]

===Clear an Attempt===
To clear attempts by a student:

# Go to the SCORM activity and select the link "View reports for x users"
# Select the attempt or attempts you want to clear using the checkbox
# Select Delete in the drop-down box at the bottom of the page

===Handling of Multiple Attempts===
SCORM is designed to allow a learner to exit and return at a later date to the same point they left from. This means that each time they enter the SCORM they are using the same single attempt. Some SCORM packages are intelligent about handling re-entry, many are not. What this means is that if the learner re-enters an existing attempt, if the SCORM content does not have internal logic to avoid overwriting cmi.core.lesson_status and cmi.core.score.raw, they can be overwritten by a lower score, confusing the learner.

When a SCORM sets the cmi.core.lesson_status value to 'completed', 'passed' or 'failed' then Moodle allows the user to create a new attempt by adding a '''Start new attempt''' checkbox to the entry page. If cmi.core.lesson_status is set to 'incomplete', 'browsed' or 'notattempted' the learner can only re-enter the existing attempt. If you are using the setting 'Student skip content structure page', this checkbox will never be shown to the user.

Moodle provides a range of settings to allow this to be controlled, some of these settings are hidden by default as advanced options.
* Number of attempts
:This allows the teacher to set how many SCORM attempts the learner may create - this is not how many times a learner can re-enter a SCORM attempt.
* Attempts grading
:This allows the teacher to set how multiple SCORM attempts(not re-entries) are graded. It is important to note that a 'failed' cmi.core_lesson_status allows a new attempt to be generated but the attempts grading setting "last completed attempt" only includes 'completed' and 'passed' values in it's calculations.
* Display attempt status
:This displays a users SCORM attempts and how their final grade is calculated on the SCORM entry page and the My Moodle page for the learner.
* Force completed
:This is a setting that can be used to force a SCORM package to report a 'completed' cmi.core.lesson_status if it doesn't currently set the value.
* Force new attempt
:This hides the '''Start new attempt''' checkbox and will force a new attempt if the previous attempt has cmi.core.lesson_status value to 'completed', 'passed' or 'failed' - this setting can also be used to make sure a new attempt is generated when the 'Student skip content structure page' setting is used.
* Lock after final attempt
:This prevents access to the SCORM after the total number of attempts have been used - if this is not set the learner can re-enter their last attempt and potentially change/overwrite their score each time depending on how the SCORM package supports multiple re-entries.

===Reducing Load Time with Captivate===
* Modify the percent that must be downloaded before the content starts to play. In Captivate 4, there's a setting in: Preferences / Project / Start and End / Preload. Reduce that to 50%.
* If you use audio in your Cp file (as background or element attachment), try to put a gap of 0,1 second at the beginning of each element including audio on your slides. If you don't do that, Cp merge all the audio files in one big audio file it need to download before playing the project. This problem have been report many times from the Cp community.

===Moodle changes cmi.core.lesson_status from "completed" or "passed" to "failed"===
Many SCORM authorware suites generate a masteryscore node in the imsmanifest.xml by default. This node is not necessary to the XML file. But when it is there, the SCORM standard designates specific behaviour with regard to the value set there.

This can also be controlled in Moodle using the setting "Mastery score overrides status" If this setting is enabled and a mastery score is provided within your package, when LMSFinish is called and a raw score has been set, if the raw score is lower than the mastery score, the lesson status will be overridden and set to "failed"

Here's what is in the scorm standard, on page 35 of 155 in SCORM_1.2_ConformanceReq.pdf, numbered page 2-19 ([http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201%2e2%2fDocumentation%20Suite%20%28SCORM%201%2e2%29&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View=%7b4D6DFFDE%2d3CFC%2d4DD9%2dA21A%2d4B687728824A%7d SCORM Version 1.2 Conformance Requirements Version 1.2]):
<blockquote>
If the value for this element is not set to “incomplete” by the SCO, then the LMS shall re-evaluate and change the value based on the following:<ul>
<li>If there is no mastery score in the Manifest, and the SCO sets a score (cmi.core.score.raw) and the lesson_status (cmi.core.lesson_status) then the LMS shall not override the SCO determined status.</li>
<li>If there is a mastery score in the Manifest, the LMS can change the status to either passed or failed depending on the student's score (cmi.core.score.raw) compared to the mastery score.</li>
<li>If the student is taking the SCO for no-credit, (cmi.core.credit = “no-credit”) there is no change to the lesson_status, with one exception. If the lesson_mode (cmi.core.lesson_mode) is "browse", the lesson_status may change to "browsed" even if the cmi.core.credit is set to no-credit.</li>
</ul>
</blockquote>
This can result in some functionality you don't intend. You can fix the problem by removing the mastery score node from your imsmanifest.xml file or by adjusting the Moodle setting "Mastery score overrides status". You may also want to find out what options you have, within your authorware suite, for the writing of that node into the manifest file, and change your authoring process accordingly.

===Player Look 'n Feel===
You should be able to adjust height and width settings for the SCORM player window '''so long as''' your theme is based on/not too much of an aberration from one of the standard themes which ship with Moodle 2.

If your site or course theme isn't closely based on one of the standard M2 themes, then it's possible that your theme CSS is overriding local height and width settings for the SCORM player. Have a Web developer (or a Moodle Partner) examine how your theme is interacting with the player layout, and make changes to your theme as needed.

'''Why can't I just change it locally?''' You can change height and width per individual SCORM package, and you can set defaults for these local height and width values ( [[SCORM Admin Options]] ). Other things, such as colors, shading, borders, backgrounds, are controlled by CSS, just like everything else on the site.

=== Courselab 2.4 ===
If you receive a " found more than one record!" error when trying to run your SCORM 1.2 package check the imsmanifest.xml file of your SCORM package and ensure that the values for <organization identifier> and <item identifier> are unique. To change the <organization identifier>, in Courselab, go to File > Course Runtime Settings. The dialog says 'Course identification in LMS' but changing the Identifier field is what sets the <organization identifier>. (see MDL-38060 for more information)

=== SCORM results deleted after package update ===

When uploading a SCORM package over a previous one, if the item identifier in the manifest file is different to the one being overwritten then the tracking data for that SCORM package in Moodle is deleted.

Ensure the item identifier is the same for the new SCORM resource

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?id=1951 SCORM forum]
* [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle SCORM doesn't work] blog post from developer Dan Marsden
* [http://danmarsden.com/blog/2009/05/23/scorm-2004-in-moodle/ SCORM 2004 in Moodle] blog post from developer Dan Marsden
* [https://moodle.org/mod/forum/discuss.php?d=276324 Identifiers to change with updated SCORM module]
* [https://docs.moodle.org/dev/SCORM_schema Internal SCORM Schema]
* The official standard: [http://www.adlnet.gov/Technologies/scorm/default.aspx Advanced Distributed Learning - SCORM]

Online resources
* [http://www.scormcourse.com/ SCORMCourse.com] serves the SCORM and ADL community as an educational resource for SCORM technology.
* [http://www.eduworks.com/index.php/Publications/Learning-Object-Tutorial.html Learning Object Tutorial]
* [http://elearningweekly.wordpress.com/2007/04/12/tutorial-build-scorm-compatible-lesson-templates-for-your-lms/ Tutorial: Build SCORM-Compatible Lesson Templates for Your LMS]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=3757 Simple introduction to SCORM]
*[http://moodle.org/mod/forum/discuss.php?d=57059 Are there any sugestions for scorm authoring with Microsoft word / or any other easy (maybe free) scorm authoring tool?]
*[http://moodle.org/mod/forum/discuss.php?d=95946 Is SCORM worth it?]
*[http://moodle.org/mod/forum/discuss.php?d=207964 Updating an Object]

[[Category:FAQ]]
[[de:Lernpaket FAQ]]

Reengagement activity

2016-07-27T22:08:53Z

Danmarsden: /* Email place holders */ add institution/city/department

{{Infobox plugin
|type = Activity module
|entry = https://moodle.org/plugins/mod_reengagement
|tracker = https://github.com/catalyst/moodle-mod_reengagement/issues
|maintainer = [https://www.catalyst.net.nz Catalyst IT]
|float = right
}}

==About the Reengagement activity==
The Reengagement activity is developed by the Moodle Partner Catalyst IT and provides a way for you to remind students to return to the course and complete activities. You can also use this plugin to selectively release timed content in a course.

==Adding a Reengagement activity==
A Reengagement activity can be added to a course in the same way as any other activity:

# Turn editing on
# Click 'Add an activity or resource'
# Select Re-engagement

===Set Reengagement details===
The Email delay can be based on the user enrolment date or a previous activity completion. If you want the delay to be based on a previous activity completion you should set that previous activity as an access restriction to this Reengagment activity, if you want to use the enrolment date then don't set up any access restrictions on this Re-engagement activity.

Set "Email User" to "After Delay" and set the "Email delay" period. The e-mail delay is the when the e-mail reminder will be sent based on the previous event (enrolment or activity completion)

Set "Target Activity" - this is the activity that you want to remind the user they must complete - if this activity is flagged as complete within the course then no e-mail reminder will be sent.

===Timed release===
If you want to release content within your course to individual users after a set period (eg 1 week after previous activity completion or 1 week after their enrolment) you use the "Activity completion" settings within the course - set the Reengagement duration to the time period you want. If you want the time period to be based on user enrolment leave the access restrictions on the activity empty, but if you want to base it on a previous activity completion set this within the restrict access configuration for the activity.

===Email place holders===
When configuring the e-mails sent from the plugin there are six place holders you can use. If need to use them properly wrap them with "percentage" (%) symbols. All six examples are given below

* %courseshortname%
* %coursefullname%
* %courseid%
* %userfirstname%
* %userlastname%
* %userid%
* %usercity%
* %userinstitution%
* %userdepartment%

Reengagement activity

2016-07-18T02:35:23Z

Danmarsden: Created page with "{{Infobox plugin |type = Activity module |entry = https://moodle.org/plugins/mod_reengagement |tracker = https://github.com/catalyst/moodle-mod_reengagement/issues |maintainer..."

{{Infobox plugin
|type = Activity module
|entry = https://moodle.org/plugins/mod_reengagement
|tracker = https://github.com/catalyst/moodle-mod_reengagement/issues
|maintainer = [https://www.catalyst.net.nz Catalyst IT]
|float = right
}}

==About the Reengagement activity==
The Reengagement activity is developed by the Moodle Partner Catalyst IT and provides a way for you to remind students to return to the course and complete activities. You can also use this plugin to selectively release timed content in a course.

==Adding a Reengagement activity==
A Reengagement activity can be added to a course in the same way as any other activity:

# Turn editing on
# Click 'Add an activity or resource'
# Select Re-engagement

===Set Reengagement details===
The Email delay can be based on the user enrolment date or a previous activity completion. If you want the delay to be based on a previous activity completion you should set that previous activity as an access restriction to this Reengagment activity, if you want to use the enrolment date then don't set up any access restrictions on this Re-engagement activity.

Set "Email User" to "After Delay" and set the "Email delay" period. The e-mail delay is the when the e-mail reminder will be sent based on the previous event (enrolment or activity completion)

Set "Target Activity" - this is the activity that you want to remind the user they must complete - if this activity is flagged as complete within the course then no e-mail reminder will be sent.

===Timed release===
If you want to release content within your course after a set period (eg 1 week after previous activity completion or 1week after enrolment) you use the "Activity completion" settings within the course - set the Reengagement duration to the time period you want. If you want the time period to be based on user enrolment leave the access restrictions on the activity empty, but if you want to base it on a previous activity completion set this within the restrict access configuration for the activity.

===Email place holders===
When configuring the e-mails sent from the plugin there are six place holders you can use. If need to use them properly wrap them with "percentage" (%) symbols. All six examples are given below

* %courseshortname%
* %coursefullname%
* %courseid%
* %userfirstname%
* %userlastname%
* %userid%

Gradebook calculation changes

2016-06-28T21:50:18Z

Danmarsden: add initial detail about MDL-45390

{{Grades}}
Note: The following information only applies if you see a message displayed in the gradebook following a site upgrade, or after restoring a course backup from a different version of Moodle.

Occasionally there are error fixes which can affect gradebook calculations in certain courses. As part of the upgrade process, such courses are identified and a message is displayed in the gradebook informing teachers that error fixes may result in some grades being changed. Details of these changes are provided below. The 8-digit version number is the date of the fix.

It is recommended that the errors are fixed by clicking the button 'Accept grade changes and fix calculation errors'. Until this is done, the message will continue to be displayed in the gradebook (only for teachers; students can't see it). The old gradebook calculations will still be used (ensuring grades remain unchanged), however they are likely to result in more errors if grades are updated in the future.

=== 20150619 - Calculation of extra credit item weights when using natural aggregation ===

Two errors were fixed:
# Overriding the weight of the extra credit item can lead to changes in other items' weights and random final grades
# The automatic weight of an extra credit item was dependent on the overrides of the normal item's weights

The second error was especially noticeable for students with excluded grade items (for example, when they are hidden or empty).

For example, a category has two normal grade items and one extra credit item. If the maximum grades for each item are the same, the weights of the three items will be: 50%, 50% and 50%. However if the weights of the normal items are overridden to be 50% and 50%, then the weight of the extra credit item would become 0%. If the teacher overrode the weight of the first item to 80%, the second item would automatically become 20% (correct) and the extra credit would also become 20% (incorrect).

The correct behaviour (after the fix): If the weight of extra credit item is not overridden, it should be itemmaxgrade / totalmaxgrade , where totalmaxgrade does not include the extra credit item. In the example, the weight of the extra credit item should always be 50%.

See MDL-49257 for further details including screenshots.

=== 20150627 - Calculated grade items ===

Two errors affecting grades were fixed:
# Changing the maxgrade for a category item with a calculation that has existing grades results in grades displayed out of the old maximum grade, not the updated one. This can cause flow on affects for automatic weights with Natural Aggregation.
# Values for grade items with a calculation are always displayed from 0 to 100 regardless of the minimum and maximum grades for the grade item. This can cause flow on affects for automatic weights with Natural Aggregation.

These fixes will impact existing grades by correcting the maximum grade for existing grade items.

See MDL-48239 for further details.

=== 20160518 - letter grade boundary issue ===

In some cases the letter grade associated with a grade was incorrect

see MDL-45390 for further details.

SCORM settings

2016-04-28T02:53:05Z

Danmarsden: /* Adding a SCORM package */ add link to creating a course - (many users try to add SCORM packages in strange places)

{{SCORM}}
==Adding a SCORM package==

First - make sure you have created a course (see: [[Adding_a_new_course#Adding_a_course|Adding_a_course]])

Quick method: (''Note - does not work with versions of Internet Explorer earlier than IE10'')
# Click the 'Turn editing on' button at the top right of the course page
# Drag and drop the SCORM package zip file onto the course section where you'd like it to appear
# Answer 'Add a SCORM package' to the popup dialogue asking what you want to do with the zip file then click the upload button
# If necessary, edit the title of the file by clicking the pencil icon, or edit other options (see below) by clicking the editing icon

Note: It is currently not yet possible to add AICC packages using the quick method.

Longer method:
# Click the 'Turn editing on' button at the top right of the course page
# Click the 'Add an activity or resource' link in the section you wish to add your SCORM package, then in the activity chooser, select SCORM package then click the Add button (or select 'SCORM package' from the 'Add an activity' dropdown menu)
# Enter a name and a description (which may be required or optional according to the admin settings)
# Either drag and drop a SCORM package zip file into the box with an arrow or click the Add button to open the [[File picker]] menu in order to choose a file from your computer or a repository
# Select display and other options as required (see below)
# Click the button 'Save and display' at the bottom of the page

You can edit or update the SCORM package later by clicking on the edit icon (usually a hand/pen) or by clicking on its name and then ''Settings > SCORM/AICC administration > Edit settings''.

Note: Moodle '''does not''' generate SCORM content. Moodle presents the content in SCORM packages to learners, and saves data from learner interactions with the SCORM package. See [[Tools for creating SCORM content]]

==Course settings==

===General===
{|
|[[File:scormgeneralsettings.png|thumb|430px|General settings expanded by default]]
|}
====Name====
Whatever you type here will form the link learners click on to access the SCORM package, so it is helpful to give it a name that suggests its purpose.
====Description====
Add a description of your SCORM activity here. Click "Show editing tools" to display the rich text editor, and drag the bottom right of the text box out to expand it.
====Display description on the course page====
If this box is ticked, the description will appear on the course page just below the name of the SCORM activity.

===Package===
This setting determines which SCORM package is used by this SCORM activity. Drag and drop or click the icon top left to upload your SCORM package. (Note that you must not unzip the package before upload.)The default (1) is to be able to upload a file. If your admin has added additional options in ''Site administration>Plugins>Activity modules>SCORM package'' then these will be available in a dropdown menu. (2)
{|
|[[File:scormpackage.png|thumb|443px|Package settings expanded by default]]
|}

====Alias/Shortcut====
If you access your SCORM package from a repository (such as [[File system repository]] or [[Private files]]) you can choose to create an alias/shortcut to it and then set an update frequency to set how often Moodle should check to see if there is an updated zip. (See [[Working with files]] for more information on setting an alias/shortcut.)

====Selecting an imsmanifest.xml====

It it possible to select the imsmanifest.xml file and have it as an alias/shortcut. To do this, you need to have created a [[File system repository]] and, when configuring it, allowed relative files. Extract your SCORM package into a folder there. When clicking on the Add button to add your SCORM package, select the file system repository folder with your SCORM package and browse for and select the imsmanfest.xml file, ensuring you the option to create an alias/shortcut to the file. Save and display. (Note this method is only currently supported by the File system repository.)

For more information with screenshots, see Dan Marsden's [http://danmarsden.com/blog/2013/09/24/managing-scorm-content-in-moodle-2-6/ blog post on Managing SCORM content]

Note: The settings (''Type'', ''URL'' and ''Auto-update frequency'') are only available when configured globally. See '''Admin settings''' below.

===Appearance===
(These settings are collapsed by default)
{|
|[[File:26scormappearance.png|thumb|450px|Appearance settings expanded]]
|}

====Display package====
Choose from current or new window. Note that if you choose a new window, students need to ensure pop ups are enabled.
====Display course structure on entry page====
If this is enabled then the table of contents of the package will be displayed when the students clicks to access the package.
====Show Navigation====
This setting determines whether the navigation buttons are shown or not.
#No -they are hidden
#Under content - they are displayed underneath the SCORM package
#Floating - the navigation buttons are floating (with options to choose the position from the left and top)

====Display attempt status====
You can choose whether to display a summary of the student's attempts on the entry page, on their [[Dashboard]] page or both. This setting is helpful when debugging grading issues - working out why a user got a certain grade.

''The following settings become visible when "Show more" is clicked:''

====Width====
Stage size width as a css value, either % or pixels. Default is 100%. You can change to a different percentage by putting a % symbol after the number (ex. 80%). You can also set to a pixels value by entering a number higher than 100 (ex. 800).
====Height====
Stage size height as a css value, either % or pixels. Default is 500 pixels. You can change to a percentage by putting a % symbol after the number (ex. 80%). You can also set to a pixels value by entering a number higher than 100 (ex. 800).

====Options====
There is a series of check boxes for:Allow the window to be resized ad scrolled, displaying directory links, location bar, menu bar, toolbar and/or status.
*'''Student skip content structure page''' - never, first access, always
*'''Disable preview mode''' - If this option is set to Yes, the Preview button in the view page of a SCORM/AICC Package activity will be hidden. The student can choose to preview (browse mode) the activity or attempt it in the normal mode. When a Learning Object is completed in preview (browse) mode, it's marked with browsed icon
*'''Display course structure in player'''

===Availability===
(These settings are collapsed by default.)
{|
|[[File:scormavailability25.png|thumb|470px|Availability settings expanded]]
|}
Choose here the dates you wish the SCORM package to be available to students.

===Grade===
(These settings are collapsed by default)
{|
|[[File:scormgrading.png|thumb|339px|Grade settings expanded]]
|}

====Grading method====
** Learning Objects - This mode shows the number of completed/passed Learning Objects for the activity. The max value is the number of Package's Learning Objects. ''Tip:'' If your SCORM package does report cmi.core.lesson_status, and does not report cmi.core.score.raw, then you should use this setting.
** Highest grade - The grade page will display the highest score obtained by users in all passed Learning Objects. ''Tip:'' If your SCORM package does report cmi.core.score.raw, and does not report cmi.core.lesson_status, then you should use this setting, Average grade, or Sum grade.
** Average grade - If you choose this mode Moodle will calculate the average of all scores.
**Sum grade - With this mode all the scores will be added.
====Maximum grade====
Not applicable if Grading Method is Learning objects. Usual setting is 100. If your SCO 's high score is something other than 100, you should adjust this value appropriately. When grading Method is one of the score settings, then the gradebook grade is package score divided by this number.

===Attempts management===
(These settings are collapsed by default.)
{|
|[[File:scormattempts.png|thumb|416px|Attempts management screen expanded]]
|}
====Number of attempts====
Defines the number of attempts permitted to users. It works only with SCORM 1.2 and AICC packages. SCORM2004 has its own max attempts definition.
** The option to start a new attempt is provided by a checkbox above the '''Enter''' button on the content structure page, so be sure you're providing access to that page if you want to allow more than one attempt.
** An attempt is not complete until the cmi.core.lesson_status for the attempt is set to either 'completed' or 'passed'. After that, the '''Start new attempt''' checkbox is available to the learner.
====Attempts grading====
When you permit multiple attempts for students, you can choose how to record the result in gradebook by first, last, average or highest settings.
* '''Display attempt status''' - If enabled, scores and grades for attempts are displayed on the SCORM outline page. This setting makes the block display more info to the user on the entry page to the SCORM and in the course overview block - if you turn it off it will display less info. This setting is helpful when debugging grading issues - working out why a user got a certain grade.

====Force new attempt====
If this is enabled then every time the student accesses the package, it will count as a new attempt.
====Lock after final attempt====
If this is enabled then once a student has used up all their attempts, they can no longer access the SCORM package.

===Compatibility settings===
(These settings are collapsed by default.)
{|
|[[File:scormcompat.png|thumb|273px|Compatibility settings expanded]]
|}
====Auto-Continue====
For SCORM packages that contain multiple learning objects (or SCO's) and Auto-continue is set to Yes, when a Learning Object calls the "close communication" method the next available object is launched automatically.If it is set to No, the users must use the navigation provided to continue to the next object. Many SCORM packages only contain a single learning object (or SCO) so this setting does not apply.
:''TIP:'' If your package contains multiple branches Auto-Continue will only move from one object to the next within the same topic.

====Force completed====
If this is enabled then the status of the current attempt is set to "complete". Note that this only applies to SCORM 1.2 packages and is useful if the SCORM package does not handle revisiting an attempt correctly, in review or browse mode, or otherwise incorrectly issues the completion status.

* Auto-update frequency - If not using a standard SCORM package uploaded using the filepicker and the SCORM package is hosted outside your Moodle installation the option to auto-update the package will be available - you can elect to have the package updated on every entry to the package or daily via the Moodle cron.

===Common module settings===

See [[Common module settings]]

===Restrict access===

These settings will be available if [[Conditional activities]] are enabled.

===Activity completion settings===

If this has been enabled for the course, then SCORM completion may be set based on minimum score or status (e.g. "Passed").

[[File:scormscore1.png]]

===Save settings===

As in most activities there are 3 save button choices. '''Cancel''', '''Save and return to course''' and '''Save changes''' buttons. The Save changes button will take the teacher back to the SCORM "stage" page.

==Site administration settings==

These options are available to the site admin via ''Site administration > Plugins > Activity Modules > SCORM Package''.

===Default Value Settings===
Many of the settings available in the SCORM Package administration simply set the default value for the SCORM activity module setup options provided within courses. Edit these settings to save yourself time when adding large numbers of packages, or to establish a standard for presentation across the site.

===Other Important Settings===
The following options provided which '''do not''' simply set a default value for the SCORM activity editing page view.
; Auto-update frequency
If not using a standard SCORM package uploaded using the filepicker and the SCORM package is hosted outside your Moodle installation the option to auto-update the package will be available - you can elect to have the package updated on every entry to the package or daily via the Moodle cron.
;Synchronization time

;Enable SCORM 1.2 standard mode
:If this setting is disabled, then it will be possible to exceed the allowed amount of stored data for SCORM 1.2 packages. Many SCORM packages go over the 4096 characters limit and while SCORM 2004 allows a higher number of characters, it is not supported. This setting will mean users can allow their 1.2 packages to store more data.
;Enable external package type
:If selected, presents a text field to paste a URL to a remote imsmanifest.xml (in an unzipped remote SCORM package), as well as the file picker option provided by default. Note that the content is played from the designated location, and not unpacked into the Moodle file system. So if the base url is different from your moodle url then browser security will block cross-domain communcation and no grades/tracking information will be passed back to Moodle.
;Enable downloaded package type
:If selected, presents a text field to paste a URL to a remote package.zip SCORM package. Package is downloaded and unzipped into the Moodle file system.
;Enable IMS package type
:Enables a package to be selected from within an IMS repository
;Force users to enable JavaScript
:Since the SCORM API uses JavaScript to save data to Moodle, this is a great idea!
;Activate API debug and tracing (set the capture mask with apidebugmask)
:Turns on debugging for SCORM activities. In Moodle 2 you no longer have to also turn on debugging in the developer options.
;API debug capture mask
:.* will debug for admin user only: You can use the mask to enable debugging under certain conditions. For example, if you are logged in using the admin user (username admin) you can set the api mask to: '''admin.*''' Users not logged in as admin will not see the debugging log. The "Default" api mask is '''.*''' which translates roughly to '''everybody'''.
;Enable direct AICC url
:Makes it easier to connect to externally hosted AICC content as the teacher doesn't have to create an AICC package and is able to link directly to the external AICC url.
;Enable external AICC HACP
:The SCORM activity can also support external AICC HACP Communication where the AICC package is hosted on an external content providers site and passes back http requests directly from the external server instead of within the users web browser session - this is disabled by default.
;AICC pass numeric user id
{{New features}}
; Protect package downloads.
:This is disabled by default, meaning packages can always be downloaded (eg for offline mobile use.) If this is enabled then only users with the capability course:manageactivities can download the package.
==See also==

* [[:dev:SCORM_schema |SCORM Schema]] for developers

[[de:Lernpaket konfigurieren]]
[[fr:Ajouter/modifier un SCORM]]
[[ja:SCORMを追加/編集する]]
[[es:Configuraciones del SCORM]]

Managing plagiarism prevention

2016-04-27T22:58:33Z

Danmarsden: /* Partially supported plugins */ Ephorus merged with Turnitin - no point listing separately.

{{Plagiarism prevention}}
==Enabling plagiarism prevention==

To make use of plagiarism prevention, the feature must be enabled by an administrator by checking the enable plagiarism plugins box in ''Administration > Site administration > [[Advanced features]]''.

[[File:Enableplagiarism.png]]

==Plagiarism prevention plugins==

An administrator then needs to install and configure one or more plagiarism prevention plugins in ''Administration > Site administration > Plugins > Plagiarism prevention > Plagiarism settings''. Possible plugins include:

=== Fully supported plugins ===
These are plugins that support plagiarism detection within the Moodle Assignment, Workshop and Forum activities.
*[[Plagiarism Prevention Compilatio|Compilatio]] - Commercial tool requires paid subscription
*[[Plagiarism Prevention Turnitin|Turnitin]] - Commercial tool requires paid subscription
*[[Plagiarism Prevention URKUND|URKUND]] - Commercial tool requires paid subscription
* [https://moodle.org/plugins/plagiarism_unplag UNPLAG] - Commercial tool requires paid subscription

=== Partially supported plugins ===
These are plugins that currently only support the Moodle Assignment activity.
* [https://moodle.org/plugins/plagiarism_copycheck CopyCheck] - Commercial tool requires paid subscription
* [https://moodle.org/plugins/plagiarism_plagiarisma PLAGIARISMA] - Commercial tool requires paid subscription
* [https://moodle.org/plugins/plagiarism_plagscan PlagScan] - Commercial tool requires paid subscription
* [https://moodle.org/plugins/plagiarism_vericite Vericite] - Commercial tool requires paid subscription

== Other tools for managing plagiarism ==
*[[Acknowledge plagiarism statement access rule]] - A plugin by the Open University lets you require students to agree to a statement about not plagiarising before starting a quiz.
*[https://moodle.org/plugins/view.php?plugin=quizaccess_safeexambrowser Safe Exam Browser quiz access rule] - Provides Safe Exam Browser 2.0 integration for Moodle.

[[Category:Site administration]]
[[de:Plagiatsuche-Plugins verwalten]]
[[es:Gestionando prevención de plagio]]

Managing plagiarism prevention

2016-04-27T22:52:00Z

Danmarsden: /* Plagiarism prevention plugins */ add details on other supported plugins.

{{Plagiarism prevention}}
==Enabling plagiarism prevention==

To make use of plagiarism prevention, the feature must be enabled by an administrator by checking the enable plagiarism plugins box in ''Administration > Site administration > [[Advanced features]]''.

[[File:Enableplagiarism.png]]

==Plagiarism prevention plugins==

An administrator then needs to install and configure one or more plagiarism prevention plugins in ''Administration > Site administration > Plugins > Plagiarism prevention > Plagiarism settings''. Possible plugins include:

=== Fully supported plugins ===
These are plugins that support plagiarism detection within the Moodle Assignment, Workshop and Forum activities.
*[[Plagiarism Prevention Compilatio|Compilatio]] - Commercial tool requires paid subscription
*[[Plagiarism Prevention Turnitin|Turnitin]] - Commercial tool requires paid subscription
*[[Plagiarism Prevention URKUND|URKUND]] - Commercial tool requires paid subscription
* [https://moodle.org/plugins/plagiarism_unplag UNPLAG] - Commercial tool requires paid subscription

=== Partially supported plugins ===
These are plugins that currently only support the Moodle Assignment activity.
* [https://moodle.org/plugins/plagiarism_copycheck CopyCheck] - Commercial tool requires paid subscription
* [https://moodle.org/plugins/plagiarism_ephorus Ephorus] - Commercial tool requires paid subscription
* [https://moodle.org/plugins/plagiarism_plagiarisma PLAGIARISMA] - Commercial tool requires paid subscription
* [https://moodle.org/plugins/plagiarism_plagscan PlagScan] - Commercial tool requires paid subscription
* [https://moodle.org/plugins/plagiarism_vericite Vericite] - Commercial tool requires paid subscription

== Other tools for managing plagiarism ==
*[[Acknowledge plagiarism statement access rule]] - A plugin by the Open University lets you require students to agree to a statement about not plagiarising before starting a quiz.
*[https://moodle.org/plugins/view.php?plugin=quizaccess_safeexambrowser Safe Exam Browser quiz access rule] - Provides Safe Exam Browser 2.0 integration for Moodle.

[[Category:Site administration]]
[[de:Plagiatsuche-Plugins verwalten]]
[[es:Gestionando prevención de plagio]]

Managing plagiarism prevention

2016-04-27T22:34:30Z

Danmarsden: /* Plagiarism prevention plugins */ remove crot from list as not supported in latest versions.

File:UrkundAssignmentSettings.png

2016-04-16T06:35:07Z

Danmarsden: Danmarsden uploaded a new version of File:UrkundAssignmentSettings.png

Settings displayed to a teacher when creating a Module that allows URKUND

Plagiarism Prevention URKUND Settings

2015-12-14T09:30:57Z

Danmarsden: /* Global Configuration of URKUND */ legacy log store no longer used.

{{Plagiarism prevention}}
==Activation of your URKUND Account==
# obtain a URKUND Subscription from [http://www.urkund.com www.urkund.com]

==Installation of the plugin ==
=== Installation using Git ===
from the root of your install:
git clone git://github.com/danmarsden/moodle-plagiarism_urkund.git plagiarism/urkund
then add plagairism/urkund to your .gitignore
Visit the Admin > Notifications page in Moodle to trigger the upgrade scripts
=== Installation using a Zip file ===
Download the zip:
https://github.com/danmarsden/moodle-plagiarism_urkund/zipball/master
or the tar.gz:
https://github.com/danmarsden/moodle-plagiarism_urkund/tarball/master

Then Extract these files into a new folder under /plagiarism/urkund and visit the Admin > Notifications page in Moodle to trigger the upgrade scripts

=== Installation failed due to unprocessed data ===
This error may occur when you try to upgrade to a version of the URKUND plugin that uses the new Moodle events API - it occurs when your installation contains unprocessed events related to the old API. If we ignored these events and upgraded then it is possible that some previously submitted files will not be sent to Urkund for processing.

This is most likely to have occurred if a user has submitted an assignment since the last time your scheduled task process was run.

There was also a recent issue related to group-based assignments that could cause a backlog of events - you may want to apply [https://github.com/danmarsden/moodle-plagiarism_urkund/issues/44 this fix] to your old version of the code to address this. Alternatively use [https://github.com/danmarsden/moodle-plagiarism_urkund/archive/3fe13052eb368faf2bfcb9ccf81aff21263192a7.zip this link] to download an complete version of the URKUND plugin that includes the fix related to the backlog of events.

You can see a list of the queued events in your database by running the following sql query(eventdata is [https://github.com/danmarsden/moodle-plagiarism_urkund/blob/310b498a9e6fcf9e757c0f925878121a78381e95/urkund_debug.php#L171 base64 encoded and serialized]):
SELECT qh.id, qh.status, qh.timemodified, eq.eventdata, eq.stackdump, eq.userid, eh.eventname,
eh.component, eh.handlerfile, eh.handlerfunction
FROM mdl_events_queue_handlers qh
JOIN mdl_events_queue eq ON eq.id = qh.queuedeventid
JOIN mdl_events_handlers eh ON eh.id = qh.handlerid
WHERE (eh.eventname = 'assessable_file_uploaded' or eh.eventname = 'assessable_content_uploaded' or eh.eventname = 'assessable_submitted')

To clear these events normally, you should revert the urkund code to using an earlier version, place the site into maintenance mode (to prevent any other submissions from occurring) run the cron process (sometimes multiple calls are required) until the above sql returns no results. If you have an event in the list with a high "qh.status" value it is possible that this event is causing the queue to block. You could relatively safely try deleting any records with a qh.status higher than 5 and then run cron multiple times until the queue is cleared, and then try to upgrade to the new version of the URKUND plugin.

If you are not concerned about these events and it does not matter if these submissions do not get posted to URKUND for processing you can run the following SQL command to clear the queue and allow the upgrade to continue.
DELETE FROM mdl_events_queue_handlers WHERE handlerid IN (SELECT id FROM mdl_events_handlers WHERE component = 'plagiarism_urkund')

==Global Configuration of URKUND==
# Go to ''Admin > Advanced Features'' find the setting “Enable plagiarism plugins” - make sure the box is ticked.[[File:Enableplagiarism.png]]
# Go to ''Admin > Plugins > Plagiarism Prevention > URKUND''
## Tick the box "Use URKUND"
## Enter your URKUND UIS username
## Enter your URKUND UIS password
## Set the Student Disclosure statement. - this is displayed to all students on the upload screen to notify them that the URKUND system is in use. [[File:Urkundsettings.png]]
# in the page ''Admin > Modules > Activities > URKUND'' click on the tab "URKUND Defaults"
## Configure the default settings to be used inside a Moodle module when creating/editing a new module. [[File:Urkunddefaults.png]]

==Advanced Configuration==
The ability to enable/disable URKUND within a Moodle module such as an assignment is managed using a capability that is by default given to all managers and editing teachers on the site.
If you want to force all assignments on your site to use URKUND and prevent your teachers from changing these settings you can set the defaults above and then remove the capability “moodle/plagiarism_urkund:enable” from your teacher roles.

You can also use this capability to selectively allow certain teachers to use URKUND by setting the default above “Enable URKUND” to “No” - and giving the capabiltiy “moodle/plagiarism_urkund:enable” only to the teachers you want to be able to use URKUND

Plagiarism Prevention URKUND Settings

2015-11-24T08:52:30Z

Danmarsden: /* Installation failed due to unprocessed data */

{{Plagiarism prevention}}
==Activation of your URKUND Account==
# obtain a URKUND Subscription from [http://www.urkund.com www.urkund.com]

==Installation of the plugin ==
=== Installation using Git ===
from the root of your install:
git clone git://github.com/danmarsden/moodle-plagiarism_urkund.git plagiarism/urkund
then add plagairism/urkund to your .gitignore
Visit the Admin > Notifications page in Moodle to trigger the upgrade scripts
=== Installation using a Zip file ===
Download the zip:
https://github.com/danmarsden/moodle-plagiarism_urkund/zipball/master
or the tar.gz:
https://github.com/danmarsden/moodle-plagiarism_urkund/tarball/master

Then Extract these files into a new folder under /plagiarism/urkund and visit the Admin > Notifications page in Moodle to trigger the upgrade scripts

=== Installation failed due to unprocessed data ===
This error may occur when you try to upgrade to a version of the URKUND plugin that uses the new Moodle events API - it occurs when your installation contains unprocessed events related to the old API. If we ignored these events and upgraded then it is possible that some previously submitted files will not be sent to Urkund for processing.

This is most likely to have occurred if a user has submitted an assignment since the last time your scheduled task process was run.

There was also a recent issue related to group-based assignments that could cause a backlog of events - you may want to apply [https://github.com/danmarsden/moodle-plagiarism_urkund/issues/44 this fix] to your old version of the code to address this. Alternatively use [https://github.com/danmarsden/moodle-plagiarism_urkund/archive/3fe13052eb368faf2bfcb9ccf81aff21263192a7.zip this link] to download an complete version of the URKUND plugin that includes the fix related to the backlog of events.

You can see a list of the queued events in your database by running the following sql query(eventdata is [https://github.com/danmarsden/moodle-plagiarism_urkund/blob/310b498a9e6fcf9e757c0f925878121a78381e95/urkund_debug.php#L171 base64 encoded and serialized]):
SELECT qh.id, qh.status, qh.timemodified, eq.eventdata, eq.stackdump, eq.userid, eh.eventname,
eh.component, eh.handlerfile, eh.handlerfunction
FROM mdl_events_queue_handlers qh
JOIN mdl_events_queue eq ON eq.id = qh.queuedeventid
JOIN mdl_events_handlers eh ON eh.id = qh.handlerid
WHERE (eh.eventname = 'assessable_file_uploaded' or eh.eventname = 'assessable_content_uploaded' or eh.eventname = 'assessable_submitted')

To clear these events normally, you should revert the urkund code to using an earlier version, place the site into maintenance mode (to prevent any other submissions from occurring) run the cron process (sometimes multiple calls are required) until the above sql returns no results. If you have an event in the list with a high "qh.status" value it is possible that this event is causing the queue to block. You could relatively safely try deleting any records with a qh.status higher than 5 and then run cron multiple times until the queue is cleared, and then try to upgrade to the new version of the URKUND plugin.

If you are not concerned about these events and it does not matter if these submissions do not get posted to URKUND for processing you can run the following SQL command to clear the queue and allow the upgrade to continue.
DELETE FROM mdl_events_queue_handlers WHERE handlerid IN (SELECT id FROM mdl_events_handlers WHERE component = 'plagiarism_urkund')

==Global Configuration of URKUND==
# Go to ''Admin > Advanced Features'' find the setting “Enable plagiarism plugins” - make sure the box is ticked.[[File:Enableplagiarism.png]]
# Go to ''Admin > Site administration >Plugins >Logging > Manage log stores''. - make sure the "legacy log" store is enabled: [[File:logstores.png]]
# Go to ''Admin > Plugins > Plagiarism Prevention > URKUND''
## Tick the box "Use URKUND"
## Enter your URKUND UIS username
## Enter your URKUND UIS password
## Set the Student Disclosure statement. - this is displayed to all students on the upload screen to notify them that the URKUND system is in use. [[File:Urkundsettings.png]]
# in the page ''Admin > Modules > Activities > URKUND'' click on the tab "URKUND Defaults"
## Configure the default settings to be used inside a Moodle module when creating/editing a new module. [[File:Urkunddefaults.png]]

==Advanced Configuration==
The ability to enable/disable URKUND within a Moodle module such as an assignment is managed using a capability that is by default given to all managers and editing teachers on the site.
If you want to force all assignments on your site to use URKUND and prevent your teachers from changing these settings you can set the defaults above and then remove the capability “moodle/plagiarism_urkund:enable” from your teacher roles.

You can also use this capability to selectively allow certain teachers to use URKUND by setting the default above “Enable URKUND” to “No” - and giving the capabiltiy “moodle/plagiarism_urkund:enable” only to the teachers you want to be able to use URKUND

Plagiarism Prevention URKUND Settings

2015-11-24T08:40:48Z

Danmarsden: add details about possible upgrade failure.

{{Plagiarism prevention}}
==Activation of your URKUND Account==
# obtain a URKUND Subscription from [http://www.urkund.com www.urkund.com]

==Installation of the plugin ==
=== Installation using Git ===
from the root of your install:
git clone git://github.com/danmarsden/moodle-plagiarism_urkund.git plagiarism/urkund
then add plagairism/urkund to your .gitignore
Visit the Admin > Notifications page in Moodle to trigger the upgrade scripts
=== Installation using a Zip file ===
Download the zip:
https://github.com/danmarsden/moodle-plagiarism_urkund/zipball/master
or the tar.gz:
https://github.com/danmarsden/moodle-plagiarism_urkund/tarball/master

Then Extract these files into a new folder under /plagiarism/urkund and visit the Admin > Notifications page in Moodle to trigger the upgrade scripts

=== Installation failed due to unprocessed data ===
This error may occur when you try to upgrade to a version of the URKUND plugin that uses the new Moodle events API - it occurs when your installation contains unprocessed events related to the old API. If we ignored these events and upgraded then it is possible that some previously submitted files will not be sent to Urkund for processing.

This is most likely to have occurred if a user has submitted an assignment since the last time your scheduled task process was run.

There was also a recent issue related to group-based assignments that could cause a backlog of events - you may want to apply [https://github.com/danmarsden/moodle-plagiarism_urkund/issues/44 this fix] to your old version of the code to address this. Alternatively use [https://github.com/danmarsden/moodle-plagiarism_urkund/archive/3fe13052eb368faf2bfcb9ccf81aff21263192a7.zip this link] to download an complete version of the URKUND plugin that includes the fix related to the backlog of events.

You can see a list of the queued events in your database by running the following sql query(eventdata is [https://github.com/danmarsden/moodle-plagiarism_urkund/blob/310b498a9e6fcf9e757c0f925878121a78381e95/urkund_debug.php#L171 base64 encoded and serialized]):
SELECT qh.id, qh.status, qh.timemodified, eq.eventdata, eq.stackdump, eq.userid, eh.eventname,
eh.component, eh.handlerfile, eh.handlerfunction
FROM mdl_events_queue_handlers qh
JOIN mdl_events_queue eq ON eq.id = qh.queuedeventid
JOIN mdl_events_handlers eh ON eh.id = qh.handlerid
WHERE (eh.eventname = 'assessable_file_uploaded' or eh.eventname = 'assessable_content_uploaded' or eh.eventname = 'assessable_submitted')

If you are not concerned about these events and it does not matter if these submissions do not get posted to URKUND for processing you can run the following SQL command to clear the queue and allow the upgrade to continue.
DELETE FROM mdl_events_queue_handlers WHERE handlerid IN (SELECT id FROM mdl_events_handlers WHERE component = 'plagiarism_urkund')
==Global Configuration of URKUND==
# Go to ''Admin > Advanced Features'' find the setting “Enable plagiarism plugins” - make sure the box is ticked.[[File:Enableplagiarism.png]]
# Go to ''Admin > Site administration >Plugins >Logging > Manage log stores''. - make sure the "legacy log" store is enabled: [[File:logstores.png]]
# Go to ''Admin > Plugins > Plagiarism Prevention > URKUND''
## Tick the box "Use URKUND"
## Enter your URKUND UIS username
## Enter your URKUND UIS password
## Set the Student Disclosure statement. - this is displayed to all students on the upload screen to notify them that the URKUND system is in use. [[File:Urkundsettings.png]]
# in the page ''Admin > Modules > Activities > URKUND'' click on the tab "URKUND Defaults"
## Configure the default settings to be used inside a Moodle module when creating/editing a new module. [[File:Urkunddefaults.png]]

==Advanced Configuration==
The ability to enable/disable URKUND within a Moodle module such as an assignment is managed using a capability that is by default given to all managers and editing teachers on the site.
If you want to force all assignments on your site to use URKUND and prevent your teachers from changing these settings you can set the defaults above and then remove the capability “moodle/plagiarism_urkund:enable” from your teacher roles.

You can also use this capability to selectively allow certain teachers to use URKUND by setting the default above “Enable URKUND” to “No” - and giving the capabiltiy “moodle/plagiarism_urkund:enable” only to the teachers you want to be able to use URKUND

Attendance activity

2015-07-12T23:50:50Z

Danmarsden: remove some old cruft.

{{Infobox plugin
|type = Activity module and optional block
|entry = https://moodle.org/plugins/browse.php?list=set&id=36
|tracker = https://github.com/danmarsden/moodle-mod_attendance/issues
|discussion = https://moodle.org/mod/forum/view.php?id=741
|maintainer = [[User:Dan Marsden|Dan Marsden]]
|float = right
}}

== Quick update, July 2013 ==

# [https://moodle.org/mod/forum/discuss.php?d=228684#p997183 Artem Andreev] is no longer working on this plugin, [https://moodle.org/mod/forum/discuss.php?d=228684#p1006980 Dan Marsden] is now maintaining the plugin.
# The old module was previously named 'attforblock' and has now been renamed to 'attendance'
# at this stage no restore code has been written to allow backup files with old style "attforblock" to be restored into the renamed module.
#See the [http://moodle.org/mod/forum/view.php?id=741 Attendance module forum] for discussion and support on this module.
#Location on GIT of the recent versions: [http://github.com/danmarsden/moodle-mod_attendance Attendance module], [http://github.com/danmarsden/moodle-block_attendance Attendance block]

===Introduction===
The '''Attendance''' [[Module|module]] is designed for ''teachers to be able take attendance'' during class, and for ''students to be able to view their own attendance record''.

A teacher can mark the attendance status of a student as "Present", "Absent", "Late", or "Excused". These status descriptions are configurable, and more can be added. The teacher adds Attendance as an activity of a course, and then sets up the sessions whose attendance is to be tracked.

The Attendance module can generate reports for either the entire class or for individual students. Students may also see their own attendance record if the activity is not hidden.

The optional [[Attendance_block|Attendance block]] allows teachers quick access to the Attendance functionality, and allows students quick access to a summary report for their own attendance. (A [[Block|block]] is a user interface element that can be added to Moodle screens.)

=== History ===

Attendance was originally a Moodle [[Block|block]] developed by Russell Jungwirth in 2003 (see post [http://moodle.org/mod/forum/discuss.php?d=2431]). In 2005, [http://moodle.org/user/view.php?id=18237 Dmitry Pupinin] picked up the reins and released version 1.0.2, his first version of the Attendance block (see post [http://moodle.org/mod/forum/discuss.php?d=33132#p158189]). In May 2007, Dmitry released a new version 2.0 suitable for Moodle 1.8. This release was a dramatic restructuring of code that resulted in a significant [[Module|module]] along with a small block (see post [http://moodle.org/mod/forum/discuss.php?d=71597]). Dmitry continued to develop the module and block through 2010.

In November 2010, [http://moodle.org/user/profile.php?id=52322 Artem Andreev] updated the code to version 2.2 (see post [http://moodle.org/mod/forum/discuss.php?d=162960]) to add common and group session options and some user interface improvements. [http://moodle.org/user/view.php?id=1281787&course=5 Luis Ramón López] wrote modifications that added the ability to create multiple attendance instances in a single course; for example, one instance for laboratory activities and another instance for lecture periods (see post [http://moodle.org/mod/forum/discuss.php?d=162960#p724169]). Version 2.3 was released in January 2011. 

Immediately after the release of version 2.3, work began on porting the code to Moodle 2.x. In July 2011, Artem released Attendance version 2.4.0 (see post [http://moodle.org/mod/forum/discuss.php?d=181299]), a rewrite of the code as a [[Module|module]] with an optional [[Block|block]] for use with Moodle 2.x only. In July 2012, Artem released a new branch of version 2.4.0 updated to work with Moodle 2.3.

In July 2013 Dan Marsden took over maintenance of the plugin and renamed the "attforblock" module to "attendance"

There is another unrelated attendance plugin in the plugins database: https://moodle.org/plugins/view.php?plugin=mod_attendanceregister

=== For developers ===

The current version of the Attendance block and the Attendance module are hosted on Dan Marsden's github site.

{| class="wikitable"
|-
! Module
! Block
|-
| [https://github.com/danmarsden/moodle-mod_attendance/tree/master https://github.com/danmarsden/moodle-mod_attendance/tree/master]
| [http://github.com/danmarsden/moodle-block_attendance/tree/master http://github.com/danmarsden/moodle-block_attendance/tree/master]
|}

== Upgrade from mod_attforblock to new mod_attendance ==
The new attendance module renames the attforblock module to attendance - when this module was first created you couldn't have a Module with the same name as a block - newer versions of Moodle allow this and in preparation for inclusion in the moodle.org plugins database we renamed "attforblock" to "attendance" - we have included some code to convert your old "attforblock" database entries to use the new "attendance" format.
# make sure you are running the latest attforblock code - the new attendance module will only allow upgrades from attforblock version 2012120700
# Download the new attendance module and install it in the usual place (in a folder called mod/attendance)
# remove the old "mod/attforblock" folder from your site (don't use the uninstall function in the admin menu unless you don't need to keep previously created attendance modules in your courses)
# Trigger the normal upgrade process by visiting admin > notifications and it will migrate the data from your old attforblock module to the newly named "attendance" module

=== Upgrade info for Developers/Admins ===
The rename of the module only changes one of the database table names - attforblock to attendance, all the other tables are already prefixed with 'attendance' so these aren't changed. The Moodle install process hits install.xml first which is a problem as it will fail as some of the tables listed in install.xml already exist. To work around this we abuse the mod/attendance/version.php file a bit. This file is included first when checking for upgrades so we do a check there to see if data from the old mod_attforblock still exists - it it does it renames the old 'attforblock' table to 'attendance' amd updates the record in the modules to rename it from 'attforblock' to 'attendance' - it also checks to make sure the old 'attforblock' directory has been deleted and will only upgrade from attforblock versions higher than 2012120700 - it's possible this could be improved, pull requests are welcome. After the upgrade has completed you may want to remove the upgrade code from version.php as it will result in an extra few db queries every time the version.php files are loaded to avoid the small unnecessary performance impact that the code causes.

== Installation ==

First, make sure you're familiar with page [[Installing contributed modules or plugins]].

The installation can only be performed by a user who has both write access to the file structure on the computer hosting Moodle and administrator rights for the Moodle installation.

=== Language files ===

The ''language files'' for localizing the module are '''<code>.../attforblock/lang/</code>'''''language code'''''<code>/attforblock.php</code>'''. In order to customize the strings, you can
* either edit the language file(s) of the language(s) you're interested in, or
* edit the string definitions through Moodle itself when logged in as an administrator, via ''Settings > Site administration > Language > Language customization''. '''(Note: this method doesn't seem to work as of 4 Aug. 2012)'''

Note that the '''date format''' is controlled by the language file you install. As an example, assume that you're using the '''<code>en_us</code>''' language file, which defines the date format as m.d.y. In order to change the format to m/d/y, you could use the first method mentioned above, and edit the language definition file '''<code>.../attforblock/lang/en_us/attforblock.php</code>''' and change the string definitions into this:

$string['strftimedm'] = '%m/%d';
$string['strftimedmy'] = '%m/%d/%Y';
$string['strftimedmyw'] = '%m/%d/%y (%a)';
$string['strftimeshortdate'] = '%m/%d/%Y';
$string['strftimedmyhm'] = '%m/%d/%Y %H:%M'; // line added to allow multiple sessions in the same day

Another example: if you're using the '''<code>en</code>''' language file, and want to change the sting "Late" to "Tardy", you could use the second method mentioned above, namely: '''(Note: this method doesn't seem to work as of 4 Aug. 2012)'''
* log in as an administrator;
* click ''Settings > Site administration > Language > Language customization'';
* choose "English (en)" from the pull-down menu, which is shown if more than one language pack has been installed;
* click on the ''Open language pack for editing'' button;
* after the language pack has been loaded, click on the ''Continue'' button;
* in the "Filter strings" screen's component list, scroll down to the bolded "mod" heading, and then click on the "attforblock.php" line under it;
** (note: you could also reduce the number of strings shown, for example by writing "Late" in the "Only strings containing" filter input line)
* click on the ''Show strings'' button;
* scroll down until you find the string ''Lfull'', whose definition is "Late";
* write "Tardy" in the edit box to the right;
* (you might also want to change the definition of the string ''Lacronym'' from "L" to "T";)
* click on the ''Save changes to the language pack'' button on the bottom of the screen; and
* in the confirmation screen, click on the ''Continue'' button.

== Teacher's usage instructions ==

=== Adding an Attendance Activity instance ===

After the attendance module has been properly installed, the teacher must add Attendance as an activity to each course they wish to keep attendance for. This is done by first ensuring that you are in the edit mode and then selecting "Add an activity or resource" in a Moodle [[Course_sections|section]] box. Note that you may now add as many instances of the Attendance module as you like, and that each instance may have multiple sections. Be sure to give the instance a name that indicates what it will be used for; for example, "Lecture Attendance". If you will be using groups in your course, set the Group mode accordingly, because even if groups exist in the course, you will not be able to use them within the Attendance module if you select ''No groups''.

Once you have added an attendance instance, you are ready to start taking attendance during classes.

=== Adding an Attendance block to a course page ===

For a shortcut to attendance information for both teachers and students, it is recommended that you install the associated [[Attendance_block|Attendance block]] (see the installation instructions above). If you have done so, you also need to add the Attendance block to your course page, like this:

* Turn editing on.
* Find the block entitled "Add a block."
* In the drop-down menu in this block, select ''Attendance'' to add the Attendance block.
* As always, move the block to fit your viewing preference.

=== Setting Attendance categories and grading options ===

Now it is time to set your attendance options. Select your attendance activity and you will see a bar of options, the last of which is "Settings." Select "Settings" and you are presented with acronyms, attendance status descriptions, and grade (points) to assign. By default, the status descriptions are "Present", "Absent", "Late", and "Excused".

You may prefer to change the descriptions (for example, by changing "Late" to "Tardy"), change the way points are counted, or add new status descriptions. To do the latter, fill in the fifth line and click the ''Add'' button. Important: when you hit the ''Add'' button, any changes made to existing options that were made after the last time the ''Update'' button was used will be lost. Likewise, when you hit the ''Update'' button, any changes made to the ''Add'' after the last time the ''Add'' button was hit will be lost.

Finally, when you are done changing items on this page, be sure to click the ''Update'' button to register the changes.

=== Adding sessions ===

Next, it is time to add sessions. To add class sections, click the ''Add'' tab (second from left) at the top of the Attendance page. Alternatively, you can click the ''Add'' button from the Attendance block (if you've installed it) to directly navigate to the page for adding sessions. If you chose "No groups", or have not defined groups, then the Session type will be forced to "Common." If you have defined groups and have chosen to use them in your course's Attendance activity, then you will have the option to create sessions for a group or all students.

You have two options for adding sessions, adding a single session or adding multiple sessions. The single session is self-explanatory as well as time-consuming to use when you have many class sessions, so we will go straight to the more useful option.

Check the ''Create multiple sessions'' button. Select the date and time for the first session you wish to add, followed by the duration of the session. Then, enter the date for the last session you wish to add. Since most classes do not meet seven days a week, select the checkboxes for days the class meets. The final option, frequency, may look confusing but it is actually straightforward: if your class meets every week, as is typical, then you want a frequency of 1 week, which is the default. If your class meets every other week, then select a frequency of 2 weeks, and so on. If you wish, you may type a description for the sessions you are creating. If you leave the description field blank, it will default to "Regular class session". Finally, click the ''Add multiple sessions'' button to create your sessions. You will see a message confirming this.

=== Editing sessions ===

Click on the ''Attendance'' tab.  Here, you will see the list of all attendance sessions you have added. You can delete an individual session by clicking the X on the session rectangle's right-hand side. Alternatively, you can check the checkboxes of each session you wish to delete, and then choose "Delete" from the pull-down menu at the bottom right-hand corner of the page to delete all the selected sessions.

You can edit a session — for example, to change its date or description — by clicking the hand icon on the session rectangle's right-hand side.

=== Taking attendance ===

Finally, we get to using the module for its intended purpose. You can take attendance for a session by clicking on the green radio button on the session rectangle's right-hand side. Those sessions whose attendance has already been taken do not have the green button. However, the description is a link that takes you to a screen for modifying the attendance record for that session.

Note that when taking attendance, the column headings for attendance status are links. If you click one of these column headings, all students will have their status changed to the status you selected. Thus, if everyone is present, you can merely click the ''P'' column header to change everyone's status to "Present". If only one person is absent, you could first click ''P'' to set everyone's status to "Present", and then set the absent student's status to "Absent".

Enter remarks as appropriate — for example, the reason for an absence if known, or the number of minutes a student was late — and click the ''OK'' button to record the information.

=== Reports ===

You can generate attendance reports on sessions:
* Select the Attendance activity of the course and session you're interested in.
* Click on the ''Export'' tab near the top.
* Change the export settings if you wish.
* From the ''Format'' pull-down menu, select the file format you'd like to export the attendance report in.
* Click on the ''OK'' button.
* Your browser will now probably ask you to either display or save the file.

One teacher's style of using the Attendance module, useful in those (probably frequent) situations where there's no access to Moodle in the classroom, is to first take attendance on paper, and then to transfer the information to Moodle later. To ease this task, one can print a monthly report before the start of the month and use the printout for recording attendance during class. This method has the added advantage of having a picture on the printed report for each student who has uploaded their photo to Moodle. '''(as of 4 Aug. 2012, can't see this feature working)'''

== Discuss the module ==

If you have an idea about new features, or need support on using the module, participate in the discussion on the [http://moodle.org/mod/forum/view.php?f=125 Attendance module forum].

== See also ==

* [[Git for Administrators]]

[[Category:Contributed code]]

[[ja:出欠]]

Creating SCORM Content

2015-06-18T01:04:58Z

Danmarsden: /* SoftChalk */ remove generic SCORM statements - this is not the place for educating users on what SCORM is... it should state the features available within the product.

{{SCORM}}

==Creating SCORM Content==
Moodle '''does not''' generate scorm content. Moodle presents the content in SCORM packages to learners, and saves data from learner interactions with the SCORM package.

Some people hand-code SCORM objects using HTML, JavaScript, and sometimes SWF files. There are some templates provided by ADL and by others, which make this process easier.

Others use SCORM authoring software to generate SCORM packages. This process is easier for non-technical users, but not as foolproof.

==Find existing SCORM packages==
You can find SCORM packages on [http://moodle.net/mod/data/view.php?d=1&mode=list&perpage=10&search=&sort=0&order=DESC&advanced=0&filter=1&advanced=1&f_2=SCORM+package&f_11=&f_13=&f_12=&f_9=&f_8= Moodle.net] Please feel free to add yours to the database.

==Before Investing in SCORM Authoring Software==
Please be aware that vendors can edit entries on this wiki page. No SCORM authoring software is without bugs, and some have significant issues when used with Moodle. Just because products are listed on this page does not mean that Moodle.org either supports or endorses them. Be sure to test all products extensively before purchase, and be sure that the built-in Moodle authoring tools will not meet your needs. Also take the time to search for past issues with a particular product in the Using Moodle SCORM forum, and read the rest of the Moodle SCORM documentation.

Many of these products piggyback on Powerpoint®, or present talking head video to a learner. Powerpoint presentations and talking heads do not promote social learning. It is valuable to consider, before embarking upon SCORM development, whether your organization wants to limit itself to the pedagogical approaches provided by the SCORM API.

It is also important to know that one does not need to purchase or obtain any product in order to produce SCORM content. SCORM content is a collection of HTML, JavaScript, and multimedia files, all of which can be produced by regular humans. Humans are, in addition, capable of testing your content in your LMS and writing code which addresses the nuances of your LMS, a valuable service which authorware does not provide.

In addition, an authorware production model, in which non-programmers produce content using graphical user interfaces, can present issues because non-programmers do not understand some of the basic tenets of the Web. It is a good idea to educate authorware users about best practices with regard to issues such as file size, file naming conventions, how to publish images for the Web, and so forth, before turning them loose with an authorware product.

==Tools for Authoring==
Here is a list of tools to create SCORM packages, both open source and commercial. Moodle is a modular authoring tool for courses but at this time does not create SCORM packages.

==Creating Reusable Content in SCORM 2004 Video Webinar==

This is the perfect video webinar for instructional designers who need to start developing e-learning content for use in a SCORM 2004-compliant LMS. Available when you need and where you need it, this webinar will give you a basic understanding of how to start developing reusable content. While intended for a SCORM 2004 audience, many of the considerations for re-use can be utilized by SCORM 1.2 developers.

* Part 1: Introduction
* Part 2: Key Terminology
* Part 3: Data Model Elements
* Part 4: Reuse
* Part 5: Designing Reusable Content

You are advise to watch the above videos on ADL's [http://www.adlnet.gov/creating-reusable-content-in-scorm-2004-video-webinar SCORM 2004 Video Webinar] wesite.

==Free OpenSource==
=== eXe OPEN SOURCE SCORM Development Package ===
The eXe project is developing a freely available Open Source authoring application to assist teachers and academics in the publishing of web content without the need to become proficient in HTML or XML markup. Resources authored in eXe can be exported in IMS Content Package, SCORM 1.2, or IMS Common Cartridge formats or as simple self-contained web pages.

The original project:

http://exelearning.org/

The new eXeLearning:

http://exelearning.net/?lang=en

=== ScenariChain Opale / OpaleSup ===
Website and community : http://scenari-platform.org/projects/scenari/en/pres/co/

=== Xerte OPEN SOURCE SCORM Development Package ===
The Xerte Project provides a full suite of open source tools for elearning developers and content authors producing interactive learning materials.

Standalone tool: Xerte http://www.nottingham.ac.uk/xerte/

Online tool: Toolkits http://www.nottingham.ac.uk/xerte/toolkits.aspx

==Freeware not OpenSource==
=== Courselab ===
CourseLab is a free program but is not open source. Feb 2009 current version is 2.4. Received an eLearnings Best of 2007 award.

CourseLab version 2.4 has a few bugs. First is with audio. Sometimes (for some reason not known to CourseLab) the audio will restart, creating an echo effect. You will need to un-check the "autostart" mark of the Video object (vidoe object is used to insert audio too)and then define an action on some event that fits the case (for example on the slide's afterdisplay event) choose METHOD (yourvideoobject, PLAY. this will play the audio after the slide is displayed.

Another issue is with FireFox browsers displaying graphics with CourseLab. It is stated in user's manual that some objects utilize Explorer-specific features and author should avoid using them, if he wants to use the course in multi-browser environment. These are: Gradient Box and all AutoShapes. AutoShapes are VML-objects and VML (Vector Markup Language) is not supported by FireFox. SVG (Scalable Vector Graphics - another vector format) could be the good alternative, but there are still problems with displaying inline SVG-objects in both Gecko-family and IE. (from CourseLab Support)

If these FireFox/Image display problems are not an issue then be sure to install the latest browser plug-ins. If you present content to non-IE users, do not use this authoring package.

There are some problems with Moodle configuration see http://moodle.org/mod/forum/discuss.php?d=96338#p425335

[http://www.courselab.com/ CourseLab home page]

=== Easygenerator===
Easygenerator has a free edition but it is not open source. SaaS based platform in connection to a windows application. Collaborative and special thanks to adaptive options for courses, lot of features like powerpoint import, WYSIWYG interface, Template based. Is now on version 8.3.
Use the HTML publication to the web, school/university intranet, blog, Facebook or your app. Use Scorm 1.2 or 2004 for any LMS. SCORM, You can track and trace learners’ results through Scorm or Xapi.
Using easygenerator ensures your developed courses will be optimized for any device: desktop, tablet or smartphone. Create content once and publish courses for any l device without having to recreate the course.
Publish to a website, blog, Facebook or app and track and trace learners advancements through TinCan (Xapi).
Easygenerator comes with multiple question types to help create the most engaging courses: Multiple Choice, Multiple select, Drag and Drop Text and fill in the blanks.
Co-Author with multiple domain experts, invite subject matter experts to review your course without requiring additional licences.
Build Instructional sound courses fast with easygenerator templates: Quiz, Examn, Adaptive Learning templates and the simple course template.

Homepage: [http://www.easygenerator.com/ Easygenerator's home page]
Signup: [http://www.easygenerator.com/register for instant activation]

=== Free QuizMaker by iSpring ===
[[Image:free-quizmaker.jpg|thumb|Free QuizMaker by iSpring]]

With a free, full-featured QuizMaker by iSpring you can quickly develop Flash-based quizzes and surveys. Easy and fast, it ensures rapid authoring of True/False, Multiple Choice and Multiple Response quizzes and surveys. In addition, you can enhance quizzes with audio, video, images and formulas. [http://www.ispringsolutions.com/free-quiz-maker View sample quizzes]. Advanced functions allow you to insert slides with additional info, and create random sequencing of questions and possible answers in a question.

Quizzes and surveys created with Free QuizMaker are compatible with SCORM 2004 R3 standard and can be easily integrated with Moodle CMS.

[http://www.ispringsolutions.com/free-quiz-maker Download Free QuizMaker by iSpring]

=== iSpring Free ===
[[Image:Ispring-free-toolbar.jpg|thumb|iSpring PowerPoint add-in]]

With iSpring freeware you can create SCORM-compliant e-learning courses that can be integrated with Moodle CMS. Easy for both experts and non-tech users, iSpring Free works as a PowerPoint add-in, accurately converting PowerPoint presentations into Flash courses. Use PowerPoint to its fullest advantage as iSpring features:

* Virtually all PowerPoint animation and slide transition support
* Trigger animation support
* Hyperlinks and action buttons
[[Image:ispring-free.jpg‎ |thumb|iSpring Free publish window]]
* Custom aspect ratio for slides
* YouTube and Flash video insertion
* SCORM 2004 r3 compliant course authoring
* Compliancy with PowerPoint 2003/2007/2010 (32-bit and 64-bit versions)

[http://www.ispringsolutions.com/free_powerpoint_to_flash_converter.html Download iSpring Free].

iSpring Free with its ease of use, conversion accuracy and SCORM compliance is a great choice considering that it can be used free of charge commercially and non-commercially.

=== MOS Solo ===
SCORM 2004 authoring tool. Entirely free.

http://www.mindonsite.com/en/produits/mos-solo/

=== MyUdutu ===
Free software for creating elearning courses with flash interactivity. Website here: http://www.udutu.com/ and an explanatory video here: http://www.udutu.com/my_udutu_video.html It is free to sign up and make the courses - there are many customisable templates enabling users to import images/video/audio/etc and incorporate them into scored questions of varying formats. The finished course can be exported as SCORM 2004 or SCORM 1.2 compliant -again for free and then hosted on a Moodle or other site. (The courses can also be hosted on the udutu site, either for free but with a watermark or for a fee) Quite intuitive to use and offering many features, it is however dependent on good connection to the site as it is created online. Also doesn't seem to like working in Opera.

=== Reload ===
Reusable eLearning Object Authoring and Delivery - NB it is rather technical and may only be suitable for those with an understanding of HTML and the underlying SCORM specification.

One problem with Reload is that it sometimes places the imsmanifest file 2 directories deep in the published SCORM package. For the solution to this issue, see https://docs.moodle.org/en/SCORM_FAQ#Manifest_not_found_error

http://www.reload.ac.uk/

==Commercial==
===ActivePresenter===
ActivePresenter allows you to create interactive contents with branching capabilities, quizzes, audios, videos, closed captions, zoom effects, annotations with flexible hotspot, object styling, integration with LMS (SCORM 1.2 and SCORM 2004). The outputs can use Flash or without using Flash (CSS + HTML + JavaScript). It is suitable for creating software demonstrations, presentations, tutorials, assessments, and surveys. More information can be found at http://atomisystems.com.

===Articulate===
Use Articulate Storyline ([http://www.articulate.com/products/storyline-top-features.php Features]) or older tools like: Articulate Presenter '09, coupled with Articulate Quizmaker '09, is a solution in developing SCORM content for Moodle. Both Articulate Presenter '09 and Articulate Quizmaker '09 are SCORM certified by an independent ADL certification expert (both SCORM 1.2 AND SCORM 2004). This means that Articulate Presenter '09 and Quizmaker '09 will seamlessly report results to Moodle by uploading the published project as a SCORM package. With the complete suite of products from Articulate, you'll be able to quickly create e-learning courses from PowerPoint and develop interactive content, quizzes, assessments, and surveys.

Here is a screencast [http://screenr.com/RON] to show you how to upload and track from Articulate Quizmaker '09 in Moodle.

To learn more about the products from Articulate, go to http://www.articulate.com and download a 30 day trial of any of the products including: Articulate Presenter '09, Articulate Quizmaker '09, Articulate Engage '09, and Articulate Video Encoder '09.

Note: Articulate products run only in Windows. There is no Mac or Linux version.

===Atlantic Link===
The Atlantic Link product suite is a rapid, collaborative eLearning tool that creates Flash based eLearning content. This can export SCORM compliant modules which will run smoothly within moodle. It allows the creation of quizes, slideshows and software emulation.

You can find out more information about the Atlantic Link products at http://www.atlanticlinkglobal.com/

===Camtasia===
This is a commercial screen-recording product for producing demonstrations and tutorials. It has SCORM compliant output as an option, and permits quizzing and branching. The SCORM output option creates a single .zip file that is appropriate for uploading into a SCORM activity for Moodle. Retail price for Camtasia is US$299, but non-profit educational discounts of about 50% are offered. 30 day trials are also available.

Note: only the Windows client has SCORM output ability. The Mac OSX version does not.

More information can be found at http://www.techsmith.com/products.asp

=== Captivate ===
Adobe's Captivate software allows you to create fully functioning interactive lessons with quizzes, scoring, and integration (via SCORM) with Moodle. You can create anything from a simple slide show, to a complete branching software simulation or evaluation, all delivered via Flash without learning any code. It is the most straight-forward package and makes it a lot of fun to work with - even adding closed-captioning is really easy! Adobe have a page on Captivate here: [http://www.adobe.com/products/captivate/] - the latest version is Captivate 7.0.

One difficulty with Captivate is that it tends to save important reporting values to a string in suspend_data, rather than in lesson_status, lesson_location, and the like. This makes it more difficult to write custom reports, or to debug interactions.

=== Claro ===
[http://www.dominknow.com/ dominKnow] award-winning HTML5-compliant collaborative authoring tool can publish AICC, SCORM 1.2 up to SCORM 2004, ADLNet's Experience API (also known as the Tin Can API), web, and exe packages (Print available in March 2012). Claro's web based collaborative content creation tool can be accessed by authors using Firefox, IE, Chrome and Safari on any platform. Learners and reviewers are able to use any browser or tablet device to access content. Sporting an easy to use interface based off the Microsoft Ribbon toolbar, Claro includes all the basic content creation features, as well as things like screen recordings, image editing, and extensive interactions. Besides content creation, it is a collaborate environment that enables content developers and reviewers to work together using a central repository with reusable content. See Claro's full [http://www.dominknow.com/index.cfm#features feature list]

* You tube channel: http://www.youtube.com/dominknow
* Try [http://clarolive.com clarolive.com]

===Composica===
Composica is a social e-learning authoring system that offers real-time collaboration among team members and provides a powerful programming- free WYSIWYG environment to create and deliver high-quality interactive e-learning content with embedded social media.

Composica offers extensive multimedia support, including central repository, thousands of media files, customizable media player, built-in audio recording, automatic narration synchronization and mashups with leading external services such as YouTube, Google, Twitter, Facebook and more.

The system provides large variety of fully customizable e-Learning interactions which can be integrated into a test or a game and communicated to the LMS via SCORM 1.2 / 2004.

Composica encourages authoring teams to share knowledge and remove development bottle-necks through a unique groupware environment, powerful tasks system and task reports, project blog, comments, community dashboards and built-in chats.

In addition, Composica includes Social Media tools, to create a real learning community around each course - learners can share knowledge with others, learn from each other, comment on anything, rate everything and more.
For more information see: http://www.composica.com/features/

=== ContentGenerator.net SCORM functionality ===
Software was successfully used at the CambsMoodle.org conference on July 10th 2008 - every teacher at the workshop was able to get their SCORM game uploaded and working. The software doesn't create extensive courses, but instead trackable interactive Flash games such as Fling the Teacher and Teacher Invaders.

* Free software (+ some pay for) at http://www.contentgenerator.net/ - need to register on forum, but downloads free from there.
* Select SCORM option within software
* Generates single .zip file
* Select 'Add SCORM / AICC' from add resource option in your course
* Edit SCORM settings - copy settings from <nowiki>http://www.contentgenerator.net/images/scorm/16_settings_mostimportant.png</nowiki>
* Some overly detailed instructions available here: http://www.contentgenerator.net/scorm/

===Coral Presenter===
With Coral Presenter, a plugin for PowerPoint, users can easily add audio and video files, as well as quizzes to create more engaging and interactive e-learning presentations. A ribbon menu, slide-level call-outs, attachments and links, custom tabs and one-click publishing are just some of the unique features of Coral Presenter. Coral will convert your content to Flash format and bundle all neccessary files and data for publishing to Moodle or any other SCORM 1.2 compliant LMS. Completion tracking can be set either by number of slides viewed or by quiz scores.

Coral Presenter was developed to work with Microsoft PowerPoint 2007, PowerPoint XP and PowerPoint 2003. Download a free trial at http://www.coral-learning.com/downloads.

=== DemoCreator ===
DemoCreator is a Flash-based screen recording software which allows users to generate screencast by recording computer screen. It's mainly used to create desktop tutorials and Web-based presentation for distance learning and training. The SCORM or AICC output package for LMS is also available. More information can be found at http://www.sameshow.com/demo-creator.html.

=== Easygenerator===
Easygenerator has a free and a paid version. SaaS based platform in connection to a windows application. Collaborative and special thanks to adaptive options for courses, lot of features like powerpoint import, WYSIWYG interface, Template based. Is now on version 8.3.
Use the HTML publication to the web, school/university intranet, blog, Facebook or your app. Use Scorm 1.2 or 2004 for any LMS. SCORM, You can track and trace learners’ results through Scorm or Xapi.
Using easygenerator ensures your developed courses will be optimized for any device: desktop, tablet or smartphone. Create content once and publish courses for any l device without having to recreate the course.
Publish to a website, blog, Facebook or app and track and trace learners advancements through TinCan (Xapi).
Easygenerator comes with multiple question types to help create the most engaging courses: Multiple Choice, Multiple select, Drag and Drop Text and fill in the blanks.
Co-Author with multiple domain experts, invite subject matter experts to review your course without requiring additional licences.
Build Instructional sound courses fast with easygenerator templates: Quiz, Examn, Adaptive Learning templates and the simple course template.

Homepage: [http://www.easygenerator.com/ Easygenerator's home page]
Signup: [http://www.easygenerator.com/register for instant activation]

=== Flypaper for eLearning ===
Create, share, edit, collaborate and track Flash content without touching a single piece of code with Flypaper™ Pro Flash content creation software.

Output content as SWF, SCORM, EXE, HTML,High Definition Video or on mobile devices.

[http://www.trivantis.com/custom-flash-for-e-learning Flypaper for eLearning]

===Helius Presenter===
Helius Presenter (previously PointeCast Publisher) is a PowerPoint plug-in that automatically converts your PowerPoint XP/2002, 2003 and 2007 presentations into a highly compressed Flash presentation. The Pro version allows you to import and edit audio, import video, and create quizzes and surveys. It's SCORM 1.2 or 2004 compatible. It seems close to Articulate Presenter in terms of functionality but at considerably less cost. Free 15 day trial available from site:
http://www.helius.com/products/scorm.php

=== iSpring Converter ===
[[Image:ppt-to-html5-converter-toolbar.png|thumb|iSpring PPT to HTML5 Converter toolbar]]

Create eLearning courses in HTML5 for viewing on iPads and other mobile devices with iSpring Converter. Installed as a PowerPoint add-in, the converter is very easy to learn and use. It allows you to easily turn your PowerPoint presentations into interactive eLearning courses in HTML5.

iSpring Converter accurately preserves even the most advanced animations, transition effects, embedded audio and embedded video. In addition, the converter provides its own features of inserting YouTube video and Web Object, which can help you create an outstanding eLearning course. Finally, iSpring Converter keeps the interactivity of your course by supporting triggers, on-click animations and hyperlinks. [http://www.ispringsolutions.com/ppt-to-html5 View sample HTML5 presentation]

Once you are done fine-tuning your eLearning course, you can publish it for your LMS. iSpring Converter generates SCORM 1.2, SCORM 2004 (2nd, 3rd and 4th editions) and AICC-compliant eLearning courses. You can specify the number of rated slides for your course, set the duration and select timeout actions. For the highest compatibility, upload your eLearning courses to iSpring Online LMS.

Visit the [http://www.ispringsolutions.com/ispring-converter iSpring website] to learn more about iSpring Converter, view demo courses and download a 30-day fully functional trial version.

=== iSpring Pro ===
[[Image:presentation_sample.jpg|thumb|Sample iSpring-created Flash course]]

Сreate high-impact eLearning courses with iSpring Pro, professional software that streamlines e-learning authoring. Whether you work in PowerPoint 2003, 2007 or 2010, iSpring will help you to transform regular PowerPoint presentations into SCORM-compliant Flash courses ready for integrating with Moodle CMS. iSpring Pro is extremely easy-to-use and allows you to stay focused on eLearning content creation rather than software mastery!

iSpring-created courses preserve the most advanced effects and interactivity of your original PowerPoint presentation including hyperlinks, custom aspect ratio for slides and trigger animations. iSpring Pro also allows the addition of voice and video narration, course branding with customized player and presenter info. Plus, you can additionally protect your content protection with a watermark, password, time limit and playback restriction on set domains only. [http://www.ispringsolutions.com/ispring-pro/demos.html View sample presentations].

iSpring Pro integrates perfectly with iSpring QuizMaker and iSpring Kinetics. Available as a [http://www.ispringsolutions.com/ispring-suite Suite], iSpring products allow the creation of courses with quizzes and interactions then integrating them with Moodle LMS.

[[Image:ispring_pro_toolbar.jpg|thumb|iSpring Pro toolbar]]

Visit the [http://www.ispringsolutions.com/ispring-pro iSpring website] to learn more about iSpring Pro, view demo courses and download a 30-day fully functional trial version.

Here is a [http://www.ispringsolutions.com/articles/upload_to_moodle.html step-by-step instruction] on how to integrate iSpring-made courses with Moodle CMS.

=== iSpring QuizMaker ===
[[Image:ispring_quizmaker.jpg|thumb|iSpring QuizMaker main window]]

Whether you are experienced or new to quiz creation, with iSpring QuizMaker you'll find it easy to create thought-provoking quizzes and surveys. Creating quizzes of 23 question types is as easy as filling out the form. You can check your work instantly with a live preview option and publish your quiz into a SCORM-compliant package ready to be uploaded and tracked with Moodle CMS. You can:

* Add images, audio, video and formulas to questions
* Insert slides with additional information
* Organize branching scenarios based on user answers
* Set custom, result-based feedback to each question
* Organize questions in question pools
* Receive quiz results via email or web server
[[Image:ispring_made_quiz.jpg|thumb|Sample Flash quiz‎ created with iSpring QuizMaker]]
* Upload your quiz to any SCORM 1.2, SCORM 2004 or AICC LMS

[http://www.ispringsolutions.com/ispring-quizmaker/download.html Download 30-day trial]

Even though iSpring QuizMaker has a lot to offer, all its features are intuitively designed into a single window for a hassle-free quiz authoring experience!

[http://www.ispringsolutions.com/ispring-quizmaker iSpring QuizMaker]

=== GOMO ===
gomo is multi-device e-learning authoring tool. It is the easiest way to create beautiful learning which look sand feels bespoke, for content that suits your needs perfectly.

Easily create interactive content - Video, audio, graphic and text content are just a drag and drop away with gomo's intuitive user interface for fast, flexible content creation.

* Simple and rich authoring
* Easy course management
* Library of themes
* Team-based development
* Shared central resources
* Hassle-free multi-device publishing
* HTML5, SCORM, TinCan (xAPI)

[http://www.gomolearning.com/ Gomo learning]

=== Knowledge Anywhere's ICE Tool - Instructional Content Editor Tool ===
Create and publish SCORM-compliant courses with WYSIWYG tool, that are ready to be uploaded into any LMS.
The Instructional Content Editor Tool offers many features including streaming video, pre-made page templates, storyboard export to Word function, language translation and many more. Anyone can create a high quality learning course easily. Learn more at http://www.knowledgeanywhere.com/ShowPage.aspx?pkContentID=102
--------------------------

=== Lectora Inspire ===
Lectora Inspire makes online course development fast and simple. Bundled with the leading flash content creation, screen capture, and recording software, Lectora’s powerful authoring tools empower you to quickly create dynamic video and Flash eLearning content.

Publish options include: SCORM and AICC-compliant Learning Management Systems, HTML, CD and a variety of mobile devices.

[http://www.trivantis.com/e-learning-software-tools Lectora Inspire]

Note: Inspire is a bundle that includes Camtasia and Snap! for outputting SCORM. It runs only in Windows, not a Mac.

=== Lectora Online ===
The power of Lectora, online. Enable teams of course developers, designers and subject matter experts to easily create, modify and collaborate on course content. Instantly view real-time changes and streamline your project life cycle.

Work with your Macintosh! [http://www.trivantis.com/lectora-online-free-trial 30-day free trial]

Publish options include: SCORM and AICC-compliant Learning Management Systems, HTML, CD and a variety of mobile devices.

[http://www.trivantis.com/online-e-learning Lectora Online]

=== Microsoft Learning Development System ===
Free tool from Microsoft that allows you to create SCORM resources using drag and drop.

"The LCDS is a free tool that enables the Microsoft Learning community to create high-quality, interactive, online courses. The LCDS allows anyone in the Microsoft Learning community to publish e-learning courses by completing the easy-to-use LCDS forms that seamlessly generate highly customized content, interactive activities, quizzes, games, assessments, animations, demos, and other multimedia."

This is an internal Microsoft tool. Has a few bugs and can crash.

NOTE READ the Help info. To upload to Moodle you will need to zip up your working directory then upload using the 'Add SCORM / AICC' from add resource option in your course

[http://www.microsoft.com/learning/tools/lcds/default.mspx Microsoft's page for LCDS updated to 2.2 on Jan 2009]

=== Mohive ===
"Mohive makes it possible for more people to design custom e-learning content thanks to a unique platform that simplifies each step of the development process. The only solution on the market to feature an integrated project management tool, Mohive makes it possible to cut production lead times considerably, especially when many different people are involved."

[http://www.crossknowledge.com/en_GB/elearning/technologies/mohive.html]

===PowerPointForce===
PowerpointForce is a MS windows program, which converts PowerPoint(2003/2007) slides into flash with different additional features and brings to you professional rapid flash-based presentations in the matter of minutes.
SCORM 1.2 or 2004 compatible. Free 14 days trial, tutorials, examples are available from site:
http://www.elearningforce.com/products/Pages/PowerPointForce.aspx

=== PowerQuizPoint - Quiz Creator ===
Create a Flash-Based Quiz from PowerPoint in two steps. PowerQuizPoint easily create interactive Macromedia Flash Quizzes from within PowerPoint. PowerQuizPoint is a convergence of power features in PowerPoint and Macromedia Flash. Flash Quizzes created with PowerQuizPoint is web ready. Insert interactive Quiz slides directly into PowerPoint presentations and Publish them to Macromedia Flash format.

[[Image:powerquizpoint-question.jpg|thumb|PowerQuizPoint question]]

PowerQuizPoint PowerPoint Quiz Maker provides options like insert your questions with up to 4 choices per Questions, Separate slides for correct and incorrect answers and Question Bank facility.

[http://www.digitalofficepro.com/powerpoint/quiz-creator.html www.digitalofficepro.com/powerpoint/quiz-creator.html]

=== QuizCreator ===
QuizCreator is a powerful Flash quiz maker that enables trainers and educators to easily create SCORM compliant Flash quizzes with images, sounds, narrations and Flash animations to engage learners through the learning process and offers flexible results tracking and score reporting toolkit.

It supports 9 question types:True/ False, Multiple Choice, Multiple Response,Fill in the Blank, Drag and Drop-Matching,Drag and Drop-Sequences,Word Bank,Click Map and Essay. You could publish you quiz for Flash, Word, Excel or LMS.

[http://www.quiz-creator.com/ QuizCreator]
[[Image:Quizcreator.png|thumb|QuizCreator]]

===QuizForce===
QuizForce is a MS Windows program that provides a comprehensive but easy-to-use set of tools for creating highly customized Flash-based quizzes and surveys for non-programmers.
SCORM 1.2 or 2004 compatible. Free 14 days trial, tutorials, examples are available from site:
http://www.elearningforce.com/products/Pages/Quizforce.aspx

=== Snap! by Lectora ===
For USD$99, create engaging Flash content in minutes (PowerPoint Plugin). Absolutely no learning curve and no more breaking the bank. Snap! by Lectora truly reinvents the term ‘rapid’ by providing you with easy-to-use e-Learning software to create stunning courses, presentations, and fun Flash content.

Publish options include: SCORM and AICC-compliant Learning Management Systems, HTML, and a variety of mobile devices.

[http://rapid-e-learning.trivantis.com/rapid-e-learning-software-for-a-PowerPoint-presentation-in-Flash Snap! by Lectora]
===SoftChalk===
SoftChalk packages your lesson in either a standard zip format or in SCORM format. If you package your lesson using the SCORM format, you can re-use your content in any learning management system that supports SCORM (with no need to revise the content). Additionally, the SCORM standards allow your content to work automatically with specific components of the course management system (for example the gradebook), and to track whether a student has completed the lesson.

SoftChalk is very simple to use. Find more information at http://softchalk.com/

=== STT Trainer===
STT Trainer from Kaplan IT Learning is a complete solution for creating software simulations, electronic user performance support, and documentation to train employees on critical web-, windows, and java-based business software. It can create SCORM compliant packages that can be used withing the moodle system.

You can find out more details about STT Trainer at http://www.stt-trainer.com/

=== ToolBook ===
[Moodle 1.9 / ToolBook Instructor 9.01] Tracking and bookmarking work well. The content should be exported using the SCORM 1.2 option; AICC and SCORM 2004 do not seem to work properly. Scoring works and is viewable within the tracking details, but does not transfer correctly into the Gradebook. see http://www.toolbook.com

=== TutorAuthor NG ===
TutorPro's TutorAuthor NG is a professional software application for quickly creating interactive lessons, training, demonstrations, and simulations. Anyone who needs to develop online product demonstrations, software simulations for e-learning, or online tutorials for user support will find TutorAuthor NG an ideal solution. TutorAuthor NG includes everything you need to capture actions in any application and instantly create a 3D life like simulation. The application is equally at home creating 'soft-skill' tutorials such as new employee introductions, company policy, in fact anything that can be taught electronically.

If you use TutorAuthor NG to create e-learning content, you can add realistic, fully interactive question slides, buttons, click boxes, and text entry boxes, and much more. TutorAuthor NG is SCORM 1.2, SCORM 2004, and AICC compliant, allowing effortless integration with any compliant Learning Management System (LMS).

More information can be found at http://www.tutorpro.com/Products/TutorAuthor_Next_Generation_

=== ViewletBuilder Enterprise ===
Qarbon's ViewletBuilder is cost-effective, comparatively easy to learn, and used by many thousands of corporate, educational, and government professionals since 1999. On Mac OSx and Windows PCs, it is used to create compelling, interactive online tutorials for distance learning and user support. ViewletBuilder Enterprise includes ViewletQuiz, for creating interactive assessments and surveys.

ViewletBuilder Pro, ViewletQuiz, and ViewletBuilder Enterprise are fully SCORM 1.2, SCORM 2004, and AICC compliant.

Qarbon.com provides the highest level of support and training for its customers.

More information and fully functional evaluation downloads are available at:
http://forum.qarbon.com/viewtopic.php?f=3&t=1007&p=3118#p3118

=== Wimba Create (formerly Course Genie) ===
A commercial tool allowing you to convert Word documents into CMS ready content. It's particularly suited for non-technical teachers who have large documents to display on Moodle and allows embedding of video, sound etc. When downloaded to your computer it generates a toolbar in Word giving options to enable easy conversion of the file to clean html pages which include navigation and interactive features. It claims to work on Windows 2000, Windows XP or Windows Vista
Word 2000, XP, 2003 or 2007 and the official site is: http://www.wimba.com/products/wimbacreate/ .

Wimba Create documentation can be found at: http://www.wimba.com/services/support/documentation#wCr

=== Wondershare PPT2Flash Professional ===
Convert PowerPoint to Flash and upload the courses to Moodle.
Note that this is not a free tool, rather there is a free '''trial''' version of the full software. Output from the trial version has a watermark on it.
* Download the trial version of the software from http://www.sameshow.com/powerpoint-to-flash-pro.html
* There is a plug-in menu in PowerPoint, click "Publish" button and select "LMS"
* Select "SCORM 1.2" or "SCORM 2004"
* Click "Convert" button
* Select "Open output folder" after conversion is completed
* Choose the output .zip file and upload to Moodle
* Done!

Some overly detailed instructions available here: http://www.sameshow.com/powerpoint-to-flash/howto3.html

==See also==
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=57059 Are there any sugestions for scorm authoring with Microsoft (MS-M$) word / or any other easy (maybe free) scorm authoring tool?] forum discussion

[[de:Autorenwerkzeuge]]
[[es:Creando contenido SCORM]]

Cron

2015-05-26T22:04:57Z

Danmarsden: copy/pasted incorrectly. (tidy up last change.)

{{Installing Moodle}}
The Moodle 'cron' process is a PHP script (part of the standard Moodle installation) that must be run regularly in the background. The Moodle cron script runs different tasks at differently scheduled intervals.

'''IMPORTANT: Do not skip setting up the cron process on your server for your Moodle. Your site will not work properly without it'''

A special program (typically called - not surprisingly - 'cron') is used to run the Moodle cron script at a regular interval. The Moodle cron script runs tasks include sending mail, updating Moodle reports, RSS feeds, activity completions, posting forum messages and other tasks. Since different tasks have different schedules, not every task will run in Moodle when the cron script is triggered.

The cron program (that runs the Moodle script) is a core part of Unix based systems (including Linux and OSX) being used to run all manner of time-dependent services. On Windows the simplest solution is to create a task in the Windows Task Scheduler and set it to run at regular intervals. On shared hosting, you should find the documentation (or ask support) how cron is configured.

Essentially, the task involves adding a single command to the list of cron activities on your system. On Unix based systems this list is a file called a 'crontab' which all users have.

== General discussion ==

See the later sections for your server type; this section contains some general background information.

There are essentially two steps to implementing cron:
# identifying the correct command to run
# finding the right place on your system to put the command

=== Working out the Moodle cron command ===

Moodle has two different ways to deploy cron which use different scripts within the Moodle install. These are as follows...
# The CLI (command line interpreter) script. This will be at the path <pre>/path/to/moodle/admin/cli/cron.php</pre> If in doubt, this is the correct script to use. This needs to be run by a 'PHP CLI' program on your computer. So the final command may look something like <pre>/usr/bin/php /path/to/moodle/admin/cli/cron.php</pre> You can (and should) try this on your command line to see if it works.
# The web based script. This needs to be run from a web browser and will be accessed via a web url something like '''http://your.moodle.site/admin/cron.php'''. You can find command line based web browser (e.g. wget) so the final command may look like <pre>/usr/bin/wget http://your.moodle.site/admin/cron.php</pre> This has the advantage that it can be run from *anywhere*. If you can't get cron to work on your machine it can be run somewhere else.

=== Finding the right place to put the command ===

This really does depend on the system you are using and you should find and read the documentation for your platform or hosting. In most cases getting the Moodle cron to run consists of establishing the correct command (above) and then adding it, and the time to run the command, to some sort of file. This might be either through a specific user interface or by editing the file directly.

If using the CLI version you also need to make sure that the cron process is run as the correct user. This is not an issue with the web version.

Example... installing cron on Ubuntu/Debian Linux. Assuming logged in as root..

''use the crontab command to open a crontab editor window for the www-data user. This is the user that Apache (the web server) runs as on Debian based systems''
<pre>
$ crontab -u www-data -e
</pre>
''This will open an editor window. To run the cli cron script every 1 minute, add the line:''
<pre>
*/1 * * * * /usr/bin/php /path/to/moodle/admin/cli/cron.php >/dev/null
</pre>
NOTE: the final '''>/dev/null''' sends all the output to the 'bin' and stops you getting an email every 1 minute.

== Setting up cron on your system ==

Choose the information for your server type:

*[[Cron with Unix or Linux]]- Cron services on various UNIX and Linux flavored operating systems.
*[[Cron with Windows OS]] - Cron services in Windows
*''Apple OSX'' - use the built-in 'crontab' service which is exactly the same as [[Cron with Unix or Linux]]. However, you might want to do it the 'Apple way' using launchd - see [[Cron with MAC OS X]]
*[[Cron with web hosting services]]- Cron services in various web hosting examples.

Here are some more instructions for specific hosts (please check that these are up to date):

*[[Cron on 1and1 shared servers]]

== Using third party cron service ==

Besides using cron hosted on your own server, you may use third party cron service (usually called webcron):

*[https://www.easycron.com EasyCron] - A webcron service provider that eliminates the need of crontab or other task schedulers to set cron job.

=== Cron settings in Moodle ===

An admin can set cron execution via command line only or a cron password for remote access in ''Administration > Site administration > Security > Site policies''.

===Remote cron===
Using the 'web based' version of cron it is perfectly ok to place the cron process on a different machine to the Moodle server. For example, the cron service on a Unix server can invoke the cron web 'page' on a Windows based Moodle server.

==Scheduling tasks==
An administrator can schedule cron tasks very precisely from Administration > Site administration > Server > Scheduled tasks, see [[Scheduled tasks]]

==Running cron for several Moodle servers==
* Tasks can run in parallel and processes use locking to prevent tasks from running at the same time which allows cron to be triggered from multiple web servers that serve the same Moodle instance.

* If you are running different Moodle instances on the same server, then each Moodle instance needs a cron job. (Even a single Apache web server can run different Moodle instances on different domains by using its virtual hosts capability [https://httpd.apache.org/docs/2.2/vhosts/index.html https://httpd.apache.org/docs/2.2/vhosts/index.html].)

== Debugging Scheduled Tasks ==

Sometimes, a particular cron task may not be working correctly. In Moodle versions before 2.7 - any cron task that was throwing exceptions would prevent the rest of cron from running. The only way to monitor if cron was completing each time, was to add some automated checking of the output of running cron (e.g. searching for the string "Cron completed at ").

In Moodle 2.7 and later, a single failing scheduled task will not prevent the remaining tasks from completing. When any single scheduled task fails, it is marked as a failure, and scheduled to be reattempted. If the task keeps failing, the next scheduled time will be backed off until it is attempted at most once every 24 hours. But checking the [[Scheduled tasks]] admin page, you can see if any task is currently failing (it will have a non-zero fail delay - which is the number of seconds to wait before reattempting a failed task). A simple way to debug a failing task, is to run it immediately using the [[Administration via command line#Scheduled_tasks|cli scheduled task runner]] and monitor the output.

==See also==
* [http://www.coursebit.net/moodle-cron-job/ All About the Moodle Cron Job]
* [https://docs.moodle.org/310/en/Scheduled_tasks Scheduled tasks Moodle docs]
* [http://en.wikipedia.org/wiki/Cron Wikipedia article on cron function]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=41827 Cron - can someone give me a quick confirmation of function?]
*[http://moodle.org/mod/forum/discuss.php?d=97684 Cronjob Question]
*[http://moodle.org/mod/forum/discuss.php?d=97457 Slow cron : avoiding simultaneous cron]
*[http://moodle.org/mod/forum/discuss.php?d=117168 Visibility of cron.php]
*[http://moodle.org/mod/forum/discuss.php?d=139263#p609060 How to log the output of a Scheduled Task on Windows] - this discussion explains a nice trick that can be very useful when you are experiencing problems with your Windows Scheduled Task and you need to log the output of the Scheduled Task to a log file.

[[es:Cron]]
[[fr:Cron]]
[[ja:Cron]]
[[de:Cron-Job]]

Cron

2015-05-26T22:03:30Z

Danmarsden: tidy up confusion over multiple processes (see MDL-50358)

{{Installing Moodle}}
The Moodle 'cron' process is a PHP script (part of the standard Moodle installation) that must be run regularly in the background. The Moodle cron script runs different tasks at differently scheduled intervals.

'''IMPORTANT: Do not skip setting up the cron process on your server for your Moodle. Your site will not work properly without it'''

A special program (typically called - not surprisingly - 'cron') is used to run the Moodle cron script at a regular interval. The Moodle cron script runs tasks include sending mail, updating Moodle reports, RSS feeds, activity completions, posting forum messages and other tasks. Since different tasks have different schedules, not every task will run in Moodle when the cron script is triggered.

The cron program (that runs the Moodle script) is a core part of Unix based systems (including Linux and OSX) being used to run all manner of time-dependent services. On Windows the simplest solution is to create a task in the Windows Task Scheduler and set it to run at regular intervals. On shared hosting, you should find the documentation (or ask support) how cron is configured.

Essentially, the task involves adding a single command to the list of cron activities on your system. On Unix based systems this list is a file called a 'crontab' which all users have.

A result of this is that cron can be run more often, which means (for example) forum posts can be sent out sooner. Admins can keep cron running at the same schedule as before, but it is strongly recommended that they increase the frequency of running cron to at least once per minute.

== General discussion ==

See the later sections for your server type; this section contains some general background information.

There are essentially two steps to implementing cron:
# identifying the correct command to run
# finding the right place on your system to put the command

=== Working out the Moodle cron command ===

Moodle has two different ways to deploy cron which use different scripts within the Moodle install. These are as follows...
# The CLI (command line interpreter) script. This will be at the path <pre>/path/to/moodle/admin/cli/cron.php</pre> If in doubt, this is the correct script to use. This needs to be run by a 'PHP CLI' program on your computer. So the final command may look something like <pre>/usr/bin/php /path/to/moodle/admin/cli/cron.php</pre> You can (and should) try this on your command line to see if it works.
# The web based script. This needs to be run from a web browser and will be accessed via a web url something like '''http://your.moodle.site/admin/cron.php'''. You can find command line based web browser (e.g. wget) so the final command may look like <pre>/usr/bin/wget http://your.moodle.site/admin/cron.php</pre> This has the advantage that it can be run from *anywhere*. If you can't get cron to work on your machine it can be run somewhere else.

=== Finding the right place to put the command ===

This really does depend on the system you are using and you should find and read the documentation for your platform or hosting. In most cases getting the Moodle cron to run consists of establishing the correct command (above) and then adding it, and the time to run the command, to some sort of file. This might be either through a specific user interface or by editing the file directly.

If using the CLI version you also need to make sure that the cron process is run as the correct user. This is not an issue with the web version.

Example... installing cron on Ubuntu/Debian Linux. Assuming logged in as root..

''use the crontab command to open a crontab editor window for the www-data user. This is the user that Apache (the web server) runs as on Debian based systems''
<pre>
$ crontab -u www-data -e
</pre>
''This will open an editor window. To run the cli cron script every 1 minute, add the line:''
<pre>
*/1 * * * * /usr/bin/php /path/to/moodle/admin/cli/cron.php >/dev/null
</pre>
NOTE: the final '''>/dev/null''' sends all the output to the 'bin' and stops you getting an email every 1 minute.

== Setting up cron on your system ==

Choose the information for your server type:

*[[Cron with Unix or Linux]]- Cron services on various UNIX and Linux flavored operating systems.
*[[Cron with Windows OS]] - Cron services in Windows
*''Apple OSX'' - use the built-in 'crontab' service which is exactly the same as [[Cron with Unix or Linux]]. However, you might want to do it the 'Apple way' using launchd - see [[Cron with MAC OS X]]
*[[Cron with web hosting services]]- Cron services in various web hosting examples.

Here are some more instructions for specific hosts (please check that these are up to date):

*[[Cron on 1and1 shared servers]]

== Using third party cron service ==

Besides using cron hosted on your own server, you may use third party cron service (usually called webcron):

*[https://www.easycron.com EasyCron] - A webcron service provider that eliminates the need of crontab or other task schedulers to set cron job.

=== Cron settings in Moodle ===

An admin can set cron execution via command line only or a cron password for remote access in ''Administration > Site administration > Security > Site policies''.

===Remote cron===
Using the 'web based' version of cron it is perfectly ok to place the cron process on a different machine to the Moodle server. For example, the cron service on a Unix server can invoke the cron web 'page' on a Windows based Moodle server.

==Scheduling tasks==
An administrator can schedule cron tasks very precisely from Administration > Site administration > Server > Scheduled tasks, see [[Scheduled tasks]]

==Running cron for several Moodle servers==
* Tasks can run in parallel and processes use locking to prevent tasks from running at the same time which allows cron to be triggered from multiple web servers that serve the same Moodle instance.

* If you are running different Moodle instances on the same server, then each Moodle instance needs a cron job. (Even a single Apache web server can run different Moodle instances on different domains by using its virtual hosts capability [https://httpd.apache.org/docs/2.2/vhosts/index.html https://httpd.apache.org/docs/2.2/vhosts/index.html].)

== Debugging Scheduled Tasks ==

Sometimes, a particular cron task may not be working correctly. In Moodle versions before 2.7 - any cron task that was throwing exceptions would prevent the rest of cron from running. The only way to monitor if cron was completing each time, was to add some automated checking of the output of running cron (e.g. searching for the string "Cron completed at ").

In Moodle 2.7 and later, a single failing scheduled task will not prevent the remaining tasks from completing. When any single scheduled task fails, it is marked as a failure, and scheduled to be reattempted. If the task keeps failing, the next scheduled time will be backed off until it is attempted at most once every 24 hours. But checking the [[Scheduled tasks]] admin page, you can see if any task is currently failing (it will have a non-zero fail delay - which is the number of seconds to wait before reattempting a failed task). A simple way to debug a failing task, is to run it immediately using the [[Administration via command line#Scheduled_tasks|cli scheduled task runner]] and monitor the output.

==See also==
* [http://www.coursebit.net/moodle-cron-job/ All About the Moodle Cron Job]
* [https://docs.moodle.org/310/en/Scheduled_tasks Scheduled tasks Moodle docs]
* [http://en.wikipedia.org/wiki/Cron Wikipedia article on cron function]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=41827 Cron - can someone give me a quick confirmation of function?]
*[http://moodle.org/mod/forum/discuss.php?d=97684 Cronjob Question]
*[http://moodle.org/mod/forum/discuss.php?d=97457 Slow cron : avoiding simultaneous cron]
*[http://moodle.org/mod/forum/discuss.php?d=117168 Visibility of cron.php]
*[http://moodle.org/mod/forum/discuss.php?d=139263#p609060 How to log the output of a Scheduled Task on Windows] - this discussion explains a nice trick that can be very useful when you are experiencing problems with your Windows Scheduled Task and you need to log the output of the Scheduled Task to a log file.

[[es:Cron]]
[[fr:Cron]]
[[ja:Cron]]
[[de:Cron-Job]]

SCORM FAQ

2015-03-26T22:36:50Z

Danmarsden: /* slash arguments warning when I add/update SCORM objects in my course */ remove duplicate link and fix text.

{{SCORM}}
==What is SCORM?==

SCORM was developed as a result of collaboration in the public and private sectors. The President of the United States, Bill Clinton issued an Executive Order that created an agency (ADL) to oversee the standard for developing and distributing online learning. All Federal agencies are mandated to use programs that meet those standards. SCORM is one result of that order.

There's a really simple "What is SCORM" introduction here: http://moodle.org/mod/forum/discuss.php?d=3757#p18828

A slightly more detailed introduction here: http://www.rusticisoftware.com/resources/whatisscorm/What%20Is%20SCORM.ht

==Should I make my Moodle courses as SCORM or use Moodle's features?==
It depends how you intend to use it. If you are planning on exporting and using in another LMS then SCORM would make this easier. If you want something shiny, then a SCORM package can fit the bill. However, reporting and grading work better in Moodle and for many educators the standard features do the job perfectly and do not require learning a new program. There is a useful form post discussing the pros and cons of SCORM in Moodle here: http://moodle.org/mod/forum/discuss.php?d=200242

==SCORM Information==

Advanced Distributed Learning (ADL) is the organization that wrote the SCORM standard. You can download documentation and samples form ADL's Web site. Documentation for SCORM 1.2 in several languages is available [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201.2%2fDocumentation%20Suite%20(SCORM%201.2)&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View={4D6DFFDE-3CFC-4DD9-A21A-4B687728824A} here].

Philip Hutchison provides an AS3 and JavaScript wrapper, as well as a sample package:
http://pipwerks.com/downloads/

==SCORM Package Contents==

A SCORM package must contains in the root of zip a file named imsmanifest.xml which defines SCORM course structure, resource location and many other things. Other files used in the package, such as HTML files, XML files, multimedia files, and JavaScript for the SCORM API must be listed in this file. The LMS parses the manifest, and provides the files listed there to the content package during runtime.

==AICC Package Contents==

An AICC package is defined by several files (from 4 to 7) with defined extensions as follows:

* CRS - Course Description file (mandatory)
* AU - Assignable Unit file (mandatory)
* DES - Descriptor file (mandatory)
* CST - Course Structure file (mandatory)
* ORE - Objective Relationship file (optional)
* PRE - Prerequisites file (optional)
* CMP - Completition Requirements file (optional)

==Basic Troubleshooting==

* Make sure you are running Moodle 2.1 or higher, a large number of SCORM related bugs are present in previous versions.
*Make sure you (and your users) have JavaScript enabled. SCORM requires JavaScript.
* Make sure your SCORM object is SCORM compliant - check it in an external SCORM player like [https://docs.moodle.org/en/Tools_for_creating_SCORM_content#Reload Reload] to see if it works there.
* Upload a copy of your SCORM object to a [http://en.wikipedia.org/wiki/File_hosting_service File Hosting Service] and post a message asking for help in the forums, linking to your SCORM object explaining exactly what you expect to happen, and what is happening instead.
* Read Dan Marsden's blog post [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle here] (Maintainer of SCORM Module in Moodle)

==Does Moodle Generate SCORM Content?==

Moodle '''does not''' generate scorm content. Moodle presents the content in SCORM packages to learners, and saves data from learner interactions with the SCORM package.

==Can I add a password for access to my SCORM package?==
No, although there is a tracker request for this: MDL-46403 As a workaround you could add your SCORM package using the single activity course format - see [[Course formats]] - and add an enrolment key to the course.

==Supported Versions==

* SCORM 1.2 is supported in Moodle 2.1(or higher) and passes all the tests in the ADL Conformance test suite 1.2.7 for SCORM 1.2. The best place for information on SCORM 1.2 conformance is the [http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Previous%20Versions/SCORM%201.2/Conformance%20Test%20Suite%20(SCORM%201.2)/SCORM_1.2_ConformanceReq.pdf SCORM Comformance Requirements documentation (PDF 3.4MB)].

* SCORM 2004 is not supported in Moodle. Parts of the API have been implemented, but others such as Navigation and Sequencing have not. Development on native SCORM 2004 support in Moodle [https://moodle.org/mod/forum/discuss.php?d=227906 has stopped]. If you require a fully certified SCORM 2004 Player in Moodle, [http://www.scorm.com Rustici Software] have a [http://support.scorm.com/entries/20394726-scorm-cloud-moodle-module Moodle plugin] which connects to their commercial [http://www.scorm.com/scorm-solved/scorm-cloud/ SCORM Cloud] service turning Moodle into a fully compliant SCORM 2004 LMS.

* AICC objects are supported in Moodle 2.1 and higher.

* Moodle does not support Tin Can at this stage.

==Asking for Help in the SCORM Forum==

When trying to engage the community to help with a problem you are facing, you will get a better response if you follow a few simple guidelines:
* Always start your report with '''version information''' - preferably the information displayed on the Admin -> Environment panel eg. http://localhost/moodle/admin/environment.php where http://localhost/moodle is your particular prefix. With this it will be clear how you are running your Moodle instance, on what platform, and at which version. This will quickly expose issues where a simple upgrade will solve your problem.
* Be prepared to '''provide the SCORM package''' that illustrates your problem - if you don't then it will be very difficult for anyone offering assistance to recreate your situation - a real barrier to help.
* '''Screenshots''' are very helpful. Provide a screenshot of all error messages, and any instance where something seems to go wrong in the interface.
* Nonstandard themes can introduce SCORM issues. Be sure to tell us '''what theme you're using'''.
* If you have admin privileges, and have access to a localhost install or other place where real-time users won't be disturbed, be sure to turn on debugging. Navigate to '''Site Administration > Development > Debugging''' and set '''Debug messages: Developer''' and '''Display debug messages: Yes'''. Access the SCORM content. If there are errors printed to the page, include them in your forum post.
* Use [https://developers.google.com/chrome-developer-tools/docs/console Chrome's JavaScript Console] or [https://developer.mozilla.org/en-US/docs/Tools/Web_Console Firebug's JavaScript console] to check that there are no JavaScript errors on the page when the content loads.
* Run your problematic SCORM package through '''API debugging''' (see below) and include the text of that API log with your post. That way we can see right away if the right function calls are not taking place.
* If you're using a content development suite which publishes to SCORM, such as Articulate, Captivate, Lectora, LessonBuilder, Udutu, or some other product, then include that in your post. Every authoring software has its ticks, and if you've run into one, it's likely that someone else has also dealt with it, and will recognize it. However, please keep in mind that '''this is a place to get help with Moodle issues, not help with your SCORM package authoring suite'''.

==Debugging ==

# Debugging settings are located at Settings > Site Administration > Plugins > Activities > Scorm.
# Check the checkbox for '''Activate API debug...'''
# Set the api mask. You can use the mask to enable debugging under certain conditions. For example, if you are logged in using the admin user (username admin) you can set the api mask to: <cite>admin.*</cite> Users not logged in as admin will not see the debugging log. The "Default" api mask is <cite>.*</cite>

==What does the debugging log mean?==

The SCO commonly sends the following communications through the API:

* '''LMSInitialize();''' opens the connection between the SCO and Moodle
* '''LMSGetValue( 'valuename' );''' gets a value from Moodle
* '''LMSSetValue( 'valuename' , 'value' );''' sends a value to Moodle
* '''LMSCommit();''' saves values sent to Moodle via LMSSetValue() and should be called after every LMSSetValue()
* '''LMSFinish()''' saves values sent to Moodle and closes the connection between the SCO And Moodle

Red lines in the debugging log means there was an error in the communication through the API.

If LMSInitialize() fails, returns an error, then no subsequent values sent to Moodle will be saved.

Click through the entire SCORM package. Then access the scorm report for your attempt, and compare the saved values in the debugging log with Moodle's report of the attempt. If the values set in the debug log do not match the values saved to Moodle, then there may be a problem with Moodle. Otherwise it's likely to be an issue with the SCO or the SCORM activity settings not giving you the functionality you need.

==SCORM and the Gradebook==
Please see [https://docs.moodle.org/en/SCORM_FAQ#My_SCORM_Module_doesn.27t_function_properly FAQ:My SCORM Module doesn't function properly] and [https://docs.moodle.org/en/SCORM_FAQ#Handling_of_Multiple_Attempts FAQ:Handling of Multiple Attempts]

Some SCORM packages report both cmi.core.lesson_status and cmi.core.score.raw. Others report only cmi.core.lesson_status, or only cmi.core.score.raw. The '''Grading Method''' setting for SCORM objects is meant to account for that.

If you have the '''Grading Method''' set to '''Highest grade''', '''Average grade''', or '''Sum grade''', and your learning object does not report a score, only, cmi.core.lesson_status, then there will be no numerical score to pass to the gradebook.

If your SCOs do not report cmi.core.score.raw, then the best '''Grading Method''' setting is '''Learning Objects'''. This reports either a 1 or a 0 as a score for each learning object. The gradebook value for that SCORM activity is the percent of scos in the package for which learners got a 1.

On the other hand, if your SCOs do not report a lesson_status, then select one of the score-based '''Grading Method''' options, such as '''Highest grade''', '''Average grade''', or '''Sum grade''', and not '''Learning Objects'''.

If you do not know what your SCOs are reporting to the LMS, then run them through to completion with debugging on.

Much of the way SCORM objects are graded is controlled inside the SCORM Authoring process before it is packaged for use in an LMS like Moodle - make sure all your grading settings are set correctly.

==SCORM Administration Options==

See [[SCORM settings]]

==Common Solutions==

===Difficulty Displaying a SCORM Package===
If you have difficulty displaying a SCORM, try loading the SCORM in [http://www.reload.ac.uk Reload] and re-saving it, then save the folder as a .zip package and try again.

===Character Display Errors===
When you notice there is a problem displaying characters correctly, it could be a misconfiguration of your server. Make sure that both httpd.conf (when using Apache) and php.ini are set to DefaultCharacterset = utf8 or switch the sending of a default character set off.

===slash arguments warning when I add/update SCORM objects in my course===
Some web servers don't support a function called '''slash arguments''' and so Moodle allows you to turn it off, but SCORM packages require '''slash arguments''' to be enabled on the web server in order to work properly.

This affects IIS 5 and earlier and some Apache servers. Under IIS 5 and earlier, a workaround using an [http://www.isapirewrite.com/ ISAPI re-write] tool can be used.

A common problem on Apache web server is the '''File not found''' error after uploading a file. For further instructions to fix this issue can be found here:
* [[Installation_FAQ#Uploaded_files_give_.22File_not_found.22|File not found error on uploaded files]]

For further information about slash arguments and web server configuration see:
* [[admin/environment/slasharguments|Slasharguments]]
* [[Internet Information Services#Slasharguments|IIS server configuration]]
* [[Apache#Slasharguments|Apache slasharguments configuration]]
* [[Nginx#Slasharguments|Nginx slasharguments configuration]]

===SCORM doesn't work on Godaddy Host===
Godaddy hosts give a 404 file not found error - this is because by default they do not allow slash arguments which SCORM requires. The best way to test this is to visit http://yourmoodlesite/admin/tool/health/index.php - but the fix involves adding a php.ini or php5.ini file with the following text:
AcceptPathInfo
cgi.fix_pathinfo=1

===My Flash-Based Content Loads, then Stalls===
This issue is most commonly associated with zlib compression. Classic presentation is that the base HTML file and SWF are loaded into the SCORM player, but the SWF is not able to load any audio or video assets, and therefore stalls. You can watch the loading of SWFs and assets using Chrome's Developer Tools or other.

Check your site's zlib compression settings as an admin by loading up the Server > phpinfo page. zlib compression is not a Moodle setting but a server setting, so you'll need a server admin to disable it. Be sure to Purge All Caches, and clear browser caches, before confirming the change.

===Zlib warning when I add/update SCORM objects in my course===
Zlib is a php compression setting made in a websites PHP configuration - unfortunately some browsers don't handle this well (especially Internet Explorer 6) Some webhosts enable this setting, but it will likely cause issues for your users when they attempt to view/use the SCORM object. You will need to contact your server administrator to turn this off. The setting to change in php configuration is "zlib.output_compression"

===Incorrect file package - missing imsmanifest.xml or AICC structure===
This means that Moodle cannot find a file called imsmanifest.xml inside the SCORM object. Reasons for this could be:
* imsmanifest.xml needs to be immediately inside the scorm directory, NOT inside a directory inside of that. So if the zipped scorm package is package.zip, the unzipped package directory should contain immediately inside of it the imsmanifest.xml. This is a common mistake and normally occurs when a SCORM author creates a package themselves and then selects that folder to compress. This places the content folder inside of another folder, The imsmanifest.xml is there, but it is 2 directories deep. To avoid this problem when zipping scorm content into a package, go INSIDE of the exported scorm folder, select all files inside, and compress them while all are selected. The resultant compressed directory has the imsmanifest.xml file in the first directory, immediately available to the moodle scorm loading process.
* when using linux based systems the filename imsmanifest.xml must be all in lowercase not IMSmanifest.xml or Imsmanifest.XML
* The SCORM authoring tool Articulate sometimes fails to create the imsmanifest.xml -Try exporting the package again and see if the manifest is generated.
* The SCORM authoring tool Articulate Presenter will publish packages where the imsmanifest.xml file is in the correct place, but there are several lines of white space in the manifest file if you do not fill out the Reporting and Tracking Options in Articulate Presenter for Keywords and LMS Description. Moodle will give a "Manifest not found" error when encountering this. To fix this problem select the Reporting and Tracking Options in the Articulate Presenter publish dialog and fill in the LMS Description and Keywords.

===File not found error===
You have this error if the scorm package is created in moodle, and the scorm menu loads, but inside of the viewing area for the scorm content, you get a page with a 404 file not found error, usually showing the current Moodle theme.

What this means is that one of the files listed in the imsmanifest.xml is not in the scorm package or not in the correct directory.

Download and unzip the package, open up imsmanifest.xml. At the bottom of the xml file, below any metadata, you'll find a place where organizations and resources for those organizations are designated:

<code xml>

<organizations default="TOC1">
<organization identifier="TOC1">
<title>SCORM Test</title>
<item identifier="I_SCO0" identifierref="SCO0">
<title>Library Quiz</title>
<adlcp:masteryscore>0</adlcp:masteryscore>
</item>
</organization>
</organizations>
<resources>
<resource identifier="SCO0" type="webcontent" adlcp:scormtype="sco" href="scorm.html">
<file href="scorm.html"/>
<dependency identifierref="ALLRESOURCES" />
</resource>
<resource identifier="ALLRESOURCES" type="webcontent" adlcp:scormtype="asset">
<file href="scorm.html" />
<file href="scorm.js" />
<file href="swfobject.js" />
<file href="scorm.swf" />
<file href="scormwrapper.js" />
</resource>
</resources>
</manifest>
</code>

In this xml, we have a single organization, and in that organization is a single resource, a single sco. There are 5 files necessary for that resource to work correctly. The scorm.html file is loaded first. It loads 3 external js files and a swf.

What you need to do now is go to the directory containing imsmanifest.xml, and check that all of those listed files are available at the correct path from imsmanfiest.xml, as listed in imsmanifest.xml. If any one of those files is missing (especially the html file or the swf), or if the paths in imsmanifest.xml are incorrect, then it's very likely that the scorm object won't be able to load at all.

Sometimes the files aren't missing, but are simply misnamed in the manifest, or placed in the wrong directory. You can fix this by moving the files to the correct places, or updating their names so that the imsmanifest and the actual file names match up. In the case of a misnamed file, change the manifest rather than the actual file names, since the the files also reference one another in other places!

===Unzip issues===
If you get a blank page after filling in the title, description, and selecting a large SCORM file, it's likely you haven't installed the PHP-zip lib which is required for Moodle 2.x for more info see [[admin/environment/php_extension/zip]]

===Clear an Attempt===
To clear attempts by a student:

# Go to the SCORM activity and select the link "View reports for x users"
# Select the attempt or attempts you want to clear using the checkbox
# Select Delete in the drop-down box at the bottom of the page

===Handling of Multiple Attempts===
SCORM is designed to allow a learner to exit and return at a later date to the same point they left from. This means that each time they enter the SCORM they are using the same single attempt. Some SCORM packages are intelligent about handling re-entry, many are not. What this means is that if the learner re-enters an existing attempt, if the SCORM content does not have internal logic to avoid overwriting cmi.core.lesson_status and cmi.core.score.raw, they can be overwritten by a lower score, confusing the learner.

When a SCORM sets the cmi.core.lesson_status value to 'completed', 'passed' or 'failed' then Moodle allows the user to create a new attempt by adding a '''Start new attempt''' checkbox to the entry page. If cmi.core.lesson_status is set to 'incomplete', 'browsed' or 'notattempted' the learner can only re-enter the existing attempt. If you are using the setting 'Student skip content structure page', this checkbox will never be shown to the user.

Moodle provides a range of settings to allow this to be controlled, some of these settings are hidden by default as advanced options.
* Number of attempts
:This allows the teacher to set how many SCORM attempts the learner may create - this is not how many times a learner can re-enter a SCORM attempt.
* Attempts grading
:This allows the teacher to set how multiple SCORM attempts(not re-entries) are graded. It is important to note that a 'failed' cmi.core_lesson_status allows a new attempt to be generated but the attempts grading setting "last completed attempt" only includes 'completed' and 'passed' values in it's calculations.
* Display attempt status
:This displays a users SCORM attempts and how their final grade is calculated on the SCORM entry page and the My Moodle page for the learner.
* Force completed
:This is a setting that can be used to force a SCORM package to report a 'completed' cmi.core.lesson_status if it doesn't currently set the value.
* Force new attempt
:This hides the '''Start new attempt''' checkbox and will force a new attempt if the previous attempt has cmi.core.lesson_status value to 'completed', 'passed' or 'failed' - this setting can also be used to make sure a new attempt is generated when the 'Student skip content structure page' setting is used.
* Lock after final attempt
:This prevents access to the SCORM after the total number of attempts have been used - if this is not set the learner can re-enter their last attempt and potentially change/overwrite their score each time depending on how the SCORM package supports multiple re-entries.

===Reducing Load Time with Captivate===
* Modify the percent that must be downloaded before the content starts to play. In Captivate 4, there's a setting in: Preferences / Project / Start and End / Preload. Reduce that to 50%.
* If you use audio in your Cp file (as background or element attachment), try to put a gap of 0,1 second at the beginning of each element including audio on your slides. If you don't do that, Cp merge all the audio files in one big audio file it need to download before playing the project. This problem have been report many times from the Cp community.

===Moodle changes cmi.core.lesson_status from "completed" or "passed" to "failed"===
Many SCORM authorware suites generate a masteryscore node in the imsmanifest.xml by default. This node is not necessary to the XML file. But when it is there, the SCORM standard designates specific behavior with regard to the value set there.

Here's what is in the scorm standard, on page 35 of 155 in SCORM_1.2_ConformanceReq.pdf, numbered page 2-19 ([http://www.adlnet.gov/Technologies/scorm/SCORMSDocuments/Forms/AllItems.aspx?RootFolder=%2fTechnologies%2fscorm%2fSCORMSDocuments%2fPrevious%20Versions%2fSCORM%201%2e2%2fDocumentation%20Suite%20%28SCORM%201%2e2%29&FolderCTID=0x0120007F801FCD5325044C89D91240519482D7&View=%7b4D6DFFDE%2d3CFC%2d4DD9%2dA21A%2d4B687728824A%7d SCORM Version 1.2 Conformance Requirements Version 1.2]):
<blockquote>
If the value for this element is not set to “incomplete” by the SCO, then the LMS shall re-evaluate and change the value based on the following:<ul>
<li>If there is no mastery score in the Manifest, and the SCO sets a score (cmi.core.score.raw) and the lesson_status (cmi.core.lesson_status) then the LMS shall not override the SCO determined status.</li>
<li>If there is a mastery score in the Manifest, the LMS can change the status to either passed or failed depending on the student's score (cmi.core.score.raw) compared to the mastery score.</li>
<li>If the student is taking the SCO for no-credit, (cmi.core.credit = “no-credit”) there is no change to the lesson_status, with one exception. If the lesson_mode (cmi.core.lesson_mode) is "browse", the lesson_status may change to "browsed" even if the cmi.core.credit is set to no-credit.</li>
</ul>
</blockquote>
This can result in some functionality you don't intend. You can fix the problem by removing the mastery score node from your imsmanifest.xml file. You will also want to find out what options you have, within your authorware suite, for the writing of that node into the manifest file, and change your authoring process accordingly.

===Player Look 'n Feel===
You should be able to adjust height and width settings for the SCORM player window '''so long as''' your theme is based on/not too much of an aberration from one of the standard themes which ship with Moodle 2.

If your site or course theme isn't closely based on one of the standard M2 themes, then it's possible that your theme CSS is overriding local height and width settings for the SCORM player. Have a Web developer (or a Moodle Partner) examine how your theme is interacting with the player layout, and make changes to your theme as needed.

'''Why can't I just change it locally?''' You can change height and width per individual SCORM package, and you can set defaults for these local height and width values ( [[SCORM Admin Options]] ). Other things, such as colors, shading, borders, backgrounds, are controlled by CSS, just like everything else on the site.

=== Courselab 2.4 ===
If you receive a " found more than one record!" error when trying to run your SCORM 1.2 package check the imsmanifest.xml file of your SCORM package and ensure that the values for <organization identifier> and <item identifier> are unique. To change the <organization identifier>, in Courselab, go to File > Course Runtime Settings. The dialog says 'Course identification in LMS' but changing the Identifier field is what sets the <organization identifier>. (see MDL-38060 for more information)

=== SCORM results deleted after package update ===

When uploading a SCORM package over a previous one, if the item identifier in the manifest file is different to the one being overwritten then the tracking data for that SCORM package in Moodle is deleted.

Ensure the item identifier is the same for the new SCORM resource

==See also==

* Using Moodle [http://moodle.org/mod/forum/view.php?id=1951 SCORM forum]
* [http://danmarsden.com/blog/2012/08/08/scorm-doesnt-work-in-moodle SCORM doesn't work] blog post from developer Dan Marsden
* [http://danmarsden.com/blog/2009/05/23/scorm-2004-in-moodle/ SCORM 2004 in Moodle] blog post from developer Dan Marsden
* [https://docs.moodle.org/dev/SCORM_schema Internal SCORM Schema]
* The official standard: [http://www.adlnet.gov/Technologies/scorm/default.aspx Advanced Distributed Learning - SCORM]

Online resources
* [http://www.scormcourse.com/ SCORMCourse.com] serves the SCORM and ADL community as an educational resource for SCORM technology.
* [http://www.eduworks.com/index.php/Publications/Learning-Object-Tutorial.html Learning Object Tutorial]
* [http://elearningweekly.wordpress.com/2007/04/12/tutorial-build-scorm-compatible-lesson-templates-for-your-lms/ Tutorial: Build SCORM-Compatible Lesson Templates for Your LMS]

Using Moodle forum discussions:
*[http://moodle.org/mod/forum/discuss.php?d=3757 Simple introduction to SCORM]
*[http://moodle.org/mod/forum/discuss.php?d=57059 Are there any sugestions for scorm authoring with Microsoft word / or any other easy (maybe free) scorm authoring tool?]
*[http://moodle.org/mod/forum/discuss.php?d=95946 Is SCORM worth it?]
*[http://moodle.org/mod/forum/discuss.php?d=207964 Updating an Object]

[[Category:FAQ]]
[[de:Lernpaket FAQ]]

Managing plagiarism prevention

2015-03-02T21:46:59Z

Danmarsden: /* Other tools for managing Plagiarism */

Managing plagiarism prevention

2015-03-02T21:46:10Z

Danmarsden: move non-plagiarism plugins into separate title

Plagiarism Prevention URKUND Settings

2015-02-11T22:43:41Z

Danmarsden: /* Global Configuration of URKUND */ add instruction to enable log store

SCORM settings

2015-01-21T22:18:51Z

Danmarsden: /* Auto-Continue */ improve text

{{SCORM}}
==Adding a SCORM package==

To add a SCORM package to your course

Quick method: (''Note - does not work with versions of Internet Explorer earlier than IE10'')
# Click the 'Turn editing on' button at the top right of the course page
# Drag and drop the SCORM package zip file onto the course section where you'd like it to appear
# Answer 'Add a SCORM package' to the popup dialogue asking what you want to do with the zip file then click the upload button
# If necessary, edit the title of the file by clicking the pencil icon, or edit other options (see below) by clicking the editing icon

Note: It is currently not yet possible to add AICC packages using the quick method.

Longer method:
# Click the 'Turn editing on' button at the top right of the course page
# Click the 'Add an activity or resource' link in the section you wish to add your SCORM package, then in the activity chooser, select SCORM package then click the Add button (or select 'SCORM package' from the 'Add an activity' dropdown menu)
# Enter a name and a description (which may be required or optional according to the admin settings)
# Either drag and drop a SCORM package zip file into the box with an arrow or click the Add button to open the [[File picker]] menu in order to choose a file from your computer or a repository
# Select display and other options as required (see below)
# Click the button 'Save and display' at the bottom of the page

You can edit or update the SCORM package later by clicking on the edit icon (usually a hand/pen) or by clicking on its name and then ''Settings > SCORM/AICC administration > Edit settings''.

Note: Moodle '''does not''' generate SCORM content. Moodle presents the content in SCORM packages to learners, and saves data from learner interactions with the SCORM package. See [[Tools for creating SCORM content]]

==Course settings==

===General===
{|
|[[File:scormgeneralsettings.png|thumb|430px|General settings expanded by default]]
|}
====Name====
Whatever you type here will form the link learners click on to access the SCORM package, so it is helpful to give it a name that suggests its purpose.
====Description====
Add a description of your SCORM activity here. Click "Show editing tools" to display the rich text editor, and drag the bottom right of the text box out to expand it.
====Display description on the course page====
If this box is ticked, the description will appear on the course page just below the name of the SCORM activity.

===Package===
This setting determines which SCORM package is used by this SCORM activity. Drag and drop or click the icon top left to upload your SCORM package. (Note that you must not unzip the package before upload.)The default (1) is to be able to upload a file. If your admin has added additional options in ''Site administration>Plugins>Activity modules>SCORM package'' then these will be available in a dropdown menu. (2)
{|
|[[File:scormpackage.png|thumb|443px|Package settings expanded by default]]
|}

====Alias/Shortcut====
If you access your SCORM package from a repository (such as [[File system repository]] or [[Private files]]) you can choose to create an alias/shortcut to it and then set an update frequency to set how often Moodle should check to see if there is an updated zip. (See [[Working with files]] for more information on setting an alias/shortcut.)

====Selecting an imsmanifest.xml====

It it possible to select the imsmanifest.xml file and have it as an alias/shortcut. To do this, you need to have created a [[File system repository]] and, when configuring it, allowed relative files. Extract your SCORM package into a folder there. When clicking on the Add button to add your SCORM package, select the file system repository folder with your SCORM package and browse for and select the imsmanfest.xml file, ensuring you the option to create an alias/shortcut to the file. Save and display. (Note this method is only currently supported by the File system repository.)

For more information with screenshots, see Dan Marsden's [http://danmarsden.com/blog/2013/09/24/managing-scorm-content-in-moodle-2-6/ blog post on Managing SCORM content]

Note: The settings (''Type'', ''URL'' and ''Auto-update frequency'') are only available when configured globally. See '''Admin settings''' below.

===Appearance===
(These settings are collapsed by default)
{|
|[[File:26scormappearance.png|thumb|450px|Appearance settings expanded]]
|}

====Display package====
Choose from current or new window. Note that if you choose a new window, students need to ensure pop ups are enabled.
====Display course structure on entry page====
If this is enabled then the table of contents of the package will be displayed when the students clicks to access the package.
====Show Navigation====
This setting determines whether the navigation buttons are shown or not.
#No -they are hidden
#Under content - they are displayed underneath the SCORM package
#Floating - the navigation buttons are floating (with options to choose the position from the left and top)

====Display attempt status====
You can choose whether to display a summary of the student's attempts on the entry page, on their [[My home]] page or both. This setting is helpful when debugging grading issues - working out why a user got a certain grade.

''The following settings become visible when "Show more" is clicked:''

====Width====
Stage size width as a css value, either % or pixels. Default is 100%. You can change to a different percentage by putting a % symbol after the number (ex. 80%). You can also set to a pixels value by entering a number higher than 100 (ex. 800).
====Height====
Stage size height as a css value, either % or pixels. Default is 500 pixels. You can change to a percentage by putting a % symbol after the number (ex. 80%). You can also set to a pixels value by entering a number higher than 100 (ex. 800).

====Options====
There is a series of check boxes for:Allow the window to be resized ad scrolled, displaying directory links, location bar, menu bar, toolbar and/or status.
*'''Student skip content structure page''' - never, first access, always
*'''Disable preview mode''' - If this option is set to Yes, the Preview button in the view page of a SCORM/AICC Package activity will be hidden. The student can choose to preview (browse mode) the activity or attempt it in the normal mode. When a Learning Object is completed in preview (browse) mode, it's marked with browsed icon
*'''Display course structure in player'''

===Availability===
(These settings are collapsed by default.)
{|
|[[File:scormavailability25.png|thumb|470px|Availability settings expanded]]
|}
Choose here the dates you wish the SCORM package to be available to students.

===Grade===
(These settings are collapsed by default)
{|
|[[File:scormgrading.png|thumb|339px|Grade settings expanded]]
|}

====Grading method====
** Learning Objects - This mode shows the number of completed/passed Learning Objects for the activity. The max value is the number of Package's Learning Objects. ''Tip:'' If your SCORM package does report cmi.core.lesson_status, and does not report cmi.core.score.raw, then you should use this setting.
** Highest grade - The grade page will display the highest score obtained by users in all passed Learning Objects. ''Tip:'' If your SCORM package does report cmi.core.score.raw, and does not report cmi.core.lesson_status, then you should use this setting, Average grade, or Sum grade.
** Average grade - If you choose this mode Moodle will calculate the average of all scores.
**Sum grade - With this mode all the scores will be added.
====Maximum grade====
Not applicable if Grading Method is Learning objects. Usual setting is 100. If your SCO 's high score is something other than 100, you should adjust this value appropriately. When grading Method is one of the score settings, then the gradebook grade is package score divided by this number.

===Attempts management===
(These settings are collapsed by default.)
{|
|[[File:scormattempts.png|thumb|416px|Attempts management screen expanded]]
|}
====Number of attempts====
Defines the number of attempts permitted to users. It works only with SCORM 1.2 and AICC packages. SCORM2004 has its own max attempts definition.
** The option to start a new attempt is provided by a checkbox above the '''Enter''' button on the content structure page, so be sure you're providing access to that page if you want to allow more than one attempt.
** An attempt is not complete until the cmi.core.lesson_status for the attempt is set to either 'completed' or 'passed'. After that, the '''Start new attempt''' checkbox is available to the learner.
====Attempts grading====
When you permit multiple attempts for students, you can choose how to record the result in gradebook by first, last, average or highest settings.
* '''Display attempt status''' - If enabled, scores and grades for attempts are displayed on the SCORM outline page. This setting makes the block display more info to the user on the entry page to the SCORM and in the course overview block - if you turn it off it will display less info. This setting is helpful when debugging grading issues - working out why a user got a certain grade.

====Force new attempt====
If this is enabled then every time the student accesses the package, it will count as a new attempt.
====Lock after final attempt====
If this is enabled then once a student has used up all their attempts, they can no longer access the SCORM package.

===Compatibility settings===
(These settings are collapsed by default.)
{|
|[[File:scormcompat.png|thumb|273px|Compatibility settings expanded]]
|}
====Auto-Continue====
For SCORM packages that contain multiple learning objects (or SCO's) and Auto-continue is set to Yes, when a Learning Object calls the "close communication" method the next available object is launched automatically.If it is set to No, the users must use the navigation provided to continue to the next object. Many SCORM packages only contain a single learning object (or SCO) so this setting does not apply.
:''TIP:'' If your package contains multiple branches Auto-Continue will only move from one object to the next within the same topic.

====Force completed====
If this is enabled then the status of the current attempt is set to "complete". Note that this only applies to SCORM 1.2 packages and is useful if the SCORM package does not handle revisiting an attempt correctly, in review or browse mode, or otherwise incorrectly issues the completion status.

* Auto-update frequency - If not using a standard SCORM package uploaded using the filepicker and the SCORM package is hosted outside your Moodle installation the option to auto-update the package will be available - you can elect to have the package updated on every entry to the package or daily via the Moodle cron.

===Common module settings===

See [[Common module settings]]

===Restrict access===

These settings will be available if [[Conditional activities]] are enabled.

===Activity completion settings===

If this has been enabled for the course, then SCORM completion may be set based on minimum score or status (e.g. "Passed").

[[File:scormscore1.png]]

===Save settings===

As in most activities there are 3 save button choices. '''Cancel''', '''Save and return to course''' and '''Save changes''' buttons. The Save changes button will take the teacher back to the SCORM "stage" page.

==Site administration settings==

These options are available to the site admin in the '''Settings''' menu: ''Site administration > Plugins > Activity Modules > SCORM Package''.

===Default Value Settings===
Many of the settings available in the SCORM Package administration simply set the default value for the SCORM activity module setup options provided within courses. Edit these settings to save yourself time when adding large numbers of packages, or to establish a standard for presentation across the site.

===Other Important Settings===
The following options provided which '''do not''' simply set a default value for the SCORM activity editing page view.
; Auto-update frequency
If not using a standard SCORM package uploaded using the filepicker and the SCORM package is hosted outside your Moodle installation the option to auto-update the package will be available - you can elect to have the package updated on every entry to the package or daily via the Moodle cron.
;Synchronization time

;Enable SCORM 1.2 standard mode
:If this setting is disabled, then it will be possible to exceed the allowed amount of stored data for SCORM 1.2 packages. Many SCORM packages go over the 4096 characters limit and while SCORM 2004 allows a higher number of characters, it is not supported. This setting will mean users can allow their 1.2 packages to store more data.
;Enable external package type
:If selected, presents a text field to paste a URL to a remote imsmanifest.xml (in an unzipped remote SCORM package), as well as the file picker option provided by default. Note that the content is played from the designated location, and not unpacked into the Moodle file system. So if the base url is different from your moodle url then browser security will block cross-domain communcation and no grades/tracking information will be passed back to Moodle.
;Enable downloaded package type
:If selected, presents a text field to paste a URL to a remote package.zip SCORM package. Package is downloaded and unzipped into the Moodle file system.
;Enable IMS package type
:Enables a package to be selected from within an IMS repository
;Force users to enable JavaScript
:Since the SCORM API uses JavaScript to save data to Moodle, this is a great idea!
;Activate API debug and tracing (set the capture mask with apidebugmask)
:Turns on debugging for SCORM activities. In Moodle 2 you no longer have to also turn on debugging in the developer options.
;API debug capture mask
:.* will debug for admin user only: You can use the mask to enable debugging under certain conditions. For example, if you are logged in using the admin user (username admin) you can set the api mask to: '''admin.*''' Users not logged in as admin will not see the debugging log. The "Default" api mask is '''.*''' which translates roughly to '''everybody'''.
;Enable direct AICC url
:Makes it easier to connect to externally hosted AICC content as the teacher doesn't have to create an AICC package and is able to link directly to the external AICC url.
;Enable external AICC HACP
:The SCORM activity can also support external AICC HACP Communication where the AICC package is hosted on an external content providers site and passes back http requests directly from the external server instead of within the users web browser session - this is disabled by default.

==See also==

* [[:dev:SCORM_schema |SCORM Schema]] for developers

[[de:Lernpaket konfigurieren]]
[[fr:Ajouter/modifier un SCORM]]
[[ja:SCORMを追加/編集する]]
[[es:Configuraciones del SCORM]]

Talk:Plagiarism Prevention Turnitin Settings

2014-09-24T21:52:31Z

Danmarsden:

This instruction seems to need updating, yes?

Activation of your Turnitin Account

obtain a Turnitin Subscription from www.turnitin.com
Email your Turnitin Account rep or the Turnitin helpdesk (turnitinsupport@turnitin.com) and paste this text into the e-mail:
'''
Please manually enable our Turnitin account to allow the use of the Turnitin Plagiarism plugin for Moodle 2.0 written by Dan Marsden from Catalyst IT.

We are aware of the Turnitin Basic, Turnitin Direct plugins and the new plugin planned to replace Dan Marsdens plugin but wish to use the older plug-in provided from Dan Marsden/Catalyst IT until the new one is available.'''

I'm trying to set up the Turnitin Assignment plugin but the documentation seems to invite confusion. Please let me know if I'm wrong, thanks.

Yes - if you're just starting with Turnitin you should be using the turnitintooltwo plugin which also includes a replacement for this particular code - this documentation is for my older plugin which is in the process of being deprecated. --[[User:Dan Marsden|Dan Marsden]] ([[User talk:Dan Marsden|talk]]) 05:52, 25 September 2014 (WST)

NTLM authentication

2014-08-18T10:40:07Z

Danmarsden: /* Using the NTLM part of Samba for Apache on Linux */ move ubuntu 12 install info to top of block

{{Authentication}}This document describes how to set up '''NTLM/Windows Integrated Authentication''' in Moodle.

==Overview==
Integrated Windows Authentication uses the security features of Windows clients and servers. It does not prompt users for a user name and password. The current Windows user information on the client computer is supplied by the browser through a challenge/response authentication process with the Web server for the Moodle site.

==Assumptions==

#You are running MS [[Active Directory]] for Authentication.
#The Server hosting your website is a member of the Active Directory Domain that your users are also members of.
#You are able to define people inside your Network (and authenticated to the Domain) from an IP range of computers.
#You are familar with or have read the LDAP authentication documentation.
#The Active Directory domain credentials of your users are returned as '''DOMAINNAME\username''' from your authentication service. If you are using the Winbind service from the Samba project, this can be untrue, depending on your Winbind configuration settings. If you are using Moodle 2.4 or later, you can specify the format of the domain credentials (see below). If you are using an older version and you can not modify your settings to satisfy this last assumption, then you will need to remove or comment out the line that reads:
$username = substr(strrchr($username, '\\'), 1); //strip domain info
and add the relevant lines of code to extract the username part from the domain user credentials and store it in $username.

::'''VERY IMPORTANT''': NTLM authentication depends on [[LDAP authentication]], and NTLM configuration is specified in the LDAP authentication settings page (Site Administration >> Plugins >> Authentication >> LDAP Server). So before trying to configure NTLM, make sure you have LDAP_authentication properly setup and working.

==Installation==

No installation needed. See Site Administration >> Plugins >> Authentication >> LDAP Server for the NTLM config options. You only have to

*Enable NTLM SSO
*Set the IP/Subnet mask for the clients (see below)
*(Optionally) Set the "Remote username format" for your domain user credentials format (see below)
*On IIS: turn on Windows Authentication
*On Apache - use one of the 3 methods outlined below
*On the client pc's, you might need to set the moodle server ip/moodle url as being in "local intranet" (From IE, tools -> options -> security -> local intranet)

It is important to note the following conditions must be satisfied to let NTLM SSO happens:
*you've arrived to the login page with one GET request
*you've ldap->ntlmsso_enabled
*you've ldap->ntlmsso_subnet
*you aren't logged
*the IP of the client is in ntlmsso_subnet

Thus it is needed to set the IP subnet.

==How to Turn Integrated Authentication on==
The auth/ldap/ntlmsso_magic.php file MUST have NTLM/Integrated Authentication enabled on the server or the authentication will not work.

===IIS Configuration===
Open the IIS Management Console and navigate to the auth/ldap/ntlmsso_magic.php file.

====IIS 6.0====
#right click on the file, choose properties
#under the "file security" tab, click on the Authentication and Access control "edit" button
#untick "Enable Anonymous Access" and tick "Integrated Windows Authentication"

====IIS 7.x====
#After navigating to the 'auth/ldap' folder, switch to Content View
#right click on the file, choose "Switch to Features View"
#click on the Authentication icon on the right
#select 'Anonymous Authentication' and click the 'Disable' button
#select 'Windows Authentication' and click the 'Enable' button

*According to [http://moodle.org/mod/forum/discuss.php?d=145171#p634027 this post], if you are using IIS 7.5 (it comes with Windows Server 2008 R2), you have to select 'Windows Authentication' and click on 'Providers'. This shows a list of enabled providers (Negotiate and NTLM, by default). Change the order so that NTLM is at the top of the list.
*If 'Windows Authentication' is not available, then you need to install it as a separate authentication provider (in Control Panel).

===APACHE Configuration===
There are currently 3 possible methods for this:

====Using the NTLM part of Samba for Apache on Linux====
* If using Ubuntu 12.04 or higher you can install this using:
sudo apt-get install php5-ldap
sudo apt-get install libapache2-mod-auth-ntlm-winbind
sudo a2enmod auth_ntlm_winbind
sudo apt-get install winbind smbfs smbclient samba
* If you are using an earlier version of Ubuntu or another distribution you can get the plugin here: http://samba.org/ftp/unpacked/lorikeet/mod_auth_ntlm_winbind/ . You need to download all the files from the link, but not the <code>contrib</code> and <code>debian</code> directories. Then follow the instructions given inside the <code>README</code> file. If you are using Debian/Ubuntu, you can follow these [[#Compiling_mod_auth_ntlm_winbind_on_Debian.2FUbuntu|compilation instructions]].
* Once you have compiled it, put it inside Apache's modules subdirectory (this location depends on a number of factors, like compiling Apache yourself, using different Linux distributions packages, an so on), and load and enable the module in Apache's configuration. For example, if your Apache modules are under <tt>/usr/lib/apache2/modules</tt>, you'll need something like this in your Apache configuration file (usually called <tt>apache2.conf</tt> or <tt>http2.conf</tt>):

<IfModule !mod_auth_ntlm_winbind.c>
LoadModule auth_ntlm_winbind_module /usr/lib/apache2/modules/mod_auth_ntlm_winbind.so
</IfModule>

* Install the Samba <tt>winbind</tt> daemon package. This packages relies on Samba's configuration file to get some important settings (like the Windows domain name, uid and gid range mappings, and so on). In addition to that, you'll need to make your Linux/Unix machine part of the domain. Otherwise winbind won't be able to pull user and groups informationi from the domain controllers. You should read the Samba documentation to perform this step, but the most important part is having something like the following lines in your <code>smb.conf</code> file, inside the [global] section (in addition to what you already have there):

workgroup = DOMAINNAME
password server = *
security = domain
encrypt passwords = true
idmap uid = 10000-20000
idmap gid = 10000-20000

: and executing the command (as root):

# net join DOMAINNAME -U Administrator

: where '''DOMAINNAME''' is the NetBIOS windows domain name, and '''Administrator''' an account with enough privileges to add new machines to the domain. You'll need to type this account's password for the command to succeed.

: In Windows environments you could also try executing the command (as root):

# net join DOMAINNAME -S DCSERVER -U Administrator

: where DCSERVER is the Domain Controller server

: Also, make sure you have disabled "Microsoft Network Server: digitally sign communications (always)" in your Domain Controllers Security Policy, unless you are using a version of Samba that can sign SMB packets.

* Restart the <tt>winbind</tt> service to apply the changes and test that it's running ok by executing:

$ wbinfo -u

: You should get the full list of Windows domain users. If you use '''<tt>-g</tt>''' instead, you'll get the domain groups list.

* Check that your <tt>winbind</tt> package installed the authentication helper command <tt>ntlm_auth</tt>, as we'll need it later. We'll assume the helper is located at <tt>/usr/bin/ntlm_auth</tt>. If yours is at a different location, make sure you adjust the path in the example below.

* Add something like this to your Apache configuration file (usually called <tt>apache2.conf</tt> or <tt>http2.conf</tt>). We'll assume that your Moodle <tt>$CFG->dirroot</tt> directory is located at <tt>/var/www/moodle</tt> in the example:
<Directory "/var/www/moodle/auth/ldap/">
<Files ntlmsso_magic.php>
NTLMAuth on
AuthType NTLM
AuthName "Moodle NTLM Authentication"
NTLMAuthHelper "/usr/bin/ntlm_auth --helper-protocol=squid-2.5-ntlmssp"
NTLMBasicAuthoritative on
require valid-user
</Files>
</Directory>
* Check the permissions of the Winbind pipe directory (Ubuntu places it under <tt>/var/run/samba/winbindd_privileged</tt>, yours may be placed at a different location). Apache will need to be able to enter that directory, so we need to make sure it has the right permissions. So have a look at the permissions of that directory and note the name of the group assigned to it. The following example is from a Ubuntu 7.10 machine:

$ ls -ald /var/run/samba/winbindd_privileged
drwxr-x--- 2 root winbindd_priv 60 2007-11-17 16:18 /var/run/samba/winbindd_privileged/

:so we see the group is <tt>winbindd_priv</tt>.

* Instead of modifying the directory permissions (which could break other services that use winbind) we are going to make the Apache user (<tt>www-data</tt> in our example, but could be <tt>httpd</tt>, or <tt>nobody</tt>, etc.) is part of the appropiate group. Execute the following as root:

# adduser www-data winbindd_priv

: <tt>adduser</tt> is available in Debian and Ubuntu at least. If your distribution doesn't have <tt>adduser</tt>, you can edit <tt>/etc/group</tt> manually to achive the same effect.

* Stop and start the Apache service to apply the changes. Have a look at Apache's error log to see that everything is ok.

* Couple of gotchas - in Fedora Core (and also in Redhat/Centos), keep alive is turned OFF by default in the httpd.conf - see this bug for further info: https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=188138 
simply change the line to that was:
KeepAlive Off
to:
KeepAlive On
and restart apache (/etc/init.d/http restart)
* Here are some notes from people who have the samba winbind option working
::-- I made it work using Ubuntu 7.04. That's what I've used to update the documentation. [[User:Iñaki Arenaza|Iñaki Arenaza]] 10:43, 30 September 2007 (CDT)
::-- I have this working on Ubuntu 8.04 LTS in an RM CC4 Active Directory Domain. [[User:munk3h|Ian]] 16:31 15 December 2009 (GMT)
::-- Running on Ubuntu 10.04 Lucid, Apache2 got this running in no time flat with AD v6. Worth noting that if Using Iñaki Arenaza's LDAP Clone plugin, you will need to add another copy of the Directory tag in <tt>apache2.conf</tt> pointing at the new ldap plugin. --[[User:Christopher O'Kelly|Christopher O'Kelly]] 10:09, 16 April 2012 (WST)

====Using the NTLM Auth Module for Apache on Linux====
The NTLM Auth module is a bit stale and even its authors suggest that you use the [[#Using_the_NTLM_part_of_Samba_for_Apache_on_Linux|NTLM part of Samba with Apache on Linux]]

Get it from here
# get the Module from: http://modntlm.sourceforge.net/
# follow the instructions given there and inside the README that comes with the package.

I (Iñaki Arenaza) strongly recommend using the [[#Using_the_NTLM_part_of_Samba_for_Apache_on_Linux|NTLM part of Samba with Apache on Linux]] over this module. It's better maintained, more robust and has more features.

====Using the mod_auth_sspi Module for Apache 2 on Windows====
NOTE: This setup is currently being used in a live production environment, and is therefore suitable for such use provided it is correctly configured and tested.

This is the recommended method for Apache 2 on Windows, however it will '''not''' work on Linux/UNIX systems.
It provides better stability and higher performance than other NTLM modules.

* Download the mod_auth_sspi Module from: http://sourceforge.net/projects/mod-auth-sspi/. At the moment of writing this (2007.09.30), the current version is mod_auth_sspi 1.0.4, which has two different ZIP files to download:

::* mod_auth_sspi-1.0.4-2.0.58.zip : Use this file if you are using Apache 2.0.x.
::* mod_auth_sspi-1.0.4-2.2.2.zip : Use this file if you are using Apache 2.2.x.

If you are using an x64 version of Apache mod_auth_sspi x64 versions are available from https://www.apachehaus.net/modules/mod_auth_sspi/

These files '''do not''' work with Apache versions 2.4.x.

* Unzip the right file and copy mod_auth_sspi.so (it's inside '''bin''' subdirectory) to your Apache modules directory.
* Edit your Apache 2 configuration file (httpd.conf) to load the module.

<IfModule !mod_auth_sspi.c>
LoadModule sspi_auth_module modules/mod_auth_sspi.so
</IfModule>

* Choose one of the two methods below

: '''Method 1''': This method is recommended for servers that will host a single Moodle instance. Configure NTLM from the main configuration file, add the following to httpd.conf (substitute "C:\moodle" with the path to your Moodle installation e.g. "C:\my-moodle"
<Directory "C:\moodle\auth\ldap">
<Files ntlmsso_magic.php>
AuthName "Moodle at My College"
AuthType SSPI
SSPIAuth On
SSPIOfferBasic Off
SSPIAuthoritative On
SSPIDomain <YOUR AD DOMAIN>
require valid-user
</Files>
</Directory>

: '''Method 2''': The alternative method is to use a .htaccess file
:This method is recommended for servers that will host multiple Moodle instances. It allows additional Moodle instances to be configured without restarting apache, and also makes the solution a little more portable. We need to add a directive to the main httpd.conf to allow configuration of authentication within .htaccess files.
<Directory C:\moodle>
AllowOverride AuthConfig
</Directory>

:::Create a new text file named '.htaccess' in the directory 'C:\moodle\moodle\auth\ldap' and add the following directives:
<Files ntlmsso_magic.php>
AuthName "Moodle at My College"
AuthType SSPI
SSPIAuth On
SSPIOfferBasic Off
SSPIAuthoritative On
SSPIDomain mycollege.ac.uk
require valid-user
</Files>

:This enables the Moodle folder to be moved to any apache webserver that is configured to allow authentication configuration through .htaccess

Lastly for Internet Explorer 7 onwards you must also replace this line in your httpd-ssl.conf file:

BrowserMatch ".*MSIE.*" \

with

BrowserMatch ".*MSIE [2-5]\..*" \

For further help and discussion: http://moodle.org/mod/forum/discuss.php?d=56565

====Using the Kerberos Auth Module for Apache on Linux/UNIX (mod_auth_kerb)====
*Install and configure http://modauthkerb.sourceforge.net/
*Configuration of mod_auth_kerb in a Microsoft Windows Active Directory environment (AD 2003 and above) (http://grolmsnet.de/kerbtut/)

Environment details in this example:
#'''Active Directory Domain:''' EXAMPLE.AC.UK
#'''Active Directory Domain Controller:''' dc.example.ac.uk
#'''Linux/UNIX web server:''' moodle.example.ac.uk
#'''Active Directory user account for web server service principal:''' moodlekerb

Install kerberos on moodle.example.ac.uk and enter the following in krb5.conf (by default: /etc/krb5.conf)

<pre>
[libdefaults]
default_realm = EXAMPLE.AC.UK
[domain_realm]
example.ac.uk = EXAMPLE.AC.UK
[realms]
EXAMPLE.AC.UK = {
admin_server = dc.example.ac.uk
kdc = dc.example.ac.uk
}:
* Test kerberos
Issue the following command at the shell prompt:
<pre>
$> kinit user@EXAMPLE.AC.UK
</pre>

Where 'user' is an Active Directory account for which you know the password.

Next, issue the following:
<pre>$>klist</pre>
If all is OK it will list the Kerberos ticket you were granted from the domain controller (KDC)

* Create HTTP service principal for moodle.example.ac.uk
#Create the 'moodlekerb' '''user''' account in Active Directory (NOT a machine account) to map to the web server service principal (HTTP/moodle.example.ac.uk@EXAMPLE.AC.UK)
NOTE: moodle.example.ac.uk MUST be the canonical DNS name of the server i.e. an A record (NOT a CNAME). Additionally a valid PTR (reverse DNS) record must exist and match the corresponding A record.

#Use the ktpass.exe utility to map the service principal and create a keytab file
Apache requires a keytab file, which is generated with ktpass.exe on the Windows Active Directory Domain Controller.
Unfortunately, this component of Windows Server 2003 SP1 does not function correctly so one must obtain a hot fix: http://support.microsoft.com/kb/919557

Run the following command on the domain controller:
<pre>
C:\path\to\hotfix\ktpass.exe -princ HTTP/moodle.example.ac.uk@EXAMPLE.AC.UK -mapuser EXAMPLE\moodlekerb -crypto DES-CBC-MD5 +DesOnly +setPass +rndPass -ptype KRB5_NT_PRINCIPAL -out moodle.example.ac.uk.keytab
</pre>

Copy C:\path\to\hotfix\moodle.example.ac.uk.keytab to the moodle web server and remember the location (/etc/httpd/moodle.example.ac.uk.keytab or similar)

* Configure Apache / mod_auth_kerb
Edit the Apache configuration for the moodle host and add the following directives:
<pre>
<Directory /path/to/moodle/docs/auth/ldap/>
<Files ntlmsso_magic.php>
AuthName "Moodle"
AuthType Kerberos
KrbAuthRealms EXAMPLE.AC.UK
KrbServiceName HTTP
Krb5Keytab /etc/httpd/moodle.example.ac.uk.keytab
KrbMethodNegotiate on
KrbMethodK5Passwd on
KrbAuthoritative on
require valid-user
</Files>
</Directory>
</pre>

==Configuring IP/Subnet Mask==
Subnet masks are based on binary patterns so need a bit of knowledge to understand. The best way to find out what IP/Subnet masks to use is to ask your Network Admin.

* Just type them one after the other, separated by commas. You can use several syntaxes:
** Type the network-number/prefix-length combination. E.g. 192.168.1.0/24
** Type the network 'prefix', ending in a period character. E.g. 192.168.1.
** Type the network address range ('''this only works for the last address octect'''). E.g. 192.168.1.1-254
:All the three examples refer to the same subnetwork. So assuming you need to specify the following subnetworks:
::* 10.1.0/255.255.0.0
::* 10.2.0.0/255.255.0.0
::* 172.16.0.0/255.255.0.0
::* 192.168.100.0/255.255.255.240
:You can type:
10.1.0.0/16, 10.2.0.0/16, 172.16.0.0/16, 192.168.100.0/28
: or:
10.1.0.0/16, 10.2.0.0/16, 172.16.0.0/16, 192.168.100.240-255
:or even:
10.1., 10.2., 172.16., 192.168.100.0/28
:(the last one cannot be expressed as a network 'prefix' as the netmask does not fall on an octect boundary).

==Configuring Domain user credentials format==
If you are using Moodle 2.4 and later there is a new setting that lets you configure the format of the domain user credentials, instead of using the old fixed format. The setting is called "Remote username format". If you leave this seting empty, the default '''DOMAINNAME\username''' format will be used. You can use the optional '''%domain%''' placeholder to specify where the domain name appears, and the mandatory '''%username%''' placeholder to specify where the username appears.

Some widely used formats are:
* '''%domain%\%username%''' : MS Windows default, contains the domain name, followed by a backlash character, followed by the username.
* '''%username%@%domain%''' : This is the same format used by Kerberos (domain name followed by an at sign, followed by the username).
* '''%domain%/%username%''' : Some people configure Samba+Winbind to use this format.
* '''%domain%+%username%''' : Some people configure Samba+Winbind to use this other format.
* '''%username%''' : Only contains the username, with no domain part.

==Notes/Tips==

#If you are using Firefox, you will need to follow these steps:
:*Load Firefox and type about:config in the address box. The configuration settings page should be displayed.
:*In the Filter box, type the word "ntlm" to filter the NTLM strings. You should see three settings displayed.
:*Double-click on "network.automatic-ntlm-auth.trusted-uris".
:*In the box, enter the full URL of your Moodle server. For example <pre>http://moodle.mydomain.com, (the comma is important)</pre>
:*Close Firefox and restart.
# NTLM seems to not work at all when BASIC authentication is enabled. (this was using the Kerberos method, other ways may work)
# If the account in your AD management console shows like "First Last", you better change the ldap settings parameter 'User Attribute' from its default of {blank} / 'cn' to 'sAMAccountName' as indicated in [http://moodle.org/mod/forum/discuss.php?d=132364#p682173 this post]. The reason is that the cn name generally looks like "First Last", once you done the ldap sync, the user name in moodle will be "first last", but IE passes the account of "domain\first.last" to moodle which does not exist in moodle.

== To get a domain name for Moodle working on IIS7.5 Windows 2008 R2 ==
Refer to http://support.microsoft.com/kb/896861. Key section listed below.
Click Start, click Run, type regedit, and then click OK. 
In Registry Editor, locate and then click the following registry key:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\MSV1_0 
Right-click MSV1_0, point to New, and then click Multi-String Value. 
Type BackConnectionHostNames, and then press ENTER. 
Right-click BackConnectionHostNames, and then click Modify. 
In the Value data box, type the host name or the host names for the sites that are on the local computer, and then click OK. 
Quit Registry Editor, and then restart the IISAdmin service.

==Compiling mod_auth_ntlm_winbind on Debian/Ubuntu==
You need to install the following packages (and all of their dependencies) by using aptitude, synaptic, etc.:

autoconf apache2-threaded-dev debian-builder

Once you have them installed, open up a text console, go to the directory where you downloaded the mod_auth_ntlm_winbind files an execute the following commands (as a normal user):

autoconf
./configure --with-apxs=/usr/bin/apxs2 --with-apache=/usr/sbin/apache2
make

That should compile it without errors. Then as a user that can run commands as root via sudo, execute the following command from the same directory:

sudo make install

This will create the final mod_auth_ntlm_winbind.so file and install it under /usr/lib/apache2/modules, with the rest of the Apache 2 modules (the size of the file and last modification time shown below may differ from your install):

ls -l /usr/lib/apache2/modules/mod_auth_ntlm_winbind.so
-rw-r--r-- 1 root root 20921 2009-02-17 04:27 /usr/lib/apache2/modules/mod_auth_ntlm_winbind.so

==See also==
*[http://moodle.org/mod/forum/view.php?id=42 Using Moodle: User authentication] forum
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=45887 NTLM Authentication] forum discussion
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=80104 Merging AD NTLM SSO into auth/ldap] forum discussion
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=186661 Moodle in a DMZ with NTLM] forum discussion
*[http://moodle.org/mod/data/view.php?d=13&rid=314 Download the NTLM Authentication Module]

[[Category:Contributed code]]

[[fr:Authentification NTLM]]

NTLM authentication

2014-08-18T10:34:01Z

Danmarsden: remove old 1.8/1.9 references.

{{Authentication}}This document describes how to set up '''NTLM/Windows Integrated Authentication''' in Moodle.

==Overview==
Integrated Windows Authentication uses the security features of Windows clients and servers. It does not prompt users for a user name and password. The current Windows user information on the client computer is supplied by the browser through a challenge/response authentication process with the Web server for the Moodle site.

==Assumptions==

#You are running MS [[Active Directory]] for Authentication.
#The Server hosting your website is a member of the Active Directory Domain that your users are also members of.
#You are able to define people inside your Network (and authenticated to the Domain) from an IP range of computers.
#You are familar with or have read the LDAP authentication documentation.
#The Active Directory domain credentials of your users are returned as '''DOMAINNAME\username''' from your authentication service. If you are using the Winbind service from the Samba project, this can be untrue, depending on your Winbind configuration settings. If you are using Moodle 2.4 or later, you can specify the format of the domain credentials (see below). If you are using an older version and you can not modify your settings to satisfy this last assumption, then you will need to remove or comment out the line that reads:
$username = substr(strrchr($username, '\\'), 1); //strip domain info
and add the relevant lines of code to extract the username part from the domain user credentials and store it in $username.

::'''VERY IMPORTANT''': NTLM authentication depends on [[LDAP authentication]], and NTLM configuration is specified in the LDAP authentication settings page (Site Administration >> Plugins >> Authentication >> LDAP Server). So before trying to configure NTLM, make sure you have LDAP_authentication properly setup and working.

==Installation==

No installation needed. See Site Administration >> Plugins >> Authentication >> LDAP Server for the NTLM config options. You only have to

*Enable NTLM SSO
*Set the IP/Subnet mask for the clients (see below)
*(Optionally) Set the "Remote username format" for your domain user credentials format (see below)
*On IIS: turn on Windows Authentication
*On Apache - use one of the 3 methods outlined below
*On the client pc's, you might need to set the moodle server ip/moodle url as being in "local intranet" (From IE, tools -> options -> security -> local intranet)

It is important to note the following conditions must be satisfied to let NTLM SSO happens:
*you've arrived to the login page with one GET request
*you've ldap->ntlmsso_enabled
*you've ldap->ntlmsso_subnet
*you aren't logged
*the IP of the client is in ntlmsso_subnet

Thus it is needed to set the IP subnet.

==How to Turn Integrated Authentication on==
The auth/ldap/ntlmsso_magic.php file MUST have NTLM/Integrated Authentication enabled on the server or the authentication will not work.

===IIS Configuration===
Open the IIS Management Console and navigate to the auth/ldap/ntlmsso_magic.php file.

====IIS 6.0====
#right click on the file, choose properties
#under the "file security" tab, click on the Authentication and Access control "edit" button
#untick "Enable Anonymous Access" and tick "Integrated Windows Authentication"

====IIS 7.x====
#After navigating to the 'auth/ldap' folder, switch to Content View
#right click on the file, choose "Switch to Features View"
#click on the Authentication icon on the right
#select 'Anonymous Authentication' and click the 'Disable' button
#select 'Windows Authentication' and click the 'Enable' button

*According to [http://moodle.org/mod/forum/discuss.php?d=145171#p634027 this post], if you are using IIS 7.5 (it comes with Windows Server 2008 R2), you have to select 'Windows Authentication' and click on 'Providers'. This shows a list of enabled providers (Negotiate and NTLM, by default). Change the order so that NTLM is at the top of the list.
*If 'Windows Authentication' is not available, then you need to install it as a separate authentication provider (in Control Panel).

===APACHE Configuration===
There are currently 3 possible methods for this:

====Using the NTLM part of Samba for Apache on Linux====

* Get the plugin here: http://samba.org/ftp/unpacked/lorikeet/mod_auth_ntlm_winbind/ . You need to download all the files from the link, but not the <code>contrib</code> and <code>debian</code> directories. Then follow the instructions given inside the <code>README</code> file. If you are using Debian/Ubuntu, you can follow these [[#Compiling_mod_auth_ntlm_winbind_on_Debian.2FUbuntu|compilation instructions]].
* Once you have compiled it, put it inside Apache's modules subdirectory (this location depends on a number of factors, like compiling Apache yourself, using different Linux distributions packages, an so on), and load and enable the module in Apache's configuration. For example, if your Apache modules are under <tt>/usr/lib/apache2/modules</tt>, you'll need something like this in your Apache configuration file (usually called <tt>apache2.conf</tt> or <tt>http2.conf</tt>):

<IfModule !mod_auth_ntlm_winbind.c>
LoadModule auth_ntlm_winbind_module /usr/lib/apache2/modules/mod_auth_ntlm_winbind.so
</IfModule>

* Install the Samba <tt>winbind</tt> daemon package. This packages relies on Samba's configuration file to get some important settings (like the Windows domain name, uid and gid range mappings, and so on). In addition to that, you'll need to make your Linux/Unix machine part of the domain. Otherwise winbind won't be able to pull user and groups informationi from the domain controllers. You should read the Samba documentation to perform this step, but the most important part is having something like the following lines in your <code>smb.conf</code> file, inside the [global] section (in addition to what you already have there):

workgroup = DOMAINNAME
password server = *
security = domain
encrypt passwords = true
idmap uid = 10000-20000
idmap gid = 10000-20000

: and executing the command (as root):

# net join DOMAINNAME -U Administrator

: where '''DOMAINNAME''' is the NetBIOS windows domain name, and '''Administrator''' an account with enough privileges to add new machines to the domain. You'll need to type this account's password for the command to succeed.

: In Windows environments you could also try executing the command (as root):

# net join DOMAINNAME -S DCSERVER -U Administrator

: where DCSERVER is the Domain Controller server

: Also, make sure you have disabled "Microsoft Network Server: digitally sign communications (always)" in your Domain Controllers Security Policy, unless you are using a version of Samba that can sign SMB packets.

* Restart the <tt>winbind</tt> service to apply the changes and test that it's running ok by executing:

$ wbinfo -u

: You should get the full list of Windows domain users. If you use '''<tt>-g</tt>''' instead, you'll get the domain groups list.

* Check that your <tt>winbind</tt> package installed the authentication helper command <tt>ntlm_auth</tt>, as we'll need it later. We'll assume the helper is located at <tt>/usr/bin/ntlm_auth</tt>. If yours is at a different location, make sure you adjust the path in the example below.

* Add something like this to your Apache configuration file (usually called <tt>apache2.conf</tt> or <tt>http2.conf</tt>). We'll assume that your Moodle <tt>$CFG->dirroot</tt> directory is located at <tt>/var/www/moodle</tt> in the example:
<Directory "/var/www/moodle/auth/ldap/">
<Files ntlmsso_magic.php>
NTLMAuth on
AuthType NTLM
AuthName "Moodle NTLM Authentication"
NTLMAuthHelper "/usr/bin/ntlm_auth --helper-protocol=squid-2.5-ntlmssp"
NTLMBasicAuthoritative on
require valid-user
</Files>
</Directory>
* Check the permissions of the Winbind pipe directory (Ubuntu places it under <tt>/var/run/samba/winbindd_privileged</tt>, yours may be placed at a different location). Apache will need to be able to enter that directory, so we need to make sure it has the right permissions. So have a look at the permissions of that directory and note the name of the group assigned to it. The following example is from a Ubuntu 7.10 machine:

$ ls -ald /var/run/samba/winbindd_privileged
drwxr-x--- 2 root winbindd_priv 60 2007-11-17 16:18 /var/run/samba/winbindd_privileged/

:so we see the group is <tt>winbindd_priv</tt>.

* Instead of modifying the directory permissions (which could break other services that use winbind) we are going to make the Apache user (<tt>www-data</tt> in our example, but could be <tt>httpd</tt>, or <tt>nobody</tt>, etc.) is part of the appropiate group. Execute the following as root:

# adduser www-data winbindd_priv

: <tt>adduser</tt> is available in Debian and Ubuntu at least. If your distribution doesn't have <tt>adduser</tt>, you can edit <tt>/etc/group</tt> manually to achive the same effect.

* Stop and start the Apache service to apply the changes. Have a look at Apache's error log to see that everything is ok.

* Couple of gotchas - in Fedora Core (and also in Redhat/Centos), keep alive is turned OFF by default in the httpd.conf - see this bug for further info: https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=188138 
simply change the line to that was:
KeepAlive Off
to:
KeepAlive On
and restart apache (/etc/init.d/http restart)
* Here are some notes from people who have the samba winbind option working
::-- I made it work using Ubuntu 7.04. That's what I've used to update the documentation. [[User:Iñaki Arenaza|Iñaki Arenaza]] 10:43, 30 September 2007 (CDT)
::-- I have this working on Ubuntu 8.04 LTS in an RM CC4 Active Directory Domain. [[User:munk3h|Ian]] 16:31 15 December 2009 (GMT)
::-- Running on Ubuntu 10.04 Lucid, Apache2 got this running in no time flat with AD v6. Worth noting that if Using Iñaki Arenaza's LDAP Clone plugin, you will need to add another copy of the Directory tag in <tt>apache2.conf</tt> pointing at the new ldap plugin. --[[User:Christopher O'Kelly|Christopher O'Kelly]] 10:09, 16 April 2012 (WST)
::-- On Ubuntu 12.04 there is no need to compile anything, just do this.
sudo apt-get install php5-ldap
sudo apt-get install libapache2-mod-auth-ntlm-winbind
sudo a2enmod auth_ntlm_winbind
sudo apt-get install winbind smbfs smbclient samba

====Using the NTLM Auth Module for Apache on Linux====
The NTLM Auth module is a bit stale and even its authors suggest that you use the [[#Using_the_NTLM_part_of_Samba_for_Apache_on_Linux|NTLM part of Samba with Apache on Linux]]

Get it from here
# get the Module from: http://modntlm.sourceforge.net/
# follow the instructions given there and inside the README that comes with the package.

I (Iñaki Arenaza) strongly recommend using the [[#Using_the_NTLM_part_of_Samba_for_Apache_on_Linux|NTLM part of Samba with Apache on Linux]] over this module. It's better maintained, more robust and has more features.

====Using the mod_auth_sspi Module for Apache 2 on Windows====
NOTE: This setup is currently being used in a live production environment, and is therefore suitable for such use provided it is correctly configured and tested.

This is the recommended method for Apache 2 on Windows, however it will '''not''' work on Linux/UNIX systems.
It provides better stability and higher performance than other NTLM modules.

* Download the mod_auth_sspi Module from: http://sourceforge.net/projects/mod-auth-sspi/. At the moment of writing this (2007.09.30), the current version is mod_auth_sspi 1.0.4, which has two different ZIP files to download:

::* mod_auth_sspi-1.0.4-2.0.58.zip : Use this file if you are using Apache 2.0.x.
::* mod_auth_sspi-1.0.4-2.2.2.zip : Use this file if you are using Apache 2.2.x.

If you are using an x64 version of Apache mod_auth_sspi x64 versions are available from https://www.apachehaus.net/modules/mod_auth_sspi/

These files '''do not''' work with Apache versions 2.4.x.

* Unzip the right file and copy mod_auth_sspi.so (it's inside '''bin''' subdirectory) to your Apache modules directory.
* Edit your Apache 2 configuration file (httpd.conf) to load the module.

<IfModule !mod_auth_sspi.c>
LoadModule sspi_auth_module modules/mod_auth_sspi.so
</IfModule>

* Choose one of the two methods below

: '''Method 1''': This method is recommended for servers that will host a single Moodle instance. Configure NTLM from the main configuration file, add the following to httpd.conf (substitute "C:\moodle" with the path to your Moodle installation e.g. "C:\my-moodle"
<Directory "C:\moodle\auth\ldap">
<Files ntlmsso_magic.php>
AuthName "Moodle at My College"
AuthType SSPI
SSPIAuth On
SSPIOfferBasic Off
SSPIAuthoritative On
SSPIDomain <YOUR AD DOMAIN>
require valid-user
</Files>
</Directory>

: '''Method 2''': The alternative method is to use a .htaccess file
:This method is recommended for servers that will host multiple Moodle instances. It allows additional Moodle instances to be configured without restarting apache, and also makes the solution a little more portable. We need to add a directive to the main httpd.conf to allow configuration of authentication within .htaccess files.
<Directory C:\moodle>
AllowOverride AuthConfig
</Directory>

:::Create a new text file named '.htaccess' in the directory 'C:\moodle\moodle\auth\ldap' and add the following directives:
<Files ntlmsso_magic.php>
AuthName "Moodle at My College"
AuthType SSPI
SSPIAuth On
SSPIOfferBasic Off
SSPIAuthoritative On
SSPIDomain mycollege.ac.uk
require valid-user
</Files>

:This enables the Moodle folder to be moved to any apache webserver that is configured to allow authentication configuration through .htaccess

Lastly for Internet Explorer 7 onwards you must also replace this line in your httpd-ssl.conf file:

BrowserMatch ".*MSIE.*" \

with

BrowserMatch ".*MSIE [2-5]\..*" \

For further help and discussion: http://moodle.org/mod/forum/discuss.php?d=56565

====Using the Kerberos Auth Module for Apache on Linux/UNIX (mod_auth_kerb)====
*Install and configure http://modauthkerb.sourceforge.net/
*Configuration of mod_auth_kerb in a Microsoft Windows Active Directory environment (AD 2003 and above) (http://grolmsnet.de/kerbtut/)

Environment details in this example:
#'''Active Directory Domain:''' EXAMPLE.AC.UK
#'''Active Directory Domain Controller:''' dc.example.ac.uk
#'''Linux/UNIX web server:''' moodle.example.ac.uk
#'''Active Directory user account for web server service principal:''' moodlekerb

Install kerberos on moodle.example.ac.uk and enter the following in krb5.conf (by default: /etc/krb5.conf)

<pre>
[libdefaults]
default_realm = EXAMPLE.AC.UK
[domain_realm]
example.ac.uk = EXAMPLE.AC.UK
[realms]
EXAMPLE.AC.UK = {
admin_server = dc.example.ac.uk
kdc = dc.example.ac.uk
}:
* Test kerberos
Issue the following command at the shell prompt:
<pre>
$> kinit user@EXAMPLE.AC.UK
</pre>

Where 'user' is an Active Directory account for which you know the password.

Next, issue the following:
<pre>$>klist</pre>
If all is OK it will list the Kerberos ticket you were granted from the domain controller (KDC)

* Create HTTP service principal for moodle.example.ac.uk
#Create the 'moodlekerb' '''user''' account in Active Directory (NOT a machine account) to map to the web server service principal (HTTP/moodle.example.ac.uk@EXAMPLE.AC.UK)
NOTE: moodle.example.ac.uk MUST be the canonical DNS name of the server i.e. an A record (NOT a CNAME). Additionally a valid PTR (reverse DNS) record must exist and match the corresponding A record.

#Use the ktpass.exe utility to map the service principal and create a keytab file
Apache requires a keytab file, which is generated with ktpass.exe on the Windows Active Directory Domain Controller.
Unfortunately, this component of Windows Server 2003 SP1 does not function correctly so one must obtain a hot fix: http://support.microsoft.com/kb/919557

Run the following command on the domain controller:
<pre>
C:\path\to\hotfix\ktpass.exe -princ HTTP/moodle.example.ac.uk@EXAMPLE.AC.UK -mapuser EXAMPLE\moodlekerb -crypto DES-CBC-MD5 +DesOnly +setPass +rndPass -ptype KRB5_NT_PRINCIPAL -out moodle.example.ac.uk.keytab
</pre>

Copy C:\path\to\hotfix\moodle.example.ac.uk.keytab to the moodle web server and remember the location (/etc/httpd/moodle.example.ac.uk.keytab or similar)

* Configure Apache / mod_auth_kerb
Edit the Apache configuration for the moodle host and add the following directives:
<pre>
<Directory /path/to/moodle/docs/auth/ldap/>
<Files ntlmsso_magic.php>
AuthName "Moodle"
AuthType Kerberos
KrbAuthRealms EXAMPLE.AC.UK
KrbServiceName HTTP
Krb5Keytab /etc/httpd/moodle.example.ac.uk.keytab
KrbMethodNegotiate on
KrbMethodK5Passwd on
KrbAuthoritative on
require valid-user
</Files>
</Directory>
</pre>

==Configuring IP/Subnet Mask==
Subnet masks are based on binary patterns so need a bit of knowledge to understand. The best way to find out what IP/Subnet masks to use is to ask your Network Admin.

* Just type them one after the other, separated by commas. You can use several syntaxes:
** Type the network-number/prefix-length combination. E.g. 192.168.1.0/24
** Type the network 'prefix', ending in a period character. E.g. 192.168.1.
** Type the network address range ('''this only works for the last address octect'''). E.g. 192.168.1.1-254
:All the three examples refer to the same subnetwork. So assuming you need to specify the following subnetworks:
::* 10.1.0/255.255.0.0
::* 10.2.0.0/255.255.0.0
::* 172.16.0.0/255.255.0.0
::* 192.168.100.0/255.255.255.240
:You can type:
10.1.0.0/16, 10.2.0.0/16, 172.16.0.0/16, 192.168.100.0/28
: or:
10.1.0.0/16, 10.2.0.0/16, 172.16.0.0/16, 192.168.100.240-255
:or even:
10.1., 10.2., 172.16., 192.168.100.0/28
:(the last one cannot be expressed as a network 'prefix' as the netmask does not fall on an octect boundary).

==Configuring Domain user credentials format==
If you are using Moodle 2.4 and later there is a new setting that lets you configure the format of the domain user credentials, instead of using the old fixed format. The setting is called "Remote username format". If you leave this seting empty, the default '''DOMAINNAME\username''' format will be used. You can use the optional '''%domain%''' placeholder to specify where the domain name appears, and the mandatory '''%username%''' placeholder to specify where the username appears.

Some widely used formats are:
* '''%domain%\%username%''' : MS Windows default, contains the domain name, followed by a backlash character, followed by the username.
* '''%username%@%domain%''' : This is the same format used by Kerberos (domain name followed by an at sign, followed by the username).
* '''%domain%/%username%''' : Some people configure Samba+Winbind to use this format.
* '''%domain%+%username%''' : Some people configure Samba+Winbind to use this other format.
* '''%username%''' : Only contains the username, with no domain part.

==Notes/Tips==

#If you are using Firefox, you will need to follow these steps:
:*Load Firefox and type about:config in the address box. The configuration settings page should be displayed.
:*In the Filter box, type the word "ntlm" to filter the NTLM strings. You should see three settings displayed.
:*Double-click on "network.automatic-ntlm-auth.trusted-uris".
:*In the box, enter the full URL of your Moodle server. For example <pre>http://moodle.mydomain.com, (the comma is important)</pre>
:*Close Firefox and restart.
# NTLM seems to not work at all when BASIC authentication is enabled. (this was using the Kerberos method, other ways may work)
# If the account in your AD management console shows like "First Last", you better change the ldap settings parameter 'User Attribute' from its default of {blank} / 'cn' to 'sAMAccountName' as indicated in [http://moodle.org/mod/forum/discuss.php?d=132364#p682173 this post]. The reason is that the cn name generally looks like "First Last", once you done the ldap sync, the user name in moodle will be "first last", but IE passes the account of "domain\first.last" to moodle which does not exist in moodle.

== To get a domain name for Moodle working on IIS7.5 Windows 2008 R2 ==
Refer to http://support.microsoft.com/kb/896861. Key section listed below.
Click Start, click Run, type regedit, and then click OK. 
In Registry Editor, locate and then click the following registry key:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\MSV1_0 
Right-click MSV1_0, point to New, and then click Multi-String Value. 
Type BackConnectionHostNames, and then press ENTER. 
Right-click BackConnectionHostNames, and then click Modify. 
In the Value data box, type the host name or the host names for the sites that are on the local computer, and then click OK. 
Quit Registry Editor, and then restart the IISAdmin service.

==Compiling mod_auth_ntlm_winbind on Debian/Ubuntu==
You need to install the following packages (and all of their dependencies) by using aptitude, synaptic, etc.:

autoconf apache2-threaded-dev debian-builder

Once you have them installed, open up a text console, go to the directory where you downloaded the mod_auth_ntlm_winbind files an execute the following commands (as a normal user):

autoconf
./configure --with-apxs=/usr/bin/apxs2 --with-apache=/usr/sbin/apache2
make

That should compile it without errors. Then as a user that can run commands as root via sudo, execute the following command from the same directory:

sudo make install

This will create the final mod_auth_ntlm_winbind.so file and install it under /usr/lib/apache2/modules, with the rest of the Apache 2 modules (the size of the file and last modification time shown below may differ from your install):

ls -l /usr/lib/apache2/modules/mod_auth_ntlm_winbind.so
-rw-r--r-- 1 root root 20921 2009-02-17 04:27 /usr/lib/apache2/modules/mod_auth_ntlm_winbind.so

==See also==
*[http://moodle.org/mod/forum/view.php?id=42 Using Moodle: User authentication] forum
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=45887 NTLM Authentication] forum discussion
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=80104 Merging AD NTLM SSO into auth/ldap] forum discussion
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=186661 Moodle in a DMZ with NTLM] forum discussion
*[http://moodle.org/mod/data/view.php?d=13&rid=314 Download the NTLM Authentication Module]

[[Category:Contributed code]]

[[fr:Authentification NTLM]]

NTLM authentication

2014-08-18T10:28:50Z

Danmarsden: /* Using the NTLM part of Samba for Apache on Linux */

{{Authentication}}This document describes how to set up '''NTLM/Windows Integrated Authentication''' in Moodle.

==Overview==
Integrated Windows Authentication uses the security features of Windows clients and servers. It does not prompt users for a user name and password. The current Windows user information on the client computer is supplied by the browser through a challenge/response authentication process with the Web server for the Moodle site.

==Assumptions==

#You are running MS [[Active Directory]] for Authentication.
#The Server hosting your website is a member of the Active Directory Domain that your users are also members of.
#You are able to define people inside your Network (and authenticated to the Domain) from an IP range of computers.
#You are familar with or have read the LDAP authentication documentation.
#The Active Directory domain credentials of your users are returned as '''DOMAINNAME\username''' from your authentication service. If you are using the Winbind service from the Samba project, this can be untrue, depending on your Winbind configuration settings. If you are using Moodle 2.4 or later, you can specify the format of the domain credentials (see below). If you are using an older version and you can not modify your settings to satisfy this last assumption, then you will need to remove or comment out the line that reads:
$username = substr(strrchr($username, '\\'), 1); //strip domain info
and add the relevant lines of code to extract the username part from the domain user credentials and store it in $username.

::'''VERY IMPORTANT''': NTLM authentication depends on [[LDAP authentication]], and NTLM configuration is specified in the LDAP authentication settings page (Site Administration >> Plugins >> Authentication >> LDAP Server). So before trying to configure NTLM, make sure you have LDAP_authentication properly setup and working.

==Installation==

No installation needed. See Site Administration >> Plugins >> Authentication >> LDAP Server for the NTLM config options. You only have to

*Enable NTLM SSO
*Set the IP/Subnet mask for the clients (see below)
*(Optionally) Set the "Remote username format" for your domain user credentials format (see below)
*On IIS: turn on Windows Authentication
*On Apache - use one of the 3 methods outlined below
*On the client pc's, you might need to set the moodle server ip/moodle url as being in "local intranet" (From IE, tools -> options -> security -> local intranet)

It is important to note the following conditions must be satisfied to let NTLM SSO happens:
*you've arrived to the login page with one GET request
*you've ldap->ntlmsso_enabled
*you've ldap->ntlmsso_subnet
*you aren't logged
*the IP of the client is in ntlmsso_subnet

Thus it is needed to set the IP subnet.

If you have used previous versions of NTLM (from 1.8 and below) in your Moodle database you will need to make two further changes.

#The type of authentication held against each user now needs to be LDAP, as NTLM will not be recognised. To edit the fields open up a SQL query for your Moodle server and use the following query "update mdl_user set auth = 'ldap' where auth = 'ntlm' "
#If you had a previous .htaccess file in the auth/ntlm directory, you will need to move it to the auth/ldap directory. Regardless of whether it is in a .htaccess file of the httpd.conf, the <Files> line now needs to refer to ntlmsso_magic.php. If it is in the httpd.conf, the <Directory> will need to change too. This is covered later on for new installs, but is one of the fundamental changes that needs to be made for those upgrading.

==How to Turn Integrated Authentication on==
The auth/ldap/ntlmsso_magic.php file MUST have NTLM/Integrated Authentication enabled on the server or the authentication will not work.

===IIS Configuration===
Open the IIS Management Console and navigate to the auth/ldap/ntlmsso_magic.php file.

====IIS 6.0====
#right click on the file, choose properties
#under the "file security" tab, click on the Authentication and Access control "edit" button
#untick "Enable Anonymous Access" and tick "Integrated Windows Authentication"

====IIS 7.x====
#After navigating to the 'auth/ldap' folder, switch to Content View
#right click on the file, choose "Switch to Features View"
#click on the Authentication icon on the right
#select 'Anonymous Authentication' and click the 'Disable' button
#select 'Windows Authentication' and click the 'Enable' button

*According to [http://moodle.org/mod/forum/discuss.php?d=145171#p634027 this post], if you are using IIS 7.5 (it comes with Windows Server 2008 R2), you have to select 'Windows Authentication' and click on 'Providers'. This shows a list of enabled providers (Negotiate and NTLM, by default). Change the order so that NTLM is at the top of the list.
*If 'Windows Authentication' is not available, then you need to install it as a separate authentication provider (in Control Panel).

===APACHE Configuration===
There are currently 3 possible methods for this:

====Using the NTLM part of Samba for Apache on Linux====

* Get the plugin here: http://samba.org/ftp/unpacked/lorikeet/mod_auth_ntlm_winbind/ . You need to download all the files from the link, but not the <code>contrib</code> and <code>debian</code> directories. Then follow the instructions given inside the <code>README</code> file. If you are using Debian/Ubuntu, you can follow these [[#Compiling_mod_auth_ntlm_winbind_on_Debian.2FUbuntu|compilation instructions]].
* Once you have compiled it, put it inside Apache's modules subdirectory (this location depends on a number of factors, like compiling Apache yourself, using different Linux distributions packages, an so on), and load and enable the module in Apache's configuration. For example, if your Apache modules are under <tt>/usr/lib/apache2/modules</tt>, you'll need something like this in your Apache configuration file (usually called <tt>apache2.conf</tt> or <tt>http2.conf</tt>):

<IfModule !mod_auth_ntlm_winbind.c>
LoadModule auth_ntlm_winbind_module /usr/lib/apache2/modules/mod_auth_ntlm_winbind.so
</IfModule>

* Install the Samba <tt>winbind</tt> daemon package. This packages relies on Samba's configuration file to get some important settings (like the Windows domain name, uid and gid range mappings, and so on). In addition to that, you'll need to make your Linux/Unix machine part of the domain. Otherwise winbind won't be able to pull user and groups informationi from the domain controllers. You should read the Samba documentation to perform this step, but the most important part is having something like the following lines in your <code>smb.conf</code> file, inside the [global] section (in addition to what you already have there):

workgroup = DOMAINNAME
password server = *
security = domain
encrypt passwords = true
idmap uid = 10000-20000
idmap gid = 10000-20000

: and executing the command (as root):

# net join DOMAINNAME -U Administrator

: where '''DOMAINNAME''' is the NetBIOS windows domain name, and '''Administrator''' an account with enough privileges to add new machines to the domain. You'll need to type this account's password for the command to succeed.

: In Windows environments you could also try executing the command (as root):

# net join DOMAINNAME -S DCSERVER -U Administrator

: where DCSERVER is the Domain Controller server

: Also, make sure you have disabled "Microsoft Network Server: digitally sign communications (always)" in your Domain Controllers Security Policy, unless you are using a version of Samba that can sign SMB packets.

* Restart the <tt>winbind</tt> service to apply the changes and test that it's running ok by executing:

$ wbinfo -u

: You should get the full list of Windows domain users. If you use '''<tt>-g</tt>''' instead, you'll get the domain groups list.

* Check that your <tt>winbind</tt> package installed the authentication helper command <tt>ntlm_auth</tt>, as we'll need it later. We'll assume the helper is located at <tt>/usr/bin/ntlm_auth</tt>. If yours is at a different location, make sure you adjust the path in the example below.

* Add something like this to your Apache configuration file (usually called <tt>apache2.conf</tt> or <tt>http2.conf</tt>). We'll assume that your Moodle <tt>$CFG->dirroot</tt> directory is located at <tt>/var/www/moodle</tt> in the example:
: '''For 1.9 or above use''':
<Directory "/var/www/moodle/auth/ldap/">
<Files ntlmsso_magic.php>
NTLMAuth on
AuthType NTLM
AuthName "Moodle NTLM Authentication"
NTLMAuthHelper "/usr/bin/ntlm_auth --helper-protocol=squid-2.5-ntlmssp"
NTLMBasicAuthoritative on
require valid-user
</Files>
</Directory>
: '''For 1.8 or below use''':
<Directory "/var/www/moodle/auth/ntlm/">
<Files oncampuslogin.php>
NTLMAuth on
AuthType NTLM
AuthName "Moodle NTLM Authentication"
NTLMAuthHelper "/usr/bin/ntlm_auth --helper-protocol=squid-2.5-ntlmssp"
NTLMBasicAuthoritative on
require valid-user
</Files>
</Directory>
* Check the permissions of the Winbind pipe directory (Ubuntu places it under <tt>/var/run/samba/winbindd_privileged</tt>, yours may be placed at a different location). Apache will need to be able to enter that directory, so we need to make sure it has the right permissions. So have a look at the permissions of that directory and note the name of the group assigned to it. The following example is from a Ubuntu 7.10 machine:

$ ls -ald /var/run/samba/winbindd_privileged
drwxr-x--- 2 root winbindd_priv 60 2007-11-17 16:18 /var/run/samba/winbindd_privileged/

:so we see the group is <tt>winbindd_priv</tt>.

* Instead of modifying the directory permissions (which could break other services that use winbind) we are going to make the Apache user (<tt>www-data</tt> in our example, but could be <tt>httpd</tt>, or <tt>nobody</tt>, etc.) is part of the appropiate group. Execute the following as root:

# adduser www-data winbindd_priv

: <tt>adduser</tt> is available in Debian and Ubuntu at least. If your distribution doesn't have <tt>adduser</tt>, you can edit <tt>/etc/group</tt> manually to achive the same effect.

* Stop and start the Apache service to apply the changes. Have a look at Apache's error log to see that everything is ok.

* Couple of gotchas - in Fedora Core (and also in Redhat/Centos), keep alive is turned OFF by default in the httpd.conf - see this bug for further info: https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=188138 
simply change the line to that was:
KeepAlive Off
to:
KeepAlive On
and restart apache (/etc/init.d/http restart)
* Here are some notes from people who have the samba winbind option working
::-- I made it work using Ubuntu 7.04. That's what I've used to update the documentation. [[User:Iñaki Arenaza|Iñaki Arenaza]] 10:43, 30 September 2007 (CDT)
::-- I have this working on Ubuntu 8.04 LTS in an RM CC4 Active Directory Domain. [[User:munk3h|Ian]] 16:31 15 December 2009 (GMT)
::-- Running on Ubuntu 10.04 Lucid, Apache2 got this running in no time flat with AD v6. Worth noting that if Using Iñaki Arenaza's LDAP Clone plugin, you will need to add another copy of the Directory tag in <tt>apache2.conf</tt> pointing at the new ldap plugin. --[[User:Christopher O'Kelly|Christopher O'Kelly]] 10:09, 16 April 2012 (WST)
::-- On Ubuntu 12.04 there is no need to compile anything, just do this.
sudo apt-get install php5-ldap
sudo apt-get install libapache2-mod-auth-ntlm-winbind
sudo a2enmod auth_ntlm_winbind
sudo apt-get install winbind smbfs smbclient samba

====Using the NTLM Auth Module for Apache on Linux====
The NTLM Auth module is a bit stale and even its authors suggest that you use the [[#Using_the_NTLM_part_of_Samba_for_Apache_on_Linux|NTLM part of Samba with Apache on Linux]]

Get it from here
# get the Module from: http://modntlm.sourceforge.net/
# follow the instructions given there and inside the README that comes with the package.

I (Iñaki Arenaza) strongly recommend using the [[#Using_the_NTLM_part_of_Samba_for_Apache_on_Linux|NTLM part of Samba with Apache on Linux]] over this module. It's better maintained, more robust and has more features.

====Using the mod_auth_sspi Module for Apache 2 on Windows====
NOTE: This setup is currently being used in a live production environment, and is therefore suitable for such use provided it is correctly configured and tested.

This is the recommended method for Apache 2 on Windows, however it will '''not''' work on Linux/UNIX systems.
It provides better stability and higher performance than other NTLM modules.

* Download the mod_auth_sspi Module from: http://sourceforge.net/projects/mod-auth-sspi/. At the moment of writing this (2007.09.30), the current version is mod_auth_sspi 1.0.4, which has two different ZIP files to download:

::* mod_auth_sspi-1.0.4-2.0.58.zip : Use this file if you are using Apache 2.0.x.
::* mod_auth_sspi-1.0.4-2.2.2.zip : Use this file if you are using Apache 2.2.x.

If you are using an x64 version of Apache mod_auth_sspi x64 versions are available from https://www.apachehaus.net/modules/mod_auth_sspi/

These files '''do not''' work with Apache versions 2.4.x.

* Unzip the right file and copy mod_auth_sspi.so (it's inside '''bin''' subdirectory) to your Apache modules directory.
* Edit your Apache 2 configuration file (httpd.conf) to load the module.

<IfModule !mod_auth_sspi.c>
LoadModule sspi_auth_module modules/mod_auth_sspi.so
</IfModule>

* Choose one of the two methods below

: '''Method 1''': This method is recommended for servers that will host a single Moodle instance. Configure NTLM from the main configuration file, add the following to httpd.conf (substitute "C:\moodle" with the path to your Moodle installation e.g. "C:\my-moodle"

:: '''For 1.9 or above use''':
<Directory "C:\moodle\auth\ldap">
<Files ntlmsso_magic.php>
AuthName "Moodle at My College"
AuthType SSPI
SSPIAuth On
SSPIOfferBasic Off
SSPIAuthoritative On
SSPIDomain <YOUR AD DOMAIN>
require valid-user
</Files>
</Directory>
:: '''For 1.8 or below use''':
<Directory "C:\moodle\auth\ntlm">
<Files oncampuslogin.php>
AuthName "Moodle at My College"
AuthType SSPI
SSPIAuth On
SSPIOfferBasic Off
SSPIAuthoritative On
SSPIDomain <YOUR AD DOMAIN>
require valid-user
</Files>
</Directory>

: '''Method 2''': The alternative method is to use a .htaccess file
:This method is recommended for servers that will host multiple Moodle instances. It allows additional Moodle instances to be configured without restarting apache, and also makes the solution a little more portable. We need to add a directive to the main httpd.conf to allow configuration of authentication within .htaccess files.
<Directory C:\moodle>
AllowOverride AuthConfig
</Directory>

:::Create a new text file named '.htaccess' in the directory 'C:\moodle\moodle\auth\ldap' and add the following directives:
<Files ntlmsso_magic.php>
AuthName "Moodle at My College"
AuthType SSPI
SSPIAuth On
SSPIOfferBasic Off
SSPIAuthoritative On
SSPIDomain mycollege.ac.uk
require valid-user
</Files>

:This enables the Moodle folder to be moved to any apache webserver that is configured to allow authentication configuration through .htaccess

Lastly for Internet Explorer 7 onwards you must also replace this line in your httpd-ssl.conf file:

BrowserMatch ".*MSIE.*" \

with

BrowserMatch ".*MSIE [2-5]\..*" \

For further help and discussion: http://moodle.org/mod/forum/discuss.php?d=56565

====Using the Kerberos Auth Module for Apache on Linux/UNIX (mod_auth_kerb)====
*Install and configure http://modauthkerb.sourceforge.net/
*Configuration of mod_auth_kerb in a Microsoft Windows Active Directory environment (AD 2003 and above) (http://grolmsnet.de/kerbtut/)

Environment details in this example:
#'''Active Directory Domain:''' EXAMPLE.AC.UK
#'''Active Directory Domain Controller:''' dc.example.ac.uk
#'''Linux/UNIX web server:''' moodle.example.ac.uk
#'''Active Directory user account for web server service principal:''' moodlekerb

Install kerberos on moodle.example.ac.uk and enter the following in krb5.conf (by default: /etc/krb5.conf)

<pre>
[libdefaults]
default_realm = EXAMPLE.AC.UK
[domain_realm]
example.ac.uk = EXAMPLE.AC.UK
[realms]
EXAMPLE.AC.UK = {
admin_server = dc.example.ac.uk
kdc = dc.example.ac.uk
}:
* Test kerberos
Issue the following command at the shell prompt:
<pre>
$> kinit user@EXAMPLE.AC.UK
</pre>

Where 'user' is an Active Directory account for which you know the password.

Next, issue the following:
<pre>$>klist</pre>
If all is OK it will list the Kerberos ticket you were granted from the domain controller (KDC)

* Create HTTP service principal for moodle.example.ac.uk
#Create the 'moodlekerb' '''user''' account in Active Directory (NOT a machine account) to map to the web server service principal (HTTP/moodle.example.ac.uk@EXAMPLE.AC.UK)
NOTE: moodle.example.ac.uk MUST be the canonical DNS name of the server i.e. an A record (NOT a CNAME). Additionally a valid PTR (reverse DNS) record must exist and match the corresponding A record.

#Use the ktpass.exe utility to map the service principal and create a keytab file
Apache requires a keytab file, which is generated with ktpass.exe on the Windows Active Directory Domain Controller.
Unfortunately, this component of Windows Server 2003 SP1 does not function correctly so one must obtain a hot fix: http://support.microsoft.com/kb/919557

Run the following command on the domain controller:
<pre>
C:\path\to\hotfix\ktpass.exe -princ HTTP/moodle.example.ac.uk@EXAMPLE.AC.UK -mapuser EXAMPLE\moodlekerb -crypto DES-CBC-MD5 +DesOnly +setPass +rndPass -ptype KRB5_NT_PRINCIPAL -out moodle.example.ac.uk.keytab
</pre>

Copy C:\path\to\hotfix\moodle.example.ac.uk.keytab to the moodle web server and remember the location (/etc/httpd/moodle.example.ac.uk.keytab or similar)

* Configure Apache / mod_auth_kerb
Edit the Apache configuration for the moodle host and add the following directives:
<pre>
<Directory /path/to/moodle/docs/auth/ldap/>
<Files ntlmsso_magic.php>
AuthName "Moodle"
AuthType Kerberos
KrbAuthRealms EXAMPLE.AC.UK
KrbServiceName HTTP
Krb5Keytab /etc/httpd/moodle.example.ac.uk.keytab
KrbMethodNegotiate on
KrbMethodK5Passwd on
KrbAuthoritative on
require valid-user
</Files>
</Directory>
</pre>

*Replace the '''ntlmsso_magic''' function in '''/auth/ldap/auth.php''' (1.9 only, as 2.x already support Kerberos format out of the box, just specify that format in the "Authentication type" setting) with the following code:

<pre>
function ntlmsso_magic($sesskey) {
if (isset($_SERVER['REMOTE_USER']) && !empty($_SERVER['REMOTE_USER'])) {

// HTTP __headers__ seem to be sent in ISO-8859-1 encoding
// (according to my reading of RFC-1945, RFC-2616 and RFC-2617 and
// my local tests), so we need to convert the REMOTE_USER value
// (i.e., what we got from the HTTP WWW-Authenticate header) into UTF-8
$textlib = textlib_get_instance();
$username = $textlib->convert($_SERVER['REMOTE_USER'], 'iso-8859-1', 'utf-8');

/**
* begin kerberos - afhole@wortech.ac.uk 21-04-2009
*/
if ($pos = strpos($username, "@")) {
$username = substr($username, 0, $pos);
} else {
$username = substr(strrchr($username, '\\'), 1); //strip domain info
}
/**
* end kerberos
*/

$username = moodle_strtolower($username); //compatibility hack
set_cache_flag('auth/ldap/ntlmsess', $sesskey, $username, AUTH_NTLMTIMEOUT);
return true;
}
return false;
}
</pre>

The above code change will account for the fact that Kerberos presents the username to REMOTE_USER in the format user@DOMAIN, rather than NTLM's DOMAIN\user

==Configuring IP/Subnet Mask==
Subnet masks are based on binary patterns so need a bit of knowledge to understand. The best way to find out what IP/Subnet masks to use is to ask your Network Admin.

* The new way of specifiying subnets is even easier/more flexible than before 1.9. Just type them one after the other, separated by commas. You can use several syntaxes:
** Type the network-number/prefix-length combination. E.g. 192.168.1.0/24
** Type the network 'prefix', ending in a period character. E.g. 192.168.1.
** Type the network address range ('''this only works for the last address octect'''). E.g. 192.168.1.1-254
:All the three examples refer to the same subnetwork. So assuming you need to specify the following subnetworks:
::* 10.1.0/255.255.0.0
::* 10.2.0.0/255.255.0.0
::* 172.16.0.0/255.255.0.0
::* 192.168.100.0/255.255.255.240
:You can type:
10.1.0.0/16, 10.2.0.0/16, 172.16.0.0/16, 192.168.100.0/28
: or:
10.1.0.0/16, 10.2.0.0/16, 172.16.0.0/16, 192.168.100.240-255
:or even:
10.1., 10.2., 172.16., 192.168.100.0/28
:(the last one cannot be expressed as a network 'prefix' as the netmask does not fall on an octect boundary).

==Configuring Domain user credentials format==
If you are using Moodle 2.4 and later there is a new setting that lets you configure the format of the domain user credentials, instead of using the old fixed format. The setting is called "Remote username format". If you leave this seting empty, the default '''DOMAINNAME\username''' format will be used. You can use the optional '''%domain%''' placeholder to specify where the domain name appears, and the mandatory '''%username%''' placeholder to specify where the username appears.

Some widely used formats are:
* '''%domain%\%username%''' : MS Windows default, contains the domain name, followed by a backlash character, followed by the username.
* '''%username%@%domain%''' : This is the same format used by Kerberos (domain name followed by an at sign, followed by the username).
* '''%domain%/%username%''' : Some people configure Samba+Winbind to use this format.
* '''%domain%+%username%''' : Some people configure Samba+Winbind to use this other format.
* '''%username%''' : Only contains the username, with no domain part.

==Notes/Tips==

#If you are using Firefox, you will need to follow these steps:
:*Load Firefox and type about:config in the address box. The configuration settings page should be displayed.
:*In the Filter box, type the word "ntlm" to filter the NTLM strings. You should see three settings displayed.
:*Double-click on "network.automatic-ntlm-auth.trusted-uris".
:*In the box, enter the full URL of your Moodle server. For example <pre>http://moodle.mydomain.com, (the comma is important)</pre>
:*Close Firefox and restart.
# NTLM seems to not work at all when BASIC authentication is enabled. (this was using the Kerberos method, other ways may work)
# If the account in your AD management console shows like "First Last", you better change the ldap settings parameter 'User Attribute' from its default of {blank} / 'cn' to 'sAMAccountName' as indicated in [http://moodle.org/mod/forum/discuss.php?d=132364#p682173 this post]. The reason is that the cn name generally looks like "First Last", once you done the ldap sync, the user name in moodle will be "first last", but IE passes the account of "domain\first.last" to moodle which does not exist in moodle.

== To get a domain name for Moodle working on IIS7.5 Windows 2008 R2 ==
Refer to http://support.microsoft.com/kb/896861. Key section listed below.
Click Start, click Run, type regedit, and then click OK. 
In Registry Editor, locate and then click the following registry key:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\MSV1_0 
Right-click MSV1_0, point to New, and then click Multi-String Value. 
Type BackConnectionHostNames, and then press ENTER. 
Right-click BackConnectionHostNames, and then click Modify. 
In the Value data box, type the host name or the host names for the sites that are on the local computer, and then click OK. 
Quit Registry Editor, and then restart the IISAdmin service.

==Compiling mod_auth_ntlm_winbind on Debian/Ubuntu==
You need to install the following packages (and all of their dependencies) by using aptitude, synaptic, etc.:

autoconf apache2-threaded-dev debian-builder

Once you have them installed, open up a text console, go to the directory where you downloaded the mod_auth_ntlm_winbind files an execute the following commands (as a normal user):

autoconf
./configure --with-apxs=/usr/bin/apxs2 --with-apache=/usr/sbin/apache2
make

That should compile it without errors. Then as a user that can run commands as root via sudo, execute the following command from the same directory:

sudo make install

This will create the final mod_auth_ntlm_winbind.so file and install it under /usr/lib/apache2/modules, with the rest of the Apache 2 modules (the size of the file and last modification time shown below may differ from your install):

ls -l /usr/lib/apache2/modules/mod_auth_ntlm_winbind.so
-rw-r--r-- 1 root root 20921 2009-02-17 04:27 /usr/lib/apache2/modules/mod_auth_ntlm_winbind.so

==See also==
*[http://moodle.org/mod/forum/view.php?id=42 Using Moodle: User authentication] forum
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=45887 NTLM Authentication] forum discussion
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=80104 Merging AD NTLM SSO into auth/ldap] forum discussion
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=186661 Moodle in a DMZ with NTLM] forum discussion
*[http://moodle.org/mod/data/view.php?d=13&rid=314 Download the NTLM Authentication Module]

[[Category:Contributed code]]

[[fr:Authentification NTLM]]

NTLM authentication

2014-08-18T10:26:02Z

Danmarsden: /* Using the NTLM part of Samba for Apache on Linux */ remove specific reference to me... I'm sure this dates back to around Moodle 1.6!

{{Authentication}}This document describes how to set up '''NTLM/Windows Integrated Authentication''' in Moodle.

==Overview==
Integrated Windows Authentication uses the security features of Windows clients and servers. It does not prompt users for a user name and password. The current Windows user information on the client computer is supplied by the browser through a challenge/response authentication process with the Web server for the Moodle site.

==Assumptions==

#You are running MS [[Active Directory]] for Authentication.
#The Server hosting your website is a member of the Active Directory Domain that your users are also members of.
#You are able to define people inside your Network (and authenticated to the Domain) from an IP range of computers.
#You are familar with or have read the LDAP authentication documentation.
#The Active Directory domain credentials of your users are returned as '''DOMAINNAME\username''' from your authentication service. If you are using the Winbind service from the Samba project, this can be untrue, depending on your Winbind configuration settings. If you are using Moodle 2.4 or later, you can specify the format of the domain credentials (see below). If you are using an older version and you can not modify your settings to satisfy this last assumption, then you will need to remove or comment out the line that reads:
$username = substr(strrchr($username, '\\'), 1); //strip domain info
and add the relevant lines of code to extract the username part from the domain user credentials and store it in $username.

::'''VERY IMPORTANT''': NTLM authentication depends on [[LDAP authentication]], and NTLM configuration is specified in the LDAP authentication settings page (Site Administration >> Plugins >> Authentication >> LDAP Server). So before trying to configure NTLM, make sure you have LDAP_authentication properly setup and working.

==Installation==

No installation needed. See Site Administration >> Plugins >> Authentication >> LDAP Server for the NTLM config options. You only have to

*Enable NTLM SSO
*Set the IP/Subnet mask for the clients (see below)
*(Optionally) Set the "Remote username format" for your domain user credentials format (see below)
*On IIS: turn on Windows Authentication
*On Apache - use one of the 3 methods outlined below
*On the client pc's, you might need to set the moodle server ip/moodle url as being in "local intranet" (From IE, tools -> options -> security -> local intranet)

It is important to note the following conditions must be satisfied to let NTLM SSO happens:
*you've arrived to the login page with one GET request
*you've ldap->ntlmsso_enabled
*you've ldap->ntlmsso_subnet
*you aren't logged
*the IP of the client is in ntlmsso_subnet

Thus it is needed to set the IP subnet.

If you have used previous versions of NTLM (from 1.8 and below) in your Moodle database you will need to make two further changes.

#The type of authentication held against each user now needs to be LDAP, as NTLM will not be recognised. To edit the fields open up a SQL query for your Moodle server and use the following query "update mdl_user set auth = 'ldap' where auth = 'ntlm' "
#If you had a previous .htaccess file in the auth/ntlm directory, you will need to move it to the auth/ldap directory. Regardless of whether it is in a .htaccess file of the httpd.conf, the <Files> line now needs to refer to ntlmsso_magic.php. If it is in the httpd.conf, the <Directory> will need to change too. This is covered later on for new installs, but is one of the fundamental changes that needs to be made for those upgrading.

==How to Turn Integrated Authentication on==
The auth/ldap/ntlmsso_magic.php file MUST have NTLM/Integrated Authentication enabled on the server or the authentication will not work.

===IIS Configuration===
Open the IIS Management Console and navigate to the auth/ldap/ntlmsso_magic.php file.

====IIS 6.0====
#right click on the file, choose properties
#under the "file security" tab, click on the Authentication and Access control "edit" button
#untick "Enable Anonymous Access" and tick "Integrated Windows Authentication"

====IIS 7.x====
#After navigating to the 'auth/ldap' folder, switch to Content View
#right click on the file, choose "Switch to Features View"
#click on the Authentication icon on the right
#select 'Anonymous Authentication' and click the 'Disable' button
#select 'Windows Authentication' and click the 'Enable' button

*According to [http://moodle.org/mod/forum/discuss.php?d=145171#p634027 this post], if you are using IIS 7.5 (it comes with Windows Server 2008 R2), you have to select 'Windows Authentication' and click on 'Providers'. This shows a list of enabled providers (Negotiate and NTLM, by default). Change the order so that NTLM is at the top of the list.
*If 'Windows Authentication' is not available, then you need to install it as a separate authentication provider (in Control Panel).

===APACHE Configuration===
There are currently 3 possible methods for this:

====Using the NTLM part of Samba for Apache on Linux====

* Get the plugin here: http://samba.org/ftp/unpacked/lorikeet/mod_auth_ntlm_winbind/ . You need to download all the files from the link, but not the <code>contrib</code> and <code>debian</code> directories. Then follow the instructions given inside the <code>README</code> file. If you are using Debian/Ubuntu, you can follow these [[#Compiling_mod_auth_ntlm_winbind_on_Debian.2FUbuntu|compilation instructions]].
* Once you have compiled it, put it inside Apache's modules subdirectory (this location depends on a number of factors, like compiling Apache yourself, using different Linux distributions packages, an so on), and load and enable the module in Apache's configuration. For example, if your Apache modules are under <tt>/usr/lib/apache2/modules</tt>, you'll need something like this in your Apache configuration file (usually called <tt>apache2.conf</tt> or <tt>http2.conf</tt>):

<IfModule !mod_auth_ntlm_winbind.c>
LoadModule auth_ntlm_winbind_module /usr/lib/apache2/modules/mod_auth_ntlm_winbind.so
</IfModule>

* Install the Samba <tt>winbind</tt> daemon package. This packages relies on Samba's configuration file to get some important settings (like the Windows domain name, uid and gid range mappings, and so on). In addition to that, you'll need to make your Linux/Unix machine part of the domain. Otherwise winbind won't be able to pull user and groups informationi from the domain controllers. You should read the Samba documentation to perform this step, but the most important part is having something like the following lines in your <code>smb.conf</code> file, inside the [global] section (in addition to what you already have there):

workgroup = DOMAINNAME
password server = *
security = domain
encrypt passwords = true
idmap uid = 10000-20000
idmap gid = 10000-20000

: and executing the command (as root):

# net join DOMAINNAME -U Administrator

: where '''DOMAINNAME''' is the NetBIOS windows domain name, and '''Administrator''' an account with enough privileges to add new machines to the domain. You'll need to type this account's password for the command to succeed.

: In Windows environments you could also try executing the command (as root):

# net join DOMAINNAME -S DCSERVER -U Administrator

: where DCSERVER is the Domain Controller server

: Also, make sure you have disabled "Microsoft Network Server: digitally sign communications (always)" in your Domain Controllers Security Policy, unless you are using a version of Samba that can sign SMB packets.

* Restart the <tt>winbind</tt> service to apply the changes and test that it's running ok by executing:

$ wbinfo -u

: You should get the full list of Windows domain users. If you use '''<tt>-g</tt>''' instead, you'll get the domain groups list.

* Check that your <tt>winbind</tt> package installed the authentication helper command <tt>ntlm_auth</tt>, as we'll need it later. We'll assume the helper is located at <tt>/usr/bin/ntlm_auth</tt>. If yours is at a different location, make sure you adjust the path in the example below.

* Add something like this to your Apache configuration file (usually called <tt>apache2.conf</tt> or <tt>http2.conf</tt>). We'll assume that your Moodle <tt>$CFG->dirroot</tt> directory is located at <tt>/var/www/moodle</tt> in the example:
: '''For 1.9 or above use''':
<Directory "/var/www/moodle/auth/ldap/">
<Files ntlmsso_magic.php>
NTLMAuth on
AuthType NTLM
AuthName "Moodle NTLM Authentication"
NTLMAuthHelper "/usr/bin/ntlm_auth --helper-protocol=squid-2.5-ntlmssp"
NTLMBasicAuthoritative on
require valid-user
</Files>
</Directory>
: '''For 1.8 or below use''':
<Directory "/var/www/moodle/auth/ntlm/">
<Files oncampuslogin.php>
NTLMAuth on
AuthType NTLM
AuthName "Moodle NTLM Authentication"
NTLMAuthHelper "/usr/bin/ntlm_auth --helper-protocol=squid-2.5-ntlmssp"
NTLMBasicAuthoritative on
require valid-user
</Files>
</Directory>
* Check the permissions of the Winbind pipe directory (Ubuntu places it under <tt>/var/run/samba/winbindd_privileged</tt>, yours may be placed at a different location). Apache will need to be able to enter that directory, so we need to make sure it has the right permissions. So have a look at the permissions of that directory and note the name of the group assigned to it. The following example is from a Ubuntu 7.10 machine:

$ ls -ald /var/run/samba/winbindd_privileged
drwxr-x--- 2 root winbindd_priv 60 2007-11-17 16:18 /var/run/samba/winbindd_privileged/

:so we see the group is <tt>winbindd_priv</tt>.

* Instead of modifying the directory permissions (which could break other services that use winbind) we are going to make the Apache user (<tt>www-data</tt> in our example, but could be <tt>httpd</tt>, or <tt>nobody</tt>, etc.) is part of the appropiate group. Execute the following as root:

# adduser www-data winbindd_priv

: <tt>adduser</tt> is available in Debian and Ubuntu at least. If your distribution doesn't have <tt>adduser</tt>, you can edit <tt>/etc/group</tt> manually to achive the same effect.

* Stop and start the Apache service to apply the changes. Have a look at Apache's error log to see that everything is ok.

* Couple of gotchas - in Fedora Core (and also in Redhat/Centos), keep alive is turned OFF by default in the httpd.conf - see this bug for further info: https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=188138 
simply change the line to that was:
KeepAlive Off
to:
KeepAlive On
and restart apache (/etc/init.d/http restart)
* Here are some notes from people who have the samba winbind option working
::-- I made it work using Ubuntu 7.04. That's what I've used to update the documentation. [[User:Iñaki Arenaza|Iñaki Arenaza]] 10:43, 30 September 2007 (CDT)
::-- I have this working on Ubuntu 8.04 LTS in an RM CC4 Active Directory Domain. [[User:munk3h|Ian]] 16:31 15 December 2009 (GMT)
::-- Running on Ubuntu 10.04 Lucid, Apache2 got this running in no time flat with AD v6. Worth noting that if Using Iñaki Arenaza's LDAP Clone plugin, you will need to add another copy of the Directory tag in <tt>apache2.conf</tt> pointing at the new ldap plugin. --[[User:Christopher O'Kelly|Christopher O'Kelly]] 10:09, 16 April 2012 (WST)
::-- On Ubuntu 12.04 there is no need to compile anything to do this. *sudo apt-get install php5-ldap
*sudo apt-get install libapache2-mod-auth-ntlm-winbind *sudo a2enmod auth_ntlm_winbind *sudo apt-get install winbind smbfs smbclient samba

====Using the NTLM Auth Module for Apache on Linux====
The NTLM Auth module is a bit stale and even its authors suggest that you use the [[#Using_the_NTLM_part_of_Samba_for_Apache_on_Linux|NTLM part of Samba with Apache on Linux]]

Get it from here
# get the Module from: http://modntlm.sourceforge.net/
# follow the instructions given there and inside the README that comes with the package.

I (Iñaki Arenaza) strongly recommend using the [[#Using_the_NTLM_part_of_Samba_for_Apache_on_Linux|NTLM part of Samba with Apache on Linux]] over this module. It's better maintained, more robust and has more features.

====Using the mod_auth_sspi Module for Apache 2 on Windows====
NOTE: This setup is currently being used in a live production environment, and is therefore suitable for such use provided it is correctly configured and tested.

This is the recommended method for Apache 2 on Windows, however it will '''not''' work on Linux/UNIX systems.
It provides better stability and higher performance than other NTLM modules.

* Download the mod_auth_sspi Module from: http://sourceforge.net/projects/mod-auth-sspi/. At the moment of writing this (2007.09.30), the current version is mod_auth_sspi 1.0.4, which has two different ZIP files to download:

::* mod_auth_sspi-1.0.4-2.0.58.zip : Use this file if you are using Apache 2.0.x.
::* mod_auth_sspi-1.0.4-2.2.2.zip : Use this file if you are using Apache 2.2.x.

If you are using an x64 version of Apache mod_auth_sspi x64 versions are available from https://www.apachehaus.net/modules/mod_auth_sspi/

These files '''do not''' work with Apache versions 2.4.x.

* Unzip the right file and copy mod_auth_sspi.so (it's inside '''bin''' subdirectory) to your Apache modules directory.
* Edit your Apache 2 configuration file (httpd.conf) to load the module.

<IfModule !mod_auth_sspi.c>
LoadModule sspi_auth_module modules/mod_auth_sspi.so
</IfModule>

* Choose one of the two methods below

: '''Method 1''': This method is recommended for servers that will host a single Moodle instance. Configure NTLM from the main configuration file, add the following to httpd.conf (substitute "C:\moodle" with the path to your Moodle installation e.g. "C:\my-moodle"

:: '''For 1.9 or above use''':
<Directory "C:\moodle\auth\ldap">
<Files ntlmsso_magic.php>
AuthName "Moodle at My College"
AuthType SSPI
SSPIAuth On
SSPIOfferBasic Off
SSPIAuthoritative On
SSPIDomain <YOUR AD DOMAIN>
require valid-user
</Files>
</Directory>
:: '''For 1.8 or below use''':
<Directory "C:\moodle\auth\ntlm">
<Files oncampuslogin.php>
AuthName "Moodle at My College"
AuthType SSPI
SSPIAuth On
SSPIOfferBasic Off
SSPIAuthoritative On
SSPIDomain <YOUR AD DOMAIN>
require valid-user
</Files>
</Directory>

: '''Method 2''': The alternative method is to use a .htaccess file
:This method is recommended for servers that will host multiple Moodle instances. It allows additional Moodle instances to be configured without restarting apache, and also makes the solution a little more portable. We need to add a directive to the main httpd.conf to allow configuration of authentication within .htaccess files.
<Directory C:\moodle>
AllowOverride AuthConfig
</Directory>

:::Create a new text file named '.htaccess' in the directory 'C:\moodle\moodle\auth\ldap' and add the following directives:
<Files ntlmsso_magic.php>
AuthName "Moodle at My College"
AuthType SSPI
SSPIAuth On
SSPIOfferBasic Off
SSPIAuthoritative On
SSPIDomain mycollege.ac.uk
require valid-user
</Files>

:This enables the Moodle folder to be moved to any apache webserver that is configured to allow authentication configuration through .htaccess

Lastly for Internet Explorer 7 onwards you must also replace this line in your httpd-ssl.conf file:

BrowserMatch ".*MSIE.*" \

with

BrowserMatch ".*MSIE [2-5]\..*" \

For further help and discussion: http://moodle.org/mod/forum/discuss.php?d=56565

====Using the Kerberos Auth Module for Apache on Linux/UNIX (mod_auth_kerb)====
*Install and configure http://modauthkerb.sourceforge.net/
*Configuration of mod_auth_kerb in a Microsoft Windows Active Directory environment (AD 2003 and above) (http://grolmsnet.de/kerbtut/)

Environment details in this example:
#'''Active Directory Domain:''' EXAMPLE.AC.UK
#'''Active Directory Domain Controller:''' dc.example.ac.uk
#'''Linux/UNIX web server:''' moodle.example.ac.uk
#'''Active Directory user account for web server service principal:''' moodlekerb

Install kerberos on moodle.example.ac.uk and enter the following in krb5.conf (by default: /etc/krb5.conf)

<pre>
[libdefaults]
default_realm = EXAMPLE.AC.UK
[domain_realm]
example.ac.uk = EXAMPLE.AC.UK
[realms]
EXAMPLE.AC.UK = {
admin_server = dc.example.ac.uk
kdc = dc.example.ac.uk
}:
* Test kerberos
Issue the following command at the shell prompt:
<pre>
$> kinit user@EXAMPLE.AC.UK
</pre>

Where 'user' is an Active Directory account for which you know the password.

Next, issue the following:
<pre>$>klist</pre>
If all is OK it will list the Kerberos ticket you were granted from the domain controller (KDC)

* Create HTTP service principal for moodle.example.ac.uk
#Create the 'moodlekerb' '''user''' account in Active Directory (NOT a machine account) to map to the web server service principal (HTTP/moodle.example.ac.uk@EXAMPLE.AC.UK)
NOTE: moodle.example.ac.uk MUST be the canonical DNS name of the server i.e. an A record (NOT a CNAME). Additionally a valid PTR (reverse DNS) record must exist and match the corresponding A record.

#Use the ktpass.exe utility to map the service principal and create a keytab file
Apache requires a keytab file, which is generated with ktpass.exe on the Windows Active Directory Domain Controller.
Unfortunately, this component of Windows Server 2003 SP1 does not function correctly so one must obtain a hot fix: http://support.microsoft.com/kb/919557

Run the following command on the domain controller:
<pre>
C:\path\to\hotfix\ktpass.exe -princ HTTP/moodle.example.ac.uk@EXAMPLE.AC.UK -mapuser EXAMPLE\moodlekerb -crypto DES-CBC-MD5 +DesOnly +setPass +rndPass -ptype KRB5_NT_PRINCIPAL -out moodle.example.ac.uk.keytab
</pre>

Copy C:\path\to\hotfix\moodle.example.ac.uk.keytab to the moodle web server and remember the location (/etc/httpd/moodle.example.ac.uk.keytab or similar)

* Configure Apache / mod_auth_kerb
Edit the Apache configuration for the moodle host and add the following directives:
<pre>
<Directory /path/to/moodle/docs/auth/ldap/>
<Files ntlmsso_magic.php>
AuthName "Moodle"
AuthType Kerberos
KrbAuthRealms EXAMPLE.AC.UK
KrbServiceName HTTP
Krb5Keytab /etc/httpd/moodle.example.ac.uk.keytab
KrbMethodNegotiate on
KrbMethodK5Passwd on
KrbAuthoritative on
require valid-user
</Files>
</Directory>
</pre>

*Replace the '''ntlmsso_magic''' function in '''/auth/ldap/auth.php''' (1.9 only, as 2.x already support Kerberos format out of the box, just specify that format in the "Authentication type" setting) with the following code:

<pre>
function ntlmsso_magic($sesskey) {
if (isset($_SERVER['REMOTE_USER']) && !empty($_SERVER['REMOTE_USER'])) {

// HTTP __headers__ seem to be sent in ISO-8859-1 encoding
// (according to my reading of RFC-1945, RFC-2616 and RFC-2617 and
// my local tests), so we need to convert the REMOTE_USER value
// (i.e., what we got from the HTTP WWW-Authenticate header) into UTF-8
$textlib = textlib_get_instance();
$username = $textlib->convert($_SERVER['REMOTE_USER'], 'iso-8859-1', 'utf-8');

/**
* begin kerberos - afhole@wortech.ac.uk 21-04-2009
*/
if ($pos = strpos($username, "@")) {
$username = substr($username, 0, $pos);
} else {
$username = substr(strrchr($username, '\\'), 1); //strip domain info
}
/**
* end kerberos
*/

$username = moodle_strtolower($username); //compatibility hack
set_cache_flag('auth/ldap/ntlmsess', $sesskey, $username, AUTH_NTLMTIMEOUT);
return true;
}
return false;
}
</pre>

The above code change will account for the fact that Kerberos presents the username to REMOTE_USER in the format user@DOMAIN, rather than NTLM's DOMAIN\user

==Configuring IP/Subnet Mask==
Subnet masks are based on binary patterns so need a bit of knowledge to understand. The best way to find out what IP/Subnet masks to use is to ask your Network Admin.

* The new way of specifiying subnets is even easier/more flexible than before 1.9. Just type them one after the other, separated by commas. You can use several syntaxes:
** Type the network-number/prefix-length combination. E.g. 192.168.1.0/24
** Type the network 'prefix', ending in a period character. E.g. 192.168.1.
** Type the network address range ('''this only works for the last address octect'''). E.g. 192.168.1.1-254
:All the three examples refer to the same subnetwork. So assuming you need to specify the following subnetworks:
::* 10.1.0/255.255.0.0
::* 10.2.0.0/255.255.0.0
::* 172.16.0.0/255.255.0.0
::* 192.168.100.0/255.255.255.240
:You can type:
10.1.0.0/16, 10.2.0.0/16, 172.16.0.0/16, 192.168.100.0/28
: or:
10.1.0.0/16, 10.2.0.0/16, 172.16.0.0/16, 192.168.100.240-255
:or even:
10.1., 10.2., 172.16., 192.168.100.0/28
:(the last one cannot be expressed as a network 'prefix' as the netmask does not fall on an octect boundary).

==Configuring Domain user credentials format==
If you are using Moodle 2.4 and later there is a new setting that lets you configure the format of the domain user credentials, instead of using the old fixed format. The setting is called "Remote username format". If you leave this seting empty, the default '''DOMAINNAME\username''' format will be used. You can use the optional '''%domain%''' placeholder to specify where the domain name appears, and the mandatory '''%username%''' placeholder to specify where the username appears.

Some widely used formats are:
* '''%domain%\%username%''' : MS Windows default, contains the domain name, followed by a backlash character, followed by the username.
* '''%username%@%domain%''' : This is the same format used by Kerberos (domain name followed by an at sign, followed by the username).
* '''%domain%/%username%''' : Some people configure Samba+Winbind to use this format.
* '''%domain%+%username%''' : Some people configure Samba+Winbind to use this other format.
* '''%username%''' : Only contains the username, with no domain part.

==Notes/Tips==

#If you are using Firefox, you will need to follow these steps:
:*Load Firefox and type about:config in the address box. The configuration settings page should be displayed.
:*In the Filter box, type the word "ntlm" to filter the NTLM strings. You should see three settings displayed.
:*Double-click on "network.automatic-ntlm-auth.trusted-uris".
:*In the box, enter the full URL of your Moodle server. For example <pre>http://moodle.mydomain.com, (the comma is important)</pre>
:*Close Firefox and restart.
# NTLM seems to not work at all when BASIC authentication is enabled. (this was using the Kerberos method, other ways may work)
# If the account in your AD management console shows like "First Last", you better change the ldap settings parameter 'User Attribute' from its default of {blank} / 'cn' to 'sAMAccountName' as indicated in [http://moodle.org/mod/forum/discuss.php?d=132364#p682173 this post]. The reason is that the cn name generally looks like "First Last", once you done the ldap sync, the user name in moodle will be "first last", but IE passes the account of "domain\first.last" to moodle which does not exist in moodle.

== To get a domain name for Moodle working on IIS7.5 Windows 2008 R2 ==
Refer to http://support.microsoft.com/kb/896861. Key section listed below.
Click Start, click Run, type regedit, and then click OK. 
In Registry Editor, locate and then click the following registry key:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\MSV1_0 
Right-click MSV1_0, point to New, and then click Multi-String Value. 
Type BackConnectionHostNames, and then press ENTER. 
Right-click BackConnectionHostNames, and then click Modify. 
In the Value data box, type the host name or the host names for the sites that are on the local computer, and then click OK. 
Quit Registry Editor, and then restart the IISAdmin service.

==Compiling mod_auth_ntlm_winbind on Debian/Ubuntu==
You need to install the following packages (and all of their dependencies) by using aptitude, synaptic, etc.:

autoconf apache2-threaded-dev debian-builder

Once you have them installed, open up a text console, go to the directory where you downloaded the mod_auth_ntlm_winbind files an execute the following commands (as a normal user):

autoconf
./configure --with-apxs=/usr/bin/apxs2 --with-apache=/usr/sbin/apache2
make

That should compile it without errors. Then as a user that can run commands as root via sudo, execute the following command from the same directory:

sudo make install

This will create the final mod_auth_ntlm_winbind.so file and install it under /usr/lib/apache2/modules, with the rest of the Apache 2 modules (the size of the file and last modification time shown below may differ from your install):

ls -l /usr/lib/apache2/modules/mod_auth_ntlm_winbind.so
-rw-r--r-- 1 root root 20921 2009-02-17 04:27 /usr/lib/apache2/modules/mod_auth_ntlm_winbind.so

==See also==
*[http://moodle.org/mod/forum/view.php?id=42 Using Moodle: User authentication] forum
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=45887 NTLM Authentication] forum discussion
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=80104 Merging AD NTLM SSO into auth/ldap] forum discussion
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=186661 Moodle in a DMZ with NTLM] forum discussion
*[http://moodle.org/mod/data/view.php?d=13&rid=314 Download the NTLM Authentication Module]

[[Category:Contributed code]]

[[fr:Authentification NTLM]]