Sync ClassLink with School Manager

Your Linewize products need up-to-date information about your school's students and teachers. Some products and features also require information about classrooms or students’ guardians. The best way to provide this information is to sync a SIS (Student Information System) with School Manager.

This article describes how to automatically sync ClassLink with School Manager.

Before You Begin

1. Note your ClassLink API details.
2. Ensure your users’ email addresses in School Manager match their email address in ClassLink.
3. Add Classwize as an app in ClassLink.
4. Schedule time outside school hours to complete Steps 1 and 2.
   
   

   Important

   ClassLink may take up to four hours to sync with School Manager for the first time.

Step 1: Configure ClassLink for Syncing

1. Sign in to ClassLink as an Administrator.
2. Select the Roster Server icon in the bottom panel.

Image 1: Select Roster Server on the ClassLink Administrator Dashboard.

3. Select the Apps tab.
4. Find Linewize Classwize Class Import.
5. Select the More Actions icon on the right.

   
   Image 2: Select the More Actions icon on the Apps tab in Roster Server.

6. Select API on the left menu.
7. Select the API Credentials tab on the main panel.
8. The Key and Secret on the main panel will be your Client Key and Client Secret when integrating ClassLink in School Manager.
9. Copy the Endpoint URL at the bottom left.

Image 3: Note the required Key, Secret and Endpoint URL in the API Credentials page.

Step 2: Integrate ClassLink with School Manager

1. 1. In School Manager, go to Configuration > Authentication > SIS Integration.
   2. Select Add New.
   3. Select ClassLink. The Add ClassLink Sync dialog will appear.
   4. Enter a Name for the ClassLink integration.
   5. Enter the Endpoint URL. This is the URL of the root of the ClassLink server.
   6. Enter the Client ID. This is the username for your school’s SIS.
   7. Enter the Client Secret. This is your password for your school’s SIS.
   8. Select the options you need to manage your users:
      

      Option	Description
      Sync Classroom Data	Sync Classroom Data is turned on by default. Only turn it off if you do not want to sync classrooms and classroom relationships.
      Respect Enrolment Date	Sync current student data and exclude students who have already left the school. Note If you don’t select this option, all existing student data will be synced.
      Respect Academic Sessions	Sync current classroom data. Academic sessions are classrooms that belong to the current term, semester, or school year. Note Not selecting this option will sync all active classrooms, regardless of the year or the date range they run in.
      Sync Parent Data	Select this option if you wish to sync guardian data. This will sync the guardian's contact details and their relationship with the students with our systems. Select a Relationship Type from the dropdown. Available options are Parent, Relative, and Guardian.

   9. Select Submit. The ClassLink integration will appear in the list.
   10. Select Sync.
       
       

       Note

       You only need to manually start the first sync. ClassLink will then sync automatically on a set schedule (see Scheduled ClassLink sync).

   11. Sync Details will show whether the sync was successful or failed.

   12. To see the sync detail, select View log.

       Sync Details will appear.

       1. A successful sync will display the number of Unmatched Users, Matched Students, Matched Teachers, and Imported Classes.

       2. A partial sync will display an error message advising why the sync was only partially successful. Contact Linewize Support with the error code for help.

       3. A failed sync will display an error code. Contact Linewize Support with the error code for help.

   13. Sync may fail or partially sync if you have multiple schools in your SIS and some schools in your SIS have incomplete datasets. You can select Exclude Schools to remove those schools from the sync.

   14. Select a school to move it between Included Schools and Excluded Schools lists.

       Note

       All schools are on the Included Schools list by default.

   15. Select Submit.

Important: Scheduled ClassLink sync

ClassLink syncs with School Manager nightly in your region.

• US/NZ region: syncs start at 6 PM US Central Time (UTC-5).
• AU region: syncs start at 6 PM Australian Western Standard Time (UTC+8).
• UK region: syncs start at 6 PM UTC.

A device's sync may start any time between 6 PM in that region to 24 hours later, depending on previous sync times from other devices. You can manually run a sync to propagate changes before the automatic sync period.