Content
- 1. Moodle LTI 1.3 Integration - Overview
- 2. External Tool Registration and Configuration
- 3. Roles and test access rules
- Frequently Asked Questions (FAQs)
1. Moodle LTI 1.3 Integration - Overview
Learning Tools Interoperability® (LTI®) allows Moodle to connect with external learning tools, such as Inspera, easily and securely. The connection supports Moodle by passing information in a standards-based way to Inspera. These include the role of that user (instructor or candidate) and the course which they launched the tool from. It can create user accounts in the tool upon launch as well, acting as both a registration and single sign-on (SSO) launch in one easy workflow. Additionally, LTI Advantage/1.3 supports returning marks from Inspera to the Moodle gradebook.
There are two steps required to configuring Moodle:
- Registering the tool (refers to the external service providing functionality)
- Registering the platform (refers to the application wanting to use the functionality provided by the tool) in Moodle.
2. External Tool Registration and Configuration
The security model for LTI Advantage and LTI 1.3 services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. This means the tool and platform must register with one another ahead of time before activities and courses can be accessed from the platform. Registration happens only once manually, when setting up a link between the tool and a platform, and is essentially a security contract between those two respective systems.
2.1 Administrator - Access LTI Integration configuration with Moodle
Note: This is available for Administrators in Moodle.
To configure the integration between Inspera and Moodle, complete the following setup within Inspera and Moodle.
📢 Important Information When Copying and Pasting URLs
When you're copying and pasting URLs, it's crucial to ensure that there are no whitespaces before or after the URL. Extra whitespaces can lead to broken links or errors in accessing the desired webpage.
- Click on Site administration.
- Click on Plugins.
- From the Activity modules panel, click on Manage tools.
-
Registration can be completed through Dynamic registration or Manual registration:
-
Dynamic registration: Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.
- As an admin user, go to "Site administration > Plugins > Enrolments > Publish as LTI tool > Tool registration"
- Click the "Register a platform" button to create a new platform registration
- Enter the name of the platform and click "Continue"
- When presented with the "Tool details" tab, click to copy the Registration URL under the "Dynamic registration" section
-
Manual Registration
Click on the configure a tool manually link.
-
Dynamic registration: Exchange of the relevant URLs and IDs is automated. The platform uses the tool's registration URL to begin this process.
2.1.1 Administrator - Configuring LTI Integration with Moodle
Note: There are three URLs required from Inspera for the first time to set up the LTI connection in your Moodle instance. They are:
- key-url: This typically refers to a set of public keys used for authentication and security purposes.
- login-init: When a user initiates a login process from LMS to an external tool using LTI 1.3, the initiate login URL is the endpoint where this process begins.
- redirect-url(s): The redirect URLs specify the URLs where the LMS should redirect the user after completing the OAuth 2.0 authorization flow.
key-url | https://{domain}/ICSXapi/metadata/PublicCertificates |
login-init | https://{domain}/ltiprovider/init |
redirect-url(s) | https://{domain}/ltiprovider/launch |
Using the URL templates in the previous table, replace {domain} with the Inspera tenancy that will be set up for integration.
For example, if your Inspera tenancy has the URL demo.inspera.com, then the URLs would be:
key-url | https://demo.inspera.com/ICSXapi/metadata/PublicCertificates |
login-init | https://demo.inspera.com/ltiprovider/init |
redirect-url(s) | https://demo.inspera.com/ltiprovider/launch |
- Click on the Tool settings accordion to display the settings.
- Enter the external tool name in the Tool name textbox e.g. Inspera.
- Enter the redirect URL in the Tool URL textbox e.g. the redirect-url with the formatting https://{domain}/ltiprovider/launch.
- Optionally, enter the description of the tool in the Tool description textbox.
- Select LTI 1.3 from the LTI version drop-down menu.
- Select Keyset URL from the Public key type drop-down menu.
- Enter the key-url in the Public keyset textbox e.g. the key-url with the formatting https://{domain}/ICSXapi/metadata/PublicCertificates.
- Enter the OIDC Connect Initialization field/login-init in the Initiate login URL textbox e.g. the login-init with the formatting https://{domain}/ltiprovider/init.
- Enter the OIDC Redirect URL/redirect-url in the Redirection URI(s) textbox e.g. the redirect-url with the formatting https://{domain}/ltiprovider/launch.
Note: Make sure you have replaced {domain} with the URL to your Inspera tenancy. - Optionally, enter any custom parameters in the Custom parameters textbox. For more information, refer to the Custom Parameters article.
- Select Show as a preconfigured tool when adding an external tool from the Tool configuration usage drop-down menu.
- Select either from Existing window, Embed, Embed without blocks or New window from the Default launch container drop-down menu.
- Uncheck the Supports Deep Linking (Content-Item Message) checkbox. Note, if the checkbox is checked, then the Content Selection URL textbox will be available while adding an external tool.
- Do not enter text in the Content Selection URL textbox as it will be used to launch the content selection page from the tool provider.
- Click on the Services accordion to display the settings.
- Select Use this service for grade sync and column management from the IMS LTI Assignment and Grade Services drop-down menu. This will enable assignment and grade services.
- Select Use this service to retrieve members’ information as per privacy settings from the IMS LTI Names and Role Provisioning drop-down menu. This will enable membership service.
-
Select Do not use this service from the Tool Settings drop-down menu. This will not allow you to save and retrieve setting values.
- Click on the Privacy accordion to display the settings:
- Select Always from the Share launcher's name with the tool drop-down menu. This will send the launcher’s name to Inspera.
- Select Always from the Share launcher's email with the tool drop-down menu. This will send the launcher’s email with Inspera.
- Select Always from the Accept grades from the tool drop-down menu. This will accept grades from Inspera.
- Click on the Save changes button.
- In Manage Tools, all the registered tools will be available. Click on the list icon to view the details that need to be shared with Inspera for the pending configuration.
- The following six values in Tool configuration details must be shared with Inspera to complete the configuration.
2.2 Administrator - Configuration of Inspera Assessment
Inspera require the following information from Moodle. Please contact Inspera Support to configure these updates for your specific Inspera tenancy.
The specific Moodle values are to be configured in Inspera to complete external tool configuration on both Moodle and Inspera.
Platform ID | https://<moodle domain>/ |
Client ID | Unique for the tool that is created and can be found as part of the initial tool registration done in Moodle |
Deployment ID | Unique ID |
Public keyset URL | https://<moodle domain>/mod/lti/certs.php |
Access token URL | https://<moodle domain>/mod/lti/token.php |
Authentication request URL | https://<moodle domain>/mod/lti/auth.php |
2.3 Teacher - Adding an Activity
Once the configuration is completed on Moodle and Inspera, the teacher can create an activity.
The Moodle integration can be set up to allow marks from Inspera Assessment to be returned to the Moodle gradebook.
- Login to Moodle as an instructor.
- Next to your profile icon, click on Edit mode to enable it.
- Click on the Course you wish to create the Inspera Assessment link.
- To ensure the External Tool will appear, click on LTI External tools from the More drop-down menu.
- For the listed tool, click on the Show in activity chooser icon.
- Click on the Course tab.
- Navigate to the required topic where the Inspera Assessment link will be added.
- Click on the Add an activity or resource link.
- Click on the appropriate External Tool.
-
Enter the name of the assessment in the Activity name textbox. e.g. ABCD1234 - Introduction to Thermal Dynamics.
Note: For best practices, each assessment should be given consistent naming conventions i.e. course/unit code and title. -
Select Inspera from the Preconfigured tool drop-down menu.
-
Click on the Save and Return to course button.
2.4 Teacher - Author Assessment
- Log in to Moodle as an instructor.
- After adding an activity in the course, click on the activity e.g. Science Exam.
- The Deliver tab for the Inspera Assessment will appear, and you can configure the appropriate settings for this test. For more information, refer to the Deliver overview article.
2.5 Candidate – How to take an Inspera Assessment from Moodle
Candidates can launch into an Inspera Assessment from Moodle and undertake scheduled assessment set up by an instructor.
- Log in to Moodle as a candidate.
- Click on the Course.
- Click on the required Inspera assessment link.
- Candidates will be redirected to the Inspera screen to attempt the scheduled assessment.
The candidate takes the test and submits their answers at the end and then can log out of Inspera Assessment.
Once the test has been graded and marks are confirmed by the Grader, the candidate will be able to see their results on the Candidate Dashboard within Inspera Assessment as well as in the Moodle Gradebook.
Note: To ensure marks are displayed in Inspera Assessment, check that the right setting(s) are enabled in the Deliver module in Inspera (i.e. "Show Final Marks or Grades on Candidate Dashboard" in the After test settings).
3. Roles and test access rules
When the user logs in, Inspera evaluates their roles/privileges and redirects the user to the following pages.
Role/Privilege | Landing-page |
Planner | Deliver, Monitor & Grade (Test Setup) |
Chief invigilator | Deliver & Monitor (Test Setup) |
Invigilator | Deliver & Monitor (Test Setup) |
Grader | Grade & Monitor |
Reporter | Report |
For example, if a user has the Planner and Reporter role, Inspera redirects them to Deliver since that rule is matched first.
Frequently Asked Questions (FAQs)
Question 1 |
What steps should I take if I encounter authentication issues during the LTI 1.3 setup? |
Answer |
Revalidate LTI Configurations for both Moodle and Inspera In Moodle, validate the tool configuration by editing the tool from the Manage Tool section. Recheck the accuracy of the following fields and are correct to ensure seamless integration and functionality: Tool URL, Public Keyset, Initiate Login URL and Redirection URI(s). |
In Inspera, the Service Desk team will need to following details to ensure configuration is properly configured. |
Question 2 | Can we use custom parameters in LTI 1.3 and how are they configured? |
Answer | Yes, custom parameters can be used to transmit specific data or information between the tool consumer Moodle, for example, a learning management system, and the tool provider, Inspera, or an external learning tool. For more information, refer to the Custom parameters article. |
Question 3 | Why does Candidate auto provisioning not work for LTI 1.3? |
Answer |
Possible explanations include:
To verify this setting using the Admin credentials, take note of the following steps:
|