如何使用 OneRoster® 1.1 API 部署學校資料同步處理How to deploy School Data Sync by using OneRoster® 1.1 API

OneRoster® 為學生資訊系統 (SIS) 資料交換之產業標準格式和 OneRoster® REST Api 是我們可以同步處理來自 Student 資訊系統提供透過學校資料同步處理的 O365 OneRoster® Api 物件所依據的方法(SDS) 服務。使用此同步處理方法,您可以直接連接到使用 rest OneRoster 1.1 Api 所 SIS 提供您 SIS 並同步處理資料直接而不是使用 CSV 檔案。若要設定 SDS 使用 OneRoster® 同步處理方法,請遵循本文中所詳述的指示。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

在您開始使用 SDS 使用 OneRoster® 同步處理方法同步處理之前,請閱讀概觀 (英文) 的學校資料同步處理並確定您符合下列先決條件: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:

  • Office 365 教育版租用戶An Office 365 for Education tenant

  • 全域管理員權限Global Admin Permissions

注意

協力廠商應用程式提供者能透過他們的應用程式存取您透過 School Data Sync 提供的資料,因此您只應該同步處理您願意向這些協力廠商公開的資料。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.

請移至下表來查看哪些 SIS 整合的解決方案可搭配 OneRoster® API 連接器以及每個解決方案的特定指示。Please go to this table to see which SIS integration solutions will work with the OneRoster® API connector as well as specific instructions for each solution.

觀賞影片Watch the Video

存取 SDS 和首次登入SDS Access and First Time Login

  1. 若要存取 School Data Sync 管理入口網站,請啟動私人 Web 瀏覽器並瀏覽至 sds.microsoft.com,然後使用您的 O365 全域管理員帳戶登入。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.

建立同步處理設定檔及同步處理 SIS 資料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.

    新增 Profile_C3_20175211236Add Profile_C3_20175211236
  2. 選擇連線類型] 頁面上,選擇 OneRoster API,然後選擇 SIS 整合提供者從 「 選擇您的提供者 」 下拉式功能表。一旦完成,請按一下 [啟動]。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.PNGhow-to-deploy-SDS-using-oneroster-sync-1.PNG
    • 為此設定檔命名 - 輸入同步處理設定檔的名稱。該名稱可用來在 SDS 儀表板中辨識同步處理設定檔,設定檔設定完成後便無法變更。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.
    • 選擇您同步處理方法-顯示可用的同步處理方法之間的選擇。如果您正在次使用 OneRoster,透過 API 同步處理的方法,選取 [連線,然後選取 OneRoster 1.1 API 服務選取範圍。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.
  3. 在 [同步處理選項] 頁面上選取 [建立新的使用者或同步處理現有使用者的適當選項。然後完成您在適當] 頁面上的選項。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.PNGhow-to-deploy-SDS-using-oneroster-sync-2.PNG
    • 現有的使用者-選取這個選項如果您已在每個學生與老師 OneRoster 中包含您 O365 租用戶內建立的使用者帳戶。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.
    • 新的使用者選取這個選項如果您想建立使用者 SDS accounts 學生與老師 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 -這是您 SIS OneRoster 端點的網際網路可存取的 URL。Web Access URL - This is the internet accessible URL for the OneRoster Endpoint of your SIS.
    • 用戶端識別碼-這是您 SIS OneRoster 端點上進行驗證的 OAuth 用戶金鑰。client Id - This is the OAuth consumer key for authenticating with the OneRoster endpoint of your SIS.
    • 用戶端密碼-這是驗證與您 SIS OneRoster 端點的 OAuth 取用者密碼。client secret - This is the OAuth consumer secret for authenticating with the OneRoster endpoint of your SIS.
    • 何時結束學校 year?-選取您想要同步處理學校年度結束年份。例如,如果您想要同步處理 2017年 2018年學校年份、 選取"2018"。根據預設,這會同步選取學校年中的所有字詞。建立設定檔之後,您可以編輯選取子集的字詞來同步處理的同步處理設定檔。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.
    • 學校屬性-這些是 SDS 可以同步處理的 OneRoster 內所含的學校屬性。灰色的屬性是必要的屬性,而且必須存在於中的每個學校 OneRoster 來同步處理。顯示的其他屬性是選擇性的並可以同步處理如果您選擇。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.
    • 區段屬性-這些是 SDS 可以同步處理的 OneRoster 中包含的一節屬性。灰色的屬性是必要的屬性,而且必須出現在每個區段 OneRoster 來同步處理。顯示的其他屬性是選擇性的並可以同步處理如果您選擇。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.
    • 區段群組顯示名稱的同步選項 - 勾選這個方塊能在第一次同步之後讓教師控制區段顯示名稱,避免 SDS 覆寫教師變更的區段顯示名稱。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.
    • 取代不受支援的特殊字元– 檢查此方塊可允許 SDS 來執行同步處理時自動取代不受支援的特殊字元。特殊字元將會取代""並不會再發生錯誤的結果在該物件的同步處理程序期間。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.
    • 學生註冊 - 勾選這個方塊後,您可以選取要開始同步處理學生註冊的未來日期。如果您勾選方塊,SDS 會在選定日期到來後將每位學生新增到所屬的個別區段。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 -檢查此方塊會在所有學生與老師 Intune 適用於教育界的都授權。Intune for Education - Checking this box will license all student and teachers for Intune for Education.
  4. 在 [教師選項]**** 頁面中,選取適當的身分識別比對選項、確認教師屬性已選取,然後按 [下一步]*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.PNGhow-to-deploy-SDS-using-CSV-files-3.PNG
    • 主索引鍵 (目標目錄) - 這是 Azure AD 中的 User 屬性,可用於 SDS 身分識別比對。若要進一步了解如何選取適當的目標目錄屬性,以及如何正確配置教師身分識別比對設定,請觀賞身分識別比對影片。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.
    • 網域 (選用) - 這是選用的網域值,您可以將該值新增到選取的來源目錄屬性,以完成教師身分識別比對。如果您需要比對 UserPrincipalName 或 Mail 屬性,字串中必須包含網域。來源屬性必須已包含網域。如果沒有的話,您也可以使用這個下拉式功能表將適當網域附加到來源屬性。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.
    • 主索引鍵 (來源目錄) -這是用於 SDS Identity 比對的 OneRoster 老師屬性。觀賞 Identity 比對影片如需有關如何選取適當的來源目錄屬性,並適當地設定 identity 符合教師的設定。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.
  5. 在 [學生選項]**** 頁面中,選取適當的身分識別比對選項、確認學生屬性已選取,然後按 [下一步]*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.PNGhow-to-deploy-SDS-using-CSV-files-4.PNG
    • 主索引鍵 (來源目錄) -這是用於 SDS Identity 比對的 OneRoster Student 屬性。觀賞 Identity 比對影片如需有關如何選取適當的來源目錄屬性,並適當地設定 identity 符合教師的設定。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.
    • 主索引鍵 (目標目錄) - 這是 Azure AD 中的 User 屬性,可用於 SDS 身分識別比對。若要進一步了解如何選取適當的目標目錄屬性,以及如何正確配置學生身分識別比對設定,請觀賞身分識別比對影片。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.
    • 網域 (選用) - 這是選用的網域值,您可以將該值新增到選取的來源目錄屬性,以完成學生身分識別比對。如果您需要比對 UserPrincipalName 或 Mail 屬性,字串中必須包含網域。來源屬性必須已包含網域。如果沒有的話,您也可以使用這個下拉式功能表將適當網域附加到來源屬性。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.
  6. 在 [檢閱]**** 頁面中,確認您已選取適當選項。如果不需要額外變更,請按一下 [建立設定檔]*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:

School Data Sync 的概觀Overview of School Data Sync