Overview
This document contains the steps that an administrator will need to perform to enable Deep Linking for existing LTI 1.3 tools This must be performed by the LMS administrator since an instructor does not have the required privileges.
We currently support Deep Linking in the following LMSs.
Canvas
If you already have the 1.3 tool installed, follow the steps below to enable deep linking.
- Navigate the the "Developer keys" and find the zyBooks LTI 1.3 tool. Then click the edit button
-
Scroll down to the "Link selection" settings. Under "Select Message Type" change the option to "LtiDeepLinkingRequest".
Optionally, set "Selection Height" to 1500 and "Selection Width" to 1000
-
Under "Assignment Selection", we recommend leaving the option as is, "LtiResourceLinkRequest". This will allow instructors who have previosly used the tool to use the tool as they have previosly.
- Save
The tool is now ready for deep linking. Please see our help article: How to Link Assignments Using Deep Linking
Blackboard
If you already have the 1.3 tool installed, follow the steps below to enable deep linking.
-
In the administrator panel, select LTI Tool Providers under Integrations
-
Find the zyBooks LTI 1.3 tool in the list and click "Manage Placements."
- Click "Create Placement". You should see the existing placement in the list
- Use the following information to create a new placement
- Label: zyBooks LTI 1.3 Deep linking
- Handle: zyBooks Deep Link
- Availability: Yes
- Type: Deep Linking (there is no need to select "Allow student access" and all other options can remain unchecked)
- We recommend launching the tool in a new window
-
Target link URL: https://lti1-3.zybooks.com/v1/lti1p3/provider
-
Click "Submit" to save. You should now see the new placement in the list of existing placements
The tool is now ready for deep linking. Please see our help article: How to Link Assignments Using Deep Linking
Brightspace
If you already have the 1.3 tool installed, follow the steps below to enable deep linking.
- Edit the existing tool by clicking on the gear icon in the upper right-hand corner and selecting “Manage Extensibility”.
2. Look for the zyBooks LTI 1.3 tool in the list and click on it
3. Under "Extensions", select "Deep Linking" and save
4. Scroll to the end and click "View Deployments"
5. Click on the deployment
6. Scroll to the end and click "View Links"
7. Click "New Link" at the top left to add a link
8. Enter the following configurations, then Save
Name: zyBooks Assignments Deep Link*
URL: https://lti1-3.zybooks.com/v1/lti1p3/provider
Type: Deep Linking Quicklink
Width: 1500*
Height: 1000*
*Note these values are just recommendations
The tool is now ready for deep linking. Please see our help article: How to Link Assignments Using Deep Linking