SDS V2.1 CSV-Dateiformat

Sie können CSV-Dateien (durch Trennzeichen getrennte Werte) im SDS V2.1-Format verwenden, um Ihr Schulinformationssystem (SIS) mit Office 365 zu synchronisieren. Wenn Sie das CSV-Dateiformat SDS V2.1 zum Erfassen der Datenkategorien verwenden, können Sie die wichtigsten SDS-Funktionen für die Bereitstellung erweitern. Es hilft Ihnen auch, die Erfahrungen für die Microsoft 365-Produkte und -Features zu verbessern. Das CSV-Dateiformat SDS V2.1 erweitert weiterhin die unterstützten Datenkategorien.

Wenn Sie das SDS V2.1-Format verwenden, müssen die Dateien entsprechend formatiert sein. Laden Sie die Dateien hoch, die genau wie detailliert benannt sind. Bei Spaltenüberschriften wird die Groß-/Kleinschreibung beachtet. CSV-Dateien müssen im UTF-8-Format und RFC-kompatibel sein. Außerdem akzeptieren wir keine Zeilenumbrüche in eingehenden Daten. Informationen zum Überprüfen und Herunterladen eines Beispielsatzes von SDS V2.1-CSV-Dateien finden Sie im SDS-GitHub-Repository.

Wichtig

Nach dem ersten Upload während der Erstellung Ihres eingehenden Datenflusses müssen Sie immer denselben Satz von Dateien für nachfolgende Uploads bereitstellen, unabhängig von Datenänderungen, die in den optionalen Dateien vorgenommen wurden oder nicht. Wenn Sie dies nicht tun, ermittelt das System, dass die Datensätze nicht mehr aktiv sind, und markiert sie als solche.

Erforderlich: Die folgenden drei Dateien müssen bereitgestellt werden. Wenn Sie nur Benutzer und keine Klassen verwalten, müssen Sie nur diese Dateien bereitstellen. 

  • orgs.csv

  • users.csv

  • roles.csv

Optional/Erforderlich: Die folgenden beiden Dateien sind nicht erforderlich, wenn Sie nur Benutzer verwalten. Wenn Sie auch Klassen und Klassenregistrierungen verwalten, müssen Sie die beiden unten aufgeführten Dateien zusammen mit den drei oben aufgeführten Dateien bereitstellen.

  • classes.csv

  • enrollments.csv

Optional: Im Folgenden sind optionale Dateien aufgeführt, die zur Verbesserung der Benutzerfreundlichkeit verwendet werden. Diese Dateien sind nicht erforderlich, es sei denn, die dateien oben enthalten Datenverweise basierend auf den nachstehenden Hinweisen. 

  • academicSessions.csv (Wenn Ihr roles.csv, classes.csv oder courses.csv Daten zu akademischen Sitzungen enthält, sollten die entsprechenden Daten bereitgestellt werden, um Fehlermeldungen bei der Datenverarbeitung zu vermeiden.)

  • courses.csv (Wenn Ihre classes.csv Daten Links zu Kursen enthalten, sollten die entsprechenden Daten bereitgestellt werden, um Fehlermeldungen bei der Datenverarbeitung zu vermeiden.)

  • demographics.csv

  • userFlags.csv

  • relationships.csv

Jede CSV-Datei muss Daten für die Felder enthalten, die unter "Erforderlich" mit "Ja" angegeben sind. Die felder mit "Nein" sind "Optional"-Daten. Die als "Erforderlich" gekennzeichneten Feldüberschriften müssen in den angegebenen Dateien vorhanden sein, andernfalls werden sie nicht akzeptiert. Die als "Optional" markierten Feldüberschriften müssen nicht in den Dateien vorhanden sein, wenn die entsprechenden optionalen Daten nicht übergeben werden.

Die Felder mit definierten Aufzählungswerten, die in der Spalte "Datentypen" markiert sind, verfügen über einen bestimmten Satz von Werten, die sie unterstützen. Die unterstützten Standardwerte für Enumerationsfelder finden Sie unter Standardliste der Werte.

orgs.csv

Feld Pflichtfeld? Beispiel Datentyp
sourcedId Ja 10001 Eindeutige ID
name Ja Technische Hochschule Zeichenfolge
type Ja College Enum
parentSourcedId Nein 10000 Eindeutige ID

users.csv

Feld Pflichtfeld? Beispiel Datentyp
sourcedId Ja 14001 Eindeutige ID
Benutzername Ja cbeane@domain.com Zeichenfolge
familyName Ja (nur beim Erstellen von Benutzern) Craig Zeichenfolge
givenName Ja (nur beim Erstellen von Benutzern) Beane Zeichenfolge
activeDirectoryMatchId Nein craig.beane@domain.com Zeichenfolge
email Nein cbeane@domain.com E-Mails
phone Nein +1234567890 Telefon
Sms Nein +1234567890 Telefon
userNumber Nein 14001 Zeichenfolge
  • familyName und givenName sind für Benutzer erforderlich, wenn sie die Option "Nicht übereinstimmende Benutzer erstellen" verwenden.
  • familyName, givenName und email sind für Benutzer erforderlich, wenn sie die Option "Studentenkontaktzuordnungen" für Benutzer verwenden, die eine Kontaktbeziehungsrolle in relationships.csv haben. Benutzern, die Mitarbeiter, aber auch Kontakte sind, wird empfohlen, zwei Benutzerdatensätze aufgelistet zu haben, wobei der Benutzerdatensatz kontakte ihrer privaten E-Mail-Adresse zugeordnet ist.
  • Erwarten Sie, dass Telefon- und SMS-Felder basierend auf dem E.164-Standard formatiert werden, bei dem das Pluszeichen verwendet und von der Telefonnummer oder besser gesagt dem Pluszeichen gefolgt von Landesvorwahl, Ortsvorwahl, Telefonpräfix und Zeilennummer gefolgt wird.
  • password wird nicht mehr zum Angeben des Standardkennworts zum Erstellen neuer Benutzer verwendet.

roles.csv

Feld Pflichtfeld? Beispiel Datentyp
userSourcedId Ja 14001 Eindeutige ID
orgSourcedId Ja 10001 Eindeutige ID
role Ja student Enum
sessionSourcedId Nein FS2021 Eindeutige ID
grade Nein PS1 Enum
isPrimary Nein true Boolesch
roleStartDate Nein 2020-08-24 Datum
roleEndDate Nein 2020-12-11 Datum
  • Erfordert einen Verweis auf den zugeordneten Benutzer, der das Feld "userSourcedId" verwendet. Dadurch entsteht eine Abhängigkeit von der users.csv-Datei.
  • Erfordert einen Verweis auf die zugeordnete Organisation mithilfe des Felds "orgSourcedId". Dadurch entsteht eine Abhängigkeit von der orgs.csv-Datei.
  • Falls übergeben: Dies erfordert einen Verweis auf die zugeordneten Begriffe (akademische Sitzungen) mithilfe des Felds "sessionSourcedId". Dadurch entsteht eine Abhängigkeit von der academicSessions.csv-Datei.
  • isPrimary gibt an, ob diese Rolle die primäre (true) oder sekundäre Rolle (false) für diese Organisation ist. Wenn mehrere Rollen übergeben werden, sollte für denselben Benutzer und dieselbe Organisation nur eine primäre Rolle für jede Organisation auf (true) festgelegt sein.
  • Datumswerte, die in ISO8601 Format angegeben werden sollen.

classes.csv

Feld Pflichtfeld? Beispiel Datentyp
sourcedId Ja 12001 Eindeutige ID
orgSourcedId Ja 10001 Eindeutige ID
title Ja Informatik 101 Zeichenfolge
sessionSourcedIds Nein FS2021 Eindeutige ID[]
courseSourcedId Nein C12001 Eindeutige ID
code Nein 12001 Zeichenfolge
  • Dies erfordert einen Verweis auf die zugeordnete Schule (Organisation) mithilfe des Felds "orgSourcedId". Dadurch entsteht eine Abhängigkeit von der orgs.csv-Datei.
  • Falls übergeben: Dies erfordert einen Verweis auf die zugeordneten Begriffe (akademische Sitzungen) mithilfe des Felds "sessionSourcedIds". Dadurch entsteht eine Abhängigkeit von der academicSessions.csv-Datei.
  • Falls bestanden: Wenn ein Kurs mehreren Sitzungen im selben Akademischen Jahr zugeordnet ist, z. B. Herbstsemester und Frühjahrssemester, können Sie beide sourcedId für die Sitzungen im Datensatz angeben. Werte sollten in einer einzelnen Zeichenfolge kombiniert werden, wobei die Werte in Anführungszeichen eingeschlossen und durch Kommas getrennt werden.
    • Die Zuordnung zu mehreren sessionSourcedIds wird nur in Data Lake gespeichert.
    • Das Microsoft 365-Gruppenerweiterungsattribut für Sitzungs-IDs unterstützt nicht mehrere Zuordnungen.
  • Falls übergeben: Dies erfordert einen Verweis auf den zugeordneten Kurs mithilfe des Felds "courseSourcedId". Dadurch entsteht eine Abhängigkeit von der courses.csv-Datei.

enrollments.csv

Feld Pflichtfeld? Beispiel Datentyp
classSourcedId Ja 12001 Eindeutige ID
userSourcedId Ja 14001 Eindeutige ID
role Ja student Enum
  • Dies erfordert einen Verweis auf die zugeordnete Klasse mithilfe des Felds "classSourcedId". Dadurch entsteht eine Abhängigkeit von der classes.csv-Datei.
  • Dies erfordert einen Verweis auf den zugeordneten Benutzer mithilfe des Felds "userSourcedId". Dadurch entsteht eine Abhängigkeit von der users.csv-Datei.

academicSessions.csv

Abgelegt Pflichtfeld? Beispiel Datentyp
sourcedId Ja FS2021 Eindeutige ID
title Ja Herbstsemester Zeichenfolge
type Ja Semester Enum
schoolYear Ja 2021 Enum
startDate Ja 2020-08-24 Datum
endDate Ja 2020-12-11 Datum
  • Es wird erwartet, dass Datumswerte in ISO8601 Format angegeben werden.

courses.csv

Feld Pflichtfeld? Beispiel Datentyp
sourcedId Ja C12001 Eindeutige ID
orgSourcedId Ja 10001 Eindeutige ID
title Ja Informatik 101 Zeichenfolge
code Nein CS101 Zeichenfolge
schoolYearSourcedId Nein Y2021 Eindeutige ID
subject Nein 10 Enum
grade Nein Undergraduate Enum
  • Dies erfordert einen Verweis auf die zugeordnete organization (Organisation) mithilfe des OrgSourcedId-Felds. Dadurch entsteht eine Abhängigkeit von der orgs.csv-Datei.
  • Falls bestanden: Dies erfordert einen Verweis auf den zugehörigen Datensatz des Akademischen Sitzungsjahres mithilfe des Felds "schoolYearSourcedId", wobei der Typ = schoolYear ist. Dadurch entsteht eine Abhängigkeit von der academicSessions.csv-Datei.

relationships.csv

Feld Pflichtfeld? Beispiel Datentyp
userSourcedId Ja 14001 Eindeutige ID
relationshipUserSourcedId Ja P14001 Eindeutige ID
relationshipRole Ja Wächter Enum
  • Wenn Sie auch Kontaktbeziehungen (Erziehungsberechtigte) synchronisieren, müssen Sie einen Datensatz für diese in die users.csv aufnehmen.
  • Dies erfordert einen Verweis auf den zugeordneten Benutzer mithilfe des Felds "userSourcedId". Dadurch entsteht eine Abhängigkeit von der users.csv-Datei.
  • Dies erfordert einen Verweis auf den zugeordneten Benutzer mithilfe des Felds "relationshipUserSourcedId". Dadurch entsteht eine Abhängigkeit von der users.csv-Datei.
  • Darüber hinaus sind familyName, givenName und email für Benutzer mit Kontaktbeziehungsrollen erforderlich.

demographics.csv

Feld Pflichtfeld? Beispiel Datentyp
userSourcedId Ja 14001 Eindeutige ID
Sex Nein Männlich Enum
birthDate Nein 2001-07-20 Datum
birthCity Nein Woodenville Zeichenfolge
birthState Nein WA Enum
birthCountry Nein USA Zeichenfolge
ethnicityCodes Nein hispanicOrLatinoEthnicity Enum[]
raceCodes Nein demographicRaceTwoOrMoreRaces Enum[]
  • Dies erfordert einen Verweis auf den zugeordneten Benutzer mithilfe des Felds "userSourcedId". Dadurch entsteht eine Abhängigkeit von der users.csv-Datei.
  • Mehrere Werte, die "raceCodes" zugeordnet sind, sollten in einer einzigen Zeichenfolge kombiniert werden, wobei die Werte in Anführungszeichen eingeschlossen und durch Kommas getrennt sind.

userFlags.csv

Feld Pflichtfeld? Beispiel Datentyp
userSourcedId Ja 14001 Eindeutige ID
Flag Ja Lep Enum
  • Dies erfordert einen Verweis auf den zugeordneten Benutzer mithilfe des Felds "userSourcedId". Dadurch entsteht eine Abhängigkeit von der users.csv-Datei.