Moodle User Integration LTI 1.3 Setup

The Course Evaluations & Surveys Moodle User Integration LTI 1.3 offers the functionality to have users pass seamlessly from Moodle into their user account within Course Evaluations & Surveys. This feature will also automatically display a survey notification to students within Moodle if they have an active survey to complete, and take the student directly to their survey. 

Step 1: Create and Configure the LTI 1.3 Tool in Moodle

This step must be performed by a Site Administrator in Moodle.

1. Log into your Moodle instance as a user with Admin role/permissions.
2. Navigate to Site administration > Plugins.
3. Under Activity modules*,* go to External tool > Manage tools.
4. Click the link "configure a tool manually".
   
5. In the Tool settings, enter the following configurations:
   1. Tool Name: Course Evaluations and Surveys 
   2. Tool URL: Copy from CES. This will be displayed under the User Integration tab corresponding to “Initiate Login URL”.
   3. Tool Description: Course Evaluations and Surveys
   4. LTI Version: LTI 1.3
   5. Public key type:  Keyset URL.
   6. Public Keyset: Copy from CES. This will be displayed under the User Integration tab corresponding to “Public Keyset URL”.
   7. Initiate Login URL:  This will be displayed under the User Integration tab corresponding to “Initiate Login URL”.
   8. Redirection URI(s) : This will be displayed under the User Integration tab corresponding to “Redirection URL”.
   9. Custom parameters: Leave it as blank
   10. Tool configuration usage: Choose “Show as preconfigured tool when adding an external tool.”
   11. Default launch container: Choose Embed.
   12. Do not check the option for “Supports Deep Linking (Content-Item Message).”
   13. Content Selection URL: Leave it as blank
   14. Click Save Changes.
6. After saving, a tool card will appear. Click the View configuration details icon on the tool card.
7. Note the following Moodle-generated values for Step 2:
   1. Platform ID: 
   2. Client ID: 
   3. Deployment ID: 
   4. Public keyset URL: 
   5. Access token URL: 
   6. Authentication Request URL:

Step 2: Sync Moodle Configuration with CES

1. Log in to your CES Account.
2. Navigate to Account > Integrations > Moodle > User Integration.
3. Under the "Moodle-provided configuration" section, enter the values you saved above in Step 1.
   
4. Click Save at the bottom of the page.

Step 3: Update Moodle Plugin (User Access Block)

1. Back in Moodle, go to Site administration > Plugins > Plugins overview.
2. Find "EvaluationKIT User Access" and click Settings.
3. Check the box "Use LTI 1.3".
   
4. Populate the LTI 1.3 Client ID and Deployment ID fields with the values from Step 1.
5. Save changes.

Action Required: Purge Caches:

To ensure the new LTI 1.3 configuration is active across the site, you must purge the Moodle cache. Go to Site administration → Development → Purge caches → Purge all caches.

Step 4: Clean Up Gradebook (Removing Tool Records)

To ensure that "External Tool" records do not clutter the grade report for students or instructors, follow these cleaning steps:

1. Disable Grade Sync (Admin Level)
   1. Go to Manage tools and click the Gear icon for your tool.
   2. Expand the Services section.
   3. Set IMS LTI Assignment and Grade Services to "Do not use this service".
   4. Save Changes.
       

2. Hide Records from Instructors & Students

   If items currently appear in the Grader report or User report, follow these steps:

   1. Navigate to Grades → Gradebook setup.
   2. Locate the items associated with the external tool.
   3. In the Actions column, click Edit → Hide (or Delete if no data has been collected).

   Figure 3: Grader report showing deletion in progress for redundant tool records.

    

3. Activity-Level Privacy
   1. When adding the activity to a course, click Edit settings.
   2. Under Privacy, uncheck "Accept grades from the tool".
   3. Under Grade, set Type to "None".

Step 5: Project Deployment & Verification

1. In your CES site, import your users from Moodle (Data settings).
   1. Make sure to do course re-sync and Refresh Users before importing courses and users.
2. Attach your survey to the project and Deploy.
3. Log in to Moodle as a Student.
4. Verify that the survey pop-up appears correctly or is accessible via the User Access block.