Module Completion Behaviors

Created:
Updated:
Avatar
by C.W. Holeman III
Follow

Module completion in your LMS is a state-based system that tracks learner progress through educational content. Understanding how completions work is essential for administrators managing learning and troubleshooting completion issues.

Key Concept: Module completions are determined by the user's relationship with the module and their progress through required content that they have permission to access.

Module Types and Completion Eligibility

Standard Modules

  • Can be completed and track learner progress
  • Support both auto-completion and manual completion methods
  • Maintain completion state and history

Reference Modules

  • Cannot be completed - no completion tracking
  • Used for reference materials and resources
  • Do not contribute to learning path progress

Module Completion Methods

Auto-Completion

  • When it occurs: System automatically completes the module when the last required media item is finished
  • Requirements:
    • Auto-complete setting must be enabled for the moduleauto-complete-toggled-on.png
    • At least one required media item must exist in the module
    • required_media.png
    • User must have viewed all required content they have permission to access

Manual Completion (Mark Done Button)

  • When it appears:
    • Auto-complete setting is disabled for the module, OR
    • Module contains no required items (even with auto-complete enabled)
  • User action: Learner must manually click "Mark Done" to completeMarkDone.png

User-Module Relationship States

When a user first accesses a module, one of three relationship states is established:

  1. Not Started - User has not yet accessed the module
  2. In Progress - User has viewed the module but not completed all requirements
  3. Completed - User has finished all required content they have permission to access

Content Requirements and Permissions

Media Item Requirements

  • Media items within modules can be set as required or optional
  • Only required items must be completed for module completion
  • Critical: Never add the same required media item from the media library to a module multiple times - this can prevent module completion or cause other unusual module behaviors.

Permission-Based Completion

  • Modules and media items have open permissions by default
  • LMS rules engine can restrict access based on user profile fields:
    • Location
    • Username
    • Role/Title
    • Custom profile fields
  • Module completion occurs when: User has completed all required content that they have permission to see

Dynamic Content and Completion Behavior

Adding Content After Completion

  • Module status: Remains "Completed" for the user
  • User experience: When user revisits, they see new content is available
  • Re-completion: If admin deletes the completion record, module shows as incomplete, but:
    • Previously completed required items remain complete
    • New content added after original completion must be completed
    • User must complete new required items to regain completion status

Content Removal Considerations

⚠️ Important Warning: Deleting media items that users have already completed can cause data integrity issues and affect completion tracking.

Completion Reset Methods

Manual Completion Deletion

  • What it does: Resets module status to "Not Started"
  • What it doesn't do: Does NOT reset individual media item completion status
  • Behavior: When user re-accesses module, it may auto-complete immediately if all required items were already complete

Full Reset (Enrollment with reset=yes)

  • Complete reset: Resets both module status AND all contained media item statuses
  • Methods:
    • Enrollment with reset=yes parameter
    • Subsequent instance of recurring enrollment
    • A Quick Enrollment
  • Use case: When you need to completely restart a user's progress

Special Completion Scenarios

Third-Party Completions

Some media items can be completed by someone other than the learner (e.g., manager completing an observation checklist):

  • Auto-completion requirement: Will only auto-complete the module if:
    • The third-party completed item is the last required item remaining, AND
    • The user has viewed the module at least once (to establish the user-module relationship)

Parent-Child Module Relationships

  • Support: Parent modules with child modules are supported
  • Recommended depth: No more than 10 levels of nested children
  • Completion percentage display: Completion percentage will only display if a module has at least one required child module in it
  • Critical warning: Avoid circular references (Module A contains Module B, which contains Module A) as this can prevent completion

Troubleshooting Common Issues

Module Won't Complete

Possible causes:

  • Duplicate required media items in the module
  • Circular parent-child module references
  • Permission restrictions preventing access to required content
  • Third-party completion requirements not met

Unexpected Auto-Completion

Possible causes:

  • User previously completed all required items
  • Manual completion deletion only reset module status, not media item status
  • Auto-complete setting enabled with all requirements already met

Completion Status Inconsistencies

Possible causes:

  • Content added after original completion
  • Permission changes affecting accessible content
  • Media items deleted after user completion

Best Practices

  1. Avoid duplicate content: Never add the same required media item to a module multiple times
  2. Plan parent-child relationships: Keep nesting shallow and avoid circular references
  3. Consider permissions: Understand how content restrictions affect completion requirements
  4. Use appropriate reset method: Choose between manual deletion and full enrollment reset based on your needs
  5. Test completion flows: Verify completion behavior when adding new content to existing modules

Summary

Module completion is a sophisticated system that considers user permissions, content requirements, and relationship states. Understanding these behaviors helps ensure smooth learner experiences and accurate progress tracking. When in doubt, test completion scenarios in a safe environment before implementing changes that affect active learners.