如何使用 OneRoster® 1.1 API 部署 School Data SyncHow to deploy School Data Sync by using OneRoster® 1.1 API

OneRoster® 是學生資訊系統 (SIS) 資料交換之業界標準格式和 OneRoster® REST Api 會依據我們可以同步處理來自提供給 O365 透過 School Data Sync 的 OneRoster® Api 的學生資訊系統物件的方法(SDS) 服務。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. 使用此同步處理方法,可以直接連線到您使用的 rest OneRoster 1.1 Api 的 SIS,所提供的 SIS,並直接而不是使用 CSV 檔案資料同步處理。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. 若要設定 SDS 使用 OneRoster® 同步處理方法,請遵循本文中的詳細指示。To set up SDS using the OneRoster® Sync method, follow the instructions detailed in this article.

本主題內容:In this topic:

必要條件Prerequisites

開始使用 OneRoster® 同步處理方法與 SDS 進行同步處理之前,請閱讀School Data Sync 的概觀,並確認您符合下列必要條件: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.

觀賞影片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.


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

  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

  • 名稱這個設定檔-輸入您的同步處理設定檔的名稱。Name this profile - Enter a name for your sync profile. 此名稱將會用來識別在 SDS 儀表板,同步處理設定檔,且無法變更設定檔安裝完成後。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. 如果您正在同步處理使用 OneRoster,透過 API 同步處理方法,選取 [連線],然後選取服務選取範圍的 [OneRoster 1.1 API。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.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.

  • 每位學生和教師 OneRoster 所含括的新使用者-選取此選項,如果您想要讓 SDS 建立的使用者帳戶。New Users - Select this option if you want SDS to create user accounts for each of your students and teachers contained within OneRoster.

  • Web 存取 URL -這是您的 SIS 的 OneRoster 端點的網際網路存取 URL。Web Access URL - This is the internet accessible URL for the OneRoster Endpoint of your SIS.

  • 用戶端 Id -這是 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.

  • 您的學校年份的結束時?When does your school year end? -選取您想要同步處理的學校年份結束年份。例如,如果您想要同步處理 2017年-2018年學校年,選取 「 2018 」。- 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.

  • 篩選不在作用中的項目-同步處理只使用中的記錄從來源目錄。Filter inactive entries - Sync only active records from source directory.

  • 取代不受支援的特殊字元– 檢查此方塊可讓 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 覆寫] 區段中 DisplayName 教師所做的變更。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.

  • 延遲學生存取-啟用此選項可讓您設定若要檢視其類別的學生的未來的日期。Delay Student Access - Enabling this option will allow you to set a future date for students to view their classes.

  • 何時我們應該停止同步處理此設定檔?When should we stop syncing this profile? 您通常會想要這麼做結尾的學校年。You will typically want to do this at the end of the school year. 一旦我們停止同步處理此設定檔,您將已淘汰此設定檔相關聯的類別選項。Once we stop syncing this profile, you will have the option to retire the classes associated with this profile.

  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.PNGhow-to-deploy-SDS-using-CSV-files-3.PNG
  • 主索引鍵 (目標目錄) -這是用於 SDS 身分識別比對 Azure AD 中的使用者屬性。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. 如果您需要符合 UserPrincipalName 還是郵件屬性,您必須包含在字串中的網域。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 身分識別比對的 oneroster 的教師屬性。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.PNGhow-to-deploy-SDS-using-CSV-files-4.PNG
  • 主索引鍵 (來源目錄) -這是用於 SDS 身分識別比對的 oneroster 的學生屬性。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.
  • 主索引鍵 (目標目錄) -這是用於 SDS 身分識別比對 Azure AD 中的使用者屬性。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. 如果您需要符合 UserPrincipalName 還是郵件屬性,您必須包含在字串中的網域。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.

OneRoster API 的篩選的狀態Filtered State of OneRoster API

  • 學生和註冊 – SDS 同步根據學校關聯及狀態某些學生。Students and enrollments – SDS syncs some students based on school association and status.

    • 已同步處理Synced
      • 使用中Active
    • 不會同步處理Not Synced
      • 要刪除To be deleted
  • 教師 – SDS 同步根據學校關聯及狀態某些學生。Teachers – SDS syncs some students based on school association and status.

    • 已同步處理Synced
      • 使用中Active
    • 不會同步處理Not Synced
      • 要刪除To be deleted
  • 類別的 SDS 同步根據學校關聯,有些類別和人員輸入。Classes - SDS syncs some classes based on school association, and staff type.

    • 已同步處理Synced
      • 使用中Active
    • 不會同步處理Not Synced
      • 要刪除To be deleted
  • 學校 – SDS 同步根據學校關聯,某些學校和人員輸入。Schools– SDS syncs some schools based on school association, and staff type.

    • 已同步處理Synced
      • 使用中Active
    • 不會同步處理Not Synced
      • 要刪除To be deleted

變更-若要對篩選-powerschool。PNG

影片: 如何比對來源和目標屬性以進行同步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