Integrating ClassLink

This guide is for IT support.

You can integrate ClassLink SIS (Student Information System) with School Manager to automatically sync and authenticate your students, teachers, parents and classrooms.

Warning

Do not enable Classlink’s DataGuard on any fields for your Linewize products without contacting Linewize support first. Enabling DataGuard may prevent your Linewize solutions from working as needed.

Parents and Guardians

We use the term "parent" to include guardians and other legal custodians. Linewize is not responsible for resolving disputes between parents, schools and school staff.

Important

ClassLink automatically syncs with School Manager twice a week based on the device's region. The syncs occur in a 24-hour window that starts on Tuesday and Friday nights in that region, along with other SIS and Google Classroom syncs.

  • In the US/NZ region, syncs start at 6 PM US Central Time (UTC-5).
  • In the AU region, syncs start at 6 PM Perth Time (UTC+8).
  • In the UK region, syncs start at 6 PM UTC.

You can manually run a sync if you need to propagate changes before the automatic sync period.

Before You Begin

  1. Ensure the email addresses for your users in School Manager match the email address for your users in ClassLink.
  2. You’ll need to add Classwize as an app in ClassLink.
  3. Allow sufficient time for the sync to complete. ClassLink syncs may take longer than expected, with some taking up to four hours or more to finish. We recommend scheduling the sync outside of school hours to prevent disruptions.

Find ClassLink API Details

To link your ClassLink to School Manager, you’ll need your ClassLink API Details. 

  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.

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

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

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


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

Integrating ClassLink

  1. Go to Configuration > Authentication > SIS Integration.
  2. Select Add New.
  3. Select ClassLink. The Add ClassLink Sync dialog will appear.


Image 4: Select ClassLink to add it as a new SIS integration

  1. Select your school’s SIS from the Which SIS would you like to integrate? dropdown. PowerSchool, Ellucian, eSchoolPlus, Illuminate Education, and Unit4 are available options.
  2. Enter a Name for the ClassLink integration .
  3. Enter the Endpoint URL. This is the URL of the root of the ClassLink server.
  4. Enter the Client ID. This is the username for your school’s SIS.
  5. Enter the Client Secret. This is your password for your school’s SIS.
  6. [Optional] Sync Classroom Data is turned on by default. Leave this option turned on unless you do not wish to sync classrooms and classroom relationships.
  7. [Optional] Select Respect Enrolment Date to only sync current student data (excludes any previous students that have already left the school). If you don’t select this option, all existing student data will be synced.
  8. [Optional] Select Respect Academic Sessions to only sync current classroom data. Academic sessions are classrooms that belong to the current term, semester, or school year.
  9. [Optional] Select Sync Parent Data if you wish to sync parent data. This syncs the parent contact details. and their relationship with the students with our systems.
  10. Select Submit. The ClassLink integration will appear in the list.
  11. Select Sync.
  12. The Sync Details will show whether the sync succeeded or failed.
  13. To see the sync detail, select View Log.

SIS Interface Sync Statuses view log.png

Image 5: Sync details will show after the sync has finished

The Sync Details will appear. 

  • A successful sync will display the number of Unmatched Users, Matched Students, Matched Teachers, and Imported Classes.
  • A partial sync will display an error message advising why the sync was only partially successful. Please contact Linewize Support with the error code for help.
  • A failed sync will display an error code. Please contact Linewize Support with the error code for help.
  1. Sync may fail or partially sync if you have multiple schools in your SIS if some of the schools in your SIS have incomplete datasets. You can select Exclude Schools to remove those schools from the sync.
  2. Select a school to move it between Included Schools and Excluded Schools lists. All schools are on the Included Schools list by default.
  3. Select Submit. 

Important

If you have unmatched users, ensure the email address for the users in School Manager matches those in ClassLink. If you still have unmatched users after verifying email addresses, contact Linewize Support.

Resetting the Integration

Resetting clears the last sync date stored in the database to appear as if it has never been synced.

  1. To do a complete sync reset, select Reset.
  2. A confirmation window will appear. Select the I Understand checkbox and select Yes, Reset.

Editing the Integration

  1. To edit the details, select Edit.
  2. The Edit ClassLink Sync dialog will appear to edit the details, when complete select Submit.

Note

You will need to sync again after editing the details.

Deleting the Integration

Warning

Deleting the integration will not remove the students, teachers, or classrooms from School Manager. Users can still log in and use the school's network, but any updates to the users and groups within the SIS will not synchronize with School Manager.

  1. To delete the integration, select Delete.
  2. A confirmation window will appear. Select the I Understand checkbox and select Yes, Delete.
      1.  

 

Was this article helpful?
1 out of 1 found this helpful
Share

Comments

0 comments

Please sign in to leave a comment.