Admin Guide for Moodle

The admin will need to create an LTI app on Moodle and launch the MagicBox portal. 

Follow the below steps to create the LTI app.

A. Add LTI external tool in Moodle: Follow the below steps:

1. Login with admin credentials on the Moodle site.
2. Navigate to Site Administration from the left-hand side Hamburger Menu. 

 3. Click the "Plugins" tab. 

4. Click "Manage Tools." 

5. Click "Configure a Tool Manually" to add the tool.

You will see the below screen. 

6. Enter the below details to complete the external tool configuration. 

i. Enter the tool name. This is used to identify the tool provider within Moodle. The name entered will be visible to teachers while adding the external tool within courses. 

ii. Enter the tool URL. (Here,  paste the auto-generated "Launch URL" value from the MagicBox platform.)

iii. Enter the "Tool Description." It can be any metadata to describe what the tool is meant for and what does it do.

iv. Select the LTI version 1.3 from the dropdown menu. 

v. Select "RSA Key" from the Public Key Type dropdown.

vi. Enter the "Public Key" in the Moodle format. (Here, paste the "Public Key" that is autogenerated on the MagicBox platform.)

vii. Enter the "Initiate login URL ." (Here, paste the "OIDC Login Initiation URL" that is auto-generated on the MagicBox platform.)

viii. Enter the "Redirection URL." (Here, paste the auto-generated "Launch URL" value from the MagicBox platform.) 

ix. Enter "Custom Parameter" (optional field). 

(Note: For grade pass back service, enter the following customer parameters:

custom_launch_id=assessment

custom_assessment_id= enter assessment id)

7. Expand the "Services" section on the page to enable LTI 1.3 services.

• Select "Use this service for grade and column management" to enable LTI grade passback service. This service will populate the grades in the already existing grade book and the service will be able to create and update the grade book column and manage the grades.
• Select "Use this service to retrieve member information as per privacy setting" to enable the Name and Roles provisioning service. This service allows the tool to retrieve member information from the courses.

8. Expand the "Privacy" section on the page to enable privacy options. The selection here depends on whether the LMS wants to share the name and email address of the user on the platform. 

Select "Always" in all the privacy setting options. This will ensure that whenever this tool is launched, all the user information will be shared. 

9. Click "Save Changes." 

B. Complete the platform setup on Magicbox once the tool is created by taking details from the external tool that you have created on Moodle. 

1. On Moodle, click on the hamburger menu on the external tool to open the configuration setting. 

2. Enter the auto-generated tool configuration details from Moddle on the MagicBox platform.

3. Click "Save" to successfully add a platform on the MagicBox portal.

Steps to launch the LTI tool:

  A.  Create a Course on Moodle

1. Login with the admin credentials on the Moodle site. 
2.  Turn the on the editing setting on from the home page. 

3. Click on "Add New Course."

You will see the below screen. 

4. Enter the required fields - "Course Full Name" and "Course Short Name" 

5. Click "Save and Return"

B. Add activity inside the course 

1. Click on the course in which you want to add the activity.

2. Enable the editing setting and click on "Add an activity or resource"

3. Select "External Tool."

4. Enter the "Activity Name."

5. Expand the General setting and select the preconfigured tool from the dropdown menu.

6. Select the "Launch Container." This affects the display of the tool when launched from the course.

7. Enter the custom parameter, if required. If the customer parameter is not mentioned, the user will be taken to the default landing page (Dashboard) of that particular user role. 

8. Click "Save and Return to Course." 

9. Click on the activity to launch the activity.

The user will be redirected to the MagicBox platform, as shown in the below screenshot.