Règles régissant tous les fichiers CSV
- Les valeurs des fichiers sont sensibles à la casse.
- Une valeur vide est représentée par deux virgules sans espace entre elles. Par exemple, excluant les guillemets, « ,, » indique une valeur vide, alors que « , , » indique un caractère d'espace, analysé en tant que valeur non valide.
- Les fichiers CSV doivent comprendre un en-tête (première ligne) qui correspond exactement, y compris la casse, au format présenté dans les exemples des sections ci-dessous.
- Les lignes subséquentes du fichier contiennent les données à traiter (insertion, mise à jour, suppression).
- Les noms de fichier sont standard (utilisateurs, organisations, etc.).
Fichier Manifest
Vous devez inclure un fichier Manifest avec chaque envoi. Il contient la version et la liste des fichiers que vous envoyez à Brightspace et indique si les données de la liste indiquent la valeur de chaque envoi.
- Le nom du fichier doit être manifest.csv.
- La valeur peut être l'une des options suivantes :
- Bloc – Pour l'importation d'instantanés en bloc. Si ce mode est utilisé, les champs status et datelastmodified doivent demeurer vierges. Le mode bloc effectue des suppressions implicites uniquement pour les inscriptions.
- Delta – Pour l'importation de deltas. Les champs status et datelastmodified doivent être remplis. Ce mode est le seul qui autorise les suppressions explicites.
- Absent – Si un fichier n'est pas envoyé, il doit être défini comme absent.
L'exemple suivant présente du contenu échantillon pour un fichier Manifest (incluant la ligne d'en-têtes nécessaire) :
propertyName,value
manifest.version,1.0
oneroster.version,1.1
file.academicSessions,delta
file.categories,absent
file.classes,delta
file.classResources,absent
file.courses,delta
file.courseResources,absent
file.demographics,absent
file.enrollments,delta
file.lineItems,absent
file.orgs,delta
file.users,delta
file.resources,absent
file.results,absent
|
Remarque : L'utilisation de OneRoster CSV en mode En bloc permet au SIS de désinscrire automatiquement les utilisateurs des cours et des sections s'ils ne sont plus inclus dans le fichier en bloc. Cette fonction veille à ce que Brightspace soit synchronisé avec le SIS sans nécessiter des données de désinscription explicites dans les fichiers OneRoster. |
Sessions académiques
L'exemple suivant présente deux rangées de contenu pour la session académique (incluant la ligne d'en-tête requise). Le fichier comprend neuf colonnes obligatoires, et chacune d'elles doit comprendre une valeur valide ou être laissée vide, selon le format de fichier.
sourcedId,status,dateLastModified,title,type,startDate,endDate,parentSourcedId,schoolYear
TERM_LW11,active,2016-04-30T00:00:00Z,Spring TERM_LW11,term,2017-04-30,2017-06-30,,2017
GRADINGPERIOD_LW11,active,2016-04-30T00:00:00Z,Full Spring GRADINGPERIOD_LW11,gradingPeriod,2017-04-30,2017-06-30,TERM_LW11,2017
| Colonne |
Champ |
Requis |
Valeurs prises en charge |
Remarques |
| 1 |
SourceId |
O |
|
Stocké avec IPSIS pour la mise en correspondance avec une unité organisationnelle Brightspace |
| 2 |
État |
O |
actif, tobedeleted |
Crée, met à jour ou supprime la session académique. Requis si dateLastModified est présent et si des Deltas sont envoyés. |
| 3 |
DateLastModified |
N |
AAAA-MM-JJTHH:mm:SS:ssZ |
*Suivi interne* |
| 4 |
Titre |
O |
|
Nom et code de l'UO |
| 5 |
Type |
O |
gradingPeriod, semester, schoolyear, term |
Type d'unité organisationnelle |
| 6 |
StartDate |
O |
AAAA-MM-JJ |
La date de début de la session académique peut être copiée dans les dates de début des offres de cours associées. |
| 7 |
EndDate |
O |
AAAA-MM-JJ |
La date de fin de la session académique peut être copiée dans les dates de fin des offres de cours associées. |
| 8 |
ParentSourceId |
N |
|
Ignoré |
| 9 |
Année scolaire |
O |
AAAA |
Sans correspondance |
Organisations
L'exemple suivant présente quatre rangées de contenu pour les organisations (y compris la ligne d'en-tête requise). Le fichier comprend sept colonnes obligatoires, et chacune d'elles doit comprendre une valeur valide ou être laissée vide, selon le format de fichier.
sourcedId,status,dateLastModified,name,type,identifier,parentSourcedId
DISTRICT_LW11,active,2016-04-30T00:00:00Z,DISTRICT_LW11,district,,
SCHOOL_LW111,active,2016-04-30T00:00:00Z,SCHOOL_LW111,school,,DISTRICT_LW11
DISTRICT_LW12,active,2016-04-30T00:00:00Z,DISTRICT_LW12,district,,
SCHOOL_LW121,active,2016-04-30T00:00:00Z,SCHOOL_LW121,school,,DISTRICT_LW12
| Colonne |
Champ |
Requis |
Valeurs prises en charge |
Remarques |
| 1 |
SourceId |
O |
|
Stocké avec IPSIS pour la mise en correspondance avec une unité organisationnelle Brightspace |
| 2 |
État |
N |
active ou tobedeleted |
Crée, met à jour ou supprime l'unité organisationnelle. Requis si dateLastModified est présent et si des Deltas sont envoyés. |
| 3 |
Date de modification la plus récente |
N |
AAAA-MM-JJTHH:mm:SS:ssZ |
*Suivi interne* |
| 4 |
Nom |
O |
|
Nom de l'UO et Code de l'UO (si l'identifiant n'est pas rempli) |
| 5 |
Type |
O |
département, école, arrondissement, région, état, national |
Type d'unité organisationnelle |
| 6 |
Identifiant |
N |
|
Code de l'UO (si fourni) |
| 7 |
ParentSourcedId |
N |
|
La valeur SourcedId de l'unité organisationnelle primaire n'est pas spécifiquement requise; cependant, sans cette information, les unités organisationnelles ne feront pas partie d'une hiérarchie. |
Cours
L'exemple suivant présente deux rangées de contenu échantillon pour les cours (incluant la ligne d'en-têtes nécessaire). Le fichier comprend dix colonnes obligatoires, et chacune d'elles doit comprendre une valeur valide ou être laissée vide, selon le format de fichier.
sourcedId,status,dateLastModified,schoolYearSourcedId,title,courseCode,grades,orgSourcedId,subjects,subjectCodes
COURSE_LW11,active,2017-04-30T00:00:00Z,,Les secrets de la Force,COURSE_LW11,,SCHOOL_LW111,,
COURSE_LW12,active,2017-04-30T00:00:00Z,,Français langue seconde,COURSE_LW12,,SCHOOL_LW111,,
| Colonne |
Champ |
Requis |
Valeurs prises en charge |
Remarques |
| 1 |
SourceId |
O |
|
Stocké avec IPSIS pour la mise en correspondance avec une unité organisationnelle Brightspace (modèle de cours) |
| 2 |
État |
N |
active ou tobedeleted |
Crée, met à jour ou supprime le modèle de cours. Requis si dateLastModified est présent et si des Deltas sont envoyés. |
| 3 |
Date de modification la plus récente |
N |
AAAA-MM-JJTHH:mm:SS:ssZ |
*Suivi interne* |
| 4 |
SchoolYearSourceId |
N |
|
Ignoré |
| 5 |
Titre |
O |
|
Nom de l'UO et Code de l'UO (si l'identifiant n'est pas rempli) |
| 6 |
CourseCode |
N |
|
Code de l’UO (si fourni) |
| 7 |
Notes |
N |
|
Ignoré
|
| 8 |
OrgSourceId |
O |
|
SourceId de l'unité organisationnelle primaire (p. ex. école) |
| 9 |
Objets |
N |
|
Ignoré |
| 10 |
SubjectCodes |
N |
|
Ignoré |
Classes
L'exemple suivant présente trois rangées de contenu échantillon pour les classes (incluant la ligne d'en-têtes nécessaire). Le fichier comprend 14 colonnes obligatoires, et chacune d'elles doit comprendre une valeur valide ou être laissée vide, selon le format de fichier. Chaque dossier est créé en tant qu'offre de cours, et une seule section se trouve sous celle-ci.
sourcedId,status,dateLastModified,title,grades,courseSourcedId,classCode,classType,location,schoolSourcedId,termSourcedIds,subjects,subjectCodes,periods
CLASS_LW111,active,2017-04-30T00:00:00Z,La Force 101,,COURSE_LW11,CLASS_LW111,scheduled,,SCHOOL_LW111,TERM_LW11,,,
CLASS_LW112,active,2017-04-30T00:00:00Z,La Force (avancé),,COURSE_LW11,CLASS_LW112,scheduled,,SCHOOL_LW111,TERM_LW11,,,
CLASS_LW121,active,2017-04-30T00:00:00Z,Français – Lecture LW1,,COURSE_LW12,CLASS_LW121 fr-lecture,scheduled,,SCHOOL_LW111,TERM_LW11,,,
| Colonne |
Champ |
Requis |
Valeurs prises en charge |
Remarques |
| 1 |
SourceId |
O |
|
Stocké avec IPSIS pour la mise en correspondance avec une unité organisationnelle dans Brightspace (offre de cours) |
| 2 |
État |
N |
active ou tobedeleted |
Crée, met à jour ou supprimer l'offre de cours et la section (définir à inactif ou supprimer en fonction de la configuration de de l'Administration d'IPSIS) Requis si dateLastModified est présent |
| 3 |
Date de modification la plus récente |
N |
AAAA-MM-JJTHH:mm:SS:ssZ |
*Suivi interne* |
| 4 |
Titre |
O |
|
Nom et code de l'unité organisationnelle (si la valeur classCode n'est pas fournie) |
| 5 |
Notes |
N |
|
Ignoré |
| 6 |
CourseSourceId |
O |
|
SourceId de l'UO primaire (modèle de cours) |
| 7 |
ClassCode |
N |
|
Code de l'UO (si fourni) |
| 8 |
ClassType |
O |
homeroom, planifié |
Ignoré |
| 9 |
Emplacement |
N |
|
Ignoré
|
| 10 |
SchoolSourceId |
O |
|
SourceId de l'unité organisationnelle primaire (p. ex. école) |
| 12 |
TermsSourceId |
O |
|
SourceId de l'unité organisationnelle primaire (p. ex. session) |
| 12 |
Objets |
N |
|
Ignoré |
| 13 |
SubjectCodes |
N |
|
Ignoré |
| 14 |
Periods |
N |
|
Ignoré |
COMMENCER ICI
Utilisateurs
L'exemple suivant présente cinq rangées de contenu échantillon pour les utilisateurs (incluant la ligne d'en-têtes nécessaire). Le fichier comprend 18 colonnes obligatoires. Chaque colonne doit afficher une valeur valide ou être laissée vide, selon le format de fichier.
|
sourcedId,status,dateLastModified,enabledUser,orgSourcedIds,role,username,userIds,givenName,familyName,middleName,identifier,email,sms,phone,agentSourcedIds,grades,password
STUDENT_LW11,active,2017-04-30T00:00:00Z,TRUE,SCHOOL_LW111,student,STUDENT_LW11,,Luke,Walker,,,email@email.com,,,"PARENT_LW11,TEACHER_LW11,GUARDIAN_LW11",,
STUDENT_LW12,active,2017-04-30T00:00:00Z,TRUE,SCHOOL_LW111,student,STUDENT_LW12,,Prince,Lee,,,email@email.com,,,"PARENT_LW11,GUARDIAN_LW11",,
PARENT_LW11,active,2017-04-30T00:00:00Z,TRUE,SCHOOL_LW111,parent,PARENT_LW11,,Bartholomew,Vadery,,,email@email.com,,,"STUDENT_LW11,STUDENT_LW12",,
GUARDIAN_LW11,active,2017-04-30T00:00:00Z,TRUE,SCHOOL_LW111,guardian,GUARDIAN_LW11,,Obi,Kennedy,,,email@email.com,,,"STUDENT_LW11,STUDENT_LW12",,
TEACHER_LW11,active,2017-04-30T00:00:00Z,TRUE,SCHOOL_LW111,teacher,TEACHER_LW11,,Mac,Yodad,,,email@email.com,,,"STUDENT_LW12,STUDENT_LW11",,
|
| Colonne |
Champ |
Requis |
Valeurs possibles |
Remarques |
| 1 |
SourcedId |
O |
|
OrgDefinedId si l'identifiant n'est pas fourni |
| 2 |
État |
N |
active ou tobedeleted |
Valeur par défaut : active (selon le réglage de l'IU)
Requis si DateLastModified est présent
L'état inactive ou tobedeleted désactive l'utilisateur |
| 3 |
Date de modification la plus récente |
N |
AAAA-MM-JJTHH:mm:SS*,s*ssZ |
*Suivi interne* |
| 4 |
EnabledUser |
O |
true (vrai), false (faux) |
Actif dans le SGA si vrai |
| 5 |
OrgSourceIds |
O |
|
Inscription d'unité organisationnelle École |
| 6 |
Rôle |
O |
|
Rôle dans l’organisation |
| 7 |
Nom d’utilisateur |
O |
|
Nom d’utilisateur
|
| 8 |
UserIds |
N |
|
Ignoré |
| 9 |
GivenName |
O |
|
FirstName |
| 10 |
FamilyName |
O |
|
LastName |
| 11 |
MiddleName |
N |
|
MiddleName |
| 12 |
Identifiant |
N |
|
OrgDefinedId (si fourni) |
| 13 |
Courriel |
N |
|
ExternalEmail |
| 14 |
SMS |
N |
|
Ignoré |
| 15 |
Phone |
N |
|
Ignoré |
| 16 |
AgentSourcedIds |
N |
|
Utilisé pour indiquer une relation parent/tuteur |
| 17 |
Notes |
N |
|
Sans correspondance |
| 18 |
Mot de passe |
N |
|
|
Inscriptions
L'exemple suivant présente une rangée de contenu échantillon pour les inscriptions (incluant la ligne d'en-têtes nécessaire). Le fichier comprend 10 colonnes obligatoires, et chacune d'elles doit comprendre une valeur valide ou être laissée vide, selon le format de fichier. Un utilisateur désigné sera inscrit à une offre de cours et une section
|
sourcedId,status,dateLastModified,classSourcedId,schoolSourcedId,userSourcedId,role,primary,beginDate,endDate
STUDENT_CLASS_LW1111,active,2017-04-30T00:00:00Z,CLASS_LW111,SCHOOL_LW111,STUDENT_LW11,student,,,
|
| Colonne |
Champ |
Requis |
Valeurs possibles |
Remarques |
| 1 |
SourceId |
O |
|
*Suivi interne* |
| 2 |
État |
N |
active ou tobedeleted |
Active est la valeur par défaut
Requis si DateLastModified est présent |
| 3 |
Date de modification la plus récente |
N |
AAAA-MM-JJTHH:mm:SS:ssZ |
*Suivi interne* |
| 4 |
UserSourcedId |
O |
|
Utilisateur à inscrire |
| 5 |
ClassSourcedId |
O |
|
Classe pour l'inscription |
| 6 |
SchoolSourcedId |
O |
true (vrai), false (faux) |
Sans correspondance |
| 7 |
Rôle |
O |
Les seules valeurs permises sont : administrateur, surveillant, étudiant et enseignant. |
Rôle dans l'UO de l'offre de cours
|
| 8 |
Primaire |
N |
|
Sans correspondance |
| 9 |
BeginDate |
N |
|
Sans correspondance |
| 10 |
EndDate |
N |
|
Sans correspondance |