Canvas Data Integration

Note: The developer key must be set up at Canvas root level. If you wish to integrate to a specific Canvas subaccount, you will be able to select which subaccount the account should use.

Configuring the Data Integration:

1. Login to Canvas as Canvas administrator. 
2. Navigate to top level account

3. In the left navigation, click on “Developer Keys”

4. Click on “+ Developer Key” -> “+ API Key”
5. Fill out the Key Name, Owner Email, and Redirect URIs. 
   
   - The Key Name field is freeform so you can name it whatever you wish.  We suggest giving it an intuitive name like CES Key or something similar.
   - The Owner Email should be the email of the user creating the key.
   - The Redirect URIs field should be configured using your CES URL in the the following formula: <customer CES domain>/Canvas/AuthenticateDataSettings (For example, if your CES URL was school.evaluationkit.com you would configure and paste: https://school.evaluationkit.com/Canvas/AuthenticateDataSettings)

NOTE: For institutions that have multiple CES account (not common) you can add multiple URLs in the Redirect URIs field.  Each URL would be on a separate row:

6. Enable the Enforce Scope slider.
   
7. Enable all the needed endpoints shown below:
   

   url:GET|/api/v1/accounts

   url:GET|/api/v1/manageable_accounts

   url:GET|/api/v1/accounts/:id

   url:GET|/api/v1/accounts/:account_id/courses

   url:GET|/api/v1/accounts/:account_id/roles

   url:GET|/api/v1/accounts/:account_id/sub_accounts

   url:GET|/api/v1/accounts/:account_id/terms

   url:GET|/api/v1/accounts/:account_id/users

   url:GET|/api/v1/calendar_events

   url:POST|/api/v1/calendar_events

   url:DELETE|/api/v1/calendar_events/:id

   url:GET|/api/v1/conversations

   url:POST|/api/v1/conversations

   url:GET|/api/v1/courses/:id

   url:PUT|/api/v1/courses/:course_id/assignments/:id

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

   url:POST|/api/v1/courses/:course_id/assignments

   url:PUT|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id

   url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id

   url:GET|/api/v1/courses/:course_id/calendar_events/timetable

   url:POST|/api/v1/courses/:course_id/calendar_events/timetable

   url:GET|/api/v1/courses/:course_id/enrollments

   url:GET|/api/v1/courses/:course_id/external_tools

   url:POST|/api/v1/courses/:course_id/external_tools

   url:DELETE|/api/v1/courses/:course_id/external_tools/:external_tool_id

   url:GET|/api/v1/courses/:course_id/external_tools/:external_tool_id

   url:PUT|/api/v1/courses/:course_id/external_tools/:external_tool_id

   url:GET|/api/v1/courses/:course_id/groups

   url:GET|/api/v1/courses/:course_id/sections

   url:GET|/api/v1/groups/:group_id/memberships

   url:GET|/api/v1/sections/:section_id/enrollments

   url:GET|/api/v1/users/:id

   url:GET|/api/v1/users/:user_id/profile

8. Click Save
9. Copy “Client Id”. You will need to paste this in CES in a later step

10. Click on “Show Key” and then copy the key. You will need to paste this in CES in a later step

11. Log in to CES as CES Admin
12. Navigate to Account -> Integrations > Canvas
13. If you have a previous setup of the Canvas data integration, you need to click on “Clear Settings” button before continuing.  New setups can ignore this step.
14. This will have a new option to enter Key. Please see the screenshot below. Now enter Client ID and Key from steps 9 and 10. And “Save” the settings

15. Once saved, a new section entitled API Access Token will appear.  In that section, click the “Create Access Token” button. This will redirect you to Canvas login page
    
16. Click on “Authorize” button
    
17. You are now ready to click Test Connection to test the data integration. You should receive a message at the bottom of the page indicating the connection Test Passed. If you receive a failed message, please review the previous steps and contact our Support Team by clicking Submit A Request for additional help, if necessary.
18. Under the Canvas Main Account section, select which level of the Canvas structure you wish to be integrated with to this account.  For example, if you wish to include all courses at your institution (more common) then you would choose the root level.  If you only wish to include courses from a specific Canvas subaccount (less common) then you would select that level instead.
    
19. If your institution has multiple CES accounts integrated to Canvas subaccounts (not common), you would use the same “Client Id” and “Key” in the subaccount setup and then select the level that aligns to that specific CES account.

Canvas Course Roles

1. The Canvas Course Roles feature allows you to choose whether to import course enrollments using only the standard Canvas course roles (Designer, Observer, Student, TA, and Teacher) or to also include custom roles created by your organization.

NOTE: Using the second option, Standard and Custom Canvas Course Roles requires the Manage Permissions permission in Canvas, assigned to the Canvas Admin account that generated the access token. See Required Permissions for Canvas Administrator Account to Generate Access Token section above.

Additionally, Custom Canvas Course Roles must be setup at the same Canvas sub-account as the integration if you wish to import users assigned a custom role.

 

Account Hierarchy Import

1. The Account Hierarchy Import feature allows you to import your Canvas account structure as your Course Evaluations & Surveys account hierarchy. The Canvas account structure imported is restricted to the level where the access token is generated, including its sub-accounts. Once imported, manual changes can be performed, but it is not recommended as this can risk creating duplicate hierarchy levels, and in turn, present course misalignment to levels in your hierarchy.

NOTE: The Canvas Account Hierarchy Import feature is not enabled by default on Course Evaluations & Surveys Accounts. If you are in implementation, please work with your Implementation Team to have this enabled.  If you are not in Implementation, please contact our Support Team by clicking Submit A Request to determine if this feature is right for your institution. The Canvas Account Hierarchy Import functionality is intended for Canvas institutions just coming on board with Course Evaluations & Surveys, and should not be utilized if you already have a hierarchy in place in Course Evaluations & Surveys. Also, to note, when initially creating the hierarchy structure, it's best to choose one path or the other, meaning that if you don't necessarily want to mirror the structure that's in Canvas, then manually creating the hierarchy in Course Evaluations & Surveys from the ground up would be the cleanest approach.

 

Gradebook Settings

1. Gradebook Settings allows the CES Administrator to enable the Canvas Gradebook feature at the Project-level. At the Project-level, the Canvas Gradebook feature provides the ability for either the CES Administrator or course Instructor to assign a specific number of points for completed surveys, and then automatically have a Gradebook item generated (column name is the Project name) along with the corresponding points added for each student who has completed a specified survey.

 

FIELD ALIGNMENT

Below is a map of the fields in Canvas and how they align to the fields in CES: