Regels voor alle CSV-bestanden
- Waarden in bestanden zijn hoofdlettergevoelig.
- Een lege waarde wordt weergegeven met twee komma's zonder spaties ertussen. Zo geeft [,,] (zonder de haakjes) een lege waarde aan, terwijl [, ,] een spatie aangeeft, die wordt geparseerd als een ongeldige waarde.
- De CSV-bestanden moeten een kopregel (eerste regel) hebben die exact overeenkomt (inclusief hoofdletters en kleine letters) met de notatie van de voorbeelden in de onderstaande secties.
- Volgende regels in het bestand bevatten de gegevens die moeten worden verwerkt (ingevoegd, bijgewerkt, verwijderd).
- Bestandsnamen zijn standaard (users, orgs enz.).
Manifest
U moet bij elk pakket een manifestbestand opnemen. Het manifest bevat de versie en de lijst met bestanden die u naar Brightspace® verzendt, en geeft aan of de roostergegevens de waarde van elk pakket aangeven.
- Bestandsnaam moet manifest.csv zijn.
- De waarde kan een van de volgende opties zijn:
- Bulk: Voor het importeren van bulkmomentopnamen. De velden status en datelastmodified moeten leeg blijven als u de bulkmodus gebruikt. De bulkmodus voert alleen voor inschrijvingen impliciete verwijderingen uit.
- Delta: Voor het importeren van delta's. De velden status en datelastmodified moeten zijn ingevuld. Dit is de enige modus die expliciete verwijderingen toestaat.
- Afwezig: Als een bestand niet wordt verzonden, moet het worden gemarkeerd als afwezig.
De volgende lijst bevat voorbeeldinhoud voor een manifest (samen met de vereiste koptekst):
propertyName,waarde
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
|
Opmerking: Als u OneRoster CSV in de modus Bulk gebruikt, kan het SIS gebruikers automatisch uitschrijven voor cursussen en secties als deze niet meer in het bulkbestand zijn opgenomen. Deze functie zorgt ervoor dat Brightspace® gesynchroniseerd blijft met het SIS zonder dat er expliciete gegevens voor uitschrijving in de OneRoster-bestanden nodig zijn. |
Academische sessies
Het volgende voorbeeld omvat twee rijen met voorbeeldinhoud voor een academische sessie (samen met de vereiste kopregel). Het bestand bestaat uit negen verplichte kolommen, die allemaal een geldige waarde moeten bevatten of leeg moeten blijven, afhankelijk van de bestandsindeling.
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
| Kolom |
Veld |
Verplicht |
Ondersteunde waarden |
Opmerkingen |
| 1 |
SourceId |
J |
|
Opgeslagen met IPSIS voor toewijzing aan een Brightspace®-organisatie-eenheid |
| 2 |
Status |
J |
actief, tobedeleted |
Gebruikt om de academische sessie te maken, bij te werken of te verwijderen Vereist als dateLastModified aanwezig is en als delta's worden verzonden. |
| 3 |
DateLastModified |
N |
JJJJ-MM-DDTHH:mm:SS:ssZ |
*Interne tracering* |
| 4 |
Titel |
J |
|
Naam organisatie-eenheid en code organisatie-eenheid |
| 5 |
Type |
J |
gradingPeriod, semester, schoolyear, term |
Type organisatie-eenheid |
| 6 |
StartDate |
J |
DD-MM-JJJJ |
De startdatum van de academische sessie kan worden gekopieerd naar de startdatums van gekoppelde cursusedities. |
| 7 |
EndDate |
J |
DD-MM-JJJJ |
De einddatum van de academische sessie kan worden gekopieerd naar de einddatums van gekoppelde cursusedities. |
| 8 |
ParentSourceId |
N |
|
Genegeerd |
| 9 |
School Year (schooljaar) |
J |
JJJJ |
Niet toegewezen |
Organisaties
Het volgende voorbeeld bevat vier rijen met voorbeeldinhoud voor organisaties (samen met de vereiste kopregel). Het bestand bestaat uit zeven verplichte kolommen, die allemaal een geldige waarde vereisen of leeg moeten blijven, afhankelijk van de bestandsindeling.
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
| Kolom |
Veld |
Verplicht |
Ondersteunde waarden |
Opmerkingen |
| 1 |
SourceId |
J |
|
Opgeslagen met IPSIS voor toewijzing aan een Brightspace®-organisatie-eenheid |
| 2 |
Status |
N |
active of tobedeleted |
De organisatie-eenheid maken/bijwerken of verwijderen. Vereist als dateLastModified aanwezig is en als delta's worden verzonden |
| 3 |
DateLastModified |
N |
JJJJ-MM-DDTHH:mm:SS:ssZ |
*Interne tracering* |
| 4 |
Naam |
J |
|
Naam organisatie-eenheid en code organisatie-eenheid (als id niet is ingevuld) |
| 5 |
Type |
J |
afdeling, school, district, lokaal, staat, nationaal |
Type organisatie-eenheid |
| 6 |
Id |
N |
|
Code organisatie-eenheid (indien aanwezig) |
| 7 |
ParentSourcedId |
N |
|
Bron-id bovenliggende organisatie-eenheid Niet specifiek vereist, maar zonder dit element maken de organisatie-eenheden geen deel uit van een hiërarchie. |
Cursussen
Hieronder staan twee rijen met voorbeeldinhoud voor cursussen (samen met de vereiste kopregel). Het bestand bestaat uit 10 verplichte kolommen, die allemaal een geldige waarde vereisen of leeg moeten blijven, afhankelijk van de bestandsindeling.
sourcedId,status,dateLastModified,schoolYearSourcedId,title,courseCode,grades,orgSourcedId,subjects,subjectCodes
COURSE_LW11,active,2017-04-30T00:00:00Z,,The ways of the Force,COURSE_LW11,,SCHOOL_LW111,,
COURSE_LW12,active,2017-04-30T00:00:00Z,,French As A Second Language,COURSE_LW12,,SCHOOL_LW111,,
| Kolom |
Veld |
Verplicht |
Ondersteunde waarden |
Opmerkingen |
| 1 |
SourceId |
J |
|
Opgeslagen met IPSIS voor toewijzing aan een Brightspace®-organisatie-eenheid (cursussjabloon) |
| 2 |
Status |
N |
active of tobedeleted |
De cursussjabloon maken/bijwerken of verwijderen. Vereist als dateLastModified aanwezig is en als delta's worden verzonden |
| 3 |
DateLastModified |
N |
JJJJ-MM-DDTHH:mm:SS:ssZ |
*Interne tracering* |
| 4 |
SchoolYearSourceId |
N |
|
Genegeerd |
| 5 |
Titel |
J |
|
Naam organisatie-eenheid en code organisatie-eenheid (als id niet is ingevuld) |
| 6 |
CourseCode |
N |
|
Code organisatie-eenheid (indien opgegeven) |
| 7 |
Scores |
N |
|
Genegeerd
|
| 8 |
OrgSourceId |
J |
|
Bovenliggende organisatie-eenheid bron-id (school) |
| 9 |
Onderwerpen |
N |
|
Genegeerd |
| 10 |
SubjectCodes |
N |
|
Genegeerd |
Groepen
Hieronder staan drie rijen met voorbeeldinhoud voor groepen (samen met de vereiste kopregel). Het bestand bestaat uit 14 verplichte kolommen, die die allemaal een geldige waarde vereisen of leeg moeten blijven, afhankelijk van de bestandsindeling. Elke record wordt gemaakt als cursuseditie met één sectie erin.
sourcedId,status,dateLastModified,title,grades,courseSourcedId,classCode,classType,location,schoolSourcedId,termSourcedIds,subjects,subjectCodes,periods
CLASS_LW111,active,2017-04-30T00:00:00Z,The Force 101,,COURSE_LW11,CLASS_LW111,scheduled,,SCHOOL_LW111,TERM_LW11,,,
CLASS_LW112,active,2017-04-30T00:00:00Z,The Force Advanced,,COURSE_LW11,CLASS_LW112,scheduled,,SCHOOL_LW111,TERM_LW11,,,
CLASS_LW121,active,2017-04-30T00:00:00Z,French - Reading LW1,,COURSE_LW12,CLASS_LW121 fr-reading,scheduled,,SCHOOL_LW111,TERM_LW11,,,
| Kolom |
Veld |
Verplicht |
Ondersteunde waarden |
Opmerkingen |
| 1 |
SourceId |
J |
|
Opgeslagen met IPSIS voor toewijzing aan een Brightspace®-organisatie-eenheid (cursuseditie) |
| 2 |
Status |
N |
active of tobedeleted |
De cursuseditie en sectie maken/bijwerken of verwijderen (instellen op inactief of verwijderen op basis van IPSIS-beheerconfiguratie) Vereist als dateLastModified aanwezig is |
| 3 |
DateLastModified |
N |
JJJJ-MM-DDTHH:mm:SS:ssZ |
*Interne tracering* |
| 4 |
Titel |
J |
|
Naam organisatie-eenheid en code organisatie-eenheid (als classCode niet is ingevuld) |
| 5 |
Scores |
N |
|
Genegeerd |
| 6 |
CourseSourceId |
J |
|
Bovenliggende organisatie-eenheid bron-id (cursussjabloon) |
| 7 |
ClassCode |
N |
|
Code organisatie-eenheid (indien aanwezig) |
| 8 |
ClassType |
J |
thuisonderwijs, gepland |
Genegeerd |
| 9 |
Locatie |
N |
|
Genegeerd
|
| 10 |
SchoolSourceId |
J |
|
Bovenliggende organisatie-eenheid bron-id (school) |
| 12 |
TermsSourceId |
J |
|
Bovenliggende organisatie-eenheid bron-id (termijn) |
| 12 |
Onderwerpen |
N |
|
Genegeerd |
| 13 |
SubjectCodes |
N |
|
Genegeerd |
| 14 |
Perioden |
N |
|
Genegeerd |
BEGIN HIER
Gebruikers
Hieronder staan vijf rijen met voorbeeldinhoud voor gebruikers (samen met de vereiste kopregel). Bestand bestaat uit 18 verplichte kolommen, die elk moeten worden gevuld met een geldige waarde of leeg moeten blijven, afhankelijk van de bestandsindeling.
|
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",,
|
| Kolom |
Veld |
Verplicht |
Mogelijke waarden |
Opmerkingen |
| 1 |
SourcedId |
J |
|
OrgDefinedId als geen id is opgegeven |
| 2 |
Status |
N |
active of tobedeleted |
Standaard actief (afhankelijk van de instelling van de gebruikersinterface)
Vereist als DateLastModified aanwezig is
Bij de waarde Inactive of tobedeleted wordt de gebruiker gedeactiveerd |
| 3 |
DateLastModified |
N |
JJJJ-MM-DDTHH:mm:SS*,s*ssZ |
*Interne tracering* |
| 4 |
EnabledUser |
J |
true of false |
Actief in LMS indien 'True' |
| 5 |
OrgSourceId's |
J |
|
Inschrijving organisatie-eenheid school |
| 6 |
Rol |
J |
|
Rol in organisatie |
| 7 |
UserName |
J |
|
UserName
|
| 8 |
UserIds |
N |
|
Genegeerd |
| 9 |
GivenName |
J |
|
FirstName |
| 10 |
FamilyName |
J |
|
LastName |
| 11 |
MiddleName |
N |
|
MiddleName |
| 12 |
Id |
N |
|
OrgDefinedId (indien aanwezig) |
| 13 |
E-mail |
N |
|
ExternalEmail |
| 14 |
Sms |
N |
|
Genegeerd |
| 15 |
Telefoon |
N |
|
Genegeerd |
| 16 |
AgentSourcedIds |
N |
|
Wordt gebruikt om de relatie tussen ouder en voogd aan te geven |
| 17 |
Scores |
N |
|
Niet toegewezen |
| 18 |
Wachtwoord |
N |
|
|
Inschrijvingen
Hieronder staat een rij voorbeeldinhoud voor inschrijvingen (samen met de vereiste kopregel). Bestand bestaat uit 10 verplichte kolommen, die elk moeten worden gevuld met een geldige waarde of leeg moeten blijven, afhankelijk van de bestandsindeling. Een opgegeven gebruiker wordt ingeschreven voor een cursuseditie en sectie
|
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,,,
|
| Kolom |
Veld |
Verplicht |
Mogelijke waarden |
Opmerkingen |
| 1 |
SourceId |
J |
|
*Interne tracering* |
| 2 |
Status |
N |
active of tobedeleted |
Standaard actief
Vereist als DateLastModified aanwezig is |
| 3 |
DateLastModified |
N |
JJJJ-MM-DDTHH:mm:SS:ssZ |
*Interne tracering* |
| 4 |
UserSourcedId |
J |
|
Gebruiker om in te schrijven |
| 5 |
ClassSourcedId |
J |
|
Groep om zich bij in te schrijven |
| 6 |
SchoolSourcedId |
J |
true of false |
Niet toegewezen |
| 7 |
Rol |
J |
De enige toegestane waarden zijn beheerder, proctor, cursist en docent. |
Rol in de organisatie-eenheid van de huidige cursuseditie
|
| 8 |
Primair |
N |
|
Niet toegewezen |
| 9 |
BeginDate |
N |
|
Niet toegewezen |
| 10 |
EndDate |
N |
|
Niet toegewezen |