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
Creating the LTI 1.3 Tool
On the left hand side, click on “Admin”
Next, click on “Developer Keys” towards the bottom of the left-hand side of the page
Create a new LTI key by clicking the green “Developer Key” button in the upper right and select “LTI Key”.
In the popup, give the tool a name and optionally provide an owner email. Fill in the following fields and click the green save button on the lower right corner.
Key Name: You may set this to “zyBooks LTI 1.3” or whatever name you wish this key to be called.
Redirect URI: https://lti1-3.zybooks.com/v1/lti1p3/provider
Under the method heading, click the drop-down box and select “Enter URL”.
JSON URL: "https://lti1-3.zybooks.com/v1/lti1p3/canvas_config"
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.
Additionally, please be sure that the Privacy level is set to "Public".
In the list of keys, ensure that the state of the new key is set to “ON” as shown below. To have your new LTI 1.3 tool work with zyBooks, record the client id of the LTI tool (in the screenshot below, this is 10000000001583). Send this information 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.
Providing the LTI 1.3 Tool to 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 the canvas course, select “Settings” on the bottom left.
Next, select the “Apps” tab towards the top of the screen.
Click “View App Configurations”.
Click the green “+ App” button.
Under “Configuration Type”, select “By Client ID” and enter the client id provided by the canvas administrator. Then click the green “Submit” button.
Finally, click “Install” to install the tool.
The tool will be installed in your course. When creating a new LTI assignment, you may select the tool by name exactly the same as in previous versions of LTI.
Blackboard
Adding the LTI 1.3 Tool to Blackboard
Log in as a Blackboard Administrator and go to the System Admin tab.
Under Integrations, click LTI Tool Providers.
Next, open the “Register LTI 1.3 Tool” tab and enter the following Client id.
c927f5f0-6ad9-4a45-8d60-2a505a9b39ae
You will be presented with the settings for the new LTI 1.3 tool as shown below.
Scroll down and ensure that the following fields are set then click the green “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.
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.
In the upper left, click “Create Placement”.
Provide a label and tag for the tool that will be displayed when adding a LTI 1.3 assignment. This will be the name shown to instructors at your institution. Also fill in the following fields.
Availability: Yes
Type: Select Course content tool and Allows evaluation. Deselect all other fields.
Launch in New Window: Optionally set this if you want LTI launches to appear in a new tab.
Tool Provider URL: Enter https://lti1-3.zybooks.com/v1/lti1p3/provider
The placement will be added and the LTI 1.3 tool will be accessible to instructors.
Lastly, 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.
Instructors may create a new LTI 1.3 link by visiting the content pane of their course and selecting the LTI 1.3 tool as shown below. The linking process is exactly the same as with previous versions of LTI.
Brightspace
Creating the LTI 1.3 Tool (for D2L/Brightspace Admins)
While logged into D2L/Brightspace as an admin, click on the gear icon in the upper right-hand corner and select “Manage Extensibility”.
Select “LTI Advantage” at the top, then click the “Register tool” button.
When prompted for the type of the tool, select “Standard”.
In the fields below, fill out the following.
Name: zyBooks LTI 1.3
Domain: https://lti1-3.zybooks.com
Redirect URLs: https://lti1-3.zybooks.com/v1/lti1p3/provider
Then, fill out the following fields:
OpenID Connect Login URL: https://lti1-3.zybooks.com/v1/lti1p3/oidc
Target Link URI: https://lti1-3.zybooks.com/v1/lti1p3/provider
Keyset URL: https://lti1-3.zybooks.com/v1/lti1p3/jwks
Extensions: Make sure Assignment and Grade Services are selected or grade passback will not work. Also, make sure to select Names and Role Provision Services.
Roles: Make sure Send Institution Roles is selected.
Click the blue “Register” button on the bottom left.
You will see a popup 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.
Close the popup and from the gear icon in the upper right-hand corner, select “External Learning Tools”
Select the “LTI Advantage” top on top, then click the “New Deployment” button.
Click “New Deployment”.
Fill in the following.
Tool: zyBooks LTI 1.3
Name: zyBooks LTI 1.3
Under “Extensions”: Make sure Assignment and Grade Services are selected
Under “Security Settings”, select all of the checkboxes except for “Anonymous”.
Under “Configuration Settings”, make sure Grades created by LTI will be included in Final Grade. If you would like LTI launches to happen in a new tab, select the Open as External Resourceoption.
Finally, 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.
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.