The TopoMojo Plugin for Moodle is an activity plugin that integrates TopoMojo labs and exercises into the Moodle Learning Management System (LMS). It enables users to access virtual labs, view Markdown content, and complete challenge questions directly from within Moodle.
This documentation is meant for Moodle system administrators.
- Embed and/or link TopoMojo labs into Moodle activities.
- Import challenge questions from TopoMojo and manage in Moodle's quiz and grading systems.
- Configure lab access, grading methods, attempts, and durations.
- Import and map TopoMojo workspace tags for better organization within Moodle.
- Moodle 3.x or above.
- TopoMojo deployed and operational.
- TopoMojo Question Type plugin installed.
- TopoMojo Question Behavior plugin installed.
System admin-type users or users who have the appropriate permissions should follow the procedures below to download and install the TopoMojo for Moodle plugin.
- Download the plugin from this repo.
- Extract the plugin into the
mod/topomojodirectory of your Moodle instance. - Log into your Moodle as a site administrator or with the appropriate permissions.
- Navigate to Site administration, Plugins, Install plugins.
- Upload the plugin zip file (for example, Admin Moodle TopoMojo Plugin.zip) and click Upload this file.
- Click Install plugin from the ZIP file.
- Follow the prompts to complete the installation process.
- Navigate to Site administration, Plugins, Manage Activities.
- Confirm that the TopoMojo plugin appears in the list of installed activities.
- Verify that the required mojomatch plugins (Question Type and Question Behavior) are also installed.
Access configurable global settings in Moodle by navigating to Site Administration, Plugins, TopoMojo. Following is an explanation of the settings.
Display Mode: Determines how labs will be displayed in Moodle.
- Embed Lab inside Moodle: The lab will appear embedded within a Moodle activity page. This is the default.
- Display Link to TopoMojo: A link to open the lab in a new tab or window i provided.
Workspace Selection Method: Configures how administrators or teachers select workspaces when setting up a TopoMojo activity.
- Dropdown: Displays a simple dropdown menu of workspaces.
- Searchable: Enables a search box for quickly finding workspaces. This is the default.
- Manual: Requires manual entry of a workspace ID.
Filter Workspaces: Enables filtering of available workspaces based on audience tags. The default is No. When enabled, an additional option, the Audience Filter becomes available.
Audience Filter: Enter the tag or audience criteria for filtering workspaces.
By default, all of these fields are empty and should be completed during the setup process.
TopoMojo API Base URL: The API endpoint URL for the TopoMojo server (e.g., https://topomojo.example.com/api).
TopoMojo Base URL: The base URL of the TopoMojo server used for linking and embedding (e.g., https://topomojo.example.com).
API Key: The authentication key required for secure communication between Moodle and TopoMojo. This key is issued by the TopoMojo administrator.
Manager Name: Specifies the manager name used for identifying the TopoMojo API integration instance.
Maximum Challenge Submissions: The maximum number of times a student can submit answers for a single challenge in a lab. Set 0 for unlimited submissions. The default is 10.
Maximum Active Labs: Limits the number of active labs a student can have at one time. Set 0 for unlimited active labs. The default is 2.
Import Tags: Enables the import of tags from TopoMojo workspaces. The default is No.
Create Tags: Automatically creates Moodle tags from imported TopoMojo workspace tags. The default is No.
Tag Collection: Allows administrators to assign imported tags to a specific Moodle tag collection for organization. The default is Default Moodle tag collection.
Map Tags: Enables mapping of imported tags for better alignment with Moodle's tagging systems. The default is No.
Follow the procedures below to add a TopoMojo activity to a course in Moodle.
- Navigate to your desired course and click Add an activity or resource.
- Select TopoMojo from the activity/resource list.
- Under General, complete the following.
- Description: Provide a description of the activity, visible to students if enabled.
- TopoMojo Workspace: Use the dropdown or search field to select a TopoMojo workspace. Workspaces can be filtered by audience or tags depending on the plugin configuration.
- Variant: Specify a variant of the lab (i.e., version).
- Under Appearance, complete the following:
- Display Mode: Either embed labs within Moodle or link externally to the TopoMojo application.
- Clock: Set how the timing information is displayed.
- Hidden: No timing information is displayed.
- Countdown: Displays a countdown timer.
- Timer: Displays elapsed time.
- Under Grade, complete the following:
- Grade: Set the maximum grade for the activity.
- Grading method: First attempt, Last completed attempt, Average of all attempts, Highest attempt.
- Finally, under Timing, specify the following:
- Open the activity/Close the activity: These are your start/end dates.
- Duration: The total time permitted to complete the lab in minutes.
- Extend Lab: Check to allow the lab time to extend if needed (requires Countdown as the Clock value).
Follow the procedures below to launch and complete a lab using the TopoMojo for Moodle plugin.
- In Moodle, locate the course that contains the TopoMojo activity.
- In the course, select a TopoMojo activity (denoted by the TopoMojo icon). See the screen print below.
- Read the preview of the lab instructions and click Launch Lab. This deploys the lab on TopoMojo.
- Read the full lab instructions and attempt to complete the lab. Most likely, after reading the instructions, your first step will be to launch one of the provided virtual machines (e.g., kali) and start your work.
Timer: Displays a countdown until the lab expires.
Extend Lab: If enabled by a Moodle admin, permits the user to extend the time to complete the lab.
End Lab: Destroys the lab in TopoMojo.
Generate Invite: Creates an invitation link for others to join the deployed lab. Give the link to a colleague or friend who can join and help.
Challenge tab: Contains the questions that must be answered to complete the activity.
Review Activity Attempts: Tracks the user's performance history.
TopoMojo Plugin for Moodle
Copyright 2024 Carnegie Mellon University.
NO WARRANTY. THIS CARNEGIE MELLON UNIVERSITY AND SOFTWARE ENGINEERING INSTITUTE MATERIAL IS FURNISHED ON AN "AS-IS" BASIS. CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY KIND, EITHER EXPRESSED OR IMPLIED, AS TO ANY MATTER INCLUDING, BUT NOT LIMITED TO, WARRANTY OF FITNESS FOR PURPOSE OR MERCHANTABILITY, EXCLUSIVITY, OR RESULTS OBTAINED FROM USE OF THE MATERIAL. CARNEGIE MELLON UNIVERSITY DOES NOT MAKE ANY WARRANTY OF ANY KIND WITH RESPECT TO FREEDOM FROM PATENT, TRADEMARK, OR COPYRIGHT INFRINGEMENT. Licensed under a GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007-style license, please see license.txt or contact [email protected] for full terms.
[DISTRIBUTION STATEMENT A] This material has been approved for public release and unlimited distribution. Please see Copyright notice for non-US Government use and distribution.
This Software includes and/or makes use of Third-Party Software each subject to its own license.
DM24-1175