Set Up Canvas Connector

Before setting up the Canvas Connector, make sure you have the required credentials and administrator access.

• You need administrator access in Schoolbox.
• You need your school's Canvas base URL.
• You need your Canvas Data 2 Client ID.
• You need your Canvas Data 2 Secret.
• You only need a Canvas Bearer Token if you plan to synchronise Canvas announcements or use Canvas API features.

Important: The Canvas URL should be the base URL of your Canvas instance. For example, https://school.instructure.com.

Configure the Canvas connection details before enabling optional synchronisation features.

1. Go to Administration > System Settings > Canvas Connector.
2. Enter the following details:
   • Canvas URL: your school's Canvas base URL.
   • Canvas Data 2 Client ID: your Canvas Data 2 client ID.
   • Canvas Data 2 Secret: your Canvas Data 2 secret.
   • Canvas Bearer Token: optional, used for Canvas announcements and other Canvas API features.
3. Select Save.

Schoolbox uses the Canvas URL together with the Canvas Data 2 credentials to connect to Canvas and synchronise assessment data.

Important: Assessment synchronisation requires both the Canvas Data 2 Client ID and Canvas Data 2 Secret.

Configure which assessment information Schoolbox imports from Canvas.

1. Enable Import Basic Quiz Data From Canvas if you want Canvas quizzes imported into Schoolbox.
2. Select an Imported Quiz Default Work Type to categorise imported quizzes.
3. Enable Import Grades From Canvas if you want grades synchronised from Canvas.
4. Select the Schoolbox Grade Group That Canvas Letter Grades Are Mapped To.
5. Select Save.

Schools can independently enable quiz imports and grade synchronisation depending on their assessment workflow.

Configure how Schoolbox matches Canvas courses to Schoolbox classes during synchronisation.

1. Enter a value for SIS Source ID Template.
2. Use the available placeholders to match your Canvas SIS Source IDs:
   • {folderCode}
   • {parentCode}
   • {folderName}
   • {year}
3. Select Save.

Example templates include:

• {parentCode} {folderCode}
• {folderCode}{parentCode}
• {folderCode}_{parentCode}

Enable news synchronisation if you want Canvas announcements imported into Schoolbox News.

1. Turn on Sync News.
2. Select a Schoolbox News Topic.
3. Select a Schoolbox News Owner.
4. Select Save.

News synchronisation requires a valid Canvas Bearer Token, a configured news topic, and a news owner.

Redirect users from Schoolbox to the corresponding content in Canvas.

1. Turn on Redirect from Assessments to open Canvas assessments and quizzes.
2. Turn on Redirect from Homepages to open Canvas course homepages.
3. Select the appropriate option for Redirect homepage to:
   • course code
   • subject code
   • subject code from section
4. Select Save.

Assessment redirects require the Canvas URL, Canvas Data 2 Client ID, and Canvas Data 2 Secret to be configured.