1. Watermark
  2. Planning & Self Study
  3. Integrations
  4. LMS Integrations

Activating Canvas

Updated
Activate the Integration
 
To use the Canvas integration, the Planning & Self-Study System Administrator must activate the integration to establish the connection with your institution's instance of Canvas. To do so, please follow these steps: 

In Planning & Self-Study, go to Admin > Integrations > Other Integrations. Click “Connect to Canvas”.
 
mceclip0.png
Connect to Canvas option.

Follow the steps as indicated to establish the connection. If you do not have administrative access to Developer Keys in Canvas, please reach out to someone who does for assistance.
mceclip1.png
Steps to connect Planning & Self-Study to Canvas.
 
Open a new tab and login to Canvas. 
mceclip0.png
Go to the Admin page and click on Developer Keys. 
Click Add Developer Key. Select the Add API Key option. 
When setting up the Developer Key for this integration in Canvas, we recommend using a Key Name of something like Watermark Planning & Self-Study Integration. 

 

Enter any Key Name and Owner Email you’d like. Paste the URI from Step 1 of canvas integration fly-out into the field called “Redirect URIs”. Click on Save the key button.

Find the key you just created. Copy the ID and Key from the Details column and paste them in Step 4 of canvas integration flyout.

Enter your institution’s canvas URL.

Click Authorize Canvas. This will open a new browser window.
After successful authorization, Canvas card will be moved to Active Integrations section.
After you've completed the developer key information, click Enforce Scopes. By default, the scopes are disabled. 
To permit usage of all "includes" parameters for this key, click Allow Include Parameters checkbox. 
Search the endpoints that are required to fetch the necessary assessment data. To search for a specific endpoint, type the name of the endpoint in the Search Endpoints field. To see all available endpoints, scroll through the Endpoints table. 
Save the API Key. 
This does not require any changes in the Planning & Self Study application. Once the scopes are enabled, we can utilize the key to make the connection to Canvas in P&SS.

Required API Endpoints

There are four API endpoints that must be selected in an API key. The below mentioned endpoints will fetch the Courses, Assignments, Rubrics, and results data from Canvas.

a. url:GET|/api/v1/courses

b. url:GET|/api/v1/courses/:course_id/assignments

c. url:GET|/api/v1/courses/:course_id/rubrics/:id

d. url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions

 

Key considerations when enabling scopes

a. All the required endpoints must be selected in the key in order to make the integration work seamlessly. The integration will not work even if one of these endpoints is missed.

b. Allow Include Parameters option must be selected in an API key. "Includes" parameters may grant access to additional data that is not included in the Endpoints table.

c. Make sure that no additional endpoints are selected other than the required ones in an API key.

 

Find the key you just created. Copy the ID and Key from the Details column and paste them in Step 4 of Canvas Integration flyout. (In Planning and Self-Study)

 

Enter your institution’s canvas URL.

 

Click Authorize Canvas. This will open a new browser window.
After successful authorization, Canvas card will be moved to Active Integrations section.
What can be integrated? 

Once the integration has been set up, users in P&SS are able to align results in a measure.

  • Users can select a course. These courses are the ones that the user has access to in their Canvas account (the credentials used for authorization). Only one course can be selected.
  • All the courses from the user’s instance in canvas will be available in P&SS through the integration.
  • Unpublished courses are also available in P&SS.
  • Outcomes created in the courses (in canvas account) cannot be accessed through integration.
  • Under the case, the assessment lead (the canvas authorized user) is not added as a teacher in the course then that course cannot be accessed through integration.
  1.  
mceclip0.png

Users in P&SS can align results from Assignment type of assessment activity.

  • Assessment activities are Assignment. Users can pull relevant assessment results as evidence. (Quizzes are not accessed through the integration).
  • Unpublished assignments are also available in P&SS.
  • User needs to add a rubric to the assignment in canvas account for it to populate in the assignment dropdown to choose an assignment.

mceclip1.png

Assessment results are fetched through integration from Canvas based on the selections made in the rubric criterion.

 

 

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

How to Contact Support
There are many ways to reach out! Click here for our support options.
Watermark Academy
Click to access the Watermark Academy for consultation, training, and implementation companion courses.