Canvas LTI 1.1 to 1.3 Upgrade
If your LMS currently has the VitalSource LTI 1.1 tool configured, the steps below will guide you through upgrading the existing 1.1 tool to a 1.3 configuration.
In Canvas, click Admin → Developer Keys and click + Developer Key. Select the LTI Key option.
Enter the following to configure the tool:
a. Key Name: VitalSource LTI 1.3
b. Owner Email: LMS admin’s email address
c. Redirect URI: https://bc.vitalsource.com/oauth2callback
d. Method: Manual Entry
e. Title: VitalSource
f. Description: VitalSource LTI 1.3 Tool
g. Target Link URI:
This URL should match the existing VitalSource LTI 1.1 App that is currently configured. If you are unsure which endpoint to use, please refer to the 1.1 app OR contact your VitalSource Integration Manager.
-
https://bc.vitalsource.com/materials OR https://bc.vitalsource.com/books
For more information about endpoint options and uses, please visit the page ‘Which LTI Endpoint Is Right For You?’
h. OpenID Connect Initiation URL: Your VitalSource Integration Manager will provide this.
i. JWK Method: Select Public JWK URL and enter https://bc.vitalsource.com/ltia/security/jwks
-
Toggle on the following items listed under LTI Advantage Services.
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 for assignments associated with the tool.
Can create and update submission results for assignments associated with the tool.
Can retrieve user data associated with the context the tool is installed in.
Can update public jwk for LTI services.
Under Additional Settings
Domain: bc.vitalsource.com
Custom Fields:
canvas_user_id=$Canvas.user.id
canvas_user_login_id=$Canvas.user.loginId
course_start_date=$Canvas.course.startAt
course_end_date=$Canvas.course.endAt
canvas_course_id=$Canvas.course.id
canvas_section_id=$Canvas.course.sectionIds
term_start_date=$Canvas.term.startAt
term_name=$Canvas.term.name
previous_context_ids=$Canvas.course.previousContextIds
previous_canvas_course_ids=$Canvas.course.previousCourseIds
canvas_api_domain=$Canvas.api.domain
canvas_account_id=$Canvas.account.id
user_integration_id=$Canvas.user.sisIntegrationId
Privacy Level = Public
Placements - Currently only placements in the Course Navigation and the Link Selection are supported by VitalSource.
Please note, depending on the student experience you want, you can choose to set up Course Navigation, Link Selection or both.
-
Our recommended link placements for are as follows:
Course Navigation = We recommend setting up the https://bc.vitalsource.com/books or https://bc.vitalsource.com/materials based on your institution’s preferred experience
Link Selection = We recommend utilising our deeplinking placement using https://bc.vitalsource.com/adopt
-
In the Placements dropdown, find ‘Course Navigation’ and click it. Then find ‘Link Selection’ and click it.
Course Navigation - link placement is enabled by default within the course navigation menu, which is ideal if you are using the same link in every course. This is not recommended if you would like to launch to a specific digital product as that requires the link to be edited when added to a course.
-
Target Link URI: https://bc.vitalsource.com/books OR https://bc.vitalsource.com/materials, depending on the experience desired
For more information about endpoint options and uses, please visit the page ‘Which LTI Endpoint Is Right For You?’
Select Message Type: LtiResourceLinkRequest
Icon URL: Leave blank
-
Text: VitalSource Course Materials
This is the text of the link in the course navigation.
Selection Height: 1200
-
Selection Width: 1200
Click Save to register the VitalSource LTI 1.3 Tool.
Now that the tool has been saved, VitalSource needs some information.
Provide the Client ID and Deployment ID in a one-time secret link to your VitalSource Integration Manager to complete the setup.
Client ID
Click the new LTI 1.3 Developer Key to On and copy the Client ID in the Details column for the newly created LTI Developer Key.
LTI 1.3 Tool Deployment
Copy the Client ID created in the steps above.
Navigate to Admin → Settings → Apps → View App Configurations → + App.
Select Configuration Type: By Client ID
Paste the Client ID from the Developer Key step above and click Submit.
Verify and install the VitalSource app by clicking Install.
An additional pop-up will appear. ‘Click Yes, Install Tool’.
Retrieve the Deployment ID for the VitalSource Tool
On the View App Configuration page, find the VitalSource tool, click the gear icon and click Deployment ID. This value can also alternatively be located by navigating to Developer Key > VitalSource LTI 1.3 > View in Canvas Apps
Copy the Deployment ID and send both the Client ID and Deployment ID to the VitalSource integration Manager to complete the integration.
Locate the exciting LTI 1.1 app that was created previously. Click the gear icon and select Edit.
Ensure that the Domain field has bc.vitalsource.com filled in and click Submit.
Link Placement for Deep Links
The next step is to set up deeplinking, a powerful feature of our existing LTI tooling that significantly improves course integration. Note that deeplinking doesn’t require a new installation. VitalSource’s deeplinking tool functions in two major capacities:
Allows for the creation of LTI links directly to specific locations within eBooks delivered in Bookshelf®
Allows for the creation of LTI links directly to specific locations within courseware delivered via our Partner Integration (SSO) with many of our publishing partners
The steps to complete the setup can be found below:
Target Link URI: https://bc.vitalsource.com/adopt
Select Message Type: LtiDeepLinkingRequest
Icon URL: Leave blank
Text: VitalSource Deep Linking Tool
Selection Height: 1200
Selection Width: 1200
Click Save.
Now that you have the main tool and deeplinking installed, you’re all set! Before sending the credentials to the Integration Manager, please confirm that both endpoints are installed. Securely share the details once everything has been verified.