| Table of Contents |
|
Installation Instructions
Revisions
Running the SRTE
Design Information
Additional Information
|
| SRTE |
IntroductionWelcome to the Sharable Content Object Reference Model (SCORM) 2004 4th Ed. SRTE Version 1.1.1. The SRTE provides an example implementation of the concepts described in SCORM. Specifically, it provides an example of the SCORM Run-Time Environment (Application Programming Interface (API) and Data Model) and SCORM Sequencing and Navigation as they might be applied in a learning management system (LMS) environment. Robust exception and error handling are not included in this sample code, nor were performance optimizations considered. Even though there are a number of valid web-enabled SCORM implementations, this version of the SRTE was implemented as a web-based client/server application using HTML, JavaScript, JavaServer Pages (JSP), Java Applets and Java Servlets. Refer to the "Design Information" section of this Readme for additional SRTE design information. |
| Installation |
Prerequisites
IMPORTANT: Read ALL of the Installation
Instructions BEFORE beginning installation.
The latest version of this software can be downloaded free of charge at http://java.sun.com/javase/downloads/index.jsp. Archived versions are available at http://java.sun.com/products/archive/. Refer to this site for a list of specific Java versions verified. Notes:
ConstraintsAs of this release, the SRTE was tested on the Intel® Pentium® PC platform running Microsoft® Windows® Vista SP1 and XP Professional SP3. Microsoft Internet Explorer 7.0 and Internet Explorer 8.0 were also tested with the SRTE. The SRTE was not formally tested with any other browsers on any other platforms than those indicated above. InstallationIMPORTANT: Only install the SRTE after installing the Java Development Kit as described in the Prerequisites. The SRTE is available for download as a self-extracting executable install file. Once you have completed downloading the file, perform the following steps:
Note: The apache-tomcat-5.5.20 servlet engine and web server will be installed and pre-configured to bind to port 8080. ConfigurationAfter installation, perform the following actions to ensure that the SRTE runs properly:
This completes the installation of the SRTE. Uninstalling the SRTEUse one of two possible methods to uninstall the SRTE:
These methods of uninstalling will not remove files or directories that have been altered in the course of running the SRTE. To complete the process of uninstalling the SRTE, the follow these steps:
|
| Revisions |
Changes from SCORM 2004 4th Ed. Sample RTE Version 1.1 to SCORM 2004 4th Ed. Sample RTE Version 1.1.1 |
|
Changes from SCORM 2004 4th Ed. Sample RTE Version 1.0 to SCORM 2004 4th Ed. Sample RTE Version 1.1 |
|
Changes from SCORM 2004 3rd Edition Sample RTE Version 1.0.2 to SCORM 2004 4th Ed. Sample RTE Version 1.0 |
|
| Running the SRTE |
Instructions |
|
These instructions are for running the SRTE on a Windows platform. Windows is the only platform on which the software has been tested and for which instructions are provided. To Run the SRTE: Ensure that your default browser is Microsoft Internet Explorer 6.0 or greater and then start the apache-tomcat-5.5.20 servlet container and Web server that is provided with this installation by:
Online help pages are available once the SRTE is started. "Help" links will typically be located on the top right of each page. To close the SRTE, first close the browser in which it is running. To stop the apache-tomcat-5.5.20 servlet container and Web server, click Start Menu -> All Programs -> ADL -> SCORM_2004_4th_Edition_Sample_Run-Time_Environment_version_1.1.1 -> Stop Server. To return the SRTE to a "clean" state, log into the SRTE and from the home page choose "Clear Database". This will remove all of the imported course files as well as any information associated with them. It will also remove all user registration information and all Global Objective information. Course Navigation User Interface In addition to any User Interface (UI) controls provided within course content, the SRTE provides several mechanisms for navigating through a course that complies with Section 2.1.7 of the SCORM 2004 4th Ed. Testing Requirements. These mechanisms include the navigation buttons in the top frame of the SRTE, such as the Quit, Suspend, Previous, and Continue buttons, and the Table of Contents provided in the left-hand frame. Navigation Buttons The navigation buttons provided by the SRTE in the top frame will be visible when they are not explicitly "hidden" by an activity via the "hideLMSUI" element within the manifest. When an activity explicitly hides any of the buttons, they will not appear in the top frame. The following section describes the behavior of the navigation buttons when they are not hidden:
Table of Contents A table of contents (ToC) will be provided by the SRTE when a course includes Choice equal to "true" anywhere within its activity tree. When a course includes Choice equal to "false" at every level of its activity tree, the table of contents will not appear. The following describes the items in the ToC when Choice is set to "true" in the course:
|
| Design Information |
|
SRTE Server ComponentThe SRTE Server Component is implemented using Java Servlets and Java Applications. The Servlets respond to requests from the Run-time Environment Client Component and are responsible for data model persistence as well as sequencing and parsing logic. The source files for the server component are located in the Sample_RTE\source\src directory. In addition, the JavaDoc associated with the source files is located at Sample_RTE\api\index.html. The modules that make up the Server Component are listed below:
|
SRTE Client Component (Java Files)The SRTE Client Component consists of a sample user interface implemented in HTML and JavaScript and the SRTE API Instance implemented as a Java Applet. The Applet is downloaded to the client when the user accesses the SRTE page through a Web browser. This Applet provides the communication to the SRTE Server Component for data model element persistence. Refer to the JavaDoc Package, "org.adl.samplerte.client", for details. |
SRTE Client Component (Web Files)The SRTE Client Component is comprised of the following modules located in the Sample_RTE\source\SampleRTE\LMSClient directory:
|
Third Party ComponentsThe SRTE uses the following third party tools:
|
Note: You are not a required to build the SRTE before using it. It will install as a fully operational unit. You only have to build the SRTE if the source code has been changed.
Complete the SRTE full installation instructions before compiling the SRTE. The SRTE build file depends on a full apache-tomcat-5.5.20 install, along with resources provided in the installation of the SRTE. When the SRTE is built, it overwrites the previously installed SRTE. To revert back to the original SRTE, execute the un-install and then rerun the downloaded self-extracting executable.
Apache Ant must be installed before building the SRTE. For information
about and downloads of Ant, refer to
http://ant.apache.org/.
To build the SRTE:
The XML Ant build files will compile all Java class and jar files needed by the SRTE. In addition the files will be installed to apache-tomcat. ( Note: Restart the Tomcat server for changes to take effect. This completes the compilation of the SRTE.
Source File Locations
| Additional Information |
Known Issues
|
Implementation DecisionsCase Sensitive URLs
Maximum Allowable Course Size
Manifest Encodings
|
Supported Java Versions
|
Environment Variable
|
ODBC Connections
|
System Requirements
|
Licenses and CopyrightsADL SCORM 2004 4th Edition Sample Run-Time Environment The ADL SCORM 2004 4th Ed. Sample Run-Time Environment is licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 United States. The Advanced Distributed Learning Initiative allows you to:
Under the following conditions:
For any reuse or distribution, you must make clear to others the license terms of this work. Any of the above conditions can be waived if you get permission from the ADL Initiative. Nothing in this license impairs or restricts the author's moral rights. |
|
This product includes software developed by the Apache Software Foundation (http://www.apache.org)
Refer to the Apache License Agreement below at |