OneRoster is de standaard IMS Global-specificatie die is ontworpen om het veilig delen van klassenroosters en gerelateerde gegevens tussen een studentinformatiesysteem (SIS) en elk ander systeem mogelijk te maken. De Brightspace® OneRoster-implementatie ondersteunt de import van spreadsheets (CSV) en directe systeemuitwisselingen met behulp van REST-API's.
Met de Brightspace®-implementatie van de OneRoster v1.1-specificatie kunnen beheerders gegevens plannen die uit hun SIS worden gehaald om de vereiste roostergerelateerde gegevens (zoals scholen, groepen, gebruikers en inschrijvingen) in Brightspace® in te vullen.
De IPSIS OneRoster REST-gebruikersinterface bevat een schema waarmee beheerders het tijdstip van de dag kunnen configureren waarop de gegevens worden opgehaald. Voor een SIS dat het terugsturen van scores ondersteunt kunnen beheerders de scores instellen die moeten worden geretourneerd met de dagelijkse gegevenssynchronisatie en/of een faculteitslid toestaan een handmatige synchronisatie te initiëren.
Voordat u uw OneRoster-integratie in het gebied IPSIS-beheer configureert, dient u de volgende informatie over installatie, toewijzing en basisconfiguratie in dit onderwerp door te nemen.
Rollen instellen
Voordat u uw OneRoster-integratie configureert in het IPSIS-beheergebied, moet u de rollen instellen die u wilt gaan gebruiken: De volgende rollen zijn beschikbaar in OneRoster:
- Beheerder
- Assistent
- Voogd
- Bovenliggend item
- Surveillant
- Familielid
- Cursist
- Docent
- Bekijk de rollen die in uw SIS zijn geconfigureerd.
- Voer een van de volgende handelingen uit voor een van de rollen die u naar het Brightspace® -platform wilt sturen:
- Controleer of de rollen die u wilt opnemen in uw Brightspace®-platform bestaan.
- Als sommige rollen niet bestaan in Brightspace®, maakt u ze in de tool Rollen en machtigingen voordat u uw SIS-systeem configureert. Raadpleeg Rollen en machtigingen beheren voor meer informatie.
Typen instellen voor organisatie-eenheden
U moet toewijzingen instellen tussen typen organisatie-eenheden in de SIS en in Brightspace® wanneer u de SIS-integratie maakt. De volgende typen organisatie-eenheden zijn beschikbaar in OneRoster:
- Nationaal
- Staat
- Lokaal
- District
- School (verplicht)
- Afdeling
- Controleer de typen organisatie-eenheden die in uw SIS zijn geconfigureerd.
- Voer een van de volgende handelingen uit voor elk type organisatie-eenheid dat u naar het Brightspace®-platform wilt verzenden:
- Controleer of de typen organisatie-eenheden die u wilt opnemen in uw Brightspace®-platform bestaan.
- Als sommige typen organisatie-eenheden niet bestaan in Brightspace®, maakt u deze in de tool Editor organisatie-eenheid voordat u uw SIS-systeem configureert. Raadpleeg Typen organisatie-eenheid maken en verwijderen voor meer informatie.
Gegevenstypen toewijzen tussen OneRoster en Brightspace®
OneRoster-objecttypen worden niet exact gekoppeld aan die in Brightspace®. De volgende tabel toont de toewijzingsrelatie tussen OneRoster- en Brightspace®-objecttypen.
|
Opmerking: Stel typen organisatie-eenheden in Brightspace® in voordat u uw OneRoster-integratie configureert. Raadpleeg Typen organisatie-eenheid maken en verwijderen voor meer informatie.
Typen organisatie-eenheden zijn doorgaans aangepaste typen organisatie-eenheden die tijdens het configuratieproces kunnen worden toegewezen.
|
| OneRoster-gegevenstype |
D2L® Brightspace®-gegevenstype |
|---|
| Academische sessies |
Organisatie-eenheden |
| Organisatie |
Organisatie-eenheden |
| School |
Organisatie-eenheden |
| Cursus |
Cursussjabloon |
| Groep |
Cursuseditie, Cursussectie |
| Gebruiker |
Gebruiker |
| Inschrijving |
Inschrijving |
| Regelitemcategorieën |
Scorecategorieën |
| Regelitems |
Score-onderdelen |
| Resultaten |
Scores |
|
Opmerking: Typen organisatie-eenheden zijn doorgaans aangepaste typen organisatie-eenheden die tijdens het configuratieproces kunnen worden toegewezen.
|
Verantwoordelijkheden voor relaties met ouders/voogden
|
Opmerking: Deze informatie is voor K-12-klanten die Brightspace® ouder & voogd willen gebruiken. |
Uw instelling is verantwoordelijk voor het handhaven van de nauwkeurigheid van gebruikersrelaties in uw studentinformatiesysteem (SIS). Raadpleeg uw adviseurs om ervoor te zorgen dat u zich houdt aan het privacy- en beveiligingsbeleid van uw instelling en de toepasselijke wetgeving. Uw instelling of rechtsgebied kan bijvoorbeeld beleidsregels of wetten hebben die bepalen dat wanneer een kind 18 jaar wordt, de ouder of wettelijke voogd geen toegang meer mag krijgen tot de inhoud van het kind, tenzij het kind toestemming geeft. Hier moet rekening mee worden gehouden bij het genereren en verzenden van ouder/voogd-kindrelaties naar Brightspace®.
Overzicht van OneRoster-integraties
Er zijn twee typen OneRoster-integraties: OneRoster Rest en OneRoster CSV. In dit gedeelte van het onderwerp vindt u basisinformatie over deze twee integraties. Raadpleeg Info over OneRoster REST-integratie of Info over OneRoster CSV-integratie voor meer informatie
OneRoster REST-integratie: Basisworkflow
In de volgende stappen wordt de volgorde op hoofdlijnen beschreven om u te helpen de OneRoster REST-integratie te begrijpen. Raadpleeg Info over OneRoster REST-integratie voor meer gedetailleerde informatie over de workflow.
- In het Student Information System (SIS) van uw organisatie genereert u een OneRoster Consumer voor Brightspace®, waarmee u uw SIS aanroept vanuit Brightspace®.
| Opmerking: Het proces voor het maken van deze rol varieert afhankelijk van uw SIS. Neem voor meer informatie contact op met uw SIS-vertegenwoordiger. |
- Noteer de OAuth-referenties van uw SIS en de eindpunt-URL van uw SIS. Bijvoorbeeld https://www.sis.com/school/api.
| Opmerking: Voeg niet ims/oneroster/v1p1 toe aan het einde van de URL. D2L® doet dit binnen de IPSIS-service. |
- Voltooi de configuratie in Brightspace® in het nieuwe IPSIS-beheergebied. Als u bestaande records wilt koppelen aan OneRoster-gegevens, selecteert u de juiste opties om Brightspace®-gegevens aan SIS-equivalenten te koppelen.
- Stel een schema in voor uw REST-integratie om te synchroniseren met uw SIS.
Nadat u uw integratie hebt opgeslagen, kunt u wachten op de volgende geplande update of direct uw integratie uitvoeren met de knop Update nu uitvoeren op de pagina Batches.
OneRoster CSV-integratie: Basisworkflow
In de volgende stappen wordt op hoofdlijnen de volgorde van de OneRoster CSV-integratie beschreven. Voor meer diepgaande workflowinformatie, verwijzen we u naar Info over OneRoster CSV-integraties.
- Maak een CSV-bestand met uw roostergerelateerde gegevens.
- Voltooi de configuratie in het IPSIS-beheergebied van de Brightspace®-leeromgeving. Als u bestaande records wilt koppelen aan OneRoster-gegevens, selecteert u de juiste opties om Brightspace®-gegevens aan SIS-equivalenten te koppelen.
- Sleep het ZIP-bestand met het CSV-bestand met de roostergegevens naar de pagina Batches en zet het daar neer of blader naar het relevante zipbestand.
De verwerking van de integratie start automatisch.
Een OneRoster-integratie verifiëren
Er zijn verschillende manieren om een OneRoster-integratie te verifiëren:
- Ga naar IPSIS-beheer > Auditlogboek om te bepalen of een REST-integratie is voltooid. Vernieuw de pagina om te controleren of alle verwachte recordtypen (zoals gebruiker, organisatie-eenheid enzovoort) zijn uitgevoerd.
- Voer een van de volgende handelingen uit om te zien of een CSV-integratie is voltooid:
Pagina Batches: Na het uploaden van een CSV ZIP-bestand verschijnt de verwerkingsindicator op de pagina Batches in het bronsysteem. Vernieuw de pagina om te bevestigen dat de indicator Voltooid weergeeft.
Auditlogboek: Vernieuw het auditlogboek om te controleren of alle verwachte recordtypen zijn verwerkt.
- Ga als volgt te werk om te bepalen of een van beide typen is voltooid:
- Organisatie-eenheden: Gebruik de Editor organisatie-eenheid om alle gemaakte organisatie-eenheden te controleren en zo nodig bij te werken.
- Gebruikers: Gebruik de tool Gebruikers om alle gebruikers te controleren die zijn gemaakt en zo nodig updates uit te voeren.
<<<<<<<<<<<<<CONCEPT BEGINT HIER
Problemen met een OneRoster-integratie oplossen
Als er tijdens de eerste run van een van beide typen OneRoster-integratie een fout optreedt, probeer dan de integratie opnieuw te verwerken.
Een CSV-integratie opnieuw verwerken:
- Sleep op de pagina batches uw CSV ZIP-bestand opnieuw naar het daarvoor bestemde gebied.
- Als het CSV ZIP-bestand beschadigd is, genereert u een nieuw bestand uit uw SIS en sleept u het naar de interface om het opnieuw te verwerken.
Een REST-integratie opnieuw verwerken:
- Selecteer op de pagina Batches via de knop Update nu uitvoeren een van de volgende opties:
- Updates opnieuw synchroniseren - u kunt de vroegste datum selecteren vanaf welke u alleen de updates van de gegevens wilt synchroniseren. Klik vervolgens op Opnieuw synchroniseren.
- Alle SIS-records opnieuw synchroniseren - u kunt alle gegevens opnieuw uit uw SIS halen, zonder tijdsbeperkingen.
<<<<<<<BRONCONCEPTINHOUD BEGINT HIER
REST-toewijzingswaarden
CSV-toewijzingswaarden
Academische sessies
| OneRoster |
Ondersteunde waarden |
Brightspace®-toewijzingen |
Verplicht |
Opmerkingen |
|---|
|
SourcedId
|
|
|
J |
|
|
Status
|
actief, tobedeleted
|
|
N |
Veld is vereist voor bestanden in delta-modus.
|
|
DateLastModified
|
|
|
N |
Veld is vereist voor bestanden in delta-modus.
Datumnotatie JJJJ-MM-DDTHH:mm:SS.sssZ
|
|
Titel
|
|
Naam organisatie-eenheid en code organisatie-eenheid
|
J |
|
|
Type
|
|
|
J |
Type organisatie-eenheid
|
|
StartDate
|
|
|
J |
DD-MM-JJJJ
|
|
EndDate
|
|
|
J |
DD-MM-JJJJ
|
|
ParentSourcedId
|
|
|
N |
Niet gebruikt
|
|
SchoolYear
|
|
|
N |
Niet gebruikt
|
Organisaties
| OneRoster |
Ondersteunde waarden |
Brightspace®-toewijzingen |
Verplicht |
Opmerkingen |
|---|
|
SourcedId
|
|
|
J
|
|
|
Status
|
actief, tobedeleted
|
|
N
|
Veld is vereist voor bestanden in delta-modus. |
|
DateLastModified
|
|
|
N
|
Veld is vereist voor bestanden in delta-modus. Datumnotatie JJJJ-MM-DDTHH:mm:SS.sssZ |
|
Naam
|
|
Naam organisatie-eenheid en code organisatie-eenheid
|
J
|
Als het veld Id leeg is, wordt de naam gekopieerd in Code organisatie-eenheid in Brightspace® |
|
Type
|
nationaal, staat, lokaal, district, school, afdeling
|
|
J
|
Definieert het OrgUnitType in Brightspace®.
http://www.imsglobal.org/oneroster-v11-final-specification#_Toc480452024
|
|
Id
|
|
Code organisatie-eenheid (indien opgegeven)
|
N
|
|
|
ParentSourcedId
|
|
|
N
|
Dit veld specificeert de bovenliggende organisatie-eenheid. |
Cursussen
| OneRoster |
Ondersteunde waarden |
Brightspace®-toewijzingen |
Verplicht |
Opmerkingen |
|---|
|
SourcedId
|
|
|
J
|
|
|
Status
|
actief, tobedeleted
|
|
N
|
Veld is vereist voor bestanden in delta-modus. |
|
DateLastModified
|
|
|
N
|
Veld is vereist voor bestanden in delta-modus. Datumnotatie JJJJ-MM-DDTHH:mm:SS.sssZ |
|
SchoolYearSourcedId
|
|
|
N
|
Niet gebruikt |
|
Titel
|
|
Naam organisatie-eenheid en code organisatie-eenheid
|
J
|
Maakt een Brightspace®-cursussjabloon. Als het veld CourseCode leeg is, wordt de titel gekopieerd naar de OrgUnitCode. |
|
CourseCode
|
|
Code organisatie-eenheid
|
N
|
Indien verstrekt |
|
Scores
|
|
|
N
|
Niet gebruikt |
|
OrgSourcedId
|
|
|
J
|
Dit veld specificeert de bovenliggende organisatie-eenheid. |
|
Onderwerpen
|
|
|
N
|
Niet gebruikt |
|
SubjectCodes
|
|
|
N
|
Niet gebruikt |
Groepen
| OneRoster |
Ondersteunde waarden |
Brightspace®-toewijzingen |
Verplicht |
Opmerkingen |
|---|
|
SourcedId
|
|
|
J
|
|
|
Status
|
actief, tobedeleted
|
|
N
|
Veld is vereist voor bestanden in delta-modus. |
|
DateLastModified
|
|
|
N
|
Veld is vereist voor bestanden in delta-modus.
Datumnotatie JJJJ-MM-DDTHH:mm:SS.sssZ
|
|
Titel
|
|
Naam organisatie-eenheid en code organisatie-eenheid
|
J
|
Maakt een Brightspace®-sectie en cursuseditie. Als het veld ClassCode leeg is, wordt de titel gekopieerd naar de code van de organisatie-eenheid. |
|
Scores
|
|
|
N
|
Niet gebruikt |
|
CourseSourcedId
|
|
|
J
|
Dit veld specificeert de bovenliggende organisatie-eenheid |
|
ClassCode
|
|
Code organisatie-eenheid (indien opgegeven)
|
N
|
Indien verstrekt |
|
ClassType
|
|
|
J
|
Niet gebruikt |
|
Locatie
|
|
|
N
|
Niet gebruikt |
|
SchoolSourcedId
|
|
|
J
|
Niet gebruikt |
|
TermsSourcedIds
|
|
|
N
|
Niet gebruikt |
|
Onderwerpen
|
|
|
N
|
Niet gebruikt |
|
SubjectCodes
|
|
|
N
|
Niet gebruikt |
|
Perioden
|
|
|
N
|
Niet gebruikt |
Gebruikers
| OneRoster |
Ondersteunde waarden |
Brightspace®-toewijzingen |
Verplicht |
Opmerkingen |
|---|
|
SourcedId
|
|
OrgDefinedId
|
J
|
Als het veld Id niet wordt ingevuld, wordt de SourcedId naar de OrgDefinedId gekopieerd. |
|
Status
|
actief, tobedeleted
|
|
N
|
Veld is vereist voor bestanden in delta-modus. |
|
DateLastModified
|
|
|
N
|
Veld is vereist voor bestanden in delta-modus.
Datumnotatie JJJJ-MM-DDTHH:mm:SS.sssZ
|
|
EnabledUser
|
|
|
J
|
Niet gebruikt |
|
OrgSourcedIds
|
|
Inschrijvingen bovenste org. eenheid (met rol in organisatie)
|
J |
Inschrijving in de organisatie-eenheden van de school |
| Rol |
beheerder, assistent, voogd, ouder, surveillant, familielid, student, leraar |
|
J |
Rol in organisatie |
|
UserName
|
|
UserName
|
J
|
|
|
UserIds
|
|
|
N
|
Niet gebruikt |
|
GivenName
|
|
FirstName
|
J
|
|
|
FamilyName
|
|
LastName
|
J
|
|
|
MiddleName
|
|
MiddleName
|
N
|
|
|
Id
|
|
OrgDefinedId
|
N
|
Indien verstrekt |
|
E-mail
|
|
ExternalEmail
|
N
|
|
|
Sms
|
|
MobilePhone
|
N
|
|
|
Telefoon
|
|
HomePhone
|
N
|
|
|
AgentSourcedIds
|
|
|
N
|
Gebruikt voor Brightspace® ouder & voogd. Dit veld bevestigt de relatie tussen ouder en kind. Zowel de onderliggende als de bovenliggende rijen moeten verwijzen naar elkaars bron-id's. |
|
Scores
|
|
|
N
|
Niet gebruikt |
|
Wachtwoord
|
|
Wachtwoord
|
N
|
|
Inschrijvingen
| OneRoster |
Ondersteunde waarden |
Brightspace®-toewijzingen |
Verplicht |
Opmerkingen |
|---|
|
SourcedId
|
|
|
J
|
|
|
Status
|
actief, tobedeleted
|
|
N
|
Veld is vereist voor bestanden in delta-modus. |
|
DateLastModified
|
|
|
N
|
Veld is vereist voor bestanden in delta-modus.
Datumnotatie JJJJ-MM-DDTHH:mm:SS.sssZ
|
|
UserSourcedId
|
|
|
J
|
Gebruiker om in te schrijven |
|
ClassSourcedId
|
DD-MM-JJJJ
|
|
J
|
Brightspace®-inschrijving |
|
SchoolSourcedId
|
|
|
N
|
Niet gebruikt |
|
Rol
|
beheerder, assistent, voogd, ouder, surveillant, familielid, student, leraar
|
Rol
|
J
|
|
|
Primair
|
|
|
N
|
Niet gebruikt |
|
BeginDate
|
|
|
N
|
DD-MM-JJJJ |
|
EndDate
|
|
|
N
|
DD-MM-JJJJ |