Bereitstellen von School Data Sync (klassisch) mithilfe der OneRoster® 1.1-API

Wichtig

School Data Sync (klassisch) wird bis Ende 2024 durch die neue School Data Sync-Benutzeroberfläche ersetzt. Wir empfehlen Ihnen, ihren Übergang zur neuen Benutzeroberfläche für Ihr nächstes Schuljahr zu planen.

OneRoster® ist ein Branchenstandardformat für den Austausch von Sis-Daten (Student Information System). Die OneRoster-REST-APIs® sind das Mittel, mit dem wir Objekte aus SISs synchronisieren können, die OneRoster-APIs® über den SDS-Dienst (klassisch) für Microsoft 365 bereitstellen. Mit dieser Synchronisierungsmethode können Sie mithilfe der REST-basierten OneRoster 1.1-APIs, die vom SIS bereitgestellt werden, eine direkte Verbindung mit Ihrem SIS herstellen und Daten direkt synchronisieren, anstatt CSV-Dateien zu verwenden. Mithilfe der OneRoster-API® zum Erfassen der hervorgehobenen Datenkategorien können Sie kerne SDS-Funktionen (klassisch) für die Bereitstellung aufhellen. Außerdem können Sie die Benutzererfahrung für die aufgeführten Microsoft 365 -Produkte und -Features (Microsoft 365) verbessern.

Befolgen Sie die anweisungen in diesem Artikel, um SDS (klassisch) mithilfe der OneRoster® Sync-Methode einzurichten.

Voraussetzungen

Bevor Sie mit der Synchronisierung mit SDS (klassisch) mithilfe der OneRoster-Synchronisierungsmethode® beginnen, lesen Sie die Übersicht über SDS (klassisch), und stellen Sie sicher, dass die folgenden Voraussetzungen erfüllt sind:

• Ein Office 365 for Education-Mandant
• Berechtigungen für globale Admin

Hinweis

Die Daten, die Sie über SDS (klassisch) bereitstellen, können für Drittanbieter von Anwendungen über ihre Apps zugänglich sein. Daher sollten Sie nur die Daten synchronisieren, die Sie diesen Dritten zur Verfügung stellen möchten.

Video zur Bereitstellung ansehen

Informationen zum Abgleich der Benutzeridentität finden Sie auch im folgenden Video.

• Video: Abgleichen von Quell- und Zielattributen für die Synchronisierung

Daten, auf die von School Data Sync (klassisch) zugegriffen wird

Wichtig

Durch das Verbinden und Verfügbarmachen von Institutionendaten mit School Data Sync (Klassisch) bestätigen Sie, dass Sie berechtigt sind, diese Daten mit Microsoft freizugeben, und verpflichten sich, die Data Governance-Standards Ihrer organization einzuhalten.

Akademische Sitzungen

Aktion	URL	Erforderliche Filtereigenschaften	Beispiele
getAllAcademicSessions	/academicSessions	schoolJahr, status	/academicSessions?filter=schoolYear='2019' AND status='active'
getAcademicSession	/academicSessions/{academicSession_id}

Benutzer

Aktion	URL	Erforderliche Filtereigenschaften	Beispiele
Getallusers	/Benutzer	status, dateLastModified	/users?filter=status='active' AND dateLastModified'2018-01-25T03>:22:03.297Z'
Getuser	/users/{user_id}

Bildungseinrichtungen

Aktion	URL	Erforderliche Filtereigenschaften	Beispiele
getAllSchools	/Schulen	status, dateLastModified	/users?filter=status='active' AND dateLastModified'2018-01-25T03>:22:03.297Z'
getSchool	/schools/{school_id}
getClassesForSchool	/schools/{school_id}/classes	status, dateLastModified	/schools/{school_id}/classes?filter=dateLastModified'2018-01-25T03>:22:07.209Z'
getStudentsForSchool	/schools/{school_id}/students	status, dateLastModified	/schools/{school_id}/students?filter=dateLastModified'2018-01-25T03>:22:07.209Z'
getTeachersForSchool	/schools/{school_id}/teachers	status, dateLastModified	/schools/{school_id}/teachers?filter=dateLastModified'2018-01-25T03>:22:07.209Z'
getEnrollmentsForSchool	/schools/{school_id}/enrollments	status, dateLastModified, role	/schools/{school_id}/enrollments?filter=role='student'/schools/{school_id}/enrollments?filter=dateLastModified'2018-01-25T03>:22:28.204Z' AND role='teacher'

Kurse

Aktion	URL	Erforderliche Filtereigenschaften	Beispiele
Getclass	/classes/{class_id}

Anmeldungen

Aktion	URL	Erforderliche Filtereigenschaften	Beispiele
getEnrollment	/enrollments/{enrollment_id}

Studenten

Aktion	URL	Erforderliche Filtereigenschaften	Beispiele
getStudent	/students/{student_id}

Lehrer

Aktion	URL	Erforderliche Filtereigenschaften	Beispiele
getTeacher	/teachers/{teacher_id}

Bedingungen

Aktion	URL	Erforderliche Filtereigenschaften	Beispiele
getTerm	/terms/{term_id}

Informationen zu Microsoft Entra Connect-Bereitstellungswarnungen

Wenn Sie SDS (klassisch) für einen Mandanten konfigurieren, der aus dem lokalen Active Directory über Microsoft Entra Connect synchronisiert wird, können Sie feststellen, dass die Anzahl der in Ihrem Fehlclient angezeigten Trennschalter erhöht wird. Dies liegt daran, dass die Microsoft 365-Gruppe nicht mit dem Microsoft Entra Connect Metaverse und dem lokalen Active Directory synchronisiert werden kann. Diese Warnungen haben keine negativen Auswirkungen auf Ihre aktuelle Microsoft Entra Connect-Bereitstellung und stellen lediglich einen Hinweis auf den resultierenden Synchronisierungsfehler bereit. Sie sollten diese Warnungen in Microsoft Entra Connect erwarten, nachdem Sie die Synchronisierung in SDS (klassisch) aktiviert haben. Für jede Klasse, die über SDS (klassisch) synchronisiert wird, wird eine Microsoft 365-Gruppe erstellt.

Synchronisieren Ihrer SIS-Daten mithilfe der OneRoster-API-Synchronisierungsmethode

Nachdem Sie sis/SMS-Zugriff eingerichtet haben, erstellen Sie ein Synchronisierungsprofil in SDS (klassisch), um Ihre Informationen zu synchronisieren.

SDS-Zugriff und erstmalige Anmeldung

Um auf das SDS Admin Portal zuzugreifen, starten Sie einen privaten Webbrowser, navigieren Sie zu sds.microsoft.com, und melden Sie sich dann mit Ihrem Microsoft 365 Global Admin-Konto an.

Erstellen eines Synchronisierungsprofils und Synchronisieren Ihrer SIS-Daten

1. Wählen Sie nach der Anmeldung im linken Navigationsbereich +Profil hinzufügen aus, um ein Synchronisierungsprofil zu erstellen.

   

2. Wählen Sie auf der Seite Verbindungstyp auswählen die Option OneRoster-API und dann ihren SIS-Integrationsanbieter aus dem Dropdownmenü "Anbieter auswählen" aus. Wählen Sie nach Abschluss des Vorgangs Start aus.

   

   • Benennen Sie dieses Profil : Geben Sie einen Namen für Ihr Synchronisierungsprofil ein. Dieser Name wird verwendet, um das Synchronisierungsprofil im SDS-Dashboard (klassisch) zu identifizieren, und kann nach Abschluss der Profileinrichtung nicht mehr geändert werden.
   • Wählen Sie Ihre Synchronisierungsmethode aus: Wählen Sie zwischen den verfügbaren Synchronisierungsmethoden aus. Wenn Sie die Synchronisierung mit OneRoster durchführen, wählen Sie Verbinden über eine API-Synchronisierungsmethode und dann OneRoster 1.1-API für die Dienstauswahl aus.

3. Wählen Sie auf der Seite Synchronisierungsoptionen die entsprechende Option aus, um neue Benutzer zu erstellen oder vorhandene Benutzer zu synchronisieren. Schließen Sie dann Ihre Auswahl auf der Seite nach Bedarf ab.

   Hinweis

   Wenn sie mit der Option zum Erstellen neuer Benutzer ausgeführt werden und V2.1-CSV einführen möchten, haben wir ein Tool veröffentlicht, mit dem Sie sich auf die Unterstützung des V2.1-CSV-Formats als Teil Ihres Übergangs zur Schule vorbereiten können. Weitere Informationen finden Sie unter Aktualisieren von Anker-IDs vor dem Erstellen von Benutzern.

   

   • Vorhandene Benutzer : Wählen Sie diese Option aus, wenn Sie bereits Benutzerkonten in Ihrem Microsoft 365-Mandanten für jeden der in OneRoster enthaltenen Schüler und Lehrer erstellt haben.
   • Neue Benutzer : Wählen Sie diese Option aus, wenn SDS (klassisch) Benutzerkonten für jeden Ihrer Schüler und Lehrer erstellen soll, die in OneRoster enthalten sind.
   • Webzugriffs-URL : Dies ist die OneRoster-Basis-API-URL für Ihre SIS/SMS, auf die über das Internet zugegriffen werden kann.
   • Client-ID : Wird verwendet, um eine Verbindung mit Ihrer SIS-/SMS-OneRoster-API herzustellen.
   • Geheimer Clientschlüssel : Wird verwendet, um eine Verbindung mit Ihrer SIS-/SMS-OneRoster-API herzustellen.
   • Zu synchronisierende Schulen auswählen : Mit dieser Option können Sie die Schule auswählen, die Sie aus OneRoster synchronisieren möchten.
   • Schuleigenschaften : Wählen Sie die School-Attribute aus, die eingeschlossen werden sollen.
   • Abschnittseigenschaften : Wählen Sie die Abschnittsattribute aus, die eingeschlossen werden sollen.
   • Inaktive Eigenschaften filtern : Wenn Sie dieses Kontrollkästchen aktivieren, werden nur aktive Datensätze synchronisiert.
   • Teamerstellungsoption : Wenn Sie dieses Kontrollkästchen aktivieren, wird sichergestellt, dass SDS (klassisch) die Microsoft 365-Gruppe und das Klassenteam für jede synchronisierte Klasse erstellt. Wenn Sie das Kontrollkästchen deaktiviert lassen, erstellt SDS (klassisch) nur die Microsoft 365-Gruppen.
   • Nicht unterstützte Zeichen ersetzen : Wenn Sie dieses Kontrollkästchen aktivieren, werden nicht unterstützte Zeichen automatisch durch unterstützte Zeichen ersetzt.
   • Synchronisierungsoption für Anzeigename der Abschnittsgruppe : Wenn Sie dieses Kontrollkästchen aktivieren, können Lehrkräfte den Abschnittsanzeigenamen nach der ersten Synchronisierung steuern und verhindern, dass SDS änderungen an Section DisplayName überschreibt, die von Lehrkräften vorgenommen wurden.
   • Zugriff auf Kursteilnehmer verzögern : Wenn Sie diese Option aktivieren, können Sie ein zukünftiges Datum festlegen, an dem Kursteilnehmer ihre Kurse anzeigen können. Deaktivieren Sie diese Option, damit Kursteilnehmer ihre Kurse sofort anzeigen können.
   • Wann sollte die Synchronisierung dieses Profils beendet werden? - In der Regel möchten Sie dies am Ende des Schuljahres tun. Nachdem wir die Synchronisierung dieses Profils beendet haben, haben Sie die Möglichkeit, die diesem Profil zugeordneten Klassen außer Kraft zu setzen.

   Hinweis

   Derzeit funktioniert ein einzelner Mandant mit gemischten Formaten (d. h., dass V1- und V2-Synchronisierungsprofile aktiv ausgeführt werden und beide auf "Mit Insights synchronisieren" festgelegt sind).

   Hinweis

   Die Unterstützung für SIMS- und Infinite Campus-Anbieter für die Synchronisierung mit Insights steht aus.

4. Wählen Sie auf der Seite Lehreroptionen die entsprechenden Identitätsabgleichsoptionen aus, vergewissern Sie sich, dass die Eigenschaften des Lehrers ausgewählt sind, und wählen Sie dann Weiter aus.

   

   • Primärschlüssel (Zielverzeichnis): Dies ist das Benutzerattribute in Microsoft Entra ID, das für den SDS-Identitätsabgleich verwendet wird. Sehen Sie sich das Video zum Identitätsabgleich an, um weitere Informationen zum Auswählen des entsprechenden Zielverzeichnis-Attributs und zum ordnungsgemäßen Konfigurieren der Identitätsabgleichseinstellungen für den Lehrer zu finden.
   • Domäne (optional): Dies ist ein optionaler Domänenwert, den Sie dem ausgewählten Quellverzeichnis-Attribut hinzufügen können, um den Abgleich Ihrer Lehreridentität abzuschließen. Wenn Sie mit einem UserPrincipalName- oder Mail-Attribut übereinstimmen müssen, muss in der Zeichenfolge eine Domäne enthalten sein. Ihr Quellattribute muss entweder die Domäne bereits enthalten, oder Sie können die entsprechende Domäne über dieses Dropdownmenü an das Quellattribute anfügen.
   • Primärschlüssel (Quellverzeichnis): Dies ist das Lehrer-Attribut in OneRoster, das für den SDS-Identitätsabgleich verwendet wird. Sehen Sie sich das Video zum Identitätsabgleich an, um weitere Informationen zum Auswählen des entsprechenden Quellverzeichnis-Attributs und zum ordnungsgemäßen Konfigurieren der Identitätsabgleichseinstellungen für den Lehrer zu finden.

5. Wählen Sie auf der Seite Student-Optionen die entsprechenden Identitätsabgleichsoptionen aus, vergewissern Sie sich, dass die Eigenschaften des Kursteilnehmers ausgewählt sind, und wählen Sie dann Weiter aus.

   

   • Primärschlüssel (Quellverzeichnis): Dies ist das Student-Attribut in OneRoster, das für den SDS-Identitätsabgleich verwendet wird. Sehen Sie sich das Video zum Identitätsabgleich an, um weitere Informationen zum Auswählen des entsprechenden Quellverzeichnis-Attributs und zum ordnungsgemäßen Konfigurieren der Identitätsabgleichseinstellungen für den Lehrer zu finden.
   • Primärschlüssel (Zielverzeichnis): Dies ist das Benutzerattribute in Microsoft Entra ID, das für den SDS-Identitätsabgleich verwendet wird. Sehen Sie sich das Video zum Identitätsabgleich an, um weitere Informationen zum Auswählen des entsprechenden Zielverzeichnis-Attributs und zum ordnungsgemäßen Konfigurieren der Identitätsabgleichseinstellungen für den Kursteilnehmer zu finden.
   • Domäne (optional): Dies ist ein optionaler Domänenwert, den Sie dem ausgewählten Quellverzeichnis-Attribut hinzufügen können, um den Abgleich Ihrer Studentenidentität abzuschließen. Wenn Sie mit einem UserPrincipalName- oder Mail-Attribut übereinstimmen müssen, muss in der Zeichenfolge eine Domäne enthalten sein. Ihr Quellattribute muss entweder die Domäne bereits enthalten, oder Sie können die entsprechende Domäne über das Dropdownmenü an das Quellattribute anfügen.

6. Stellen Sie auf der Seite Überprüfen sicher, dass Sie die entsprechende Auswahl getroffen haben. Wenn sie zufrieden sind, wählen Sie Profil erstellen aus.

   

Gefilterter Status der OneRoster-API

• Schüler und Einschreibungen – SDS synchronisiert einige Schüler basierend auf der Schulvereinigung und status.

  • Synchronisiert
    • Aktiv
  • Nicht synchronisiert
    • Zu löschen

• Lehrer– SDS synchronisiert einige Schüler basierend auf schulbezogener Zuordnung und status.

  • Synchronisiert
    • Aktiv
  • Nicht synchronisiert
    • Zu löschen

• Klassen: SDS synchronisiert einige Klassen basierend auf der Schulzuordnung und dem Mitarbeitertyp.

  • Synchronisiert
    • Aktiv
  • Nicht synchronisiert
    • Zu löschen

• Schulen: SDS synchronisiert einige Schulen basierend auf der Schulzuordnung und dem Mitarbeitertyp.

  • Synchronisiert
    • Aktiv
  • Nicht synchronisiert
    • Zu löschen

  

Video: Bereitstellung der OneRoster-API

Video: Abgleichen von Quell- und Zielattributen für die Synchronisierung

Verschiedene Beispiele für erfolgreiche und fehlerhafte Übereinstimmungslogik für die Synchronisierung watch das Video zum Identitätsabgleich: