Allure Connect

Distributing Dispatch Packages

Guide to distributing SCORM dispatch packages to third-party LMSs and managing distributions.

Table of Contents

Overview

Once you've created a dispatch package, you need to distribute it to third-party LMSs. This guide covers the complete distribution workflow.

Distribution Process

Step 1: Download Dispatch Package

Download the dispatch ZIP file:

Via Dashboard:

  1. Navigate to Dashboard → Dispatch
  2. Find your dispatch package
  3. Click "Download ZIP"

Via API:

curl -X GET "https://app.allureconnect.com/api/customer/dispatches/dispatch_xyz789/zip" \
  -H "X-API-Key: your-api-key" \
  --output dispatch-package.zip

Step 2: Send to LMS Administrator

Provide the dispatch package to the LMS administrator:

Email Template:

Subject: SCORM Package for Import

Hi [LMS Admin],

Please find attached the SCORM package for [Course Name].

Instructions:
1. Import the attached ZIP file into your LMS
2. The package will work like any standard SCORM package
3. Content is hosted on our infrastructure and updates automatically

If you have any questions, please let me know.

Best regards,
[Your Name]

Step 3: LMS Administrator Imports

The LMS administrator:

  1. Logs into their LMS
  2. Navigates to course import/upload section
  3. Uploads the dispatch ZIP file
  4. LMS validates and imports the package
  5. Package appears in LMS course catalog

Step 4: Learners Launch

When learners launch:

  1. LMS launches the dispatch package
  2. Package redirects to SCORM API
  3. Content loads from SCORM API
  4. Progress is tracked in SCORM API

LMS Integration

Standard SCORM Import

Dispatch packages work with any SCORM-compliant LMS:

  • Moodle: Import via Course → Import
  • Canvas: Import via Course Settings → Import Course Content
  • Blackboard: Import via Packages and Utilities → Import Package
  • Cornerstone: Import via Learning → Import SCORM
  • Any SCORM-compliant LMS: Standard SCORM import process

No Special Configuration Required

  • No API keys needed
  • No special setup required
  • Works like any SCORM package
  • Standard SCORM launch process

User ID Handling

The dispatch package automatically:

  1. Extracts user_id from LMS context
  2. Passes user_id to SCORM API
  3. Creates session with correct user ID
  4. Tracks progress per user

LMS Requirements:

  • LMS must provide user identifier in SCORM context
  • Most modern LMSs do this automatically
  • No additional configuration needed

Monitoring Distributions

View All Distributions

Via Dashboard:

  1. Navigate to Dashboard → Dispatch
  2. Click on a dispatch package
  3. View distribution metrics

Via API:

curl -X GET "https://app.allureconnect.com/api/customer/dispatches/dispatch_xyz789/distributions" \
  -H "X-API-Key: your-api-key"

Response:

{
  "distributions": [
    {
      "lms_name": "Client A LMS",
      "lms_url": "https://client-a-lms.com",
      "first_launch": "2025-01-10T08:00:00.000Z",
      "last_launch": "2025-01-15T14:30:00.000Z",
      "total_launches": 125,
      "unique_users": 45
    }
  ],
  "summary": {
    "total_distributions": 3,
    "total_launches": 450,
    "total_unique_users": 120
  }
}

Track Usage Per Distribution

Monitor:

  • Number of launches per LMS
  • Unique users per LMS
  • First and last launch times
  • Registration counts
  • License usage (if enabled)

View Consolidated Reports

Get reports across all distributions:

curl -X GET "https://app.allureconnect.com/api/customer/dispatches/dispatch_xyz789/reports" \
  -H "X-API-Key: your-api-key"

Response:

{
  "report": {
    "total_launches": 450,
    "total_completions": 320,
    "completion_rate": 71.1,
    "avg_score": 0.82,
    "avg_time_spent_seconds": 3600,
    "by_distribution": [
      {
        "lms_name": "Client A LMS",
        "launches": 125,
        "completions": 90,
        "completion_rate": 72.0
      }
    ]
  }
}

Managing Updates

Update Source Package

When you update the source package:

  1. Upload new version to SCORM API
  2. Update package in your library
  3. Dispatch packages automatically load new version

Version Control Options

Option 1: Automatic Updates (Default)

  • All launches use latest version
  • In-progress learners may see version change
  • Recommended for minor updates

Option 2: Version Pinning

  • Pin dispatch to specific package version
  • Updates require new dispatch package
  • Recommended for major updates

Handling In-Progress Learners

When updating content:

Scenario 1: Minor Updates

  • Allow in-progress learners to continue
  • New learners get updated version
  • Gradual migration

Scenario 2: Major Updates

  • Force restart for all learners
  • All learners get new version
  • Clean slate approach

Update Dispatch Package

To update dispatch configuration:

curl -X PUT "https://app.allureconnect.com/api/customer/dispatches/dispatch_xyz789" \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "registration_limit": 2000,
    "expires_in_hours": 17520
  }'

Note: Updating dispatch doesn't require redistributing the ZIP file. Changes take effect immediately.

Troubleshooting

Issue: Package Not Launching

Symptoms:

  • Package imports successfully
  • Launch fails or redirects incorrectly

Solutions:

  1. Verify dispatch package is active
  2. Check dispatch hasn't expired
  3. Verify registration/license limits not exceeded
  4. Check allowed domains configuration
  5. Verify LMS provides user_id in SCORM context

Issue: Content Not Loading

Symptoms:

  • Package launches
  • Content doesn't load
  • Blank screen or error

Solutions:

  1. Check network connectivity
  2. Verify SCORM API is accessible from LMS
  3. Check CORS configuration
  4. Verify dispatch token is valid
  5. Check browser console for errors

Issue: User ID Not Passing

Symptoms:

  • Package launches
  • User ID is missing or incorrect
  • Progress not tracked

Solutions:

  1. Verify LMS provides user identifier
  2. Check SCORM API configuration
  3. Verify dispatch package version
  4. Check browser console for errors

Issue: Registration Limit Exceeded

Symptoms:

  • New launches blocked
  • Error message about limit

Solutions:

  1. Increase registration limit
  2. Remove old registrations
  3. Create new dispatch package

Issue: License Limit Exceeded

Symptoms:

  • New user launches blocked
  • License error message

Solutions:

  1. Increase license limit
  2. Remove inactive licenses
  3. Create new dispatch package

Best Practices

1. Test Before Distribution

  • Import into test LMS
  • Launch and verify functionality
  • Test with multiple users
  • Verify progress tracking

2. Document Distribution

  • Keep list of which LMSs received which dispatch
  • Track distribution dates
  • Note any special configurations

3. Monitor Usage

  • Regularly check distribution metrics
  • Monitor for errors or issues
  • Track usage trends

4. Communicate Updates

  • Notify LMS administrators of updates
  • Provide update schedule
  • Explain version changes

5. Handle Expirations

  • Set appropriate expiration times
  • Renew before expiration
  • Notify before expiration

Related Documentation

Last Updated: 2025-01-15