Articles in this section

LTI 1.3: Canvas Setup for LMS Administrators

Sarafina Starling
  • Updated
Follow

What you will need before starting:

  • Canvas admin access with Developer Keys privileges (Admin > Account > Developer Keys)
  • A decision on your integration type: Anonymous (students launch directly, no login required) or Known (students are matched by name and email). If you are unsure, please reach out to support@solidprofessor.com, before proceeding..

Log into Canvas as an admin and navigate to Admin > Account > Developer Keys. Click + Developer Key > LTI Key.

Fill out the Basic Information section:

Field Value
Title [School Name] (SP)
Key Name [School Name] (SP)
Description SolidProfessor tool for [School Name]
Method Manual Entry
Owner Email Your Canvas admin email address

Change the JWK Method to Public JWK URL, then fill out the Endpoint Configuration section:

Field Value
Redirect URI https://plt-backend.solidprofessor.com/api/v1/lti/launch
Target Link URI https://plt-backend.solidprofessor.com/api/v1/lti/launch
OpenID Connect Initiation URL https://plt-backend.solidprofessor.com/api/v1/lti/oidc
Public JWK URL https://plt-backend.solidprofessor.com/api/v1/lti/jwks?iss=https://canvas.instructure.com

Under LTI Advantage Services, enable the following toggles:

  • Can create and view assignment data in the gradebook associated with the tool.
  • Can view assignment data in the gradebook associated with the tool.
  • Can view submission data in the gradebook associated with the tool.
  • Can retrieve user data associated with the context the tool is installed in.

Under Additional Settings, enter the following:

Field Value
Domain https://plt.solidprofessor.com
Privacy Level Public (for Known integration) or Private (for Anonymous integration)

In the Custom Fields box, enter the following exactly as shown, each on its own line, no extra spaces, no blank lines between them

user_id=$Canvas.user.id lms_school_id=$Canvas.account.id

Important: Any extra spaces or blank lines in the Custom Fields will cause student launches to fail.

Under Placements, select all four of the following from the dropdown and configure each one as shown:

Assignment Selection:

Field Value
Target Link URI https://plt-backend.solidprofessor.com/api/v1/lti/launch
Select Message Type LtiDeepLinkingRequest
Text SolidProfessor
Selection Height 800
Selection Width 1000

Editor Button:

Field Value
Target Link URI https://plt-backend.solidprofessor.com/api/v1/lti/launch
Select Message Type LtiDeepLinkingRequest
Icon URL https://static-exp1.licdn.com/sc/h/3dio89ba7ceqktt0kek3tla5w
Text SolidProfessor
Selection Height 800
Selection Width 1000

Link Selection:

Field Value
Target Link URI https://plt-backend.solidprofessor.com/api/v1/lti/launch
Select Message Type LtiDeepLinkingRequest

Course Assignments Menu:

Field Value
Target Link URI https://plt-backend.solidprofessor.com/api/v1/lti/launch
Select Message Type LtiDeepLinkingRequest

Click Save. You will be taken to the Developer Keys list where your new key appears with an auto-generated Client ID (a long numeric string). Copy this value, you will need it for the next step and for the form at the end.

Critical: Change the State of the Developer Key to ON. If this remains OFF, all LTI launches will fail with no error message displayed. This is the most common Canvas setup issue.

Step 2:  Install the SolidProfessor App in Canvas
  • Navigate to Admin > Account > Settings. Select the Apps tab at the top and click View App Configurations, then + App.
  • Set Configuration Type to By Client ID. Paste your Client ID from the previous step, and click Submit. Click Install when the app is found.
  • If Enabled, toggle the RCE Toolbar slider to Disabled. Click the gear dropdown on the app and select Deployment ID.
  • Copy this value, you will need it for the form at the end.
Step 3: Capture Your Client ID, Deployment ID, and School ID

Client ID and Deployment ID:

From Organization Apps, click Configure on the SolidProfessor app. Click the "Copy Client ID" button. Save this value. Then, copy the Deployment ID listed on that page. Save this value.

School ID:

Go to Admin > Sub-Accounts. Click on each school that will use SolidProfessor. The School ID is the number at the end of the URL. Save this value. Repeat for each school.

Note: You now have your Client ID, Deployment ID, and School ID. Proceed to the Hand-Off section below.

Once you have collected all three values, your part of the setup is complete. You do not need to enter anything into SolidProfessor. That step is handled by an Instructor or District Admin with the appropriate access level in SolidProfessor.

Pass the following three values to your instructor or district admin (If you have not already entered them into the SolidProfessor Platform):

  • Client ID
  • Deployment ID
  • School ID (or IDs if multiple schools)

Let your Instructor or District Admin know they will need to log in to SolidProfessor and enter these values in Instructor Tools to complete the integration. Ask them to confirm with you once it has been entered. They can then follow the steps here to complete the integration process: LTI 1.3: Canvas Setup for Instructors

Related articles