Formato file CSV SDS V2.1

È possibile usare i file CSV (valori delimitati da virgole) nel formato SDS V2.1 per sincronizzare il sistema informativo dell'istituto di istruzione (SIS) con Office 365. L'uso del formato di file CSV SDS V2.1 per inserire le categorie di dati consente di illuminare le funzionalità SDS di base per il provisioning. Consente inoltre di migliorare le esperienze per i prodotti e le funzionalità di Microsoft 365. Il formato di file CSV SDS V2.1 continuerà ad espandere le categorie di dati supportate.

Se si usa il formato SDS V2.1, i file devono essere formattati in modo appropriato. Caricare i file, denominati esattamente come dettagliati. Le intestazioni di colonna fanno distinzione tra maiuscole e minuscole. I file CSV devono essere in formato UTF-8 e conformi a RFC. Inoltre, non si accettano interruzioni di riga nei dati in ingresso. Per esaminare e scaricare un set di esempi di file CSV SDS V2.1, vedere il repository SDS GitHub.

Importante

Dopo il caricamento iniziale durante la creazione del flusso in ingresso, è necessario fornire sempre lo stesso set di file per i caricamenti successivi, indipendentemente dalle modifiche apportate ai dati nei file facoltativi o meno. In caso contrario, il sistema determinerà che i record non sono più attivi e li contrassegnerà come tali.

Obbligatorio: devono essere forniti i tre file seguenti. Se si gestiscono solo utenti e non classi, è sufficiente fornire questi file. 

  • orgs.csv

  • users.csv

  • roles.csv

Facoltativo/ Obbligatorio: i due file seguenti non sono obbligatori se si gestiscono solo gli utenti. Se si gestiscono anche classi e registrazioni di classi, è necessario fornire i due file elencati di seguito, insieme ai tre file precedenti.

  • classes.csv

  • enrollments.csv

Facoltativo: i seguenti sono file facoltativi e vengono usati per migliorare le esperienze. Questi file non sono obbligatori, a meno che i file precedenti non abbiano riferimenti ai dati basati sulle note seguenti. 

  • academicSessions.csv (se il roles.csv, classes.csv o courses.csv contiene dati di sessione accademica, è necessario fornire i dati corrispondenti per evitare messaggi di errore durante l'elaborazione dei dati.

  • courses.csv (se i dati classes.csv contengono collegamenti ai corsi, è necessario fornire i dati corrispondenti per evitare messaggi di errore durante l'elaborazione dei dati.

  • demographics.csv

  • userFlags.csv

  • relationships.csv

Ogni file CSV deve contenere dati per i campi annotati 'Sì' in 'Obbligatorio', i campi annotati 'No' sono dati 'Facoltativi'. Le intestazioni di campo contrassegnate come "Obbligatorio" devono esistere nei file forniti o non verranno accettate. Le intestazioni di campo contrassegnate come "Facoltativo" non devono essere presenti nei file se non vengono passati i dati facoltativi corrispondenti.

I campi con valori enumerati definiti come contrassegnati nella colonna 'Tipi di dati' hanno un set specifico di valori supportati. Il set supportato di valori predefiniti per i campi Enum vedere Elenco predefinito di valori.

orgs.csv

Campo Obbligatorio? Esempio Tipo di dati
sourcedId 10001 ID univoco
Nome College of Engineering Stringa
tipo Università Enum
parentSourcedId No 10000 ID univoco

users.csv

Campo Obbligatorio? Esempio Tipo di dati
sourcedId 14001 ID univoco
Nome utente cbeane@domain.com Stringa
Familyname Sì (solo se si creano utenti) Craig Stringa
givenName Sì (solo se si creano utenti) Beane Stringa
activeDirectoryMatchId No craig.beane@domain.com Stringa
email No cbeane@domain.com Posta elettronica
telefono No +1234567890 Telefono
Sms No +1234567890 Telefono
userNumber No 14001 Stringa
  • FamilyName e givenName sono necessari per gli utenti se si usa l'opzione "Crea utenti non corrispondenti".
  • FamilyName, givenName e posta elettronica sono necessari per gli utenti se si usa l'opzione "Associazioni di contatti degli studenti" per gli utenti con un ruolo di relazione di contatto in relationships.csv. Gli utenti che sono personale, ma anche i contatti, è consigliabile che abbiano due record utente elencati, con il record utente contatti associato al proprio indirizzo di posta elettronica privato.
  • Si prevede che i campi telefono e SMS vengano formattati in base allo standard E.164 in cui il carattere più viene usato e completato dal numero di telefono, o piuttosto il carattere più seguito da codice paese, prefisso di area, prefisso telefonico e numero di riga.
  • password non viene più usata per fornire la password predefinita per la creazione di nuovi utenti.

roles.csv

Campo Obbligatorio? Esempio Tipo di dati
userSourcedId 14001 ID univoco
orgSourcedId 10001 ID univoco
Ruolo Studente Enum
sessionSourcedId No FS2021 ID univoco
Grado No PS1 Enum
isPrimary No true Booleano
roleStartDate No 2020-08-24 Data
roleEndDate No 2020-12-11 Data
  • Richiede un riferimento all'utente associato usando il campo 'userSourcedId'. Ciò produce una dipendenza dal file users.csv.
  • Richiede un riferimento all'organizzazione associata usando il campo 'orgSourcedId'. Ciò produce una dipendenza dal file orgs.csv.
  • Se superato: richiede un riferimento ai termini associati (sessioni accademiche) usando il campo 'sessionSourcedId'. Ciò produce una dipendenza dal file academicSessions.csv.
  • isPrimary indica se questo ruolo è il ruolo primario (true) o secondario (false) per l'organizzazione. Se si passano più ruoli, per lo stesso utente e la stessa organizzazione, dovrebbe essere presente un solo ruolo primario impostato su (true) per ogni organizzazione.
  • Valori di data da specificare in formato ISO8601.

classes.csv

Campo Obbligatorio? Esempio Tipo di dati
sourcedId 12001 ID univoco
orgSourcedId 10001 ID univoco
title Informatica 101 Stringa
sessionSourcedIds No FS2021 ID univoco[]
courseSourcedId No C12001 ID univoco
code No 12001 Stringa
  • Ciò richiede un riferimento all'istituto di istruzione associato (organizzazione) usando il campo 'orgSourcedId'. Ciò produce una dipendenza dal file orgs.csv.
  • Se superato: richiede un riferimento ai termini associati (sessioni accademiche) usando il campo 'sessionSourcedIds'. Ciò produce una dipendenza dal file academicSessions.csv.
  • Se viene passata: se una classe è associata a più sessioni nello stesso anno accademico, ad esempio Fall Semester e Spring Semester, è possibile fornire entrambi gli sourcedId per le sessioni nel record. I valori devono essere combinati in una singola stringa con i valori racchiusi tra virgolette e separati da virgole.
    • L'associazione a più sessionSourcedIds viene archiviata solo in Data Lake.
    • L'attributo di estensione Gruppo di Microsoft 365 per gli ID sessione non supporta più associazioni.
  • Se superato: richiede un riferimento al corso associato usando il campo 'courseSourcedId'. Ciò produce una dipendenza dal file courses.csv.

enrollments.csv

Campo Obbligatorio? Esempio Tipo di dati
classSourcedId 12001 ID univoco
userSourcedId 14001 ID univoco
Ruolo Studente Enum
  • Ciò richiede un riferimento alla classe associata usando il campo 'classSourcedId'. Ciò produce una dipendenza dal file classes.csv.
  • Ciò richiede un riferimento all'utente associato usando il campo 'userSourcedId'. Ciò produce una dipendenza dal file users.csv.

academicSessions.csv

Archiviato Obbligatorio? Esempio Tipo di dati
sourcedId FS2021 ID univoco
title Semestre di autunno Stringa
tipo Semestre Enum
schoolYear 2021 Enum
Startdate 2020-08-24 Data
Enddate 2020-12-11 Data
  • Si prevede che i valori di data vengano forniti in formato ISO8601.

courses.csv

Campo Obbligatorio? Esempio Tipo di dati
sourcedId C12001 ID univoco
orgSourcedId 10001 ID univoco
title Informatica 101 Stringa
code No CS101 Stringa
schoolYearSourcedId No Y2021 ID univoco
subject No 10 Enum
Grado No Laurea Enum
  • Ciò richiede un riferimento all'organizzazione associata (organizzazione) usando il campo orgSourcedId. Ciò produce una dipendenza dal file orgs.csv.
  • Se superato: richiede un riferimento al record dell'anno della sessione accademica associato usando il campo "schoolYearSourcedId" in cui il tipo = schoolYear. Ciò produce una dipendenza dal file academicSessions.csv.

relationships.csv

Campo Obbligatorio? Esempio Tipo di dati
userSourcedId 14001 ID univoco
relationshipUserSourcedId P14001 ID univoco
relationshipRole Custode Enum
  • Se si sincronizzano anche le relazioni di contatto (tutori), è necessario includere un record nel users.csv.
  • Ciò richiede un riferimento all'utente associato usando il campo 'userSourcedId'. Ciò produce una dipendenza dal file users.csv.
  • Ciò richiede un riferimento all'utente associato usando il campo 'relationshipUserSourcedId'. Ciò produce una dipendenza dal file users.csv.
  • Inoltre, familyName, givenName e posta elettronica sono necessari per gli utenti con ruoli Contact Relationship.

demographics.csv

Campo Obbligatorio? Esempio Tipo di dati
userSourcedId 14001 ID univoco
Sesso No Uomo Enum
Nascita No 2001-07-20 Data
birthCity No Woodenville Stringa
birthState No ZM Enum
birthCountry No USA Stringa
ethnicityCodes No ispanicOrLatinoEthnicity Enumerazione[]
raceCodes No demographicRaceTwoOrMoreRaces Enumerazione[]
  • Ciò richiede un riferimento all'utente associato usando il campo 'userSourcedId'. Ciò produce una dipendenza dal file users.csv.
  • Più valori che eseguono il mapping a "raceCodes" devono essere combinati in una singola stringa con i valori racchiusi tra virgolette e separati da virgole.

userFlags.csv

Campo Obbligatorio? Esempio Tipo di dati
userSourcedId 14001 ID univoco
Bandiera Lep Enum
  • Ciò richiede un riferimento all'utente associato usando il campo 'userSourcedId'. Ciò produce una dipendenza dal file users.csv.