Canvas LTI 1.3 Tool Setup and Link Placement

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 and Course Setup

  • Managing Link Placements

  • Link Placement for Deep Linking

  • LTI 1.3 Tool Deployment

  • Completing the Integration

  • Add VitalSource LTI Links to Courses
    

  • 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 (schools can choose to customise the Key Name)
  • 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

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.
  • *To learn more about the benefits of rostering, please visit the VitalSource Rostering: Make the Most of Your Investment in Day-One Access page.
• 

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

5. Under Privacy Level, click Public.

Managing Link Placements

Please note, depending on the student experience you want, you can choose to set up Course Navigation, 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.
    • This option is especially recommended for Inclusive Access and Equitable Access where the link is needed in all courses.
      
      
  • Link Selection - enables link placement within course modules. This is recommended depending on the endpoint you wish to use. For more information about endpoints, please visit: Which LTI Endpoint Is Right For You? For example, we recommend you set up Link Selection if you want to launch users into a particular digital product with an endpoint that requires the link to be edited when added to a course. 
    • This can be used for deeplinking to specific locations within an eBook, or if you are using certain publisher Partner Integrations, this allows deeplinking to specific locations within courseware.
    • Another use case for Link Selection is for schools that want to place the link in some courses but not all courses.

1. 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/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 
     • Please note that schools have the flexibility to customise this text according to their preferences.
   • Selection Height: 1200
   • Selection Width: 1200

2. Set Up Link Selection
   • 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/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?"
       • If you are linking 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.
   • Select Message Type: LtiResourceLinkRequest
   • Icon URL: Leave blank
   • Text: VitalSource Course Materials

     • Please note that schools have the flexibility to customise this text according to their preferences.

   • Selection Height: 1200
   • Selection Width: 1200
     
3. Click Save to register the VitalSource LTI 1.3 Tool.

Link Placement for Deep Linking

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

1. Link Selection enables link placement within course modules. This is used for deeplinking to specific locations within an eBook or if you are using certain publisher partner Integrations. This allows deeplinking to specific locations within courseware.
   
   • • 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 
       
       

2. Click Save.

Using the VitalSource Deeplinking Interface

This is available to instructors or LMS 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. Select your current adoption or search for content by title, author or SKU (if available).
   Note: Inclusive Access courses will not have search capability

6. Click the Link to Specific Page 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.

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.

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.

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.
   
   

Add VitalSource LTI Links to Courses

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

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://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 ticked, but it is not required to load the VitalSource app in a new tab

5. Click Add Item.

   

• Note: If you are interested in deeplinking into an Explore collection via your LMS, please complete the steps outlined above and then visit our Deeplinking into an Explore Collection page for more instructions.

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