Articles in this section

See more

LTI 1.3 Deep Link Configuration

Avatar
Estefania
  • Updated
Follow

Overview

This document contains the steps that an administrator will need to perform to configure LTI 1.3 when using zyBooks. This must be performed by the LMS administrator since an instructor does not have the required privileges.

We currently support LTI 1.3 in the following LMS's.

 

Canvas

1. On the left-hand side, click on “Admin”

 

mceclip0.png

 

2. Click on “Developer Keys” towards the bottom of the left-hand side of the page

 
mceclip1.png
 
 

3. Create a new LTI key by clicking the blue “Developer Key” button in the upper right and select “LTI Key”.

 
mceclip2.png
 

4. In the popup, give the tool a name and optionally provide an owner email. Fill in the following fields 

 

Key Name: You may set this to “zyBooks LTI 1.3 Deep Linking” or whatever name you wish this key to be called.

Redirect URI: https://lti1-3.zybooks.com/v1/lti1p3/provider

Method: Manual Entry

Title: zyBooks LTI 1.3 DeepLinking

Description: zyBooks LTI 1.3 DeepLinking

Target Link URI: https://lti1-3.zybooks.com/v1/lti1p3/provider

OpenID Connect Initiation Url: https://lti1-3.zybooks.com/v1/lti1p3/oidc

JWK Method: Public JWK URL

Public JWK URL: https://lti1-3.zybooks.com/v1/lti1p3/jwks

 

5. The new LTI 1.3 tool key should be automatically configured with the settings required for zyBooks. 

For reference, this is what it should look like.

 

6. Additionally, please be sure that the Privacy level is set to "Public" and the Domain is set to https://lti1-3.zybooks.com

 

 

7. Add "Link Selection" and "Assignment Selection" to Placements

8. Under Link Selection, set the following values

Target Link URI: https://lti1-3.zybooks.com/v1/lti1p3/provider

Select Message Type: LtiDeepLinkingRequest 

Selection Height: 1500*

Selection Width: 1000*

*These are recommendations, not required sizing 

9. Set the same values under Assignment Selection and click the blue save button in the lower right corner.

*If you already have the LTI 1.3 tool installed, we recommend leaving the "Assignment Selection" settings on "LTiResourceRequest" so instructors have the option to continue building links as before.

 

10. In the list of keys, ensure that the state of the new key is set to “ON” as shown below.

mceclip4.png

 

8. Record the client id of the LTI tool (in the screenshot below, this is 10000000001583).

Note: A common mistake is to click on "Show key" and use the long alphanumeric string. That is NOT the client id. 

 

Send the client id to Support <support@zybooks.com> and your institution will have LTI 1.3 access to zyBooks.

Additionally, please send your LMS domain name to Support as well.

 Important: Be sure to provide the tool so that instructors are able to use the tool.

 

The tool is now ready for deep linking. Please see our help article: How to Link Assignments Using Deep Linking

 

Providing the LTI 1.3 Tool to Canvas Instructors

Now that the LTI 1.3 tool is configured, you may provide the client id to instructors and have them follow the steps below to add this tool to their course.

In Canvas, LTI 1.3 tools can be provided at the Account level or the Course level. We recommend adding it at the Account level to prevent having to add it to each course individually.

 

Some instructors may be able to add the tool to their own Course, without help from their admin, if they know the client id.

 

Adding the tool at the Account level

1. Click on Admin. Then, the account you wish to add the tool to.

 

2. Once inside the account, scroll to the bottom and click on "Settings". 

 

2eaffa29-a595-456d-a6c6-7bbd61b737e6.png

 

3. Then click on "Apps" in the toolbar near the top of the page.
a381d07f-3eda-472a-8d3c-1f5a219199ba.png

 

4. Next, skip to the steps under Adding the App in View App Configurations in order to complete the process.

 

 

 

Adding the tool at the Course level

1. In the desired Canvas course, select “Settings” on the bottom left.

 

 

 

2. Next, select the “Apps” tab on the toolbar towards the top of the screen.

 
 
3. Please follow the rest of the steps under, Adding the App in View App Configurations, to complete the process.
 
 
 

Adding the App in View App Configurations

 

1. Click “View App Configurations”.mceclip7.png

 
 

2. Click the blue “+ App” button.

 
 
Note: Some instructors may have the ability to add installed apps (via client_id) to their own shell. If you are an instructor and do not see the “+ App” button, you may not have the permissions in Canvas to do this. Instead, you will need to reach out to your Canvas admin to complete these steps.
 
 

3. Under “Configuration Type”, select “By Client ID” and enter the client id provided by the canvas administrator. Then click the blue “Submit” button.

 
mceclip9.png
 

4. Finally, click “Install” to install the tool.

 
mceclip10.png
 

The tool will be installed in the desired account/course.

 

 


 

Blackboard 

Adding the LTI 1.3 Tool to Blackboard

1. Log in as a Blackboard Administrator and under "Administrator Tools" select "LTI Providers". 

 

 

 

2.  Open the “Register LTI 1.3 Tool” tab and enter the following Client id.

c927f5f0-6ad9-4a45-8d60-2a505a9b39ae

3. You will be presented with the settings for the new LTI 1.3 tool as shown below.

BlackBoardLTI1-3Settings.png
 

 

4. Scroll down and ensure that the following fields are set then click the blue “Submit” button.

  • User Fields to Send: “Constituency in Course”, “Name”, and “Email Address”.
  • Allow evaluation service access: Yes. This is critical for grade passback to work with your zyBook.
  • Allow Membership Service Access: Yes.

7f181043-6293-4a5f-b38d-dd4ad7ab647c.png

5. You will be brought back to the LTI Tool Providers page. Scroll through the list of tools to find LTI 1.3 tool and click on the arrow next to the tool name. Then click Manage Placements.

 

6. In the upper left, click “Create Placement”. 

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

     

7. Click "Submit" to save

The placement will be added, and the LTI 1.3 tool will be accessible to instructors.

 

8. On the LTI Tool Providers page, find the LTI 1.3 tool and select Edit.

 

Find the Deployment ID of the tool and send this information to Support <support@zybooks.com> to configure access.

Additionally, please send your LMS domain name to Support as well.

 

cec8de6b-f4cb-4359-ba57-82b8676a10b6__1_.png

 

 

 

Instructors may create a new LTI 1.3 link by visiting the content pane of their course and selecting the LTI 1.3 Deep Linking tool, as shown below. 

 

The tool is now ready for deep linking. Please see our help article: How to Link Assignments Using Deep Linking

 

Brightspace

Creating the LTI 1.3 Tool (for D2L/Brightspace Admins)

1. While logged into D2L/Brightspace as an admin, click on the gear icon in the upper right-hand corner and select “Manage Extensibility”.

 

mceclip0.png
 

2. Select “LTI Advantage” at the top, then click the “Register tool” button.

mceclip1.png

3. When prompted for the type of the tool, select “Standard”.

mceclip2.png

 

4. In the fields below, fill out the following.

 

mceclip3.png

 

5. Then, fill out the following fields:

 

6. Click the blue “Register” button on the bottom left.

You will see a pop-up that will have several pieces of information on it. Copy these values and save them. You will send this to zyBooks so we can set up your LTI 1.3 integration.

 

7. From the same pop-up, click "View Deployment"

 

 

 

8. Click the “New Deployment” button.

mceclip6.png

 

9. Fill in the following.

  • Tool: zyBooks LTI 1.3 Deep Link
  • Name: zyBooks LTI 1.3 Deep Link
  • Under “Extensions”: Make sure Assignment and Grade Services ,   Names and Role Provisioning Services are selected

 

10. Under “Security Settings”, select all of the checkboxes except for “Anonymous”.

mceclip9.png

 

 

11. Under Configuration Settings, please:
  • Check Open as External Resources
  • Check Grades created by LTI will be included in Final Grade
  • Do NOT Check Auto Create Grade Items
 

Note: if Auto Create Grade Items is checked, the grade item will automatically be created with the points set to 100 as soon as the first student submits. Scores will populate this grade item instead of the one the instructor created/added themselves.

 

 

12. Make sure to add your Org Unit using the Add Org Units button to make the tool visible to instructors.

Note: Instructors should have permission to create a new link for external tools.

 

mceclip11.png

 

13. Click “Create Deployment,”, then copy the deployment ID. You will email this along with the Client ID, public keyset URL,access token URL, and authentication or oidc URL to zyBooks Support (support@zybooks.com) once the tool has been fully set up.

 

 

mceclip12.png

 

 14. Click "View Links" 

 

15. Click "New Link" at the top left to add a link

16. 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 width and height values determine the size of the modal that opens when the link is selected


 

The tool is now ready for deep linking. Please see our help article: How to Link Assignments Using Deep Linking

 

 

 


 

Related articles

Powered by Zendesk