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

OneRoster®是一種行業標準格式,可供 exchange 使用學生資訊系統 (SIS) 資料,而 OneRoster 的 REST®則是我們可從學生資訊系統同步處理物件的方法,而這些系統是透過 School Data Sync APIs SDS OneRoster 服務,從提供® APIs (到 O365。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. 使用此同步處理方法,您可以使用 SIS 所提供的 REST 型 OneRoster 1.1 APIs 直接連線至 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. 若要使用 OneRoster® Sync 方法來設定 SDS,請遵循本文所述的指示。To set up SDS using the OneRoster® Sync method, follow the instructions detailed in this article.

本主題內容:In this topic:

必要條件Prerequisites

在您使用 OneRoster® Sync 方法開始與 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 (方案 1) School Data Sync (Plan 1) enabled

注意

透過 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 Admin 入口網站,請啟動私人網頁瀏覽器,流覽至 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.

新增設定檔

  1. 在 [ 選擇連線類型 ] 頁面上,選擇 [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.

選擇連線類型

  • 名稱此設定檔 -輸入您同步處理設定檔的名稱。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.
  • 選擇同步處理方法 -選擇顯示可用的 sync 方法。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.

同步處理選項

  • 現有使用者 -如果您已在 O365 租使用者中建立使用者帳戶,以供 OneRoster 中所包含的每位學生和教師,請選取此選項。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 為 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 -這是可存取網際網路的 PowerSchool SIS 基礎 URL。Web Access URL - This is the base URL for your PowerSchool SIS which is Internet accessible.

  • 用戶端識別碼 -這是在本文的「 安裝 POWERSCHOOL 的 REST API 外掛程式 」一節中記錄的用戶端識別碼。client Id - This is the client Id recorded in the Install the REST API plug-in for PowerSchool section of this article.

  • 用戶端密碼 -這是在本文的「 安裝 REST API 外掛程式 PowerSchool 區段中記錄的用戶端密碼。client secret - This is the client secret recorded in the Install the REST API plug-in for PowerSchool section of this article.

  • 選取要同步 處理的學校-此選項可讓您選取要從 PowerSchool 同步處理的學校。Select schools to sync - This option allows you to select the school you want to sync from PowerSchool.

  • 學校屬性 -上載 CSV 檔案之後,會自動選取 School.csv 中包含的屬性。School properties - After uploading your CSV files, the attributes contained within your School.csv will be auto- selected. 在此驗證選取的屬性與 School.csv 中所含的屬性相同You should validate the attributes selected here are the same attributes contained in your School.csv

  • 區段屬性 -在上傳 CSV 檔案之後,將會自動選取 Student.csv 中包含的屬性。Section Properties - After uploading your CSV files, the attributes contained within your Student.csv will be auto-selected. 在此驗證選取的屬性與 School.csv 中所含的屬性相同You should validate the attributes selected here are the same attributes contained in your School.csv

  • 篩選停用的屬性 -檢查此方塊只會同步處理使用中的記錄。Filter inactive properties - Checking this box will only sync active records.

  • 小組建立選項 –勾選此方塊可確保 SDS 為每個同步處理的類別建立 M365 群組和類別團隊。Team Creation Option – Checking this box will ensure SDS creates both the M365 Group and Class Team for each class synced. 如果您保持方塊未勾選,SDS 將只會建立 M365 群組。If you leave the box unchecked, SDS will only create the M365 Groups.

  • 取代不支援的字元 -檢查此方塊會自動將不支援的字元取代為支援的字元。Replace unsupported characters - Checking this box will automatically replace unsupported characters with supported ones.

  • 區段群組顯示名稱的同步處理選項 :複選此方塊可讓教師在第一次同步後控制區段的顯示名稱,並避免 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.

  • Sync To Insights -檢查此方塊會將 SDS 同步處理設定檔資料與 Microsoft 365 應用程式中的使用者活動資料組合在一起,在小組的真知灼見應用程式中提供有價值分析資訊的教師和領導者。Sync to Insights - Checking this box will combine SDS Sync Profiles data with User Activity data from Microsoft 365 applications, providing educators and leaders with valuable analytics information in the Team's Insights app. 如果您看不到 [同步處理 Insights] 選項,請移至 SDS 系統管理主控台中的 [設定] 頁面,並啟用「Insights」和「同步處理至見解」。If you do not see the Sync to Insights option, go to the Settings page in the SDS Admin Console and enable "Insights" and "Sync to Insights."

注意

同步處理深入瞭解 CAPITA 及無限校園提供者的支援。Sync to Insights is pending support for CAPITA and Infinite Campus providers.

  • 延遲學生存取 -啟用此選項可讓您設定未來的學生查看其類別的日期。Delay Student Access - Enabling this option will allow you to set a future date for students to view their classes. 停用此選項可讓學生立即查看其類別。Disable this option to allow students view their classes immediately.
  • 何時停止同步處理此設定檔?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.

教師選項

  • **Primary Key (Target Directory) ** -這是 Azure AD 中用於 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.
  • **網域 (選用) ** -這是一個選用的網域值,您可以將此值新增至所選的來原始目錄屬性,以完成教師身分識別的相符。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 或 Mail 屬性,則必須在字串中包含一個網域。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 (來原始目錄) ** -這是 OneRoster 中用於 SDS 身分識別的教師屬性。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.

學生選項

  • **Primary Key (來原始目錄) ** -這是 OneRoster 中用於 SDS 身分識別的學生屬性。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) ** -這是 Azure AD 中用於 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.
  • **網域 (選用) ** -這是一個選用的網域值,您可以將它新增至選取的來原始目錄屬性,以完成您的學生身分身分識別。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 或 Mail 屬性,則必須在字串中包含一個網域。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

changes-to-filtering-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