Upgrading the SCORM Engine

Upgrading the SCORM Engine from a modern version

Step 1: Update the application files

Between major releases of the SCORM Engine we may make point releases that fix bugs and add small pieces of functionality that are needed by our clients. When you update your SCORM Engine implementation to one of these point releases we recommend that you follow these instructions so that we can continue to support you easily.

If you have any questions about these instructions, or you think they are not optimal for your deployment scenario, then please contact us and we will help you through the upgrade process.

The SCORM Engine interface is a web application that is customized for our clients by adding a custom Client Integration dll to its bin folder and configuring its web config settings through the SCORMEngineSettings.config file. We test our configurations with all files at the same code level so we encourage you to think of the files in the SCORM Engine directory as a single unit, despite the fact we may be providing a patch that only affects a handful of JavaScript files. Some updates may include database scripts for schema or stored procedure changes but we will explicitly call out if/when that is necessary. The standard upgrade instructions depend on your deployment scenario:

This update can be performed using the standard upgrade process for point releases found below:

Updating Your SCORM Engine for Java

Updating the SCORM Engine application for your Java platform should primarily consist of redeploying the included WAR files. If you have made custom UI changes to your environment you will need to unpack the WAR files, merge your changes, and recreate your WAR files. Information on what changes you may need to make to accommodate your custom UI changes can be found below in the .NET section.

Updating Your SCORM Engine for .NET

SCORM Engine 2010.1 and higher
Single SCORM Engine Web Application, default user interface

In the most common deployment scenario where the SCORM Engine is deployed separately to the Client LMS as a single web application, and the Client LMS uses the standard UI files located in /defaultui. You'll essentially need to completely replace the SCORM Engine application while keeping your own integration DLL and configuration file. Follow these steps (assuming the SCORMEngineInterface web app is located at ):

/SCORMEngineSettings.config

Single SCORM Engine Web Application, custom user interface.

In this deployment the Client LMS has its own set of SCORM Engine UI files, usually based on the /defaultui files, in a separate web application. It is rare that we will have made changes to the UI files in a point release. If we have then we will indicate the changes so that the client can merge these changes into their modified UI. Additionally:

Single Central SCORM Engine, multiple Remote SCORM Engines

In this deployment there is a single SCORM Engine co-located with the database and one or more remote SCORM Engines co-located with the course content.

Step 2: Update your database

In the SCORM Engine update files that were delivered to you, open the "db" folder and then open the folder corresponding to the database you are using. Then open the folder "current" and then the "install" folder". In here, you will find a SQL script file (SCPcurrent_SCP.sql) that will upgrade the SCORM Engine database objects to be compatible with the most recent ScormEngine release. Simply run this script against the database containing the SCORM Engine tables to complete the upgrade. We recommend backing up your existing database before attempting the upgrade to protect against the unlikely event of an error during script execution.

Step 3: Custom UI Updates

If you using a custom UI, meaning something other than scormengine/defaultui/deliver.aspx[or jsp], you will need to make the following additions to to take advantage of the new IE Compatibility Mode package property. If this step is skipped, your player will continue to function but it will continue to use the hard-coded META tag, if any.

Remove code in RED. Add code in GREEN.

*Deliver.aspx or jsp

<html>

<head>

<meta http-equiv="X-UA-Compatible" content="IE=EmulateIE8" />

<%=Data.InternetExplorerCompatibilityMetaTag %>

*Intermediate.aspx or jsp

<html>

<head>

<%=Data.InternetExplorerCompatibilityMetaTag %>

Step 4: Upgrade historical Tin Can Statements

If you have existing Tin Can data that you would like to be available in your 2013.2 installation, we’ve provided a utility to migrate the data into your new installation. With your SCORM Engine upgrade, you should have also received a copy of TinCanSchemaConverter appropriate for your platform (.NET or Java).

To run the converter: