Vorgehensweise Bereitstellen von School Data Sync mithilfe der PowerSchool SIS-APIHow to deploy School Data Sync by using PowerSchool SIS API

PowerSchool ist ein Student Information System (SIS), das in School Data Sync (SDS) integriert wird.PowerSchool is a Student Information System (SIS) that integrates with School Data Sync (SDS). Mithilfe der PowerSchool-Synchronisierungsmethode können Sie mithilfe der von PowerSchool bereitgestellten Rest-basierten APIs direkt eine Verbindung mit Ihrem SIS herstellen und Daten direkt anstatt mit CSV-Dateien synchronisieren.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. Befolgen Sie die in diesem Artikel beschriebenen Anweisungen, um SDS mithilfe der PowerSchool-Synchronisierungsmethode einzurichten.To set up SDS using the PowerSchool Sync method, follow the instructions detailed in this article.

VoraussetzungenPrerequisites

Bevor Sie mit der Synchronisierung mit SDS mithilfe der PowerSchool-Synchronisierungsmethode beginnen, lesen Sie die Übersicht über School Data Sync , und stellen Sie sicher, dass die folgenden Voraussetzungen erfüllt sind: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:

  • Ein Office 365 für Education-MandantenAn Office 365 for Education tenant

  • Globale AdministratorberechtigungenGlobal Admin Permissions

  • School Data Sync (Plan 1) aktiviertSchool Data Sync (Plan 1) enabled

Note

Die Daten, die Sie über School Data Sync bereitstellen, sind möglicherweise über ihre Apps für Drittanbieter-Anwendungsanbieter zugänglich, daher sollten Sie nur die Daten synchronisieren, die Sie diesen Drittanbietern zur Verfügung stellen möchten.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.

Installieren des Rest-API-Plug-Ins für PowerSchoolInstall the REST API plug-in for PowerSchool

Bevor SDS auf Daten von Ihrem PowerSchool SIS zugreifen kann, müssen Sie das Anwendungs-Plug-in unten in PowerSchool installieren und OAuth-Anmeldeinformationen folgendermaßen abrufen.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. Erstellen Sie auf Ihrem lokalen Computer eine XML-Plug-in-Installationsdatei mit folgendem Inhalt, und speichern Sie die Datei als "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. Melden Sie sich mit Ihren System Administrator Anmeldeinformationen bei der PowerSchool-Verwaltungsportal-Website an.Sign in to the PowerSchool admin portal website using your System Administrator credentials.

  3. Wählen Sie auf der Startseite im Hauptmenü System aus, und wechseln Sie dann zu Systemeinstellungen > Plugin-Verwaltungs Konfigurations > InstallationOn the start page, choose System from the main menu, then go to System Settings > Plugin Management Configuration > Install

  4. Geben Sie die soeben erstellte Plug-in-Installationsdatei (XML) ein, oder wählen Sie dann Installieren aus.Enter or select the plug-in installation file you just created (.xml), and then choose Install. Das Plug-in wird im Abschnitt installierte Plugins auf der Seite Plugin Management Dashboard angezeigt.The plug-in will appear in the Installed Plugins section on the Plugin Management Dashboard page. Stellen Sie sicher, dass das Plug-in aktiviert ist.Make sure the plug-in is enabled. Wenn dies nicht der Fall ist, wählen Sie die Option aktivieren auf der Seite Plugin Management Dashboard aus.If it is not, choose the Enable option on the Plugin Management Dashboard page.

  5. Stellen Sie auf der Seite "Plugin Management Dashboard" sicher, dass das Plugin aktiviert ist.On the Plugin Management Dashboard page, make sure that the plugin is enabled.

  6. Wählen Sie Datenkonfiguration aus, um die OAuth-Anmeldeinformationen anzuzeigen, die für das Plug-in generiert wurden.Choose Data Configuration to view the OAuth credentials that were generated for the plug-in.

  7. Notieren Sie sich die Werte für die Client-ID und den geheimen Client Schlüssel , damit Sie diese Anmeldeinformationen eingeben können, wenn Sie Ihr School Information Sync-Profil erstellen.Record the values for the Client ID and Client Secret so you can enter these credentials when you create your School Information Sync profile.

Stellen Sie sicher, dass die Rest-Endpunkte Internet zugänglich sindMake sure the REST endpoints are Internet accessible

Microsoft School Data Sync muss in der Lage sein, den PowerSchool-Server Ihrer Schule zu erreichen.Microsoft School Data Sync must be able to reach your school's PowerSchool server. Um sicherzustellen, dass auf den Server zugegriffen werden kann, öffnen Sie die Ports 80 und 443 aus dem Internet auf Ihrem PowerSchool-Server.To make sure the server is accessible, open ports 80 and 443 from the Internet to your Powerschool server.

Um zu überprüfen, ob die Endpunkte ordnungsgemäß festgelegt sind, überprüfen Sie, ob Sie die PowerSchool Server-Website Seiten aus dem Internet öffnen können.To validate that the endpoints are set correctly, check that you can open the PowerSchool server website pages from the Internet. Wechseln Sie beispielsweise in Ihrem Browser zu ( https://Powerschool.com/public/) und ( http://Powerschool.com/public/) .For example, in your browser, go to (https://Powerschool.com/public/) and (http://Powerschool.com/public/).

Informationen zu AADConnect-Bereitstellungs WarnungenAbout AADConnect deployment warnings

Wenn Sie die School Data Sync für einen Mandanten konfigurieren, der von einem lokalen Active Directory über AADConnect synchronisiert wird, wird möglicherweise die Anzahl der in Ihrem miisclient angezeigten Trennstellen erhöht.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. Dies ist das Ergebnis, dass Office 365 Gruppe keine Synchronisierung mit der AADConnect-Metaverse und der lokalen Active Directory wieder synchronisieren kann.This is a result of Office 365 Group being unable to synchronize back to the AADConnect Metaverse and on-premises Active Directory. Diese Warnungen haben keine negativen Auswirkungen auf Ihre aktuelle AADConnect-Bereitstellung und geben nur einen Informationshinweis für den resultierenden Synchronisierungsfehler an.These warnings do not have any negative impact on your current AADConnect deployment, and only provide an informational note on the resultant sync failure. Sie sollten diese Warnungen in AADConnect nach dem Aktivieren von Sync in SDS erwarten, da eine Office 365 Gruppe für jede mit SDS synchronisierte Klasse erstellt wird.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.

Synchronisieren Ihrer SIS-Daten mithilfe der PowerSchool-SynchronisierungsmethodeSynchronize your SIS data using the PowerSchool sync method

Video ansehen: Bereitstellen der School Data SyncWatch the video: Deploy School Data Sync

Nachdem Sie das Plug-in installiert und den Zugriff eingerichtet haben, erstellen Sie ein Profil in Microsoft School Data Sync, um die Informationen Ihrer Benutzer zu synchronisieren.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-Zugriff und erstmalige AnmeldungSDS Access and First Time Login

Um auf das Administrator Portal für School Data Sync zuzugreifen, starten Sie einen Webbrowser, navigieren Sie zu SDS.Microsoft.com, und melden Sie sich dann mit ihrem globalen O365-Administratorkonto an.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.

Erstellen eines Synchronisierungsprofils und Synchronisieren Ihrer SIS-DatenCreate a Sync Profile and Sync your SIS Data

  1. Klicken Sie nach der Anmeldung im linken Navigationsbereich auf + Profil hinzufügen , um ein Synchronisierungsprofil zu erstellen.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. Füllen Sie auf der Seite Verbindungstyp auswählen das Formular nach Bedarf aus.On the Choose Connection Type page complete the form as appropriate. Klicken Sie nach Abschluss des Vorgangs auf Start.Once complete, click Start.

How-to-deploy-SDS-using-PowerSchool-API-1. png

  • Name dieses Profils – geben Sie einen Namen für Ihr Synchronisierungsprofil ein.Name this profile - Enter a name for your sync profile. Dieser Name wird verwendet, um das Synchronisierungsprofil im SDS-Dashboard zu identifizieren, und kann nicht mehr geändert werden, nachdem die Profileinrichtung abgeschlossen ist.This name will be used to identify the sync profile in the SDS Dashboard, and cannot be changed once the profile setup is complete.
  • Wählen Sie Ihre Sync-Methode – wählen Sie zwischen den angezeigten Synchronisierungsmethoden aus.Choose your sync method - Choose between the sync methods shown. Wenn Sie mit der PowerSchool-API synchronisieren, aktivieren Sie das Kontrollkästchen Connect via a API, und wählen Sie dann die PowerSchool-API-Option aus.If you’re syncing using PowerSchool API, select the Connect via an API box and then select the PowerSchool API option.
  1. Wählen Sie auf der Seite Synchronisierungsoptionen die entsprechende Option zum Erstellen neuer Benutzer oder zum Synchronisieren vorhandener Benutzer aus.On the Sync Options page, select the appropriate option to create new users or sync existing users. Schließen Sie dann Ihre Auswahl auf der Seite entsprechend ab.Then complete your selections on the page as appropriate.

How-to-deploy-SDS-using-PowerSchool-API-2. png

  • Vorhandene Benutzer : Wählen Sie diese Option aus, wenn Sie bereits Benutzerkonten in Ihrem O365-Mandanten für jeden Schüler und Lehrer in PowerSchool erstellen.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.
  • Neue Benutzer : Wählen Sie diese Option aus, wenn SDS Benutzerkonten für alle Schüler und Lehrer erstellen soll, die in PowerSchool enthalten sind.New Users - Select this option if you want SDS to create user accounts for each of your students and teachers contained within PowerSchool.

Note

Wenn ein Kursteilnehmer/Lehrer einen Benutzernamen in PowerSchool hat, versucht SDS, dieses zu verwenden, um Ihr Konto zu generieren.If a student/teacher has a user name within PowerSchool, SDS will attempt to use that to generate their account. Wenn dieser Benutzername nicht verfügbar ist, wird er im folgenden Format erstellt:s-<firstName>.<lastName>.<SIS ID>@<selectedDomain>If that username is not available then it will create one in the following format: s-<firstName>.<lastName>.<SIS ID>@<selectedDomain>

  • Web Access-URL : Dies ist die Basis-URL für Ihr PowerSchool SIS, auf das Internet zugegriffen werden kann.Web Access URL - This is the base URL for your PowerSchool SIS which is Internet accessible.
  • Client-ID : Dies ist die Client-ID, die im Abschnitt Installieren des Rest-API-Plug-Ins für PowerSchool dieses Artikels aufgezeichnet wird.client Id - This is the client Id recorded in the Install the REST API plug-in for PowerSchool section of this article.
  • geheimer Client Schlüssel -Dies ist der geheime Client Schlüssel, der im Abschnitt Installieren des Rest-API-Plug-Ins für PowerSchool dieses Artikels aufgezeichnet wurde.client secret - This is the client secret recorded in the Install the REST API plug-in for PowerSchool section of this article.
  • Zu synchronisierende Schulen auswählen – mit dieser Option können Sie die Schule auswählen, die Sie mit PowerSchool synchronisieren möchten.Select schools to sync - This option allows you to select the school you want to sync from PowerSchool.
  • Wann beginnt Ihr Schul Jahr?When does your school year start? -Dies ist das Schuljahr von PowerSchool, das Sie unter diesem Profil synchronisieren möchten.- This is the school year from PowerSchool you wish to sync under this profile. Pro Profil kann nur 1 Schul Jahr synchronisiert werden.Only 1 school year can be synced per profile.
  • Lehrer haben Kurse an mehreren Schulen – Wenn Sie einen Lehrer oder Schüler in PowerSchool mit mehr als einer Schule verbunden haben, aktivieren Sie dieses Kontrollkästchen.Teachers have classes at multiple schools - If you have a teacher or student associated to more than one school within PowerSchool, check this box.
  • School Properties -Dies sind die Schul Attribute, die in PowerSchool enthalten sind, die von SDS synchronisiert werden können. Die ausgegrauten Attribute sind die erforderlichen Attribute und müssen in PowerSchool vorhanden sein, damit die einzelnen Schulen synchronisiert werden können. Die angezeigten zusätzlichen Attribute sind optional und können synchronisiert werden, wenn Sie sich entscheiden.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.
  • Section-Eigenschaften : Dies sind die Abschnittsattribute, die in PowerSchool enthalten sind, die von SDS synchronisiert werden können. Die ausgegrauten Attribute sind die erforderlichen Attribute und müssen in PowerSchool für jeden zu synchronisierenden Abschnitt vorhanden sein. Die angezeigten zusätzlichen Attribute sind optional und können synchronisiert werden, wenn Sie sich entscheiden.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 inaktive Eigenschaften – durch Aktivieren dieses Kontrollkästchens werden nur aktive Datensätze synchronisiert.Filter inactive properties - Checking this box will only sync active records.
  • Ersetzen nicht unterstützter Zeichen – durch das Aktivieren dieses Kontrollkästchens werden nicht unterstützte Zeichen automatisch durch unterstützte ersetzt.Replace unsupported characters - Checking this box will automatically replace unsupported characters with supported ones.
  • Synchronisierungsoption für Abschnittsgruppen Anzeigename – durch das Aktivieren dieses Kontrollkästchens können Lehrer den Abschnitt Anzeigenamen nach der ersten Synchronisierung steuern und SDS daran hindern, Änderungen durch den Abschnitt DisplayName zu überschreiben, die von Lehrern vorgenommen wurden.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.
  • Studenten Zugriff verzögern – durch Aktivieren dieser Option können Sie ein zukünftiges Datum für Schüler festlegen, um Ihre Klassen anzuzeigen.Delay Student Access - Enabling this option will allow you to set a future date for students to view their classes. Deaktivieren Sie diese Option, um Teilnehmern die Möglichkeit zu geben, Ihre Klassen sofort anzuzeigen.Disable this option to allow students view their classes immediately.
  • Wann sollten wir die Synchronisierung dieses Profils beenden?When should we stop syncing this profile? -Normalerweise möchten Sie dies am Ende des Schuljahres tun.- You will typically want to do this at the end of the school year. Wenn die Synchronisierung dieses Profils nicht mehr möglich ist, können Sie die mit diesem Profil verknüpften Klassen zurückziehen.Once we stop syncing this profile, you will have the option to retire the classes associated with this profile.
  1. Wählen Sie auf der Seite Lehrer Optionen die entsprechenden Optionen für den Identitäts Abgleich aus, bestätigen Sie, dass die Lehrer Eigenschaften ausgewählt sind, und klicken Sie dann auf weiter.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

  • Primärschlüssel (Zielverzeichnis) : Dies ist das Benutzerattribut in Azure AD, das für die SDS-Identitäts Übereinstimmung verwendet wird.Primary Key (Target Directory) - This is the User attribute in Azure AD used for SDS Identity Matching. Sehen Sie sich das Identitäts Übereinstimmungs Video an, um weitere Informationen zum Auswählen des entsprechenden Zielverzeichnis Attributs zu erhalten und die Identitäts Übereinstimmungs Einstellungen für den Lehrer ordnungsgemäß zu konfigurieren.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) : Dies ist ein optionaler Domänenwert, den Sie dem ausgewählten Quellverzeichnis Attribut hinzufügen können, um den Lehrer Identitäts Abgleich abzuschließen.Domain (optional) - This is an optional domain value that you can add to the selected Source Directory attribute to complete your Teacher Identity Matching. Wenn Sie mit einem userPrincipalName-oder Mail-Attribut übereinstimmen müssen, müssen Sie eine Domäne in der Zeichenfolge enthalten.If you need to match to a UserPrincipalName or Mail attribute, you must have a domain included in the string. Das Source-Attribut muss entweder die Domäne bereits enthalten, oder Sie können die entsprechende Domäne mithilfe dieses Dropdownmenüs an das Source-Attribut anfügen.Your source attribute must either include the domain already or you can append the appropriate domain to the source attribute using this dropdown menu.
  • Primärschlüssel (Quellverzeichnis) : Dies ist das Teacher-Attribut in PowerSchool, das für die SDS-Identitäts Übereinstimmung verwendet wird.Primary Key (Source Directory) - This is the Teacher attribute in PowerSchool used for SDS Identity Matching. Sehen Sie sich das Identitäts Übereinstimmungs Video an, um weitere Informationen zum Auswählen des entsprechenden Quellverzeichnis Attributs zu erhalten und die Identitäts Übereinstimmungs Einstellungen für Lehrer ordnungsgemäß zu konfigurieren.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. Wählen Sie auf der Seite Kursteilnehmer Optionen die entsprechenden Optionen für den Identitäts Abgleich aus, bestätigen Sie, dass die Kursteilnehmer Eigenschaften ausgewählt sind, und klicken Sie dann auf weiter.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

  • Primärschlüssel (Quellverzeichnis) -Dies ist das Student-Attribut in PowerSchool, das für die SDS-Identitäts Übereinstimmung verwendet wird.Primary Key (Source Directory) - This is the Student attribute in PowerSchool used for SDS Identity Matching. Sehen Sie sich das Identitäts Übereinstimmungs Video an, um weitere Informationen zum Auswählen des entsprechenden Quellverzeichnis Attributs zu erhalten und die Identitäts Übereinstimmungs Einstellungen für Lehrer ordnungsgemäß zu konfigurieren.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.
  • Primärschlüssel (Zielverzeichnis) : Dies ist das Benutzerattribut in Azure AD, das für die SDS-Identitäts Übereinstimmung verwendet wird.Primary Key (Target Directory) - This is the User attribute in Azure AD used for SDS Identity Matching. Sehen Sie sich das Identitäts Übereinstimmungs Video an, um weitere Informationen zum Auswählen des entsprechenden Zielverzeichnis Attributs zu erhalten und die Identitäts Übereinstimmungs Einstellungen für den Kursteilnehmer ordnungsgemäß zu konfigurieren.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) – Dies ist ein optionaler Domänenwert, den Sie dem ausgewählten Quellverzeichnis Attribut hinzufügen können, um den Kursteilnehmer-Identitäts Abgleich abzuschließen.Domain (optional) - This is an optional domain value that you can add to the selected Source Directory attribute to complete your Student Identity Matching. Wenn Sie mit einem userPrincipalName-oder Mail-Attribut übereinstimmen müssen, müssen Sie eine Domäne in der Zeichenfolge enthalten.If you need to match to a UserPrincipalName or Mail attribute, you must have a domain included in the string. Das Source-Attribut muss entweder die Domäne bereits enthalten, oder Sie können die entsprechende Domäne mithilfe dieses Dropdownmenüs an das Source-Attribut anfügen.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. Stellen Sie auf der Seite Überprüfung sicher, dass Sie die entsprechenden Auswahl getroffen haben.On the Review page, ensure you've made the appropriate selections. Wenn keine weiteren Änderungen erforderlich sind, klicken Sie auf Profil erstellen.If no additional changes are needed, click Create Profile.

Gefilterter Zustand der PowerSchool-SIS-APIFiltered State of PowerSchool SIS API

  • Studenten und Anmeldungen – SDS synchronisiert einige Schüler basierend auf Schul Zuordnung und Status.Students and enrollments – SDS syncs some students based on school association and status.

    • SynchronisiertSynced
      • VorregistriertPre-enrolled
      • AktivActive
    • Nicht synchronisiertNot Synced
      • AbsolvierteGraduated
      • AusgelassenDropped Out
      • WeitergeleitetTransferred Out
  • Teachers – SDS synchronisiert einige Lehrer basierend auf Schulvereinigung und Mitarbeitertyp.Teachers – SDS syncs some teachers based on school association, and staff type.

    • SynchronisiertSynced
      • LehrerTeacher
      • WechselnSubstitute
    • Nicht synchronisiertNot Synced
      • Mittags MitarbeiterLunch Staff
      • StabStaff
      • Nicht zugewiesenNot Assigned
  • Klassen und Schulen – SDS synchronisiert alle innerhalb des ausgewählten Schuljahres.Classes and Schools- SDS syncs all within the selected school year.

Änderungen an der Filterung-PowerSchool. PNG

Video: Abgleichen von Quell-und Zielattributen für die SynchronisierungVideo: How to match source and target attributes for sync

Verschiedene Beispiele für die Übereinstimmung von Logik Erfolg und Fehler bei der Synchronisierung finden Sie im Video zur Identitäts Übereinstimmung:For various examples of matching logic success and failure for sync, watch the Identity Matching video:

Übersicht über School Data SyncOverview of School Data Sync