Skip to main content

Sync PowerSchool with Linewize Filter

Updated

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

  Important

You can't sync data for student’s guardians from PowerSchool for Linewize Parent.

Before you begin

  1. You must have access to Configuration in Linewize Filter.
  2. To integrate PowerSchool and Linewize Filter, you need to install a Linewize plugin within PowerSchool. Contact your Linewize Success or Account Manager to get the plugin.
  3. Note your PowerSchool Endpoint URL, OAuth2 Token URL, Client ID, and Client Secret.
  4. Ensure the email addresses of your users in Linewize Filter match the email address of your users in PowerSchool.
  5. Schedule time outside school hours to complete Steps 1 and 2. PowerSchool may take up to four hours to sync with Linewize Filter for the first time.

Step 1: Configure PowerSchool for Syncing

  1. Sign in to PowerSchool.
  2. Go to System Management > Server > Plugin Configuration.
  3. Select Install.
  4. Select Choose File, then locate the downloaded Linewize plugin.
  5. Select Install.
  6. Select Register on the Plugin Registration dialog.
  7. Select OK on the Registration Results dialog.
  8. Select the Enable checkbox for the Linewize plugin.
  9. Select Enable on the Enable Plugin panel.
  10. Select the Linewize plugin link, the Linewize Plugin Setup dialog will appear.
  11. Select the Data Provider Configuration link, then copy the Client ID and Client Secret for later use.

Step 2: Integrate PowerSchool 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. Sign in to Linewize Filter.
  2. Go to Configuration > Authentication > SIS Integration.
  3. Select Add New.
  4. Select PowerSchool. The Configure PowerSchool Sync dialog will appear.
  5. Enter a Name for the PowerSchool integration.
  6. Enter https://sis.powerschool.com/api/ for Endpoint URL.
  7. Enter https://sis.powerschool.com/api/ims/oneroster/v1p1/token for OAuth2 Token URL.
  8. Enter the Client ID.
  9. Enter the Client Secret.

  10. Select the options you need to manage your users:

    Option Description
    Respect Enrolment Date

    Sync current student data and exclude any previous 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.
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 PowerSchool 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.