- Getting Set Up in Canvas
- Technical Documentation and Troubleshooting
- Additional Resources
Installation Process Overview
Here is a high-level overview of the installation process.
After ISKME releases the LTI 1.3 tool to openNCCC for Canvas, the openNCCC Administrator creates the Tool Consumer in openNCCC Site Admin using the same Auth login URL, Auth token URL, and Key set URL for each new tool consumer (provided by ISKME).
The openNCCC Administrator sends an email to the LMS Administrator for each college using Canvas. The email contains a link to this article and the Redirect URL, OpenID Connect Initiation URL, JWKS URL, and the Icon URL.
The LMS Administrator configures the Developer Keys for the LTI 1.3 tool for each school in Canvas, installs the tool in each Canvas account, sends each school’s unique Client ID and Deployment ID to the openNCCC Administrator, and ensures that the State button on the Developer Keys screen in Canvas is Off (red button).
The openNCCC Administrator adds the Client ID and Deployment ID to the Tool Consumer in the openNCCC Site Admin and asks the LMS Administrator to change the State button in Canvas to On (green button) and to begin testing in Canvas.
The LMS Administrator changes the State button on the Developer Keys screen in Canvas to On (green button).
The LMS admin notifies Canvas instructors of the openNCCC LTI tool name so they can add content to their courses.
Supported Browsers and Platforms
ISKME supports the LTI 1.3 tool in openNCCC in these browsers and platforms.
The LTI 1.3 tool allows any educator to browse and embed media objects alongside other content within assignments, or to select content which comprises entire modules, lessons, or units. All users can search content added to openNCCC Collections. Additionally, users can also browse or search content from Group Shared Folders and personal My Items libraries, if that content has been configured and made available.
Authentication and Account Provisioning
The tool will automatically create new openNCCC accounts for instructors if they don’t already have one, and grant instructors access to all of their college’s private openNCCC collections and all shared openNCCC collections. Account information from openNCCC is not collected or stored for student users. Instead, students have view-only access to openNCCC content that their instructors have embedded in Canvas courses.
LTI 1.3 Tool Preview Images
Below are preview images of the content provided by the LTI tool. When an instructor adds a new activity using the openNCCC LTI tool, the instructor will be able to search and browse items in their college’s Collections, their own personal saved Items, and their openNCCC Group folders. For more details, refer to Canvas: Adding openNCCC content to Courses with the LTI 1.3 Tool.
This screen shows what browsing My Collections looks like in the LTI 1.3 tool.
This screen shows what browsing My Items looks like in the LTI 1.3 tool.
This screen shows what browsing My Group folders looks like in the LTI 1.3 tool.
Getting Set Up in Canvas
LTI 1.3 must be installed by the openNCCC Administrator and the LMS Administrator. It can’t be installed by teachers or course managers. For more information about LTI 1.3’s security features, refer to Why Platforms and Tools Should Adopt LTI 1.3 by IMS Global.
Install and Configure the App in Canvas
As the LMS Administrator, your openNCCC Administrator will provide you with setup URLs and these instructions. Follow these steps to create a new LTI Tool in Canvas.
As the LMS Administrator, log in to Canvas and select Admin from the left navigation.
Click Developer Keys from the inner left navigation.
Select the blue Developer Keys button. Choose LTI Key from the dropdown menu.
On the Key Settings screen, enter the required information.
For Redirect URI, enter the value provided by your openNCCC administrator.
For Method, choose Manual Entry.
Title is the name of the LTI 1.3 tool that you will send to instructors so they can add the tool and openNCCC content to their course.
For the Target Link URI, enter the Redirect URI again.
For OpenID Connection Initiation Url, enter the value provided by your openNCCC administrator.
For JWK Method, choose Public JWK.
For Public JWKS, enter the value provided by your openNCCC administrator.
Now scroll down to Placements.
Delete Account Navigation, which is populated by default.
Begin entering Editor and then select Editor Button to add it beside Link Selection.
Select > next to Link Selection to expand the page.
In the Target Link URI field, copy and paste the Target Link URI that you entered earlier on this page.
In the Icon URI field, enter the value provided by your openNCCC administrator.
For Select Message Type, choose LtiDeepLinkingRequest.
For Text, enter the name of the openNCCC LTI tool.
Select > next to Editor Button to expand the page and enter the same values as you did for Link Selection.
Click Save below the completed Link Selection and Editor Button sections.
Send the Client ID to the openNCCC Administrator
After you save the Key Settings screen, you will go back to the Developer Keys screen. Alternatively, log in to Canvas, select Admin from the left navigation, and select Developer Keys from the inner left navigation.
Copy the Client ID from the Details column and start an email to the openNCCC administrator who will complete the setup in openNCCC. Copy the value directly above Show Key. Don't click Show Key to see and copy a longer ID. You want the shorter version. To avoid configuration errors, please email the text instead of a screenshot.
Note: The State button for the Developer Key you created should be Off (red button) until the openNCCC Administrator notifies you that the setup is complete in openNCCC. If the State button is On before the setup is complete, instructors attempting to add openNCCC content to their courses will receive the error message “Client ID not found.”
The openNCCC Administrator also needs the Deployment ID as explained in the next section in this article, so don’t send the email yet.
Install the Tool in Each Canvas Account and Get the Deployment ID
To complete this operation, you need the Client ID as explained in the previous section of this article.
Log in to Canvas, select Admin from the left navigation, and choose the appropriate account.
Select Settings from the inner left navigation.
Click to copy the shorter Client ID as explained in the previous section of this article.
Select Settings from the inner left navigation, and then select the Apps tab at the top of the screen.
Click View App Configurations.
Click + App.
Select By Client ID.
Enter the Client ID and select Submit.
Go back to the External Apps screen to get the Deployment ID for the openNCCC administrator. Select the gear icon associated with the new LTI tool, and choose Deployment ID.
Copy the Deployment ID and paste it into your email with the Client ID. Send the email to the openNCCC email.
Deploy the Tool to Instructors
After the openNCCC Administrator notifies you that the setup is complete in openNCCC, log in to Canvas, select Admin from the left navigation, and click Developer Keys from the inner left navigation.
Change the State button on the Developer Keys screen to On (green button) in Canvas. Note: A delay may occur between this State change and when the tool appears in the list of available tools for instructors to use. Test before communicating with instructors.
Send instructors the openNCCC tool name in Canvas and the openNCCC Help Center article Canvas: Adding openNCCC Content to Courses with the LTI 1.3 Tool.
Technical Documentation and Troubleshooting
Refer to LTI 1.3 Troubleshooting and Technical Documentation (for all LMSs) as a first step in supporting your users.
Refer to these articles on the openNCCC Help Center.