ISO/IEC TR 29163-3:2009
(Main)Information technology — Sharable Content Object Reference Model (SCORM®) 2004 3rd Edition — Part 3: Run-Time Environment Version 1.1
Information technology — Sharable Content Object Reference Model (SCORM®) 2004 3rd Edition — Part 3: Run-Time Environment Version 1.1
Within the context of the Sharable Content Object Reference Model (SCORM®), ISO/IEC TR 29163-3:2009 describes the Learning Management System (LMS) requirements in managing the run-time environment (i.e., content launch process, standardized communication between content and LMSs and standardized data model elements used for passing information relevant to the learner's experience with the content). It also covers the requirements of Sharable Content Objects (SCOs) and their use of a common Application Programming Interface (API) and the SCORM® Run-Time Environment (RTE) Data Model. ISO/IEC TR 29163-3:2009 covers the essential LMS responsibilities for sequencing content objects (SCOs or Assets) during run-time and allowing SCOs to indicate navigation requests. In addition, guidance is offered for providing navigation controls to learners. General subjects discussed include the following: RTE Management: Launching of content objects – SCOs and Assets, Management of communications with a SCO, Run-time environment data model management; Application Programming Interface (API): LMS API requirements, SCORM® communication requirements, communication error conditions; SCORM® Run-Time Environment Data Model: Data model management and behavior requirements, Data type requirements.
Technologies de l'information — Modèle de référence d'objet de contenu partageable (SCORM®) 2004 3e édition — Partie 3: Environnement du temps d'exécution Version 1.1
General Information
Standards Content (Sample)
TECHNICAL ISO/IEC
REPORT TR
29163-3
First edition
2009-12-15
Information technology — Sharable
Content Object Reference Model
(SCORM®) 2004 3rd Edition —
Part 3:
Run-Time Environment Version 1.1
Technologies de l'information — Modèle de référence d'objet de
contenu partageable (SCORM®) 2004 3e édition —
Partie 3: Environnement du temps d'exécution Version 1.1
Reference number
ISO/IEC TR 29163-3:2009(E)
©
ISO/IEC 2009
---------------------- Page: 1 ----------------------
ISO/IEC TR 29163-3:2009(E)
PDF disclaimer
This PDF file may contain embedded typefaces. In accordance with Adobe's licensing policy, this file may be printed or viewed but
shall not be edited unless the typefaces which are embedded are licensed to and installed on the computer performing the editing. In
downloading this file, parties accept therein the responsibility of not infringing Adobe's licensing policy. The ISO Central Secretariat
accepts no liability in this area.
Adobe is a trademark of Adobe Systems Incorporated.
Details of the software products used to create this PDF file can be found in the General Info relative to the file; the PDF-creation
parameters were optimized for printing. Every care has been taken to ensure that the file is suitable for use by ISO member bodies. In
the unlikely event that a problem relating to it is found, please inform the Central Secretariat at the address given below.
COPYRIGHT PROTECTED DOCUMENT
© ISO/IEC 2009
All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized in any form or by any means,
electronic or mechanical, including photocopying and microfilm, without permission in writing from either ISO at the address below or
ISO's member body in the country of the requester.
ISO copyright office
Case postale 56 • CH-1211 Geneva 20
Tel. + 41 22 749 01 11
Fax + 41 22 749 09 47
E-mail copyright@iso.org
Web www.iso.org
Published in Switzerland
ii © ISO/IEC 2009 – All rights reserved
---------------------- Page: 2 ----------------------
ISO/IEC TR 29163-3:2009(E)
Foreword
ISO (the International Organization for Standardization) and IEC (the International Electrotechnical
Commission) form the specialized system for worldwide standardization. National bodies that are members of
ISO or IEC participate in the development of International Standards through technical committees
established by the respective organization to deal with particular fields of technical activity. ISO and IEC
technical committees collaborate in fields of mutual interest. Other international organizations, governmental
and non-governmental, in liaison with ISO and IEC, also take part in the work. In the field of information
technology, ISO and IEC have established a joint technical committee, ISO/IEC JTC 1.
International Standards are drafted in accordance with the rules given in the ISO/IEC Directives, Part 2.
The main task of the joint technical committee is to prepare International Standards. Draft International
Standards adopted by the joint technical committee are circulated to national bodies for voting. Publication as
an International Standard requires approval by at least 75 % of the national bodies casting a vote.
In exceptional circumstances, the joint technical committee may propose the publication of a Technical Report
of one of the following types:
— type 1, when the required support cannot be obtained for the publication of an International Standard,
despite repeated efforts;
— type 2, when the subject is still under technical development or where for any other reason there is the
future but not immediate possibility of an agreement on an International Standard;
— type 3, when the joint technical committee has collected data of a different kind from that which is normally
published as an International Standard (“state of the art”, for example).
Technical Reports of types 1 and 2 are subject to review within three years of publication, to decide whether
they can be transformed into International Standards. Technical Reports of type 3 do not necessarily have to
be reviewed until the data they provide are considered to be no longer valid or useful.
Attention is drawn to the possibility that some of the elements of this document may be the subject of patent
rights. ISO and IEC shall not be held responsible for identifying any or all such patent rights.
ISO/IEC TR 29163-3, which is a Technical Report of type 3, was prepared by the Advanced Distributed
®
Learning (ADL) Initiative (as SCORM 2004 3rd Edition Run-Time Environment Version 1.1) and was
adopted, under a special “fast-track procedure”, by Joint Technical Committee ISO/IEC JTC 1, Information
technology, in parallel with its approval by the national bodies of ISO and IEC.
ISO/IEC TR 29163 consists of the following parts, under the general title Information technology — Sharable
®
Content Object Reference Model (SCORM ) 2004 3rd Edition:
⎯ Part 1: Overview Version 1.1
⎯ Part 2: Content Aggregation Model Version 1.1
⎯ Part 3: Run-Time Environment Version 1.1
⎯ Part 4: Sequencing and Navigation Version 1.1
© ISO/IEC 2009 – All rights reserved iii
---------------------- Page: 3 ----------------------
ISO/IEC TR 29163-3:2009(E)
This page intentionally left blank.
iv © ISO/IEC 2009 – All rights reserved
---------------------- Page: 4 ----------------------
ISO/IEC TR 29163-3:2009(E)
Advanced Distributed Learning (ADL)
SCORM® 2004 3rd Edition
Run-Time Environment (RTE)
Version 1.1
For questions and comments visit
Ask The Experts at ADLNet.gov
SCORM® is a registered trademark of the Department of Defense, an agency of the United States
government, located at The Pentagon, Washington, DC 20301.
SCORM® 2004 3rd Edition Run-Time Environment (RTE) Version 1.1 v
© ISO/IEC 2009 – All rights reserved
---------------------- Page: 5 ----------------------
ISO/IEC TR 29163-3:2009(E)
This page intentionally left blank.
vi SCORM® 2004 3rd Edition Run-Time Environment (RTE) Version 1.1
© ISO/IEC 2009 – All rights reserved
---------------------- Page: 6 ----------------------
ISO/IEC TR 29163-3:2009(E)
Chief Technical Architect
Philip Dodds
Technical Editor
Schawn E. Thropp
Acknowledgements
ADL would like to thank the following organizations and their members for their
continued commitment to building interoperable e-learning standards and specifications:
Alliance of Remote Instructional Authoring & Distribution Networks for
Europe (ARIADNE) (http://www.ariadne-eu.org/)
Aviation Industry CBT Committee (AICC) (http://www.aicc.org/)
Institute of Electrical and Electronics Engineers (IEEE) Learning
Technology Standards Committee (LTSC) (http://ltsc.ieee.org/)
IMS Global Learning Consortium, Inc. (http://www.imsglobal.org/)
ADL would also like to thank the ADL Community for their commitment and
contribution to the evolution of SCORM.
SCORM® 2004 3rd Edition documentation suite reprinted with permission from IEEE Std. 1484.11.1-2004 IEEE
Standard for Learning Technology – Data Model for Content to Learning Management System Communication,
Copyright 2004, by IEEE; IEEE Std. 1484.11.2-2003 IEEE Standard for Learning Technology – ECMAScript
Application Programming Interface for Content to Runtime Services Communication, Copyright 2003, by IEEE; IEEE
Std. 1484.12.1-2002 IEEE Standard for Learning Object Metadata, Copyright 2002, and IEEE Std. 1484.12.3-2005
IEEE Standard for Learning Technology – Extensible Markup Language (XML) Schema Definition Language Binding
for Learning Object Metadata, Copyright 2005, by IEEE. The IEEE disclaims any responsibility or liability resulting
from the placement and use in the described manner.
SCORM® 2004 3rd Edition documentation suite reprinted with permission from IMS Content Packaging v1.1.4
Copyright 2004, by IMS Global Learning Consortium Inc. and IMS Simple Sequencing v1.0 Copyright 2003, by IMS
Global Learning Consortium Inc. IMS Global Learning Consortium has made no inquiry into whether or not the
implementation of third party material included in this document would infringe upon the intellectual property rights of
any party. Recipients of this document are requested to submit, with their comments, notification of any relevant
patent claims or other intellectual property rights of which they may be aware that might be infringed by any
implementation of the document set forth in this document, and to provide supporting documentation to IMS. This
material is being offered without any warranty whatsoever, and in particular, any warranty of non-infringement is
expressly disclaimed. Any use of this material shall be made entirely at the implementer’s own risk, and neither the
IMS Global Learning Consortium, nor any of its members or submitters, shall have any liability whatsoever to any
implementer or third party for any damages of any nature whatsoever, directly or indirectly, arising from the use of this
material.
SCORM® 2004 3rd Edition Run-Time Environment (RTE) Version 1.1 vii
© ISO/IEC 2009 – All rights reserved
---------------------- Page: 7 ----------------------
ISO/IEC TR 29163-3:2009(E)
This page intentionally left blank.
viii SCORM® 2004 3rd Edition Run-Time Environment (RTE) Version 1.1
© ISO/IEC 2009 – All rights reserved
---------------------- Page: 8 ----------------------
ISO/IEC TR 29163-3:2009(E)
Table of Contents
SECTION 1 THE SCORM® RUN-TIME ENVIRONMENT (RTE) . 1-1
1.1. INTRODUCTION TO THE SCORM RUN-TIME ENVIRONMENT (RTE) BOOK. 1-3
1.1.1. What is Covered in the SCORM RTE Book?. 1-3
1.1.2. Using the SCORM RTE Book. 1-4
1.1.3. Relationship with other SCORM Books. 1-4
1.2. RUN-TIME ENVIRONMENT OVERVIEW . 1-7
SECTION 2 MANAGING THE RUN-TIME ENVIRONMENT (RTE). 2-1
2.1. RUN-TIME ENVIRONMENT (RTE) MANAGEMENT . 2-3
2.1.1. Run-Time Environment Temporal Model . 2-4
2.1.2. Launching Content Objects . 2-7
2.1.3. Taking Content Objects Away. 2-9
SECTION 3 APPLICATION PROGRAMMING INTERFACE (API) . 3-1
3.1. APPLICATION PROGRAMMING INTERFACE (API). 3-3
3.1.1. API Overview . 3-3
3.1.2. API Methods and Syntax . 3-5
3.1.3. Session Methods . 3-6
3.1.4. Data-Transfer Methods. 3-7
3.1.5. Support Methods. 3-9
3.1.6. Communication Session State Model . 3-11
3.1.7. API Implementation Error Codes . 3-13
3.2. LMS RESPONSIBILITIES. 3-27
3.2.1. API Instance. 3-27
3.3. SCO RESPONSIBILITIES . 3-30
3.3.1. Finding the API Instance . 3-30
3.3.2. API Usage Requirements and Guidelines. 3-33
SECTION 4 SCORM® RUN-TIME ENVIRONMENT DATA MODEL. A-1
4.1. DATA MODEL OVERVIEW. A-3
4.1.1. SCORM Run-Time Environment Data Model Basics. A-4
4.2. SCORM RUN-TIME ENVIRONMENT DATA MODEL . A-19
4.2.1. Data Model Version. A-22
4.2.2. Comments From Learner . A-23
4.2.3. Comments From LMS . A-30
4.2.4. Completion Status. A-36
4.2.5. Completion Threshold . A-40
4.2.6. Credit . A-41
4.2.7. Entry . A-43
4.2.8. Exit. A-45
4.2.9. Interactions . A-48
4.2.10. Launch Data. A-85
4.2.11. Learner Id . A-87
4.2.12. Learner Name . A-88
4.2.13. Learner Preference. A-89
4.2.14. Location . A-95
4.2.15. Maximum Time Allowed. A-97
4.2.16. Mode. A-98
4.2.17. Objectives . A-100
4.2.18. Progress Measure. A-120
4.2.19. Scaled Passing Score . A-122
SCORM® 2004 3rd Edition Run-Time Environment (RTE) Version 1.1 ix
© ISO/IEC 2009 – All rights reserved
---------------------- Page: 9 ----------------------
ISO/IEC TR 29163-3:2009(E)
4.2.20. Score. A-124
4.2.21. Session Time . A-129
4.2.22. Success Status. A-131
4.2.23. Suspend Data. A-135
4.2.24. Time Limit Action. A-137
4.2.25. Total Time .A-139
APPENDIX A ACRONYM LISTING. A-1
ACRONYM LISTING. A-3
APPENDIX B REFERENCES.B-1
REFERENCES.B-3
APPENDIX C DOCUMENT REVISION HISTORY .C-1
DOCUMENT REVISION HISTORY .C-3
List of Figures
Figure 1.1a: The SCORM Run-Time Environment Book as Part of the SCORM Bookshelf. 1-3
Figure 1.2a: SCORM Conceptual Run-Time Environment. 1-8
Figure 2.1a: Conceptual Content Structure Illustration. 2-3
Figure 2.1.1.1a: Single Learner Attempt with one Learner Session. 2-6
Figure 2.1.1.1b: Learner Attempt Spread Over Several Learner Sessions . 2-6
Figure 2.1.1.1c: Successive Learner Attempts, Spread Over Several Learner Sessions . 2-6
Figure 3.1.1a: Illustration of API, API Instance and API Implementation. 3-4
Figure 3.1.6a: Conceptual API Instance State Transitions .3-12
Figure 3.2.1a: Permitted DOM Locations of an API Implementation. 3-28
Figure 3.3.1a: Illustration of Finding the API . 3-31
Figure 4.1.1a: Illustration of Using the Data Model with the API . A-3
Figure 4.2.9a: Interactions and Interaction Data . A-48
x SCORM® 2004 3rd Edition Run-Time Environment (RTE) Version 1.1
© ISO/IEC 2009 – All rights reserved
---------------------- Page: 10 ----------------------
ISO/IEC TR 29163-3:2009(E)
List of Tables
Table: 3.1.1b: Categories of API Methods . 3-5
Table 3.1.7a: Error Code Categories and Range. 3-13
Table 4.1.1.6a: Reserved Property Delimiters. A-9
Table 4.1.1.6b: Reserved Separator Delimiters . A-12
Table 4.2a: SCORM Run-Time Environment Data Model Elements Summary . A-19
Table 4.2b: Data Model Element Table Explanation.A-20
Table 4.2.1a: Dot-notation Binding for the Data Model Version Data Model Element . A-22
Table 4.2.2a: Dot-notation Binding for the Comments from Learner Data Model Element . A-23
Table 4.2.3a: Dot-notation Binding for the Comment from LMS Data Model Element . A-30
Table 4.2.4a: Dot-notation Binding for the Completion Status Data Model Element . A-36
Table 4.2.4.1a: GetValue() Evaluation of Completion Status . A-38
Table 4.2.5a: Dot-notation Binding for the Completion Threshold Data Model Element. A-40
Table 4.2.6a: Dot-notation Binding for the Credit Data Model Element. A-41
Table 4.2.7a: Dot-notation Binding for the Entry Data Model Element. A-43
Table 4.2.8a: Dot-notation Binding for the Exit Data Model Element. A-45
Table 4.2.9a: Dot-notation Binding for the Interactions Data Model Element. A-49
Table 4.2.9.1a: Correct Response Pattern Format Requirements . A-68
Table 4.2.9.2a: Learner Response Format Requirements . A-78
Table 4.2.10a: Dot-notation Binding for the Launch Data Data Model Element . A-85
Table 4.2.11a: Dot-notation Binding for the Learner ID Data Model Element . A-87
Table 4.2.12a: Dot-notation Binding for the Learner Name Data Model Element. A-88
Table 4.2.13a: Dot-notation Binding for the Learner Preference Data Model Element . A-89
Table 4.2.14a: Dot-notation Binding for the Location Data Model Element . A-95
Table 4.2.15a: Dot-notation Binding for the Max Time Allowed Data Model Element . A-97
Table 4.2.16a: Dot-notation Binding for the Mode Data Model Element . A-98
Table 4.2.16.1a: Mode and Credit Values . A-99
Table 4.2.17.1a: Scenarios for Storing Collection Data . A-101
Table 4.2.17a: Dot-notation Binding for the Objectives Data Model Element. A-103
Table 4.2.18a: Progress Measure relationship with Completion Status. A-120
Table 4.2.18b: Dot-notation Binding for the Progress Measure Data Model Element . A-120
Table 4.2.19a: Dot-notation Binding for the Scaled Passing Score Data Model Element. A-122
Table 4.2.20a: Dot-notation Binding for the Score Data Model Element. A-124
Table 4.2.21a: Dot-notation Binding for the Session Time Data Model Element . A-129
Table 4.2.22a: Dot-notation Binding for the Success Status Data Model Element . A-131
Table 4.2.22.1a: GetValue() Evaluation of Success Status. A-133
Table 4.2.23a: Dot-notation Binding for the Suspend Data Data Model Element. A-135
Table 4.2.24a: Dot-notation Binding for the Time Limit Action Data Model Element. A-137
Table 4.2.25a: Dot-notation Binding for the Total Time Data Model Element. A-139
SCORM® 2004 3rd Edition Run-Time Environment (RTE) Version 1.1 xi
© ISO/IEC 2009 – All rights reserved
---------------------- Page: 11 ----------------------
ISO/IEC TR 29163-3:2009(E)
This page intentionally left blank.
xii SCORM® 2004 3rd Edition Run-Time Environment (RTE) Version 1.1
© ISO/IEC 2009 – All rights reserved
---------------------- Page: 12 ----------------------
ISO/IEC TR 29163-3:2009(E)
SECTION 1
The SCORM® Run-Time Environment
(RTE)
From IEEE Std. 1484.11.1-2004 IEEE Standard for Learning Technology – Data Model for Content to Learning Management System
Communication, Copyright 2004 IEEE; IEEE Std. 1484.11.2-2003 IEEE Standard for Learning Technology – ECMAScript
Application Programming Interface for Content to Runtime Services Communication, Copyright 2003 IEEE; IEEE Std. 1484.12.1-
2002 IEEE Standard for Learning Object Metadata, Copyright 2002 IEEE; and IEEE Std. 1484.12.3-2005 IEEE Standard for Learning
Technology – Extensible Markup Language (XML) Schema Definition Language Binding for Learning Object Metadata, Copyright
2005 IEEE. All rights reserved.
From IMS Content Packaging v1.1.4 Copyright 2004, by IMS Global Learning Consortium Inc. and IMS Simple Sequencing v1.0
Copyright 2003, by IMS Global Learning Consortium Inc. All rights reserved.
SCORM® 2004 3rd Edition Run-Time Environment (RTE) Version 1.1 RTE-1-1
© ISO/IEC 2009 – All rights reserved
---------------------- Page: 13 ----------------------
ISO/IEC TR 29163-3:2009(E)
This page intentionally left blank.
RTE-1-2 SCORM® 2004 3rd Edition Run-Time Environment (RTE) Version 1.1
© ISO/IEC 2009 – All rights reserved
---------------------- Page: 14 ----------------------
ISO/IEC TR 29163-3:2009(E)
1.1. Introduction to the SCORM Run-Time Environment
(RTE) Book
The Sharable Content Object Reference Model (SCORM®) is often described as a set of
books on a bookshelf. The Run-Time Environment (RTE) book is one of a set of books
(refer to Figure 1.1a: The Run-Time Environment Book as Part of the SCORM
Bookshelf). More information on the other SCORM books and their relationships to one
another can be found in the SCORM 2004 Overview. The SCORM RTE book describes
the Learning Management System (LMS) requirements in managing the run-time
environment (i.e., content launch process, standardized communication between content
and LMSs and standardized data model elements used for passing information relevant to
the learner’s experience with the content). The RTE book also covers the requirements
of Sharable Content Objects (SCOs) and their use of a common Application
Programming Interface (API) and the SCORM Run-Time Environment Data Model.
Figure 1.1a: The SCORM Run-Time Environment Book as Part of the SCORM Bookshelf
1.1.1. What is Covered in the SCORM RTE Book?
There are several key concepts that are introduced in the SCORM RTE book. The book
covers the essential LMS responsibilities for sequencing content objects (SCOs or
Assets) during run-time and allowing SCOs to indicate navigation requests. In addition,
guidance is offered for providing navigation controls to learners. General subjects
discussed include:
• RTE Management: Launching of content objects – SCOs and Assets,
Management of communications with a SCO, Run-time environment data model
management
SCORM® 2004 3rd Edition Run-Time Environment (RTE) Version 1.1 RTE-1-3
© ISO/IEC 2009 – All rights reserved
---------------------- Page: 15 ----------------------
ISO/IEC TR 29163-3:2009(E)
• Application Programming Interface (API): LMS API requirements, SCORM
communication requirements, communication error conditions
• SCORM Run-Time Environment Data Model: Data model management and
behavior requirements, Data type requirements
1.1.2. Using the SCORM RTE Book
This book should prove useful to LMS, SCO and authoring tool vendors wishing to
support SCORM in their products, and to anyone wishing to understand the
communications relationship between content and LMSs, such as SCORM content
developers.
Section 1: The SCORM® Run-Time Environment (RTE) and Section 2: Managing the
Run-Time Environment (RTE) of this book cover general RTE-related concepts. These
sections are recommended reading for those seeking an introduction to the concepts
behind the SCORM RTE and who may not wish to delve into its technical details. Others
who may find these sections useful include those wishing to learn about updates to the
RTE. Section 2.1: Run-Time Environment (RTE) Management, for instance, discusses
how the new Sequencing and Navigation book impacts the SCORM RTE.
Section 3: Application Programming Interface (API) is the first section providing
technical details about the RTE. This section explains every SCORM API method and
error message available to content developers, and even provides sample code as well as
API Usage Requirements and Guideline
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.