OneRoster

Student Information Systems (also known as Student Management Systems) are employed by many schools to track student information and coordinate communication between teachers and staff. Many SIS use a roster data standard called OneRoster. If your SIS uses OneRoster, it can be configured to work with Surpass Cloud so that any changes made to a student record in the SIS is reflected in their patron record within Surpass.

Setup

OneRoster configuration can be found under Settings: Patrons: OneRoster. You will be prompted to add in host credentials, such as Host, OAuth URL, Client ID, and Client Secret. If you do not know these details, please contact your SIS.
Note: The OAuth URL is used to authenticate the system's connection to your SIS. In most cases, this can be left blank and the system will autofill the correct address. However, if your patron data is coming from a different endpoint, you will need to specify the location here.

Sync

Select sync schedule option. If Recurring Schedule is selected, the schedule will need to be set.

Mappings

Once OneRoster host credentials have been added, you can map fields between the SIS and Surpass. All found mapping fields must be configured. The fields to map are:

• Grade to Patron Type
• Org to Location
• Role Mapping
• Identity Mapping

Fields to Update

Select what fields you want to update in surpass side when synchronization occurs. Name, Email, and Grade are mandatory.

Execution

If the Recurring schedule option has been selected, the synchronization between systems will occur automatically per the schedule you have set. If using the On Demand option, you can manually perform synchronization by going to Patrons > Import > Patrons and selecting OneRoster from the dropdown menu.

Even if you have selected recurring schedule you can still perform on demand sync from patron import page.