Canvas

General

Before you begin this step, ensure you have three URLs from the Integration Profile in Alma.

These links are generated in the step of creating an integration profile.

In this step you will:

  1. Create a new “Developer Key”
  2. Create a new “LTI application”
  3. Copy 2 parameters (Client Id and Deployment ID) to be used in the next step

Create a Developer Key

Go to Admin->Developer Keys-> + Developer Key -> + LTI Key

Fill out the configuration screen as described below:

Key Name – any name you choose. This name will only be seen by the LMS administrator

Method = Manual Entry

 

Title – Any title you choose. This title will be seen by instructors when adding LTI links (as seen in the screenshot below)
(Think about the student experience. What will students be looking for when you want them to click on the Leganto link, and what language will prompt them to click in the right place? We recommend naming Leganto something that ties directly to the student need, such as “Course Materials,” “Course Resources,” “Course Readings,” or “Reading List.”)

Description – Any description you choose. This description will be seen by instructors when adding LTI links (as seen in the screenshot below)

 

             

How instructors see title + description

 

Target Link URI – The 1st link from the integration profile (Launch URL)

OpenID Connect Initiation Url – The 2nd link from the integration profile (Login URL)

JWK Method = choose Public JWK

Public JWK – Delete the existing {} and place the following value instead:

Place the 3rd URL in your browser but modify it by adding 2 to the jwk string. You should see a value like this:

Copy this value to the Public JWK field.

Redirect URIs – The 1st link from the integration profile (Launch URL)

Continue to the “Additional Settings” and set the following

Custom Fields –

In the Custom Fields set 3 parameters to send over to Leganto the course code and the username:

lis_course_code=$com.instructure.contextLabel
lis_user_username=$User.username
canvas_masq=$Canvas.masqueradingUser.id

lms_user_roles=$Canvas.membership.roles (used for automatically adding the Instructor role to users when arriving to Leganto)

In addition you should configure the following mapping for role to be added.

(Inspect the LTI parameters to be sure what value/s needs to be configured. see here LTI 1.1 or here LTI 1.3):


lms_course_start_date=$Canvas.course.startAt (used for creating courses on the fly)
lms_course_end_date=$Canvas.course.endAt (used for creating courses on the fly)

lis_course_name=$Canvas.course.name (Only needed if you are using the Automatic Course Creation feature)

In the example above we are sending the Canvas course “Context Label” as the course code (most Canvas Leganto customers use this as the course code).

If you want to send a different value, take look here for other placeholders.

canvas_masq (optional) – Used to detect “Student View”. If “Student View” is used when clicking the LTI link, an error message will be displayed. You can configure the text of the message under this leganto label: lti.user.error.studentView

Banner users

For users which are using the Banner ERP, there might be some exceptions to the above.

If the integration is not workingfor you, try the following changes

    • In the “Add Custom Field“, use the following fields instead of what is documented:
      • lis_course_code=$Canvas.course.sisSourceId
      • lis_user_username=$Person.sourcedId

 

Privacy Level

Set the value to PUBLIC

Placements

Leave the Link Selection placement.

Think of adding the Course Navigation placement if you want an LTI link to automatically appear for all of your courses

(See Course navigation for more advanced configuration options)

Click save.

Copy the Client ID

Copy the Client ID (this value needs to be used in the next step) and make sure the tool is ON:

Create an LTI Application

Go to Admin->Settings->Apps-> Click the “View App Configurations”

Click the +App

Choose Configuration Type = By Client ID

Client ID – paste the client ID copied in previous step.

Click Submit

Click Install

Click Yes, Install Tool

Copy the Deployment ID (this value needs to be used in the next step)

 

When you are done you should have copied 2 values:

  1. Client ID
  2. Deployment ID

These 2 values should be used in the next step of Update your integration profile