Set Up Canvas Connector

Before setting up the Canvas Connector, confirm the following requirements:

• The Canvas integration is enabled for your Schoolbox site and you have Schoolbox superuser access.
• A faculty or course root homepage is configured in Schoolbox.
• Your Canvas instance has exactly one root account.
• Schoolbox class folder codes and user external IDs are populated and aligned with the corresponding Canvas SIS IDs.
• You have your school's Canvas base URL, for example https://school.instructure.com.
• You have a Canvas Data 2 Client ID and Canvas Data 2 Secret from Canvas Identity Services. The secret is shown only when it is created, so store it securely.
• If synchronising announcements, you also have a Canvas API bearer token.

For help creating Canvas Data 2 credentials, see the Canvas Data 2 getting-started documentation.

Configure the Canvas connection before enabling optional imports.

1. Go to Administration > System Settings > Canvas Connector.
2. Enter the following details:
   • Canvas URL: your school's Canvas base URL. Schoolbox uses this URL for Canvas links, announcements and redirects; it is not the Canvas Data 2 authentication endpoint.
   • Canvas Data 2 Client ID: the client ID issued through Canvas Identity Services.
   • Canvas Data 2 Secret: the secret paired with that client ID.
   • Canvas Bearer Token: required only for announcement synchronisation. The token user must be able to view announcements in every course being imported, with access to GET /api/v1/announcements and GET /api/v1/users/:id.
3. Select Save.

Saving stores the settings but does not validate the credentials or start a synchronisation. Confirm the connection by reviewing Previous Imports after the next scheduled run.

Configure the optional quiz and grade imports.

1. Enable Import Basic Quiz Data From Canvas to represent available Classic Canvas quizzes as basic Schoolbox quizzes.
2. In Imported Quiz Default Work Type, enter the numeric Schoolbox work type ID to use when no exact Canvas assignment-group name matches a Schoolbox work type.
3. Enable Import Grades From Canvas to synchronise grades and feedback from Canvas.
4. In Schoolbox Grade Group That Canvas Letter Grades Are Mapped To, enter the numeric Schoolbox grade group ID used for Canvas letter grades.
5. Select Save.

These work type and grade group settings require Schoolbox IDs rather than names. Contact Schoolbox Support if you cannot identify the correct IDs for your site.

The SIS Source ID Template controls how Canvas course-section SIS IDs are matched to Schoolbox classes.

1. Enter a template using one or more of these placeholders:
   • {folderCode} — the Schoolbox folder code, with any campus prefix removed.
   • {parentCode} — the parent folder code. If none is set, Schoolbox uses a four-digit year found in the parent folder name.
   • {folderName} — the Schoolbox folder name.
   • {year} — the current year.
2. Select Save.

Example templates include {parentCode} {folderCode}, {folderCode}{parentCode} and {folderCode}_{parentCode}.

Schoolbox imports Canvas courses in the available or completed state when their enrolment term has not ended. Canvas users are matched separately: each Canvas sis_user_id must equal the user's external ID in Schoolbox.

Enable news synchronisation to import published Canvas announcements into Schoolbox News.

1. Turn on Sync News.
2. In Schoolbox News Topic, enter the numeric ID of the Schoolbox news topic for imported announcements.
3. In Schoolbox News Owner, enter the numeric Schoolbox user ID to use when the Canvas author cannot be matched.
4. Select Save.

News synchronisation requires a valid Canvas bearer token and a successful Canvas Data 2 course import. It matches a Canvas course code ending in the current or next year to the remaining Schoolbox folder code; the SIS Source ID Template is not used for news.

Only published announcements are imported. An announcement is imported once, so later edits or deletions in Canvas are not reflected in Schoolbox. A matched Canvas author becomes the Schoolbox owner; otherwise the configured default owner is used.

Configure links from Schoolbox to matched content in Canvas.

1. Turn on Redirect from Assessments to add a View in Canvas action to matched assessments and quizzes. This does not automatically redirect the Schoolbox assessment page.
2. Turn on Redirect from Homepages to automatically open matched Canvas course homepages.
3. Use Redirect homepage to to choose how Schoolbox locates the Canvas course:
   • course code
   • subject code
   • subject code from section
4. Select Save.

Redirects are available to staff and students, not parents, and rely on Canvas course data already imported into Schoolbox. If no match is found, the user remains in Schoolbox.