Content
- 1. Canvas LTI 1.3 Integration - Overview
-
2. External Tool Registration and Configuration
- 2.1 Administrator - Access LTI Developer Key in Canvas
- 2.2 Administrator - View LTI Developer Key In Canvas
- 2.3 Administrator - Configure an external app using Client ID
- 2.4 Administrator - Configuration of Inspera Assessment
- 2.5 Teacher - Adding an Activity where Marks Return to Canvas Gradebook
- Teacher - Adding an activity where marks are not required to be returned to Canvas Gradebook
- 2.7 Teacher - Author Assessment
- 2.8 Candidate – How to attempt an assessment on Inspera Assessment via Canvas
- 3. Frequently Asked Questions (FAQ)
1. Canvas LTI 1.3 Integration - Overview
Learning Tools Interoperability® (LTI®) allows Canvas to connect with external learning tools such as Inspera, easily and securely. The connection supports Canvas 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 which acts 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 Canvas gradebook.
There are a three steps to configure Canvas:
- Configuration of an LTI developer key.
- Configure an External app using Client ID.
- Registering the platform (refers to the application wanting to use the functionality provided by the tool) in Canvas.
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 Developer Key in Canvas
📢 Important Information When Copying and Pasting URLs
When copying and pasting URLs, ensure there are no whitespaces before or after; extra whitespaces can cause broken links, access errors, and break the LTI setup
To configure the integration between Inspera and Canvas, complete the following setup with Inspera and Canvas.
Note: This is available for Administrators in Canvas.
- Click on to Admin.
- Click on the name of the account e.g. Inspera Assessment.
- Click on Developer Keys.
- Click on the +Developer Key button.
- Select +LTI Key from the drop-down menu.
2.1.1 Administrator - Configuring LTI Integration with Canvas
Note: There are three URLs required from Inspera for the first time to set up the LTI connection in your Canvas instance. They are:
There are three (3) URLs that you will need from Inspera to set up the LTI connection in your Canvas 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 |
- Enter the key name in the Key name textbox e.g. Inspera Assessment.
- Enter the email of the person who owns the external tool in the Owner Email textbox.
- Enter the redirect URL in the Redirect URIs textbox e.g. the redirect-url with the formatting https://{domain}/ltiprovider/launch.
- Select Manual Entry from the Method drop-down menu.
- Enter the name of the external tool in the Title textbox e.g. Inspera.
- Enter a description of the tool in the Description textbox e.g. Connection to Inspera.
- Enter the redirect-url in the Target Link URI textbox e.g. the redirect-url with the formatting https://{domain}/ltiprovider/launch.
- Enter the OIDC Connect Initialization field/login-init in the OpenID Connect Initiation Url textbox e.g. the login-init with the formatting https://{domain}/ltiprovider/init.
- Select Public JWK URL from the JWK Method drop-down menu.
- Enter the key-url in the Public JWL URL textbox e.g. the key-url with the formatting https://{domain}/ICSXapi/metadata/PublicCertificates.
Important: Make sure you have replaced {domain} with the URL to your Inspera tenancy.
- Click on the LTI Advantage Services accordian to display the settings.
- Enable or disable additional features the tool provides based on your institution's requirements. The options in the image below have been selected to reflect marks, assignments, submissions and user data in Canvas.
- Can create and view assignment data in the gradebook associated with the tool: The user can create new assignments, view the data associated with the assignments, assignments, and the corresponding data linked to a specific tool.
- Can view assignment data in the gradebook associated with the tool: The user can view detailed information associated with assignments.
- Can create and update submission results for assignments associated with the tool: The user can record and modify the submission results for students' assignments. These actions are specifically related to assignments, and the assignments are linked or connected to a particular tool.
- Can retrieve user data associated with the context the tool is installed in: The user can obtain information about users associated with the context.
- Can update public jwk for LTI services: The user can update the message used for securing communication between Canvas and external tools.
- Can lookup Account information: Application can retrieve information related to a Canvas account.
- Can view submission data for assignments associated with the tool: Indicates access and review information related to student submissions within a specific tool integrated into Canvas.
-
Can view Progress records associated with the context the tool is installed in: Indicates that the tool can view or record the data related to the student.
- Click on the Additional Settings accordion to display the settings.
- Set the Privacy Level to either Public or Private for your institution's requirements.
Note: By default, the Privacy Level is set to Private. - Optionally, enter any custom parameters in the Custom Fields textbox. For more information, refer to the Custom Parameters article.
- Select Link Selection and Assignment Selection from the Placements drop-down menu.
- Link Selection: Add hyperlinks within the course content
- Assignment Selection: A creation or selection of assignments within a Canvas course
Note: For more information, refer to the Canvas Help Document.
- Click on the Link Selection accordion to display the settings.
- Enter the redirect URL in the Target Link URI textbox e.g. the redirect-url with the formatting https://{domain}/ltiprovider/launch.
Note: This is the same link that was entered in Step 7. - Click on the Save button.
2.2 Administrator - View LTI Developer Key In Canvas
Upon saving the changes, the details for the Developer Key will appear.
- Copy the Client ID in the Details column as it will be required at the time of configuration.
- Click on the State button to enable it so the LTI key can be used for the integration.
2.3 Administrator - Configure an external app using Client ID
External apps that support LTI 1.3 and LTI Advantage require configuration using a Client ID and can be found after the external tool has been configured in 2.1 Administrator - Access LTI Developer Key in Canvas.
- Click on to Admin.
- Click on the name of the account e.g. Inspera Assessment.
- Click on Settings.
- Click on the Apps tab.
- Click on the View App Configurations button.
- Click on the +App button.
- Select By Client ID from the Configuration Type drop-down menu.
- Enter the Client ID in the Client ID textbox. For more information, refer to the 2.2 Administrator - View LTI Developer Key In Canvas section.
- Click on the Submit button.
Note: If the submitted client ID is not found in your account's Developer Keys, Canvas will display an error message stating that the LTI configuration for client ID <numbers> was not found. If this occurs, check that the information was entered correctly by referring to the 2.2 Administrator - View LTI Developer Key In Canvas section.
- Click on the Install button.
- After installing the app, the values in the next section must be shared with Inspera to complete the configuration.
2.4 Administrator - Configuration of Inspera Assessment
Inspera will need the following information from Canvas. Please contact Inspera Support to configure these updates for your specific Inspera tenancy.
The specific Canvas values are to be configured in Inspera to complete external tool configuration on both Canvas and Inspera.
Client ID |
A unique Client ID for the tool created as part of the initial tool registration in Canvas. This can be found in 2.2 Administrator - View LTI Developer Key In Canvas |
|
Issuer/Platform | https://<canvas-domain> | |
Canvas Keyset URL | https://<canvas-domain>/api/lti/security/jwks | |
Canvas OAuth2 Access token URL | https://<canvas-domain>/login/oauth2/token | |
OpenID Connect Authentication Endpoint Keyset URL | https://<canvas-domain>/api/lti/authorize_redirect | |
Deployment ID | Unique ID |
2.5 Teacher - Adding an Activity where Marks Return to Canvas Gradebook
Inspera Assessment transfers total marks after the test status is set to Graded in Inspera.
The Canvas integration with Inspera Assessment can be set up to allow for marks from Inspera Assessment to be returned to the Canvas Gradebook.
- Login to Canvas as an Instructor.
- Open the required Course.
- Navigate to an existing module and click on the Add item to module icon then proceed to Step 8.
Note: Optionally, click on the + Module button to create a module then click on the Add item to module icon and proceed from Step 4. - Select Assignment from the Add drop-down menu.
- Click on [ Create Assignment ].
- Enter the name of the test that has been created/will be created in the Assignment Name textbox.
- Click on the Add Item button.
- Click on the Publish icon on the item.
Note: This action should only take place after the test is activated in Inspera.
Note: The icon will turn into a green circle with a tick inside. - Click on the item created.
- Click on the Edit button.
- Enter the total number of marks in the Points textbox.
Note: Ensure the total marks are consistent through both the Canvas item and Inspera Assessment. For example, if an Inspera Assessment assessment is created with 40 marks, but in Canvas the assessment is set for 10 marks, and a student receives 27 out of 40 in Inspera, the student will see the Inspera Assessment marks as 27 and they will see in Canvas marks as 6.75. - In the Submission Type section, select External Tool from the drop-down menu.
- Click on the Find button.
- Select the required External Tool from the list.
- Click on the Select button.
- Optionally, check the Load This Tool In A New Tab checkbox.
- Enter the other fields as required.
- Click on the Save button.
- Click on the activity name to launch Inspera Assessment’s Deliver page.
2.6 Teacher - Adding an activity where marks are not required to be returned to Canvas Gradebook
At times, it may not be a requirement to have marks from Inspera Assessment returned to the Canvas Gradebook. Complete the following steps to ensure marks are not returned.
- Login to Canvas as an instructor
- Open the required Course.
- Navigate to an existing module and click on the Add item to module icon.
Note: Optionally, click on the + Module button to create a module then click on the Add item to module icon. - Select External Tool from the Add drop-down menu.
- Select the required External Tool from the list.
- Click on the Add Item button.
- For the Item, click on the 3 vertical dots.
- Click on Edit.
- Rename the title in the Title textbox.
- Check the Load in a new tab button.
- Click on the Update button.
- Click on the Publish icon on the item.
Note: This action should only take place after the test is activated in Inspera.
Note: The icon will turn into a green circle with a tick inside. - Click on the activity name to launch Inspera Assessment’s Deliver page.
2.7 Teacher - Author Assessment
- Log in to Canvas as an instructor.
- Navigate to the required Course.
- Click on the appropriate activity.
- Click on the Load [title] in a new window button.
- The Inspera Assessment Deliver page will appear where you can configure the appropriate settings for the assessment. For more information, refer to the Deliver overview article.
2.8 Candidate – How to attempt an assessment on Inspera Assessment via Canvas
Candidates can complete assessments from Inspera Assessment from Canvas.
- Log in to Canvas as a candidate.
- Navigate to the required Course.
- Click on the appropriate activity.
- Click on the Load [title] in a new window button.
- Complete the assessment and submit answers as per usual with Inspera Assessment.
Once the assessment has been graded and marks confirmed by the Grader, the candidate will be able to see their results in the Candidate Dashboard within Inspera Assessment and the Canvas Gradebook, if enabled.
Inspera: To enable displaying Marks in Inspera Assessment, in Deliver, check the Show Final Marks or Grades on Student Dashboard in the After test options.
Canvas: Enable the gradebook services under LTI Advantage services.
For more information, refer to the 2.1.1 Administrator - Configure an LTI Developer Key In Canvas section.
3. Frequently Asked Questions (FAQ)
Question 1 | Why aren't my marks imported to the Canvas gradebook? |
Answer |
In such a case, the following steps should be followed:
For more information, refer to the 2.1.1 Administrator - Configure an LTI Developer Key In Canvas section.
|
Question 2 | The save button does not work on the key settings page while configuring the LTI developer key? |
Answer |
If you're facing an issue with the Save button not working, the probable reason could be that the page retains the session even after fixing errors. A workaround to this is as follows:
Contact Support if the issue persists. |