Skip to main content

Sync OneRoster with Linewize Filter

Updated

This article is for IT Support. 

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

This article describes how to automatically sync OneRoster with Linewize Filter.

Before you begin

  1. Note your OneRoster Endpoint URL, Client ID, and Client Secret.
  2. Ensure your users’ email addresses in Linewize Filter match their email addresses in OneRoster.
  3. Assign a user role (Guardian, Parent, Relative) and add an email address for each parent. Without these, the parent will not sync with Linewize Filter and won’t have access to Linewize Community or Qustodio.
  4. Schedule time outside school hours to complete Step 1. OneRoster may take up to four hours to sync with Linewize Filter for the first time.

Step 1: Configure OneRoster for syncing

  1. In Linewize Filter, go to Configuration > Authentication > SIS Integration.
  2. Select Add New.
  3. Select OneRoster. The Add OneRoster Sync dialog will appear.
  4. Select your SIS from the Which SIS would you like to integrate? dropdown. If your SIS vendor is not listed, select Other.
  5. Enter a Name for the OneRoster integration.
  6. Enter the Endpoint URL. This is your OneRoster server's root URL. Read OneRoster Endpoints for more information.
  7. [Optional] Enter the OAuth2 Token URL. This token is found in your SIS.
  8. Enter the Client ID. This is the username that can be found in your SIS.
  9. Enter the Client Secret. This is your password that can be found in your SIS.
  10. 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 don’t want to sync classrooms and classroom relationships.

Respect Enrolment Date

Sync the 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 parent data. This will sync the parent 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.

If you use multiple synced directories that contain the same users, the Merge configuration defines how to combine users so they’re treated as a single user on the Linewize platform.

  1. For Merge Priority, enter a value lower than your primary provider.
  2. In the Merge Key dropdown, select:
    • Email - If the user’s email address in each directory is the same (case sensitive).
    • Email Without Domain - If the domain is different in each directory.
  3. Select Submit. The OneRoster integration will appear in the list.
  4. Select Sync.

  Note

You only need to manually start the first sync. OneRoster will sync automatically on a set schedule (see Scheduled OneRoster sync ). Sync Details will show whether the sync was successful or failed.

  1. To see the sync detail, select View log. 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. Contact Linewize Support with the error code for help.
    • A failed sync will display an error code. Contact Linewize Support with the error code for help.

  Warning

If you have multiple schools in your SIS and some of them have incomplete data sets, this may result in a sync failure or a partial sync. You can select Exclude Schools to exclude those schools from the sync.

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

  Note

All schools are on the Included Schools list by default.

  1. Select Submit.

  Note

Linewize Filter syncs nightly based on your region.

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

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