如何使用 PowerSchool API 部署 School Data SyncHow to deploy School Data Sync by using PowerSchool API

PowerSchool 是能與 School Data Sync (SDS) 整合的學生資訊系統 (SIS)。透過 PowerSchool 同步處理方法,您可以使用 PowerSchool 提供的 REST API 直接連接 SIS,也可以在不使用 CSV 檔案的情況下直接同步處理資料。若要使用 PowerSchool 同步處理方法設定 SDS,請遵循本文章詳述的指示。PowerSchool is a Student Information System (SIS) that integrates with School Data Sync (SDS). Using the PowerSchool sync method, you can connect directly to your SIS using the REST-based APIs provided by PowerSchool, and synchronize data directly instead of using CSV files. To set up SDS using the PowerSchool Sync method, follow the instructions detailed in this article.

本主題內容:In this topic:

必要條件Prerequisites

開始使用 PowerSchool 同步處理方法與 SDS 同步處理之前,請先閱讀 School Data Sync 的概觀,並確認您符合以下必要條件:Before you start synchronizing with SDS using the PowerSchool 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.

安裝 PowerSchool 的 REST API 外掛程式Install the REST API plug-in for PowerSchool

之前 SDS 可以從 PowerSchool SIS 存取資料,則您必須安裝 PowerSchool 下方外掛程式的應用程式和取得 OAuth 認證遵循下列步驟。 Before SDS can access data from your PowerSchool SIS, you must install the application plug-in below within PowerSchool and obtain OAuth credentials following these steps.

  1. 在本機電腦上,利用以下內容建立 XML 外掛程式安裝檔案,再將檔案儲存為 plugin.xml。On your local computer, create an XML plug-in installation file with following content, and save the file as "plugin.xml".

    <?xml version="1.0" encoding="UTF-8"?>
    <plugin xmlns="http://plugin.powerschool.pearson.com" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:schemaLocation="http://plugin.powerschool.pearson.com plugin.xsd" 
    name="Microsoft School Data Sync" 
    version="1.0.0" 
    description="Plugin for Powerschool REST API for Microsoft SDS"> 
    <oauth></oauth> 
    <publisher name="Microsoft Corp."> 
    <contact email="sdshelp@microsoft.com" /> 
    </publisher>  
    </plugin>
    
  2. 使用系統管理員認證登入 PowerSchool 管理入口網站。Sign in to the PowerSchool admin portal website using your System Administrator credentials.
  3. 在開始頁面中,從主要功能表選擇 [系統]*,然後前往 [系統設定] * > [外掛程式管理組態]**** > [安裝]*On the start page, choose *System from the main menu, then go to System Settings > Plugin Management Configuration > Install
  4. 輸入或選取您剛建立 (.xml) 的外掛程式安裝檔案,然後選擇安裝。 外掛程式會出現在 [安裝外掛程式] 區段中 [外掛程式管理儀表板] 頁面上。請確定已啟用外掛程式。如果不存在,選擇 [外掛程式管理儀表板] 頁面上的 [啟用] 選項。Enter or select the plug-in installation file you just created (.xml), and then choose Install. The plug-in will appear in the Installed Plugins section on the Plugin Management Dashboard page. Make sure the plug-in is enabled. If it is not, choose the Enable option on the Plugin Management Dashboard page.
  5. 在 [外掛程式管理儀表板] 頁面中,確認外掛程式已啟用。On the Plugin Management Dashboard page, make sure that the plugin is enabled.
  6. 選擇要檢視所產生的外掛程式的 OAuth 認證的資料設定Choose Data Configuration to view the OAuth credentials that were generated for the plug-in.
  7. 記下 [用戶端 ID]**** 和 [用戶端密碼]**** 的值,以便在建立 School Information Sync 設定檔時輸入這些認證。Record the values for the Client ID and Client Secret so you can enter these credentials when you create your School Information Sync profile.

確認 REST 端點可從網際網路存取Make sure the REST endpoints are Internet accessible

Microsoft 學校資料同步處理必須能夠連線到您學校 PoweerSchool 伺服器。若要確定伺服器是可存取,開啟從網際網路連接埠 80 和 443 Powerschool 伺服器。Microsoft School Data Sync must be able to reach your school's PoweerSchool server. To make sure the server is accessible, open ports 80 and 443 from the Internet to your Powerschool server.

若要驗證端點的正確設定,請檢查您可以從網際網路開啟 PowerSchool server 網站頁面。例如,在瀏覽器中移至 (https://Powerschool.com/public/)和 (http://Powerschool.com/public/)。To validate that the endpoints are set correctly, check that you can open the PowerSchool server website pages from the Internet. For example, in your browser, go to (https://Powerschool.com/public/) and (http://Powerschool.com/public/).

關於 AADConnect 部署警告About AADConnect deployment warnings

如果您正在針對透過 AADConnect 從內部部署 Active Directory 同步處理的租用戶設定 School Data Sync,可能會注意到 miisclient 中顯示的斷路器數量增加。這是因為 Office 365 群組無法反向同步處理回 AADConnect Metaverse 和內部部署 Active Directory。這些警告不會對目前的 AADConnect 部署產生任何負面影響,只能做為後續同步處理失敗的參考附註。在 SDS 中啟用同步處理後,這些警告應該會出現在 AADConnect 中,因為系統會為每個透過 SDS 同步處理的班級建立一個 Office 365 群組。If you are configuring School Data Sync for a tenant which is synchronized from onpremises Active Directory through AADConnect, you may notice an increase in the number of Disconnectors shown in your miisclient. This is a result of Office 365 Group being unable to synchronize back to the AADConnect Metaverse and on-premises Active Directory. These warnings do not have any negative impact on your current AADConnect deployment, and only provide an informational note on the resultant sync failure. You should expect these warnings in AADConnect after enabling sync in SDS, as one Office 365 Group is created for each class synchronized through SDS.

使用 PowerSchool 同步處理方法同步處理 SIS 資料Synchronize your SIS data using the PowerSchool sync method

觀賞影片:部署 School Data SyncWatch the video: Deploy School Data Sync

安裝外掛程式及設定存取權限後,請在 Microsoft School Data Sync 中建立設定檔以同步處理使用者資訊。After you've installed the plug-in and set up access, create a profile in Microsoft School Data Sync to synchronize your users' information.

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

若要存取學校資料同步處理系統入口網站啟動網頁瀏覽器中,瀏覽至 sds.microsoft.com,然後再登入使用 O365 全域管理員帳戶。To access the School Data Sync Admin Portal launch a 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.PNG

  2. 在 [選擇連線類型] 頁面上填妥適當的表單。一旦完成,請按一下 [啟動]。On the Choose Connection Type page complete the form as appropriate. Once complete, click Start.
    how-to-deploy-SDS-using-Powerschool-API-1.PNGhow-to-deploy-SDS-using-Powerschool-API-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.
    • 選擇您同步處理方法-顯示同步處理方法之間的選擇。如果您正在次使用 PowerSchool API,選取 [連線透過 API] 方塊,然後選取 [PowerSchool API] 選項。Choose your sync method - Choose between the sync methods shown. If you’re syncing using PowerSchool API, select the Connect via an API box and then select the PowerSchool API option.
  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-Powerschool-API-2.PNG

    • 現有的使用者 - 如果 PowerSchool 中包含的每位學生和教師已在 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 PowerSchool.
    • 新使用者 - 如果您想要讓 SDS 為 PowerSchool 中包含的每位學生和教師建立使用者帳戶,請選取這個選項。New Users - Select this option if you want SDS to create user accounts for each of your students and teachers contained within PowerSchool.
    • Web Access URL -這是您 PowerSchool SIS 這是可存取網際網路的基底 URL。Web Access URL - This is the base URL for your PowerSchool SIS which is Internet accessible.
    • 用戶端 Id - 這是收錄在本文章安裝 PowerSchool 的 REST API 外掛程式一節的用戶端 ID。client Id - This is the client Id recorded in the Install the REST API plug-in for PowerSchool section of this article.
    • 用戶端密碼 - 這是收錄在本文章安裝 PowerSchool 的 REST API 外掛程式一節的用戶端密碼。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.
    • 選取學年 - 這是您希望依據這個設定檔同步處理的 PowerSchool 學年。每個設定檔只能同步處理 1 個學年。Select School Year - This is the school year from PowerSchool you wish to sync under this profile. Only 1 school year can be synced per profile.
    • 老師有多個學校類別-如果您有教師或學生至多個相關聯內 PowerSchool 學校、 核取此方塊。Teachers have classes at multiple schools - If you have a teacher or student associated to more than one school within PowerSchool, check this box.
    • 學校屬性 - 這些是 PowerSchool 中的學校屬性,可供 SDS 同步處理。顯示為灰色的屬性是必要屬性,每間學校的這些屬性都必須存在 PowerSchool 中才能進行同步處理。顯示的其餘屬性是選用屬性,您可以選擇是否要同步處理。School properties - These are the school attributes contained within PowerSchool that SDS can sync. The greyed out attributes are the required attributes, and must be present in PowerSchool for each school to sync. The additional attributes shown are optional, and can be synced if you choose.
    • 區段屬性 - 這些是 PowerSchool 中的區段屬性,可供 SDS 同步處理。顯示為灰色的屬性是必要屬性,每個區段的這些屬性都必須存在 PowerSchool 中才能進行同步處理。顯示的其餘屬性是選用屬性,您可以選擇是否要同步處理。Section Properties - These are the section attributes contained within PowerSchool that SDS can sync. The greyed out attributes are the required attributes, and must be present in PowerSchool 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 會在選定日期到來後將每位學生新增到所屬的個別區段。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 教育版應用程式內使用的預設群組。Intune for Education - Checking this box will license all student and teachers for Intune for Education. This will also auto-create several default groups which can be used within the Intune for Education app.
  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.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.
    • 主索引鍵 (來源目錄) - 這是 PowerSchool 中的 Teacher 屬性,可用於 SDS 身分識別比對。若要進一步了解如何選取適當的來源目錄屬性,以及如何正確配置教師身分識別比對設定,請觀賞身分識別比對影片。Primary Key (Source Directory) - This is the Teacher attribute in PowerSchool 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.PNG

    • 主索引鍵 (來源目錄) - 這是 PowerSchool 中的 Student 屬性,可用於 SDS 身分識別比對。若要進一步了解如何選取適當的來源目錄屬性,以及如何正確配置教師身分識別比對設定,請觀賞身分識別比對影片。Primary Key (Source Directory) - This is the Student attribute in PowerSchool 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