Canvas LTI 1.3 Tool Setup and Link Placement

These instructions describe how to register the VitalSource LTI 1.3 tool and enable LTI 1.3 launches in the Canvas learning management system (LMS).

Tool & Course Setup

New LTI 1.3 Developer Key

In Canvas, click Admin → Developer Keys and click + Developer Key. Select the LTI Key option.

Under Key Settings enter the following to configure the tool:

Key Name: VitalSource LTI 1.3
Owner Email: LMS admin’s email address
Redirect URI:
- https://bc.vitalsource.com/oauth2callback
Configure: Manual Entry
Title: VitalSource
Description: VitalSource
Target Link URI: https://bc.vitalsource.com/books or https://bc.vitalsource.com/materials depending on the experience desired.
- - For more information on endpoint options and uses, please visit the page "Which LTI Endpoint Is Right For You?"
OpenID Connect Initiation URL: A VitalSource Integration Manager will provide this.
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.

*To learn more about the benefits of rostering, please visit https://success.vitalsource.com/hc/en-us/articles/360026342494-VitalSource-Rostering-Make-the-Most-of-Your-Investment-in-Day-One-Access:

Under Additional Settings, leave all fields blank except for 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

Under Privacy Level, click Public.

Managing Link Placements

After you have set VitalSource up as an LTI 1.3 Tool, you can place LTI links into courses. Depending on the VitalSource tool you are using, there are different options for doing this.

VitalSupport supports LTI 1.3 which allows you to place links via Course Navigation, or via the tool modules via Link Selection, or both.

Course Navigation - link placement is enabled by default within the course navigation menu. Using course navigation 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 is edited when added to a course.
Link Selection - enables link placement within course modules. This is ideal for launching to specific digital products.

Enter the following information in the Placement(s) where you wish to add the VitalSource LTI 1.3 tool.

Target Link URI: https://bc.vitalsource.com/books or https://bc.vitalsource.com/materials, depending on the experience desired
- - For more information on 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
Selection Height: 1200
Selection Width: 1200

Selecting "Link Selection" allows you to place links to content on a course-by-course basis via modules.

Screenshot_2023-01-05_at_3.34.13_PM.png

Selecting "Course Navigation" inserts the link in every course by default via the side navigation.

Screenshot_2023-01-05_at_3.35.01_PM.png

Using the VitalSource Content Deeplinking Interface

When VitalSource uses the content deeplinking interface VitalSource places an LTI deeplinking request type. If your school is configured to use the VitalSource Content Deeplinking Interface, you can add deep links to specific locations of the content back into your Canvas course.

* If your institution doesn't plan to utilize Deeplinking, skip this section and continue to the LTI 1.3 Tool Deployment section.

Not sure if your institution plans to utilize Deeplinking? Please contact your CSM.

If your institution plans to use the VitalSource Deeplinking Interface, follow the below instructions.

Under Placements, select the Link Selection option, and enter the following configurations:

Target Link URI: https://bc.vitalsource.com/adopt
Select Message Type: LtiDeepLinkingRequest
Icon URL: Leave Blank
Text: VitalSource Course Materials Adoptions
Selection Height: 1200
Selection Width: 1200

Deep_Linking_LTI_1.3.png

Click Save to register the VitalSource LTI 1.3 Tool.

Now that the tool has been saved, VitalSource needs some information

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.

Screenshot_2022-12-08_at_10.57.07_AM.png

Note: The Key will not be utilized at at any point during these instructions.

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.

Retrieve the Deployment ID for the VitalSource Tool

On the View App Configurations page, find the VitalSource tool, click the gear icon, and click Deployment ID.
Copy the Deployment ID and send both the Client ID and Deployment ID to the VitalSource integration Manager to complete the integration.

Add VitalSource LTI Links to Courses

Adding Links to Course Modules

When in a Course, click the Modules link in the Course Navigation.
In the Module where you’d like to add the link, click the + button.
In the Add [Item Type] To: drop-down menu, select External Tool.
Find the VitalSource external tool and review the following:

URL: This will pre-populate based on how the LTI External App was configured. If you are launching to a specific VitalSource digital product, you may need to edit the URL to include the VitalSource product SKU for the item you are using. Example: https://bc.vitalsource.com/books/978000000000R180.
Page Name: This will pre-populate based on the name of the LTI External App, but it can be edited.
Load in a new tab: We recommend this box is checked, but it is not required to load the VitalSource app in a new tab

Click Add Item.
If you selected to add the VitalSource LTI 1.3 tool to the Course Navigation in the Registration steps above, the tool will automatically be added to the Course navigation panel.

Using the VitalSource Deeplinking Interface

This is available to instructors or LMS admins who are enrolled in the course only.

When in a Course, click the Modules link in the Course Navigation.
In the Module where you’d like to add the link, click the + button.
In the Add [Item Type] To: drop-down menu, select External Tool.
Find the VitalSource Course Materials Adoptions tool in the list. (It should have a search magnifying glass icon next to it.)
Select your current adoption or search for content by title, author or SKU (if available).
Note: Inclusive Access courses will not have search capability
Click the Link to Specific Page button for the content for which you want to create links.
Select a location and click Add Materials.
Click Review and Submit.
Click Add to Course.
Back in Canvas, review the selection and click Add Item.