Follow

Configuring Engine for Use with Offline SDKs

Avatar

In order to use Engine with one of our offline SDKs, you must configure Engine correctly.

In your Engine settings file, you will see a section for "Optional Offline Settings".

In that section, you will need to uncomment the entry for "ScormEngineFilesystemRoot" and ensure that it points to the filesystem path to your Engine application.

You will also need to add an entry for "OfflineExporterFileTypeExclusions" and use it to denote any file types that should not be included in courses exported for offline viewing. It is fine for this entry to be empty.

Once these settings are in place, you should be able to visit Engine's console, where you will see a new "Export for Offline" link associated with packages displayed there.

In order for the export process to work, the values of the "ScormEngineUrl" and "WebPathToContentRoot" entries in your Engine settings file must be absolute URLs.

You will also need to create an "offline" directory with permissions that can be written by your application server in your WebPathToContentRoot directory.

Now you're ready to export! Get hype!

When you click "Export for Offline" for a given package, your browser will display the filepath to the exported package if it was exported successfully. N.B. If you attempt to export a package that had been previously imported with a relative web path to content, the export will fail.

Once you've exported successfully, you will need to update the package properties for the given package (which can also be done via console) to make it available offline in order for it to be available to the SDK's offline catalog.

Once you've saved the package property, then an app built using the offline SDKs will have the exported package available in the offline catalog.

To summarize the necessary steps:

  1. Uncomment and update "ScormEngineFilesystemRoot" in your Engine settings file.
  2. Add an entry for "OfflineExporterFileTypeExclusions".
  3. Ensure that your "ScormEngineUrl" and "WebPathToContentRoot" are absolute.
  4. Add an "offline" directory to your content root.
  5. Ensure that "Available Offline" is set as a package property for any packages you'd like displayed in the offline catalog.
  6. Export ... and profit!
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk