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
• Managing Link Placements
• LTI 1.3 Tool Deployment
• Completing the Integration
• Canvas Documentation

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. 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/materials
     • 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
  3. 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.

4. 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
  • 

5. Under Privacy Level, click Public.

Managing Link Placements

1. Set Up Global Navigation
   • In the box under Placements, type and select Global Navigation
   • Expand the Global Navigation option and input the following:
     • Target Link URI: https://bc.vitalsource.com/materials
     • Icon URL: Leave Blank
     • Text: VitalSource Course Materials 
     • Selection Height: 1200
     • Selection Width: 1200
2. Set Up Course Navigation
   • In the box under Placements, type and select Course Navigation.
   • Expand the Course Navigation option and input the following values:
     • Target Link URI:  https://bc.vitalsource.com/materials
     • Select Message Type: LtiResourceLinkRequest
     • Icon URL: Leave Blank
     • Text: VitalSource Course Materials 
     • Selection Height: 1200
     • Selection Width: 1200

3. Set Up Deep Link Tool
   • In the box under Placements, type and select Link Selection.
   • Expand the Link Selection option and input the following values:
   • 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

*To use deep linking tool, find more information here: https://success.vitalsource.com/hc/en-us/articles/31791134155287-Deep-Linking-to-a-Specific-Location-in-an-eBook-LTI-1-3

4. Click Save to register the VitalSource LTI 1.3 Tool.

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.

Verify and install the VitalSource app by clicking Install.  

Completing the Integration

Now that the tool has been created and deployed, VitalSource needs some information to finalize the integration:

• Client ID
• Deployment ID
   

1. 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.  

You will also need to provide the Deployment ID which is outlined in the next step. The Deployment ID is different from the Developer Key. Note: The Developer Key is not utilized at any point during this process.

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. 

    

   Canvas Documentation

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

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

Data Storage & Usage

This section describes what data VitalSource receives about Canvas users and courses through the LTI tool and how that data is stored & used.