neoScorm
This plugin allows interaction with a SCORM 1.2 capable LMS (Learning Management System). It is based in pipwerks SCORM API wrapper:
https://github.com/pipwerks/scorm-api-wrapper
Description
The neoScorm plugin for VisualNEO Web integrates SCORM (Sharable Content Object Reference Model) support, allowing interaction with SCORM 1.2-compatible Learning Management Systems (LMS). This plugin is essential for creating e-learning applications, tracking user progress, and managing quiz scores and completion statuses. Here’s an overview of its core features and how to use it effectively:
Initializing SCORM Connection
The neoScormInitialize command starts the connection to the LMS, enabling communication between the VisualNEO Web app and the LMS.
- Command: neoScormInitialize
- Syntax: neoScormInitialize [returnVar]
- returnVar: Variable to store the result (true if successful, false if unsuccessful).
Example:
neoScormInitialize "[isConnected]"
This command initializes the SCORM connection and stores the result in isConnected.
Tracking Completion Status
The plugin provides commands to get and set lesson completion statuses, helping to track whether users have completed, passed, or failed the lesson.
- Commands:
- neoScormGetCompletionStatus: Retrieves the current completion status.
- Syntax: neoScormGetCompletionStatus [returnVar]
- neoScormSetCompletionStatus: Sets the lesson completion status.
- Syntax: neoScormSetCompletionStatus [returnVar] "theValue"
- theValue: Status values like passed, completed, failed, incomplete, etc.
Example:
neoScormSetCompletionStatus "[statusResult]" "completed"
This sets the lesson status to completed and stores the result in [statusResult].
Managing Learner Information
The plugin offers commands to retrieve learner details, such as name and ID, which can be used to personalize content or store progress.
- Commands:
- neoScormGetLearnerName: Retrieves the learner's name.
- neoScormGetLearnerId: Retrieves the learner's ID.
Example:
neoScormGetLearnerName "[learnerName]"
This command fetches the learner’s name and stores it in [learnerName].
Handling Scores and Progress
The plugin includes commands to get and set scores, allowing you to record and track quiz results or performance metrics.
- Commands:
- neoScormGetScore: Retrieves the learner's score for the lesson.
- neoScormSetScore: Sets the learner's score (0–100 scale).
Example:
neoScormSetScore "[scoreResult]" 85
This sets the score to 85% and stores the result in scoreResult.
Saving and Disconnecting
- neoScormSave: Saves all set data to the LMS, ensuring that the user's progress and status are updated.
- neoScormQuit: Disconnects from the LMS, closing the session and ending the SCORM interaction.
Practical Applications
The neoScorm plugin is perfect for:
- E-learning Modules: Tracking user progress, completion, and scores.
- Compliance Training: Ensuring users meet required training criteria and saving results.
- Interactive Learning Tools: Providing data-driven feedback and real-time progress updates.
With SCORM-compliant commands, the neoScorm plugin facilitates robust LMS integration, enhancing VisualNEO Web applications with essential e-learning functionality. Please watch the video tutorial to understand the whole process.
neoScormInitialize
|
Purpose: |
Initializes SCORM connection with the LMS. Returns true or false. |
|
Category: |
neoScorm |
|
Syntax: |
neoScormInitialize [returnVar]
returnVar Variable to store result |
neoScormGetCompletionStatus
|
Purpose: |
Get the lesson completion status from the LMS |
|
Category: |
neoScorm |
|
Syntax: |
neoScormGetCompletionStatus [returnVar]
returnVar Variable to store result |
neoScormSetCompletionStatus
|
Purpose: |
Set the lesson completion status from the LMS |
|
Category: |
neoScorm |
|
Syntax: |
neoScormSetCompletionStatus [returnVar] "theValue
returnVar Variable to store the result (true or false) "theValue Value to store" |
neoScormGetElements
|
Purpose: |
Listing of supported data model elements |
|
Category: |
neoScorm |
|
Syntax: |
neoScormGetElements [returnVar]
returnVar Variable to store result |
neoScormGetLearnerName
|
Purpose: |
Get the learner name from the LMS |
|
Category: |
neoScorm |
|
Syntax: |
neoScormGetLearnerName [returnVar]
returnVar Variable to store result |
neoScormGetLearnerId
|
Purpose: |
Get the learner ID from the LMS |
|
Category: |
neoScorm |
|
Syntax: |
neoScormGetLearnerId [returnVar]
returnVar Variable to store result |
neoScormSetLessonLocation
|
Purpose: |
Set the learner’s current location within the lesson |
|
Category: |
neoScorm |
|
Syntax: |
neoScormSetLessonLocation [returnVar] "theValue"
returnVar Variable to store result (true or false) theValue Location name |
neoScormGetLessonLocation
|
Purpose: |
Get the learner’s current location within the lesson |
|
Category: |
neoScorm |
|
Syntax: |
neoScormGetLessonLocation [returnVar]
returnVar Variable to store result |
neoScormGetLessonMode
|
Purpose: |
Get the lesson mode (browse, normal or review) |
|
Category: |
neoScorm |
|
Syntax: |
neoScormGetLessonMode [returnVar]
returnVar Variable to store result |
neoScormSetLessonMode
|
Purpose: |
Set the lesson mode (browse, normal or review) |
|
Category: |
neoScorm |
|
Syntax: |
neoScormSetLessonMode [returnVar] theValue
returnVar Variable to store result (true or false) theValue Lesson mode |
neoScormGetScore
|
Purpose: |
Get the learner Score for the current lesson |
|
Category: |
neoScorm |
|
Syntax: |
neoScormGetScore [returnVar]
returnVar Variable to store result |
neoScormSetScore
|
Purpose: |
Set the learner Score for the current lesson |
|
Category: |
neoScorm |
|
Syntax: |
neoScormSetScore [returnVar] theValue
returnVar Variable to store result (true or false) theValue Value to store (0 - 100) |
neoScormSetTime
|
Purpose: |
Set the learner time spent within the lesson |
|
Category: |
neoScorm |
|
Syntax: |
neoScormSetTime [returnVar] theValue
returnVar Variable to store result (true or false) theValue Value to store in milliseconds |
neoScormSet
|
Purpose: |
Set any SCORM 1.2 value |
|
Category: |
neoScorm |
|
Syntax: |
neoScormSet [returnVar] "theName" "theValue"
returnVar Variable to store result (result will be true or false) theName SCORM 1.2 value (ie: cmi.core.lesson_status) theValue Value to set |
neoScormGet
|
Purpose: |
Get any SCORM 1.2 value |
|
Category: |
neoScorm |
|
Syntax: |
neoScormGet "theValue" [returnVar]
theValue SCORM 1.2 value (ie: cmi.core.lesson_status) returnVar Variable to store result |
neoScormSave
|
Purpose: |
Save all previous SET commands data to the LMS database |
|
Category: |
neoScorm |
|
Syntax: |
neoScormSave
|
neoScormQuit
|
Purpose: |
Disconnect from the LMS and closes the lesson |
|
Category: |
neoScorm |
|
Syntax: |
neoScormQuit |
Created with the Personal Edition of HelpNDoc: Free help authoring tool