Canvas LTI 1.3 - Integration with Inspera Assessment

Content

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 as well, acting as both a registration and single sign-on in one easy workflow. Additionally, LTI Advantage / 1.3 supports marks return from Inspera to the Canvas gradebook.

There are a few 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 1.3 and LTI Advantage services is based on OAuth 2.0 and OpenID Connect. This differs from previous versions of the LTI standard, which used OAuth 1.0. Practically, 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 - Configure an LTI Developer Key In Canvas

You need to configure an LTI key from the Developer Key page.

This is available for Administrators in Canvas.

  1. To configure an LTI developer key in Canvas, select Admin [i] on the left panel, then click on the name of the account [ii].

  1. In Account Navigation, click the Developer Keys link [i].

  1. Click the + Developer Key button [i]. Then click the + LTI Key option [ii].

NOTE: 

There are three (3) URLs that you will need from Inspera to set up the LTI connection in your Canvas instance. They are: 

  1. key-url: A key-url typically refers to a set of public keys used for authentication and security purposes.
  2. login-init: When a user initiates a login process from LMS to an external tool using LTI 1.3, the "login-init" URL is the endpoint where this process begins.
  3. redirect-url(s): The redirect URLs specify the URLs where LMS should redirect the user after completing the OAuth 2.0 authorization flow.

URL template

Using the URL templates above, replace {domain} with your Inspera tenancy that you will be setting up the integration against.

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
  1. Enter LTI settings i.e. Key Settings and Configure.

Enter the settings for the LTI key:

i) Key Name: The name of the external tool.

ii) Owner Email: The email of the person who owns the external tool. 

iii) Redirect URLs: Redirect URL data should be provided by the tool provider.

      https://{domain}/ltiprovider/launch 

iv) Notes: Any notes about the LTI key, such as the reason it was created.

Enter the configure settings for the LTI tool:

i) Method: Click the Method drop-down menu and select Manual Entry option To 

manually enter the details for your LTI key.

ii) Title: Name of the external tool

iii) Description: Brief description of the tool.

iv) Target Link URL: This will be the same as the redirect URL

        https://{domain}/ltiprovider/launch 

v) OpenID Connect Initiation URL: Enter the OpenID Connect Initiation URL

        https://{domain}/ltiprovider/init

vi) JWK Method: Choose Public JWK URL from the dropdown menu for the JWK 

method.

vii) Public JWK URL: Enter the Public JWL URL

        https://{domain}/ICSXapi/metadata/PublicCertificates

Important: Make sure you have replaced {domain} with the URL to your Inspera tenancy.
  1. Under the LTI Advantage Services [i], the user can select additional features the Tool provides. The following options have been selected to reflect marks, assignments, submissions, and user data in Canvas (other options can also be selected based on the customer's requirement).

  • 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 see 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.
  1. Expand the Additional Settings.

Note: By default, the privacy level will be set to private. You must select the privacy setting based on your requirements.

i) Custom Fields: Add custom parameters, if any (Refer Custom Parameters)

  1. In the Placements section, open the drop-down menu and choose Link Selection and Assignment Selection. 

  • link selection can add hyperlinks within the course content, whereas assignment selection can be a creation or selection of assignments within a Canvas course.

Note: For other options please refer canvas help document here

  1. Link Selection : Expand the Link Selection, and enter the link in Target Link URL (This link will be the same as Target Link Url  which has been entered while configuring the tool.)     

https://{domain}/ltiprovider/launch

  1. Click on the save button [i] to save the LTI Key.

2.2  Administrator - View LTI Developer Key In Canvas

After saving changes, the screen should navigate to Developer Keys.

i) Client ID: Each LTI key has a unique client ID and this client ID will be required at the 

time of configuration of the external app.

ii) State: Set the State to ON so that 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. The client ID can be found by configuring an LTI Developer key from the Developer Keys page.

This is available for Administrators in Canvas.

  1. Select Admin Link [i] on the left panel, then click on the name of the account [ii].

  1. In Account Navigation, click the Settings link [i].

  1. Click the Apps tab [i], then click on View App Configurations [ii].

  1. Now, click on the +App button [i], to configure the App.

  1. Select the Configuration Type drop-down menu and set the configuration type to By Client ID [i].

  1. Enter the Client ID and then click the submit button.

  1. On clicking the submit button, a pop-up should appear to install the app.

  1. After installing the App, the App will be visible on the External Apps page.

Note 1 : After installing the App, the values must be shared with Inspera to complete the configuration.

Note 2 : If you do not have a client ID, you must first Configure an LTI key.

If the submitted client ID is not found in your account's developer keys, Canvas will display an error message.

2.4 Administrator - Configuration of Inspera Assessment

Inspera will need the following information back from Canvas. You will need to contact Inspera Support to have them make 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 & Inspera.

Client ID Unique client id for the tool that is created and can be found as part of the initial tool registration done in Canvas
Issuer/Platform https://canvas.instructrue.com
Canvas Keyset URL https://canvas.instructrue.com/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 (Optional)

 

2.5 Teacher - Adding an Activity where Marks Return to Canvas Gradebook

IA 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. In such a scenario, the following steps should be followed:

  • Login to Canvas as an instructor
  • Open the Course in which you wish to create the linkage to an assessment
  • Go into or create a module[i] for which you will add this linkage
  • Click the Add item to module +[ii] sign on the Module title bar

  • Select Assignment’ [i], then choose Create Assignment [ii]. In the Assignment Name [iii]' section, enter the name of the test to be created in Inspera Assessment. Finally, click Add Item [iv].

  • Click on the Publish [i] icon, so that the assignment is visible to students. This action should only take place after the test is activated in Inspera.

  • Click on the name of the assignment you created, then click Edit [i] to access the assignment edit page.

Complete the following fields:

  • Points: Enter the number of marks this test will be out of eg. 20 marks

Note: Ensure that the scores are consistent by maintaining identical total points in both Inspera and Canvas. If a question set is created with 40 marks in Inspera, but in Canvas, the assignment is set for 10 marks, and a student scores 27 out of 40 in Inspera, the student will see the marks as 27 in Inspera. However, in Canvas, it will show as 6.75 marks with a maximum score of 10. 

  • Submission Type: Change Submission type to External tool in the dropdown
  • Find Button: Click the Find button to see the list of external tools available to this course
  • Select the external tool [i], then click on the select button.

  • Enable the checkbox [i] to open the tool in a new tab (or ignore to let it launch in the same tab).

  • Fill in the other fields as required, then click on the Save button.

  • After submitting, the screen should display as follows

2.6 Teacher - Adding an Activity where marks are NOT required to be returned to the Canvas Gradebook

At times, it may not be a requirement to have marks from an Inspera Assessment returned to the Canvas gradebook. In such a scenario, the following steps should be followed:

  • Login to Canvas as an instructor
  • Open the Course in which you wish to create the linkage to an assessment
  • Go into or create a module for which you will add this linkage
  • Click the Add item to module + [i] sign on the Module title bar

  • Choose External Tool [i] from the dropdown
    • Select the appropriate external tool [ii].
  • Click the Add item [iii] button.

  • Click on the Edit  [i] option, which is accessible by clicking the three dots located to the right of the activity.

  • Rename the title [i] on Edit item details pop up and then, click on Update [ii] button.

  • Before clicking the name to launch the Inspera assessment test set up in the new window, it should be published. This action should only take place after the test is activated in Inspera.

2.7 Teacher - Author Assessment

Log in to Canvas as an instructor.

Click the “Load [Title] in a new window” button to open up the Inspera Assessment test setup page in a new window.

The Inspera Assessment test setup will open at the Deliver tab, and you can set about configuring the appropriate settings for this test. Further instructions on this can be found in the Help Center article, Deliver overview.

 

2.8  Candidate – How to take an Inspera Assessment from Canvas

Candidates can start scheduled Inspera Assessments from Canvas.

  • Log in to Canvas as a candidate. 
  • Click on the Course containing the link to your assessment, then click on the name of the assessment [i].

  • Click the Load New Assignment Dec 20 in a new window. The candidate will be redirected to the Inspera screen to attempt the scheduled test.

The Candidate takes the test and submits their answers at the end. The candidate can then log out of Inspera Assessment.

Once the test has been graded and marks confirmed by the grader, the candidate will be able to see their results on the candidate dashboard within the Inspera Assessment and the Canvas Gradebook.

Note: 

Inspera: To enable displaying Marks/Results in Inspera Assessment, select option i.e. ‘Show Final Marks or Grades on Candidate Dashboard’  in the After test settings during the assessment setup process.

Canvas: For Canvas, you need to enable the gradebook services under LTI Advantage services. 

For reference: Please refer to sec 2.1 Pt.# 'e'

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:

  1. To ensure that grades are reflected by the tool in the Canvas gradebook under LTI Advantage Services, it is essential to select the option "Can create and view assignment data in the gradebook associated with the tool."

Please refer to the pt. # (e)  on Configure an LTI Developer Key for comprehensive guidance.

  1. Please ensure that the test is graded in Inspera Assessment. The grading must be confirmed to facilitate the transfer of marks.

 

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 on the Key Settings page while setting up the LTI Developer Key, the probable reason could be that the page retains the session even after fixing errors. Here's a simple workaround:

  1. Open a new tab or page specifically for the Key Settings related to the LTI Developer Key.
  2. Carefully enter the correct details for the LTI Developer Key without any mistakes.
  3. Click the Save button once you've double-checked that all details are accurate.

Kindly contact Support if the issue persists.

 

Articles in this section

Was this article helpful?
0 out of 0 found this helpful