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

PowerSchool 是學生資訊系統 (SIS) 的整合與學校資料同步處理 (SDS)。PowerSchool is a Student Information System (SIS) that integrates with School Data Sync (SDS). 您可以使用 PowerSchool 同步處理方法,直接連接到使用 rest Api 所 PowerSchool,提供您 SIS 並同步處理資料直接而不是使用 CSV 檔案。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. 若要設定 SDS 使用 PowerSchool 同步處理方法,請遵循本文中所詳述的指示。To set up SDS using the PowerSchool Sync method, follow the instructions detailed in this article.

本主題內容:In this topic:

必要條件Prerequisites

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

注意

您提供透過學校資料同步處理資料可能存取其應用程式,透過協力廠商應用程式提供者,您應該同步處理您想要提供這些協力廠商提供的資料。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 APIInstall 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. 記錄值的用戶端識別碼用戶端密碼讓您可以輸入這些認證時建立學校資訊同步處理設定檔。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 伺服器。Microsoft School Data Sync must be able to reach your school's PoweerSchool server. 若要確定伺服器是可存取,開啟從網際網路連接埠 80 和 443 Powerschool 伺服器。To make sure the server is accessible, open ports 80 and 443 from the Internet to your Powerschool server.

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

關於 AADConnect 部署警告About AADConnect deployment warnings

如果您要從內部部署 AADConnect 透過 Active Directory 同步處理的承租人設定學校資料同步處理,您可能會發現增加的隨時您 miisclient 所示的數目。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. 這是 Office 365 群組正在無法回到 AADConnect Metaverse 同步處理的結果與內部部署 Active Directory。This is a result of Office 365 Group being unable to synchronize back to the AADConnect Metaverse and on-premises Active Directory. 這些警告沒有任何負面影響上目前 AADConnect 部署,而且只有在產生的同步處理失敗提供資訊的附註。These warnings do not have any negative impact on your current AADConnect deployment, and only provide an informational note on the resultant sync failure. 啟用同步處理中 SDS,為每個類別會建立一個 Office 365 群組同步處理到 SDS 後應 AADConnect 中可預期這些警告。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.

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

觀賞影片: 部署學校資料同步處理Watch the video: Deploy School Data Sync

您已安裝外掛程式及設定後存取、 建立設定檔同步處理您的使用者資訊的 Microsoft 學校資料同步。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.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 sync methods shown. 如果您正在次使用 PowerSchool API,選取 [連線透過 API] 方塊,然後選取 [PowerSchool API] 選項。If you’re syncing using PowerSchool API, select the Connect via an API box and then select the PowerSchool API option.
  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-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 accounts 學生與老師 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.
  • 用戶端識別碼-這是本文的用戶端識別碼記錄在 [安裝外掛程式 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.
  • 用戶端密碼-這是本文的 [安裝外掛程式 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.
  • 選取 [學校 Year -這是您想要下此設定檔同步處理的 PowerSchool 從學校年份。Select School Year - This is the school year from PowerSchool you wish to sync under this profile. 僅限 1 學校年可以每一個設定檔同步處理。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.
  • 學校屬性-這些是 SDS 可以同步處理的 PowerSchool 內所含的學校屬性。灰色的屬性是必要的屬性,而且必須存在於中的每個學校 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.
  • 區段屬性-這些是 SDS 可以同步處理的 PowerSchool 中包含的一節屬性。灰色的屬性是必要的屬性,而且必須出現在每個區段 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.
  • 篩選不在作用中的內容-檢查此方塊將只會同步處理作用中的記錄。Filter inactive properties - Checking this box will only sync active records.
  • 取代不受支援的字元-檢查此方塊會自動取代不受支援的字元支援的錯誤。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.
  • 延遲 Student Access -啟用此選項可讓您設定學生檢視其類別的未來的日期。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. 教師選項] 頁面上,選取適當的 identity 比對選項,確認老師屬性選取,然後按 [下一步]。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

  • 主索引鍵 (目標目錄) -這是用於 SDS Identity 比對的 Azure AD 中的使用者的屬性。Primary Key (Target Directory) - This is the User attribute in Azure AD used for SDS Identity Matching. 觀賞 Identity 比對影片如需有關如何選取適當的目標目錄屬性,並適當地設定 identity 符合教師的設定。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.
  • (選用) 的網域-這是選用的網域值,您可以新增至所選來源目錄屬性以完成您老師 Identity 比對。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 Identity 比對的 PowerSchool 老師屬性。Primary Key (Source Directory) - This is the Teacher attribute in PowerSchool used for SDS Identity Matching. 觀賞 Identity 比對影片如需有關如何選取適當的來源目錄屬性,並適當地設定 identity 符合教師的設定。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. 學生選項] 頁面上,選取適當的 identity 比對選項,確認 student 屬性已選取,然後按 [下一步]。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

  • 主索引鍵 (來源目錄) -這是用於 SDS Identity 比對的 PowerSchool Student 屬性。Primary Key (Source Directory) - This is the Student attribute in PowerSchool used for SDS Identity Matching. 觀賞 Identity 比對影片如需有關如何選取適當的來源目錄屬性,並適當地設定 identity 符合教師的設定。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 Identity 比對的 Azure AD 中的使用者的屬性。Primary Key (Target Directory) - This is the User attribute in Azure AD used for SDS Identity Matching. 觀賞 Identity 比對影片如需有關如何選取適當的目標目錄屬性,並適當地設定 identity 符合學生的設定。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.
  • (選用) 的網域-這是選用的網域值,您可以新增至所選來源目錄屬性以完成您 Student Identity 比對。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.

影片: 如何符合同步處理的來源與目標屬性Video: How to match source and target attributes for sync

如需的比對邏輯成功和失敗的同步處理的各種範例、 觀賞 Identity 比對影片:For various examples of matching logic success and failure for sync, watch the Identity Matching video:


School Data Sync 的概觀Overview of School Data Sync