Note: You are currently viewing documentation for Moodle 2.2. Up-to-date documentation for the latest stable version is available here: SCORM settings.

SCORM settings: Difference between revisions

From MoodleDocs
 
(38 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Improve}}
{{SCORM}}
{{SCORM}}
<p class="note">'''Please refer to [[TOC_with_notes#SCORM|these notes]] before editing this page.'''</p>
 
To edit or add a SCORM to a course, turn on the course edit mode as a teacher with editing privileges.  
To add a SCORM package to a course, or to edit the SCORM activity settings, turn on the course edit mode as a teacher with editing privileges.  


The SCORM activity can also be used to add AICC content running using AICC HACP (HTTP AICC Communication Protocol "Appendix A"), see CMI001 - AICC/CMI Guidelines For Interoperability [http://www.aicc.org/pages/down-docs-index.htm#cmi001]
The SCORM activity can also be used to add AICC content running using AICC HACP (HTTP AICC Communication Protocol "Appendix A"), see CMI001 - AICC/CMI Guidelines For Interoperability [http://www.aicc.org/pages/down-docs-index.htm#cmi001]
==Creating==
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]]


==Adding==  
==Adding==  
Line 17: Line 21:


===General settings===
===General settings===
[[Image:M2-scorm-settings.png|thumb|500px|center|Launch file picker]]
*'''Name''' field records the short name of the activity. This appears in the navigation breadcrumb.
*'''Name''' field records the short name of the activity. This appears in the navigation breadcrumb.
*'''Description''' text is only seen after the name in the list shown when you choose "activities > Scorm"
*'''Description''' text is only seen after the name in the list shown when you choose "activities > Scorm"
*'''Package file''' button to open the course Files area. Locate the zipped SCORM package (otherwise upload it to the server before continuing). 
*'''Package file''' setting determines what SCORM package is used by this SCORM activity. To select the SCORM package, first select the '''Choose''' button to launch the file picker.
** Use the '''choose''' link (NOT the Unzip link) to select the package.  
[[Image:M2-scorm-settings.png|thumb|400px|center|Launch file picker]]
Some people are confused by this, and they think that "choose" means that you select the checkbox to the left of the file name. This is not the case. You may need to increase the size of the file browser window to see the Choose link, or scroll to the right.  
With the file picker launched, you can navigate to an existing file, or select the '''Choose''' button in the file picker to upload a new file.
[[Image:Picture-3.jpg|thumb|500px|center|File browser window, arrow points to Choose link]]
[[Image:M2-scorm-file-picker-choose.png|thumb|400px|center|Launch file picker]]
A SCORM package must contains in the root of zip a file named imsmanifest.xml that define SCORM course structure, resource location and many other things.
Browse to the new SCORM package on your local machine and select it. When you are returned to the file picker, select '''Upload'''.
[[Image:M2-scorm-upload-file-to-site.png|thumb|400px|center|Launch file picker]]
If selecting files is difficult, you might want to learn more about the [[File picker]].
:''Tip:'' Additional '''Package file''' settings are available when configured globally. See '''Admin settings''' below.


An AICC package is defined by several files (from 4 to 7) with defined extensions as follows:
===Restrict answering to this time period===
*Open
*Until


* CRS - Course Description file (mandatory)
===Display settings===
* AU - Assignable Unit file (mandatory)
[[Image:SCORM_settings_other_19.png|thumb|300px|right|Moodle 1.9 SCORM Other Settings block - advanced  shown ]]
* DES - Descriptor file (mandatory)
*'''Display package''' - in current or new window
* CST - Course Structure file (mandatory)
*'''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).
* ORE - Objective Relationship file (optional)
*'''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).
* PRE - Prerequisites file (optional)
*'''Options''' - There are 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.
* CMP - Completition Requirements file (optional)
*'''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.
:''Tip:'' If the Choose link is not visible - close the pop-up window and click the "Choose or upload a file" button again.  
* '''Display course structure on entry page''' - If enabled, the table of contents is displayed on the SCORM outline page.
:''Tip:'' As an alternative to the previous two steps, you may paste a URL into the Package file field that references a zip file or imsmanifest.xml file hosted on an external repository.
* '''Display course structure in player''' - This setting specifies how the table of contents is displayed in the SCORM player:
** To the side
** Hidden
** In a drop down menu
** Disabled
*'''Hide navigation buttons'''


===Other settings===
===Grade settings===
Pressing the advance button will reveal all the choices below.
[[Image:SCORM_settings_other_19.png|thumb|300px|right|Moodle 1.9 SCORM Other Settings block - advanced  shown ]]
*'''Grading method'''
*'''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.  
** 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.  
*** Note that 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.  
**Highest grade - The grade page will display the highest score obtained by users in all passed Learning Objects.  
*** Note that 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.
** 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.
**Sum grade - With this mode all the scores will be added.
*'''Maximum grade'''
*'''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.
*'''Number of attempts''' - This define the number of attempts permitted to users. It works only with SCORM 1.2 and AICC packages. SCORM2004 has its own max attempts definition.  
 
===Additional settings===
Pressing the advance button will reveal all the choices below.
*'''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.
** 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.   
** 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.
*'''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.
*'''Window''' - Stage size width, Stage size height
* '''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.
*'''Display package''' - in current or new window
* '''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.
*'''Options''' - There are 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.
* '''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 either 'completed' or 'passed' - this setting can also be used to make sure a new attempt is generated when the 'Student skip content structure page' setting is used.
*'''Student skip content structure page''' - never, first access, always
* '''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.
*'''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
*'''Course structure display''' - Table of Contents display
*'''Hide navigation buttons'''
*'''Auto-Continue''' - If Auto-continue is set to Yes, when a Learning Object calls the "close communication" method, the next available Learning Object is launched automatically.If it is set to No, the users must use the "Continue" button to go on.
*'''Auto-Continue''' - If Auto-continue is set to Yes, when a Learning Object calls the "close communication" method, the next available Learning Object is launched automatically.If it is set to No, the users must use the "Continue" button to go on.
:''TIP:'' Auto-Continue will only to move from one SCORM to the next in the same topic.  
:''TIP:'' Auto-Continue will only to move from one SCORM to the next in the same topic.
 
*'''Display package''' - Allow the window to be resized, Allow the window to be scrolled, Show the directory links, Show the location bar, Show the menu bar, Show the toolbar, Show the status bar.
 
{{Moodle 2.0}}In Moodle 2.0 onwards, the following additional settings influencing player/package interaction are available:
* Display attempt status
* Display course structure
* Force completed
* Force new attempt
* Lock after final attempt


===Common module settings===
===Common module settings===
See [[Common module settings]]
See [[Common module settings]]
[[Image:SCORM_setting_common_19.png|thumb|300px|right|Moodle 1.9 SCORM Common settings block - advanced shown ]]


===Save settings===
===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.
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.
[[Image:SCORM_activity_homepage_teacher_19.png|thumb|300px|right|Moodle 1.9 SCORM Teacher staging area ]]


==Admin Settings==
==Site administration settings==
These options are available to the site admin in the '''Settings''' menu: Site Administration > Plugins > Activity Modules > SCORM Package.  
[[Image:M2-scorm-admin-nav.png|thumb|163px|right|Moodle 2.0 SCORM Admin Settings]]
These options are available to the site admin in the '''Settings''' menu: ''Site administration > Plugins > Activity Modules > SCORM Package''.  


Many of the settings available here simply set the default value for the SCORM activity module setup options provided within courses. This will cover the options provided which '''do not''' simply set a default value for the SCORM activity editing page view.  
===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.


'''Synchronization time:''' For SCORM packages that have the auto-update setting to 'Every Day' this defines what time the process should run.
===Other Important Settings===
The following options provided which '''do not''' simply set a default value for the SCORM activity editing page view.  


'''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 any reporting data will not be saved via the SCORM API in to Moodle.
;Synchronization time
 
:For SCORM packages that have the auto-update setting to 'Every Day' this defines what time the process should run.
'''Enable downloaded package type:''' If selected, presents a text field to paste a URL to a remove package.zip SCORM package. Package is downloaded and unzipped into the Moodle file system.  
;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 any reporting data will not be saved via the SCORM API in to Moodle.
'''Enable IMS package type:''' Enables a package to be selected from within an IMS repository
;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.  
'''Force users to enable JavaScript:''' Since the SCORM API uses JavaScript to save data to Moodle, this is a great idea!
;Enable IMS package type
 
:Enables a package to be selected from within an IMS repository
'''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.  
;Force users to enable JavaScript
 
:Since the SCORM API uses JavaScript to save data to Moodle, this is a great idea!
'''API debug capture mask - use a simple regex on <username>:<activityname> e.g. admin:.* 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'''.
;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'''.
{{New features}};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
{{New features}}: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==


==Tips and tricks==
* [[:dev:SCORM_schema |SCORM Schema]] for developers
*Please note that Moodle can't create SCORM packages - the SCORM module is simply for deploying SCORM packages. If you wish to create SCORM packages please see the [[SCORM#External links | links to SCORM tools]].
* [https://moodle.org/mod/forum/discuss.php?d=214527 External AICC HACP setting] in a specific Windows environment (WISP, NTLM, ISA)
* 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.
* 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.
 
 
 
==See also==


[[Category:Teacher]]
[[Category:Teacher]]
[[Category:SCORM]]
[[Category:SCORM]]


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

Latest revision as of 11:37, 22 August 2014

This page really needs improving. Please see the page comments for suggestions of what to include, then remove this template when you're done.


To add a SCORM package to a course, or to edit the SCORM activity settings, turn on the course edit mode as a teacher with editing privileges.

The SCORM activity can also be used to add AICC content running using AICC HACP (HTTP AICC Communication Protocol "Appendix A"), see CMI001 - AICC/CMI Guidelines For Interoperability [1]

Creating

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

Adding

  1. While logged in as a teacher, select Turn edit on button.JPG at the top right of a course homepage or in the course admin menu. See Turn_editing_on.
  2. in one of the Add an activity... drop down menus that appear, select SCORM package.

Editing

If the SCORM/AICC package has already been added, you can edit it by clicking the edit icon (pen) in the resource/activity list on front page of the course. If you are in the SCORM page, you can click the Update this SCORM button. Both these methods bring you to the settings page.

Settings

On the Setting page, the teacher can view the 3 settings areas, along with the save options buttons.

Moodle 2.0 SCORM Setting Page

General settings

  • Name field records the short name of the activity. This appears in the navigation breadcrumb.
  • Description text is only seen after the name in the list shown when you choose "activities > Scorm"
  • Package file setting determines what SCORM package is used by this SCORM activity. To select the SCORM package, first select the Choose button to launch the file picker.
Launch file picker

With the file picker launched, you can navigate to an existing file, or select the Choose button in the file picker to upload a new file.

Launch file picker

Browse to the new SCORM package on your local machine and select it. When you are returned to the file picker, select Upload.

Launch file picker

If selecting files is difficult, you might want to learn more about the File picker.

Tip: Additional Package file settings are available when configured globally. See Admin settings below.

Restrict answering to this time period

  • Open
  • Until

Display settings

Moodle 1.9 SCORM Other Settings block - advanced shown
  • Display package - in current or new window
  • 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 are 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 on entry page - If enabled, the table of contents is displayed on the SCORM outline page.
  • Display course structure in player - This setting specifies how the table of contents is displayed in the SCORM player:
    • To the side
    • Hidden
    • In a drop down menu
    • Disabled
  • Hide navigation buttons

Grade settings

  • 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.

Additional settings

Pressing the advance button will reveal all the choices below.

  • 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 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 either 'completed' or 'passed' - 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.
  • Auto-Continue - If Auto-continue is set to Yes, when a Learning Object calls the "close communication" method, the next available Learning Object is launched automatically.If it is set to No, the users must use the "Continue" button to go on.
TIP: Auto-Continue will only to move from one SCORM to the next in the same topic.

Common module settings

See Common module settings

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

Moodle 2.0 SCORM Admin 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.

Synchronization time
For SCORM packages that have the auto-update setting to 'Every Day' this defines what time the process should run.
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 any reporting data will not be saved via the SCORM API in 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.

New feature
in Moodle 2.2!

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

New feature
in Moodle 2.2!

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