Documentatie over integraties

OneRoster v1.1-integratie instellen

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. OneRoster 1.1 is een belangrijke upgrade van een educatief materiaal, tool en platformroostergerelateerde standaard.

OneRoster ondersteunt export-import van spreadsheets (CSV) en directe uitwisseling van systemen met behulp van REST API's. IPSIS in het Brightspace®-platform ondersteunt de IMS OneRoster v1.1-specificatie, die het veilig delen van lesroosters en gerelateerde gegevens tussen een studentinformatiesysteem (SIS) en het Brightspace®-platform mogelijk maakt. Meer in het bijzonder is het Brightspace®-platform gecertificeerd voor IMS Global in de volgende conformiteitscertificeringen:

OneRoster v1.1 CSV Rostering Import Bulk
OneRoster v1.1 CSV Rostering Import Delta
OneRoster v1.1 REST Data Consumer Rostering Core

Rollen instellen voor OneRoster

Voordat u uw OneRoster-integratie configureert in het IPSIS-beheergebied, moet u het volgende doen:

Bekijk de rollen die in uw SIS zijn geconfigureerd en de bijbehorende rollen die zijn toegewezen. De volgende rollen zijn beschikbaar in OneRoster:
- Beheerder
- Assistent
- Voogd
- Bovenliggend item
- Surveillant
- Familielid
- Cursist
- Docent
Voor alle bovenstaande rollen die u naar het Brightspace®-platform wilt sturen, moet u een toewijzing instellen wanneer u de SIS-integratie maakt. Als er nog geen geschikte rol is op het Brightspace®-platform, maak er dan een voordat u uw SIS-integratie configureert.

Typen instellen voor organisatie-eenheden

Bekijk de typen organisatie-eenheden die zijn geconfigureerd in uw studentinformatiesysteem en de bijbehorende rollen die zijn toegewezen. De volgende organisatietypen zijn beschikbaar in OneRoster:
- Nationaal
- Staat
- Lokaal
- District
- School (verplicht)
- Afdeling
Voor elk van de bovenstaande typen organisatie-eenheden die u naar het Brightspace®-platform wilt verzenden, moet u een toewijzing instellen wanneer u de SIS-integratie maakt, die wordt toegewezen aan typen organisatie-eenheden in het educatief beheersysteem. Als er nog geen geschikt type organisatie-eenheid op het Brightspace®-platform is, maak er dan een voordat u uw SIS-integratie configureert.

Info over gebruikersrelaties

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®.

Een REST SIS-integratie configureren

Genereer in het studentinformatiesysteem van uw organisatie een OneRoster Consumer voor het Brightspace®-platform waarmee u uw studentinformatiesysteem kunt aanroepen. Opmerking: Het proces hiervoor varieert afhankelijk van uw studentinformatiesysteem. Raadpleeg uw SIS-vertegenwoordiger voor meer informatie.
Noteer de OAuth-aanmeldingsgegevens uit uw studentinformatiesysteem.
Noteer de URL van het OneRoster-eindpunt van uw studentinformatiesysteem. 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 het nieuwe IPSIS-beheergebied.
Selecteer REST in de vervolgkeuzelijst Indeling voor gegevensuitwisseling.
Opmerking: Als u bestaande records hebt die u wilt afstemmen op de OneRoster-gegevens, zorg er dan voor dat u de juiste opties selecteert voor de vragen over het koppelen van Brightspace®-platformgegevens met hun SIS-equivalenten.
Selecteer in het veld Geplande updates het tijdstip waarop de REST-integratie elke dag automatisch moet worden bijgewerkt.
Wanneer u uw integratie opslaat, wordt deze verwerkt wanneer de volgende geplande update plaatsvindt. Als u uw integratie onmiddellijk wilt uitvoeren, selecteert u op de pagina Batches met de knop Nu update uitvoeren de optie Alle SIS-records opnieuw synchroniseren.

Een CSV SIS-integratie configureren

Maak een CSV-bestand met uw roostergerelateerde gegevens.
Voltooi de configuratie in het nieuwe IPSIS-beheergebied (zie de sectie IPSIS-beheer voor nieuwe SIS-integraties). Selecteer in de vervolgkeuzelijst Gegevensuitwisselingsindeling de optie CSV slepen en neerzetten.
Opmerking: Als u bestaande records hebt die u wilt afstemmen op de OneRoster-gegevens, zorg er dan voor dat u de juiste opties selecteert voor de vragen over het koppelen van Brightspace®-platformgegevens met hun SIS-equivalenten.
Sleep het zipbestand 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:

Als u wilt weten of een REST-integratie is voltooid, gaat u naar het controlelogboek (in de oorspronkelijke IPSIS-beheerinterface) en vernieuwt u de pagina om te controleren of alle recordtypen die u verwacht (gebruiker, organisatie-eenheid enzovoort) zijn uitgevoerd.
Voer een van de volgende handelingen uit om te zien of een CSV-integratie is voltooid:
- Wanneer u een CSV ZIP-bestand sleept en neerzet of selecteert, wordt er een verwerkingsindicator weergegeven op de pagina Batches van dat bronsysteem. Wanneer dit is gebeurd, vernieuwt u de pagina. De indicator wordt dan bijgewerkt en geeft Voltooid weer.
- Ga naar het controlelogboek en vernieuw de pagina om te controleren of alle recordtypen die u had verwacht (gebruiker, organisatie-eenheid enzovoort) zijn uitgevoerd.
Als u wilt weten of een van beide typen integratie is voltooid, voert u een van de volgende handelingen uit:
- Voor organisatie-eenheden kunt u Editor organisatie-eenheid gebruiken om alle gemaakte organisatie-eenheden te controleren en zo nodig bij te werken.
- Voor gebruikers kunt u de tool Gebruikers gebruiken om alle gebruikers te controleren die zijn gemaakt en zo nodig updates uit te voeren.

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.

OneRoster-toewijzingswaarden

OneRoster-objecttypen worden niet exact gekoppeld aan die op het Brightspace®-platform. De volgende tabel laat zien hoe de OneRoster-waarden zich verhouden tot die op het Brightspace®-platform.

OneRoster-waarde	Brightspace®-platformwaarde
Academische sessies	Organisatie-eenheden*
Organisaties	Organisatie-eenheden*
Cursussen	Cursussjablonen
Groepen	Cursuseditie en Cursussectie
Gebruikers	Gebruiker
Inschrijvingen	Inschrijving

*Het type organisatie-eenheid waaraan elk object wordt toegewezen, is afhankelijk van de configuratie van de toewijzingssecties voor de SIS-integratie in het IPSIS-beheergebied.

REST-toewijzingswaarden

Academische sessies

OneRoster	Ondersteunde waarden	Brightspace®-platform	Verplicht
SourcedId		Interne tracking	J
Status	actief, tobedeleted	Actief	J
DateLastModified	YYYY-MM-DDTHH:mm:SS.sssZ	Interne tracking	J
MetaData		Toegekend
Titel		Naam organisatie-eenheid en code organisatie-eenheid	J
StartDate	DD-MM-JJJJ	Interne tracking	J
EndDate	DD-MM-JJJJ	Interne tracking	J
Type		Type organisatie-eenheid	J
Bovenliggend item		Toegekend
Onderliggende onderdelen		Toegekend
SchoolYear		Toegekend

Organisaties

OneRoster	Ondersteunde waarden	Brightspace®-platform	Verplicht
SourcedId		Interne tracking	J
Status	actief, tobedeleted	Actief	J
DateLastModified	YYYY-MM-DDTHH:mm:SS.sssZ	Interne tracking	J
MetaData		Toegekend
Naam		Naam organisatie-eenheid en code organisatie-eenheid	J
Id		Code organisatie-eenheid (indien opgegeven)	N
StartDate	DD-MM-JJJJ	Interne tracking	J
EndDate	DD-MM-JJJJ	Interne tracking	J
Type		Type organisatie-eenheid	J
Bovenliggend item		Bovenliggende items	N
Onderliggende onderdelen		Toegekend

Cursussen

OneRoster	Ondersteunde waarden	Brightspace®-platform	Verplicht
SourcedId		Interne tracking	J
Status	actief, tobedeleted	Actief	J
DateLastModified	YYYY-MM-DDTHH:mm:SS.sssZ	Interne tracking	J
MetaData		Toegekend
Titel		Naam organisatie-eenheid en code organisatie-eenheid	J
SchoolYear		Bovenliggende items	N
CourseCode		Code organisatie-eenheid (indien opgegeven)	N
Scores		Toegekend
Onderwerpen		Toegekend
Organisatie		Bovenliggende items	N
StartDate	DD-MM-JJJJ	Interne tracking
EndDate	DD-MM-JJJJ	Interne tracking
SubjectCodes		Toegekend
Bronnen		Toegekend

Groepen

OneRoster	Ondersteunde waarden	Brightspace®-platform	Verplicht
SourcedId		Interne tracking	J
Status	actief, tobedeleted	Actief	J
DateLastModified	YYYY-MM-DDTHH:mm:SS.sssZ	Interne tracking	J
MetaData		Toegekend
Titel		Naam organisatie-eenheid en code organisatie-eenheid	J
ClassCode		Code organisatie-eenheid (indien opgegeven)	N
ClassType		Toegekend
StartDate	DD-MM-JJJJ	Startdatum cursus	N
EndDate	DD-MM-JJJJ	Einddatum cursus	N
Locatie		Toegekend
Scores		Toegekend
Onderwerpen		Toegekend
Cursus		Bovenliggende items	N
School		Bovenliggende items	J
Termen		Bovenliggende items	N
SubjectCodes		Toegekend
Perioden		Toegekend
Bronnen		Toegekend

Gebruikers

OneRoster	Ondersteunde waarden	Brightspace®-platform	Verplicht
SourcedId		OrgDefinedId	J
Status	actief, tobedeleted	IsActive	J
DateLastModified	YYYY-MM-DDTHH:mm:SS.sssZ	Interne tracking	J
MetaData		Toegekend
UserName		UserName	J
UserIds		Toegekend
EnabledUser		IsActive	J
GivenName		FirstName	J
FamilyName		LastName	J
MiddleName		MiddleName	N
Rol		Rol in organisatie	J
Id		OrgDefinedId (indien aanwezig)	N
E-mail		ExternalEmail	N
Sms		MobilePhone	N
Telefoon		HomePhone	N
Agenten		Toegekend
Organisaties		Inschrijvingen bovenste org. eenheid (met rol in organisatie)
Scores		Toegekend
Wachtwoord		Toegekend

Inschrijvingen

OneRoster	Ondersteunde waarden	Brightspace®-platform	Verplicht
SourcedId		Interne tracking	J
Status	actief, tobedeleted	Actief	J
DateLastModified	YYYY-MM-DDTHH:mm:SS.sssZ	Interne tracking	J
MetaData		Toegekend
Gebruiker		Gebruiker om in te schrijven	J
Groep	DD-MM-JJJJ	Groep en sectie om bij in te schrijven	J
School	DD-MM-JJJJ	Toegekend
Rol		Rol	J
Primair		Toegekend
BeginDate		Toegekend
EndDate		Toegekend

CSV-toewijzingswaarden