Aeries Integration Overview

Document created by Abby Adams Employee on Nov 18, 2019Last modified by Abby Adams Employee on Nov 22, 2019
Version 2Show Document
  • View in full screen mode

Canvas and Aeries developed an automated integration between the two systems for provisioning (rostering) and grade passback, utilizing APIs made available from OneRoster 1.1. OneRoster enables a bi-directional transaction to provision data to Canvas, and post grades back to Aeries. 

 

This article gives an overview of the Canvas and Aeries integration.

Integration Overview

The bi-directional OneRoster integration breaks down as follows:

  1. Provisioning: a one-way transfer from your SIS's OneRoster 1.1 API to Canvas. As you make changes to users, courses, enrollments, ect. in your SIS, those changes will be reflected in Canvas with your nightly sync. 
  2. Grade passback (GPB): a one-way transfer from Canvas to your SIS using OneRoster 1.1 API. As you make changes to your grades and assignments in Canvas, those changes will be sent to your SIS when synced from the Canvas gradebook. OneRoster provisioning is required for GPB functionality.

Supported Objects

Provisioning:

  • Staff
  • Students
  • Sub-accounts
  • Terms
  • Courses
  • Sections
  • Enrollments

 

GPB:

  • Graded Assignments
  • Graded Quizzes
  • Graded Discussions
  • Assignment-level scores (grades) 

Aeries Integration Prerequisites 

  1. Request your OneRoster 1.1 credentials from Aeries. Your OneRoster credentials (API URL, client key, and client secret) should be sent to us securely via a Canvas-provided link. 
  2. Once our team receives your OneRoster 1.1 credentials, we will check our ability to connect.
  3. If you are converting from one SIS to another, or are transitioning from from a different integration, our team will need to perform an evaluation against your data. Our team will let you know if we have concerns about converting.

Known Aeries Integration Limitations

Time-based gradebook linking (1) in Aeries is supported for Canvas grade passback. However, linked course gradebooks (2) in Aeries are not supported for Canvas grade passback. 

  1. Supported Example: Linking a Fall and Spring semester gradebook for the same Biology course in Aeries would allow grade passback from Canvas to Aeries. 
  2. Not Supported Example: Linking a Biology course gradebook with an English course gradebook in Aeries will not allow grade passback from Canvas to Aeries. 

Next Steps

If you are interested in enabling the Aeries Integration for provisioning, please contact your Customer Success Manager (CSM) for consideration. 

Additional Resources

Attachments

    Outcomes