Skip to main content

Sync ClassLink with Linewize Filter

Updated

Syncing ClassLink provides up-to-date information about your school's students, staff, classrooms and guardians for your school’s Linewize products.

Warning

Do not turn on 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.

Before You Begin

  1. You must have access to Configuration in Linewize Filter.
  2. Note your ClassLink API details.
  3. Ensure your users’ email addresses in Linewize Filter match their email address in ClassLink.
  4. Add Classwize as an app in ClassLink.

  5. Schedule time outside school hours to complete Steps 1 and 2.

      Important

    ClassLink may take up to four hours to sync with Linewize Filter 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.

  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 Linewize Filter.
  7. 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 Linewize Filter

  Note

If you sync School data from multiple sources and want to limit the number of users synced from each provider, contact your Linewize Deployment Engineer.

  1. In Linewize Filter, 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.
Optional Advanced Configuration

Merge Identities

If you use multiple synced SIS or 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. (Optional) You can select Attach to existing users only.

Compatibility Mode

If your SIS vendor only provides the minimum implementations, you must turn on Compatibility Mode. If you’re unsure whether you need Compatibility Mode, contact Linewize Support.

  1. Select Submit. The ClassLink integration will appear in the list.
  2. Select Sync.

  Note

Linewize Filter syncs nightly depending 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 in that region 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.

Sync Details

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

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.

Exclude school

All schools are on the Included Schools list by default.

  1. In the Operations section, select Exclude Schools.
  2. Select a school to move it between the Included Schools and Excluded Schools lists.
  3. Select Submit.