1. VitalSource Customer Success
  2. Institutional Admins/Librarians
  3. Integrate with VitalSource
  4. Canvas

Canvas LTI 1.3 Tool Setup and Link Placement

Avatar
Warren Eels
Follow

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 LMS/VLE. 

Tool & Course Setup

New LTI 1.3 Developer Key

  1. In Canvas, click Admin → Developer Keys and click + Developer Key. Select the LTI Key option.
  2. Enter the following to configure the tool:
  • Key Name: VitalSource LTI 1.3
  • Owner Email: LMS/VLE admin’s email address
  • Redirect URIs
    • https://launch.vitalsource.com/oauth2callback
    • https://bc.vitalsource.com/oauth2callback
  • Configure: Manual Entry
  • Title: VitalSource
  • Description: VitalSource
  • Target Link URI: https://launch.vitalsource.com/books or https://launch.vitalsource.com/materials depending on the experience desired.
  • OpenID Connect Initiation URL: A VitalSource Integration Manager will provide this.
  • JWK Method: Select Public JWK URL and enter https://launch.vitalsource.com/ltia/security/jwks
  1.  Under Key Settings, toggle on the following:
  • 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.
  1. 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

lti_1.3_tool_setup_canvas_additional_settings.png

  1. Under Privacy Level, click Public.

Placements

VitalSource currently supports LTI 1.3 placements in the Course Navigation and the Link Selection options of Canvas LMS/VLE. Enter the following information in the Placement(s) where you wish to add the VitalSource LTI 1.3 tool.

  • Target Link URI: https://launch.vitalsource.com/books or https://launch.vitasource.com/materials, depending on the experience desired
  • Select Message Type: LtiResourceLinkRequest
  • Icon URL: Leave Blank
  • Text: VitalSource Course Materials
  • Selection Height: 1200
  • Selection Width: 1200

LTI Advantage Deeplinking

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

  1. Under Placements, select the Link Selection option, and enter the following configurations:
  • Target Link URI: https://launch.vitalsource.com/adopt
  • Select Message Type: LtiDeepLinkingRequest
  • Icon URL: Leave Blank
  • Text: VitalSource Course Materials Adoptions
  • Selection Height: 1200
  • Selection Width: 1200 
  1. Click Save to register the VitalSource LTI 1.3 Tool.
  2. 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

  1. Copy the Client ID created in the steps above.
  2. Navigate to Admin → Settings → Apps → View App Configurations → + App.
  3. Select Configuration Type: By Client ID
  4. Paste the Client ID from the Developer Key step above and click Submit.
  5. Verify and install the VitalSource app by clicking Install.

Retrieve the Deployment ID for the VitalSource Tool

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

lti_1.3_tool_setup_canvas_copy_deployment_id.png

 

  1. When in a Course, click the Modules link in the Course Navigation.
  2. In the Module where you’d like to add the link, click the + button.
  3. In the Add [Item Type] To: drop-down menu, select External Tool.
  4. 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://launch.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
  1. 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/VLE admins who are enrolled in the course only.

  1. When in a Course, click the Modules link in the Course Navigation.

  2. In the Module where you’d like to add the link, click the + button.

  3. In the Add [Item Type] To: drop-down menu, select External Tool.

  4. Find the VitalSource Course Materials Adoptions tool in the list. (It should have a search magnifying glass icon next to it.)

  5. Search for content by title, author or SKU.

  6. Click the Table of Contents button for the content for which you want to create links.

  7. Select a location and click Add Materials.

  8. Click Review and Submit.

  9. Click Add to Course.

  10. Back in Canvas, review the selection and click Add Item.

 

Canvas Documentation

Registering a new LTI 1.3 Tool: https://community.canvaslms.com/docs/DOC-16729-42141110178

Deploying an LTI 1.3 Tool: https://community.canvaslms.com/docs/DOC-16730-42141110273

 

Was this article helpful?