How to deploy School Data Sync by using OneRoster® 1.1 API

OneRoster® is an Industry Standard format for exchange of Student Information System (SIS) data, and the OneRoster® REST APIs are the means by which we can sync objects from Student Information Systems that provide OneRoster® APIs to O365 through the School Data Sync (SDS) service. Using this sync method, you can connect directly to your SIS using the REST-based OneRoster 1.1 APIs provided by the SIS, and synchronize data directly instead of using CSV files. To set up SDS using the OneRoster® Sync method, follow the instructions detailed in this article.

In this topic:

Prerequisites

Before you start synchronizing with SDS using the OneRoster® Sync method, read the Overview of School Data Sync and make sure you meet the following prerequisites:

  • An Office 365 for Education tenant

  • Global Admin Permissions

Note

The data that you provide through School Data Sync may be accessible to third-party application providers through their apps, so you should sync only the data that you want to make available to these third parties.

Watch the Video

SDS Access and First Time Login

  1. To access the School Data Sync Admin Portal launch a private web browser, navigate to sds.microsoft.com, and then sign in using your O365 Global Admin account.

Create a Sync Profile and Sync your SIS Data

  1. After logging in, click +Add Profile in the left hand navigation pane to create a Sync Profile.


    how-to-deploy-SDS-using-CSV-files.PNG

  2. On the Choose Connection Type page, choice OneRoster API and then choose your SIS integration provider from the “Choose your provider” drop-down menu. Once complete, click Start.

    how-to-deploy-SDS-using-oneroster-sync-1.PNG

  • Name this profile - Enter a name for your sync profile. This name will be used to identify the sync profile in the SDS Dashboard, and cannot be changed once the profile setup is complete.
  • Choose your sync method - Choose between the available sync methods shown. If you're syncing using OneRoster, select Connect via an API sync method, and then select OneRoster 1.1 API for the service selection.
  1. On the Sync Options page, select the appropriate option to create new users or sync existing users. Then complete your selections on the page as appropriate.
    how-to-deploy-SDS-using-oneroster-sync-2.PNG
  • Existing Users - Select this option if you already have user accounts create within your O365 tenant for each of the students and teachers contained within OneRoster.
  • New Users - Select this option if you want SDS to create user accounts for each of your students and teachers contained within OneRoster.
  • Web Access URL - This is the internet accessible URL for the OneRoster Endpoint of your SIS.
  • client Id - This is the OAuth consumer key for authenticating with the OneRoster endpoint of your SIS.
  • client secret - This is the OAuth consumer secret for authenticating with the OneRoster endpoint of your SIS.
  • When does your school year end? - Select the end year of the school year that you want to sync. For example, if you would like to sync 2017-2018 school year, select “2018”. By default, this syncs all the terms in the selected school year. After the profile is created, you can edit the sync profile to select a subset of terms to sync.
  • School properties - These are the school attributes contained within OneRoster that SDS can sync. The greyed out attributes are the required attributes, and must be present in OneRoster for each school to sync. The additional attributes shown are optional, and can be synced if you choose.
  • Section Properties - These are the section attributes contained within OneRoster that SDS can sync. The greyed out attributes are the required attributes, and must be present in OneRoster for each section to sync. The additional attributes shown are optional, and can be synced if you choose.
  • Sync option for Section Group Display Name - Checking this box will allow teachers to control the section display name after the first sync, and prevent SDS from overwriting Section DisplayName changes made by teachers.
  • Replace unsupported Special Characters – Checking this box will allow SDS to automatically replace unsupported special characters while the sync is running. Special characters will be replaced with an “_”, and no longer result in an error during the sync process for that object.
  • Student Enrollment - Checking this box will allow you to select a date in the future for starting to sync the student enrollments. If checked, on this selected date, SDS will start adding each student to their respective sections.
  • Intune for Education - Checking this box will license all student and teachers for Intune for Education.
  1. On the Teacher options page, select the appropriate identity matching options, confirm the teacher properties are selected, then click Next.

    how-to-deploy-SDS-using-CSV-files-3.PNG
  • Primary Key (Target Directory) - This is the User attribute in Azure AD used for SDS Identity Matching. Watch the Identity Matching video for additional information on how to select the appropriate target directory attribute, and properly configure the identity matching settings for the teacher.
  • Domain (optional) - This is an optional domain value that you can add to the selected Source Directory attribute to complete your Teacher Identity Matching. If you need to match to a UserPrincipalName or Mail attribute, you must have a domain included in the string. Your source attribute must either include the domain already or you can append the appropriate domain to the source attribute using this dropdown menu.
  • Primary Key (Source Directory) - This is the Teacher attribute in OneRoster used for SDS Identity Matching. Watch the Identity Matching video for additional information on how to select the appropriate source directory attribute, and properly configure the identity matching settings for teacher.
  1. On the Student options page, select the appropriate identity matching options, confirm the student properties are selected, and then click Next.


    how-to-deploy-SDS-using-CSV-files-4.PNG
  • Primary Key (Source Directory) - This is the Student attribute in OneRoster used for SDS Identity Matching. Watch the Identity Matching video for additional information on how to select the appropriate source directory attribute, and properly configure the identity matching settings for teacher.
  • Primary Key (Target Directory) - This is the User attribute in Azure AD used for SDS Identity Matching. Watch the Identity Matching video for additional information on how to select the appropriate target directory attribute, and properly configure the identity matching settings for the student.
  • Domain (optional) - This is an optional domain value that you can add to the selected Source Directory attribute to complete your Student Identity Matching. If you need to match to a UserPrincipalName or Mail attribute, you must have a domain included in the string. Your source attribute must either include the domain already or you can append the appropriate domain to the source attribute using this dropdown menu.
  1. On the Review page, ensure you've made the appropriate selections. If no additional changes are needed, click Create Profile.

Video: How to match source and target attributes for sync

For various examples of matching logic success and failure for sync, watch the Identity Matching video:

Overview of School Data Sync