Back to DocumentationAPI Reference

Dispatch Package Overview

Dispatch Package Overview

Learn about SCORM dispatch packages and how they enable content distribution to third-party LMSs.

Table of Contents

What are Dispatch Packages?

Dispatch packages are lightweight SCORM 1.2 or SCORM 2004 shell packages that can be distributed to third-party Learning Management Systems (LMSs). When a learner launches a dispatch package, it automatically loads the actual course content from the SCORM API.

Key Characteristics

  • Lightweight: Small ZIP files (~10-50KB) containing only a redirect shell
  • SCORM Compliant: Valid SCORM 1.2 or SCORM 2004 packages
  • Dynamic Content: Content is loaded from SCORM API at runtime
  • Centralized Control: Update content without redistributing packages
  • Multi-LMS Support: Works with any SCORM-compliant LMS

How They Work

1. Package Creation

When you create a dispatch package:

  1. You select a source SCORM package from your library
  2. The system generates a lightweight shell package containing:
    • imsmanifest.xml - SCORM manifest
    • index.html - Redirect page that loads content from SCORM API
  3. You download the shell package (ZIP file)
  4. You distribute the ZIP to third-party LMSs

2. LMS Integration

Third-party LMSs:

  1. Import the dispatch package like any SCORM package
  2. Launch the package for learners
  3. The shell redirects to SCORM API with learner information
  4. Actual content loads from SCORM API

3. Content Delivery

When a learner launches:

  1. LMS launches the dispatch package
  2. Shell extracts user_id from LMS context
  3. Shell redirects to SCORM API launch URL with user_id
  4. SCORM API creates session and serves actual content
  5. Learner interacts with content hosted on SCORM API
  6. Progress is tracked in SCORM API

Benefits

For Content Providers

  • Centralized Updates: Update content once, all LMSs get new version
  • No Re-distribution: No need to send new packages to each LMS
  • Usage Tracking: Track usage across all LMSs in one place
  • Version Control: Manage versions centrally
  • Analytics: Consolidated reporting across all distributions

For LMS Administrators

  • Standard Integration: Works like any SCORM package
  • No Special Setup: No API keys or configuration needed
  • Automatic Updates: Content updates automatically
  • Reliable Delivery: Content served from reliable infrastructure

For Learners

  • Seamless Experience: Works like any SCORM course
  • Always Current: Always get latest version of content
  • Consistent Tracking: Progress tracked consistently

Use Cases

1. Content Distribution to Multiple LMSs

Scenario: You create training content and need to distribute it to 50+ customer LMSs.

Solution: Create one dispatch package, distribute to all LMSs. Update content once, all LMSs automatically get updates.

2. White-Label Content Delivery

Scenario: You provide training content as a service to multiple clients.

Solution: Create dispatch packages per client. Track usage per client. Update content centrally.

3. Version Management

Scenario: You need to update course content frequently without disrupting learners.

Solution: Update source package in SCORM API. Dispatch packages automatically load new version. In-progress learners can continue with old version or restart with new.

4. Multi-Tenant Content

Scenario: You have different content versions for different customer segments.

Solution: Create separate dispatch packages per segment. Each loads appropriate content version.

Architecture

Dispatch Flow

┌─────────────────┐
│  Content        │
│  Provider       │
└────────┬────────┘
         │
         │ 1. Create Dispatch
         │
┌────────▼────────┐
│  SCORM API      │
│  (Source)       │
└────────┬────────┘
         │
         │ 2. Generate Shell
         │
┌────────▼────────┐
│  Dispatch ZIP   │
│  (Shell)        │
└────────┬────────┘
         │
         │ 3. Distribute
         │
┌────────▼────────┐      ┌──────────────┐
│  LMS 1          │      │  LMS 2       │
│  (Customer A)  │      │  (Customer B)│
└────────┬────────┘      └──────┬───────┘
         │                       │
         │ 4. Learner Launches   │
         │                       │
         └───────────┬───────────┘
                     │
                     │ 5. Redirect to API
                     │
         ┌───────────▼───────────┐
         │  SCORM API            │
         │  (Content Delivery)   │
         └───────────────────────┘

Technical Details

Dispatch Package Contents:

dispatch-package.zip
├── imsmanifest.xml    # SCORM manifest
└── index.html         # Redirect page

index.html Functionality:

  • Extracts user_id from LMS context
  • Redirects to SCORM API launch URL
  • Passes user_id and dispatch token
  • Handles errors gracefully

Launch URL Format:

https://scorm-api.allurelms.com/player/dispatch/{token}?user_id={user_id}

Related Documentation

Last Updated: 2025-01-15