Canvas Integration Guide

Tiffany Winters

Modified on: Wed, Apr 16, 2025 at 4:33 PM

Overview

During the Assessment implementation, your Project Manager will work with your team to set up the Canvas integration.

Institution provides your Project Manger with your Canvas Install URL.
If hosted by Instructure, the install URL will look something like https://example.instructure.com
Coursedog will configure this URL in the web-app under #/int/global-settings/connection-configuration and in the OAuth Configuration.
Institution must also create and Provide Coursedog with a Canvas OAuth Client ID and Client Secret.
- This is necessary to whitelist Coursedog to authenticate against the institution’s LMS.
- Once this is provided, institution may proceed to the OAuth2 Connection Flow.
- External Documentation:
  - OAuth Client ID and Client Secret [External Canvas Documentation]
  - How To Manage Developer Keys for an Account [External Canvas Documentation]
Institution may also choose to provision a Coursedog LMS user and give us the username and password to the account, to be used in the OAuth connection flow.This is not necessary if the institution has a different LMS user (such as a specific administrative account) they would like to authorize the Coursedog application via.

Navigate to the OAuth Integration settings. These can be found under The Integrations Hub Administration OAuth Settings (/#/int/settings/oauth).
Enter the Canvas Install URL, Client ID, and Client Secret as identified in step one below.

Click “Connect”. You will get redirected to the Institutional Authorization Page, where a school ITS user needs to complete authorization by logging in as an authorized user.
- As specified in “Client Pre-requisites”, this may either be the Coursedog-specific user or Administrative user that the institution wants to authorize on the behalf of the Coursedog integration.
- It is important that the authorizing account has access to course data that the institution wants to integrate with Coursedog; otherwise, Coursedog will not be able to retrieve that data!

After authorizing, an automatic redirect should bring you back to the Integration Page, showing successful connection. If something fails, you will see an error instead.

After a measure has been created within an Assessment Plan, navigate to the measure you want to add results to and click “+ Add Results”.

Select the source from where you want to import assessment results from (Canvas).

When an LMS integration is not connected, a note redirecting the user to the appropriate settings page should appear.

Both Course and Assignment fields are live, server-searched data based on user queries.
Select which data source in an assignment you want to import: “overall rubric score” or “individual rubric line score”. This will then base the imported data on this selection.

Provide the threshold score for this measure. This should be the minimum score, as defined on the measure target, that an individual student should attain in order to be considered having met the learning outcome.
The imported results are then aggregated into two categories: met and notMet.

Select an individual rubric criteria for grading the submission.
Then, select from that assignment’s rubric’s criteriaRatings which criteria ratings correspond to which outcome achievement levels.
- Not Approached
- Not Met
- Met
- Exceeded

You should then see a list of the final counts-per-criteria-level.
If an assignment was not graded on a rubric, it will be skipped in this data aggregation, and you should verify in Canvas if this is expected.