Use Canvas Assessment Synchronisation

Canvas Assessment Data Sync

Are you sure you want to remove this component?

Canvas Assessment Data Sync imports the Canvas account hierarchy, courses, sections, enrolments, published assignments, available Classic Canvas quizzes, grades and feedback into Schoolbox.

The main import normally runs once each morning, between approximately 7:00 am and 8:00 am server time. Saving the Canvas Connector settings does not start an immediate import.

Canvas is the source of truth for connector-managed records. Synchronisation can create, update, move or delete corresponding Schoolbox folders, courses, units, classes, assessments, plans, participants and feedback. Manual changes to managed Schoolbox records may therefore be overwritten by a later import.

Core Data Requirements

Are you sure you want to remove this component?

Canvas data must be matched to Schoolbox before assessment information can be imported.

  • The Canvas Data 2 Client ID and Secret must be configured.
  • Canvas course-section SIS IDs must match the value generated by the Schoolbox SIS Source ID Template.
  • The Schoolbox class folders must contain the folder codes, parent codes, names or year values used by the template.
  • The Canvas course must be in the available or completed state and its enrolment term must not have ended.
  • The Canvas sis_user_id for each student or teacher must equal that user's external ID in Schoolbox.

If the course cannot be matched, its assessments are not imported. If a user cannot be matched, Schoolbox cannot reliably create that participant, marker, grade or feedback record.

Assessment Data Mapped to Schoolbox

Are you sure you want to remove this component?

Schoolbox maps Canvas data as follows:

  • Canvas accounts become the Schoolbox faculty and course folder hierarchy.
  • Canvas courses become Schoolbox course and unit specifications.
  • Canvas course sections become course or unit classes.
  • Published Canvas assignments become Schoolbox Due Work.
  • Available Classic Canvas quizzes can become basic Schoolbox quizzes when quiz import is enabled.
  • Assignment overrides and enrolments become plans, participants and markers.
  • Graded submissions and submission comments become marks and feedback when grade import is enabled.

Assignment titles, descriptions, due and availability dates, submission settings and maximum marks are imported. Maximum marks above 999 are limited to 999 in Schoolbox.

Schoolbox matches a Canvas assignment-group name to a Schoolbox work type with the same name. If none matches, it uses the configured Imported Quiz Default Work Type where applicable.

Quiz and Grade Imports

Are you sure you want to remove this component?

Canvas quizzes and grades are imported when their connector settings are enabled.

  • Import Basic Quiz Data From Canvas creates a basic Schoolbox quiz representation for each available Classic Canvas quiz. It does not reproduce the complete Canvas quiz.
  • Imported Quiz Default Work Type is the numeric Schoolbox work type ID used when Schoolbox cannot match a Canvas assignment-group name.
  • Import Grades From Canvas imports graded submissions, marks and feedback comments.
  • Schoolbox Grade Group That Canvas Letter Grades Are Mapped To is the numeric Schoolbox grade group ID used to map Canvas letter grades.

Feedback is not imported unless grade import is enabled.

Course Matching Behaviour

Are you sure you want to remove this component?

Schoolbox first imports the Canvas account and course hierarchy, then matches Canvas course sections to Schoolbox classes using the configured SIS Source ID Template.

The template can use folder codes, parent folder codes, folder names and the current year. Schoolbox removes a campus prefix from {folderCode}. If {parentCode} is empty, a four-digit year in the parent folder name is used as the fallback.

If the generated value does not exactly match the Canvas course-section SIS ID, assessment data for that class is not imported. Canvas News uses a separate course-code and year-suffix match and does not use this template.

Canvas Integration Help Navigation

Are you sure you want to remove this component?

Troubleshoot Assessment Synchronisation

Are you sure you want to remove this component?

If Canvas data is not appearing in Schoolbox, open Administration > System Settings > Canvas Connector and check Previous Imports first.

  • Review the latest Download entry for Canvas Data 2 credential or download errors.
  • Review the latest Sync entry for matching or import errors.
  • For news, review the latest Announcements entry and confirm the bearer token, topic ID and owner ID.
  • Confirm the Canvas course state and enrolment-term end date are eligible for import.
  • Confirm the SIS Source ID Template produces the exact Canvas course-section SIS ID.
  • Confirm Canvas user SIS IDs equal the corresponding Schoolbox external IDs.
  • Confirm the required quiz or grade setting is enabled.

Each process retains its five most recent entries, including status, duration and errors. If the cause is still unclear, provide those details to Schoolbox Support.