Documentatie over integraties

OneRoster REST voor Classlink

Het IPSIS-platform (Integratiepakket voor studentintegratiesystemen)

Het IPSIS-platform is een integratieplatform in Brightspace® dat bestaat uit gemeenschappelijke componenten en een verzameling producten waarmee u informatie uit het informatiesysteem van uw organisatie kunt importeren naar Brightspace®, bijvoorbeeld uw organisatiestructuur, gebruikers en inschrijvingsgegevens. Zodra die informatie is geïmporteerd in Brightspace®, kunt u uw informatiesysteem blijven bijwerken en die informatie importeren naar Brightspace® met behulp van het IPSIS-platform.

Ondersteunde informatiesystemen

Het IPSIS-platform kan worden geïntegreerd met de volgende gangbare typen informatiesystemen:

SIS (studentinformatiesysteem) - Een softwaretool die door onderwijsinstellingen wordt gebruikt om studenten, cursussen en inschrijvingen te beheren.
HRIS (HR-informatiesysteem) - Een softwaretool die door bedrijfsorganisaties wordt gebruikt om werknemers en hun gegevens te beheren.
LIS (cursistinformatiesysteem) - Een softwaretool die door onderwijsinstellingen wordt gebruikt om de registratie van studenteninschrijvingen te beheren.

Componenten en producten in het IPSIS-platform

Onder het IPSIS-platform bevinden zich gemeenschappelijke componenten en diverse producten met unieke functies om uw specifieke informatiesysteem te integreren met Brightspace. De verzameling van componenten en producten bestaat uit:

D2L® Standaard CSV - Gebruikt voor integratie met SIS/HRIS-systemen door gebruik te maken van door D2L® gedefinieerde CSV-bestanden (Comma Separated Value).
Ellucian ILP - Gebruikt voor integratie met banner- of collegesystemen, gebaseerd op LIS-specificaties.
OneRoster CSV of OneRoster REST - Gebruikt voor integratie met K-12-informatiesystemen die de OneRoster-specificatie van het IMS Global Learning Consortium ondersteunen.
LIS v2.0 adapter - Gebruikt voor integratie met informatiesystemen die de LIS-specificatie van het IMS Global Learning Consortium ondersteunen.
SIS Course Merge - Een interface in Brightspace® waarmee instructeurs meerdere door IPSIS verwerkte cursussen kunnen samenvoegen met en kunnen loskoppelen van één bovenliggende cursuseditie.
Interface (UI) voor Sectiekoppeling: een interface in Brightspace® die wordt gebruikt om handmatig relaties te bewerken tussen aanmeldingen van cursussen of secties in een SIS en cursusedities in Brightspace®.
IPSIS-beheerinterface (Beheer-UI) - Een beheerinterface in Brightspace® die wordt gebruikt voor het configureren en controleren van de status van SIS-integraties met Brightspace.

Info over OneRoster 1.1 REST

OneRoster is een IMS-norm die is ontworpen om het veilig delen van groepsroosters en gerelateerde gegevens tussen een studentinformatiesysteem (SIS) en elk ander systeem mogelijk te maken. De OneRoster-norm ondersteunt export-importbewerkingen in spreadsheetstijl (CSV) en directe systeemuitwisselingen met behulp van REST API's. Deze beheerdershandleiding richt zich op de REST-specificatie.

Voordat u OneRoster REST 1.1 gaat gebruiken

D2L® ondersteunt de IMS OneRoster v1.1-specificatie en hercertificeert jaarlijks aan de hand op de IMS Global-productencertificatiesuite. D2L® ondersteunt de volgende conformiteitscertificaten:

REST Data Provider Gradebook Push Core
REST Data Consumer Rostering Core

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 (scholen, klassen, gebruikers, inschrijvingen, enz.) in het Brightspace®-platform in te vullen. De nieuwe IPSIS OneRoster REST-gebruikersinterface bevat een schema waarmee beheerders het tijdstip van de dag kunnen configureren waarop de gegevens worden opgehaald. Bovendien kunnen beheerders voor een SIS-partner die de Gradebook-service ondersteunt de scores instellen die moeten worden geretourneerd met de dagelijkse gegevenssynchronisatie en/of een faculteitslid toestaan een handmatige synchronisatie te initiëren.

Gebruikte eindpunten

Type	URL
GET	ims/oneroster/v1p1/academicSessions
GET	ims/oneroster/v1p1/classes
GET	ims/oneroster/v1p1/enrollments
GET	ims/oneroster/v1p1/orgs
GET	ims/oneroster/v1p1/orgs/{id}
GET	ims/oneroster/v1p1/users

De toewijzing van OneRoster REST aan Brightspace

Hieronder staan de toewijzingswaarden tussen een OneRoster-objecttype en een Brightspace®-objecttype

OneRoster	D2L® Brightspace
Academische sessies	Organisatie-eenheden*
Organisaties	Organisatie-eenheden*
Scholen	Organisatie-eenheden*
Cursussen	Cursussjabloon
Groepen	Cursuseditie en Cursussectie
Gebruikers	Gebruiker
Inschrijvingen	Inschrijving

*Org-eenheidstypen zijn doorgaans aangepaste typen organisatie-eenheden die tijdens het configuratieproces kunnen worden toegewezen.

Academische sessies

OneRoster	Ondersteunde waarden	Gebruikt door Brightspace® voor	Verplicht
sourcedId		N.v.t.	J
status	active of tobedeleted	Maken/vervangen of verwijderen	J
dateLastModified	YYYY-MM-DDTHH:mm:SS.sssZ	N.v.t.	J
metadata	N.v.t.	N.v.t.
title		Naam organisatie-eenheid en code organisatie-eenheid	J
startDate	DD-MM-JJJJ	Geopend voor academische sessie in scorerapport en cursuseditie	J
endDate	DD-MM-JJJJ	Geopend voor academische sessie in scorerapport en cursuseditie	J
type	Semester, Termijn, Scoreperiode, Schooljaar	Type organisatie-eenheid	J
bovenliggend item	N.v.t.	N.v.t.	N.v.t.
Onderliggende onderdelen	N.v.t.	N.v.t.	N.v.t.
SchoolYear	N.v.t.	N.v.t.	N.v.t.

Organisaties

OneRoster	Ondersteunde waarden	Gebruikt door Brightspace® voor	Verplicht
SourcedId		N.v.t.	J
Status	active of tobedeleted	Vervangen of verwijderen	J
DateLastModified	YYYY-MM-DDTHH:mm:SS.sssZ	N.v.t.	J
MetaData	N.v.t.	N.v.t.
Naam		Naam organisatie-eenheid en code organisatie-eenheid	J
Id		Code organisatie-eenheid (indien aanwezig)	N
StartDate	DD-MM-JJJJ	N.v.t.	J
EndDate	DD-MM-JJJJ	N.v.t.	J
Type	District, Afdeling, Lokaal, Nationaal, School, Staat	Type organisatie-eenheid	J
Bovenliggend item		Bovenliggende organisatie-eenheden	Vereist om organisatiestructuur aan te maken
Onderliggende onderdelen	N.v.t.	N.v.t.	N.v.t.

Cursussen

OneRoster	Ondersteunde waarden	Gebruikt door Brightspace® voor	Verplicht
SourcedId		N.v.t.	J
Status	active of tobedeleted	Actief	J
DateLastModified	YYYY-MM-DDTHH:mm:SS.sssZ	N.v.t.	J
MetaData	N.v.t.	N.v.t.
Titel		Naam organisatie-eenheid en code organisatie-eenheid	J
SchoolYear		Bovenliggende organisatie-eenheden	N
CourseCode		Code organisatie-eenheid (indien aanwezig)	N
Scores	N.v.t.	N.v.t.
Onderwerpen	N.v.t.	N.v.t.
Organisatie		Bovenliggende organisatie-eenheden	Vereist om organisatiestructuur aan te maken
StartDate	DD-MM-JJJJ	N.v.t.
EndDate	DD-MM-JJJJ	N.v.t.
SubjectCodes	N.v.t.	N.v.t.
Bronnen	N.v.t.	N.v.t.

Groepen

OneRoster	Ondersteunde waarden	Gebruikt door Brightspace® voor	Verplicht
SourcedId		N.v.t.	J
Status	active of tobedeleted	Actief of inactief	J
DateLastModified	YYYY-MM-DDTHH:mm:SS.sssZ	N.v.t.	J
MetaData	Niet toegewezen
Titel		Naam organisatie-eenheid en code organisatie-eenheid	J
ClassCode		Code organisatie-eenheid (indien aanwezig)	N
ClassType	N.v.t.
Locatie	N.v.t.
Scores	N.v.t.
Onderwerpen	N.v.t.
Cursus		Bovenliggende organisatie-eenheden	J
School		Bovenliggende organisatie-eenheden	J
Termen		Bovenliggende organisatie-eenheden	J
SubjectCodes	N.v.t.
Perioden	N.v.t.
Bronnen	N.v.t.

Gebruikers

OneRoster	Ondersteunde waarden	Gebruikt door Brightspace® voor	Verplicht
SourcedId		OrgDefinedId	J
Status	active of tobedeleted	IsActive	J
DateLastModified	YYYY-MM-DDTHH:mm:SS.sssZ	N.v.t.	J
MetaData	Niet toegewezen
UserName		UserName	J
UserIds	Niet toegewezen
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		N.v.t.	N
Telefoon		N.v.t.	N
Agenten		Brightspace® Ouder & voogd	N
Organisaties	Inschrijvingen bovenste organisatie-eenheid (met rol in organisatie)
Scores	N.v.t.
Wachtwoord		Gebruikerswachtwoord	N

Inschrijvingen

OneRoster	Ondersteunde waarden	Gebruikt door Brightspace® voor	Verplicht
SourcedId		N.v.t.	J
Status	active of tobedeleted	Actief	J
DateLastModified	YYYY-MM-DDTHH:mm:SS.sssZ		J
MetaData	N.v.t.
Gebruiker		Gebruiker om in te schrijven	J
Groep		Cursuseditie en sectie om in te schrijven	J
School	N.v.t.
Rol		Rol	J
Primair	N.v.t.
BeginDate	N.v.t.
EndDate	N.v.t.

Aannames en beperkingen

Aannames

D2L® kan werken met elk SIS dat OneRoster 1.1 REST ondersteunt en is gecertificeerd door IMS Global of werkt aan de certificering hiervan.

REST-proces

Geplande uitvoeringen worden uitgevoerd vanaf de vorige uitvoerdatum van het gegevensextract tot de startdatum van het huidige gegevensextract. Als dit de eerste uitvoering is, fungeert deze als synchronisatiebewerking en wordt deze uitgevoerd zonder startdatum voor het datumbereik.
U kunt een uitvoering handmatig activeren vanaf de vorige uitvoerdatum, vanaf een specifieke datum of voor alle records in het systeem
Aanroepvolgorde: De volgorde waarin de verschillende eindpunten of het consumeren van de verschillende bestanden worden opgeroepen.
- Academische sessies
- Organisaties
- Scholen
- Cursussen
- Groepen
- Gebruikers
- Inschrijvingen

Beperkingen

Records met een status tobedeleted worden alleen verwijderd als het onderliggende onderdeel is verwijderd.
Inschrijvingen in bovenste organisatorische eenheden die zijn gemaakt vóór de release van juni 2024/20.24.6, kunnen niet worden uitgeschreven via de OneRoster-integratie.
Inschrijvingen die handmatig in Brightspace® zijn gemaakt, kunnen niet worden uitgeschreven via de OneRoster-integratie.
Niet-ondersteunde tekens: Er zijn verschillende tekens die niet worden ondersteund in de Brightspace®-code voor de organisatie-eenheid. Deze tekens worden vervangen door een onderstrepingsteken (_). Niet-ondersteunde karakters: \ : ? " " < > | ' # , % &
Afkappingen: De maximumlengte voor de code van de organisatie-eenheid in Brightspace® is 50 tekens. Als deze lengte wordt overschreden, wordt de code afgekapt in de gebruikersinterface.

Configuratieopties voor OneRoster REST

U gaat samen met de Brightspace®-implementatieconsultant het OneRoster REST-bronsysteem configureren. Brightspace® gaat automatisch terug naar de meest gebruikelijke instellingen. Deze instellingen kunnen echter op elk gewenst moment worden bewerkt met de juiste machtigingen.

Voordat het bronsysteem kan worden geconfigureerd, moet u ervoor zorgen dat u de volgende items hebt voltooid:

Algemene vereisten

Neem contact op met uw OneRoster-vertegenwoordiger voor uw API-informatie. U hebt het volgende nodig:

Eindpunt-URL
Consumentensleutel
Consumentengeheim
OAuth-ondertekeningsmethode = SHA-256

Configuratie

Na de eerste installatie kunt u de configuratie van uw OneRoster REST-bronsysteem bijwerken:

Selecteer in het menu Beheertools de optie IPSIS-beheer en selecteer het tabblad Configuratie
De aanmeldingsgegevens die tijdens de eerste installatie zijn opgegeven, worden als eerste weergegeven. Deze gegevens kunnen indien nodig worden bewerkt.
Velden Bronsysteem:

SIS-naam: Het veld SIS-naam is bewerkbaar en het wordt aanbevolen om dit veld up-to-date te houden.
Geplande updates: De tijd dat Brightspace® automatisch wordt gesynchroniseerd met het SIS. Het wordt aanbevolen dit proces 's nachts te voltooien.
Brightspace overschrijven: Gedetailleerde keuzemogelijkheden om aan te geven welke velden in Brightspace® door het SIS overschreven kunnen worden.

Personen
- Toewijzingen van SIS-rollen: Dit gedeelte bevat de specifieke OneRoster-rol om SIS-rolnamen toe te wijzen aan Brightspace®-rolnamen. De rollen van docent en student zijn standaard opgenomen, maar kunnen worden verwijderd. Hieronder volgen de rollen die beschikbaar zijn in OneRoster:
- Beheerder
- Assistent
- Voogd
- Bovenliggend item
- Surveillant
- Familielid
- Cursist
- Docent

SIS-vermeldingen toewijzen aan bestaande gebruikers:Biedt de mogelijkheid SIS-vermeldingen op basis van gebruikersnaam of OrgDefinedId toe te wijzen aan bestaande gebruikers die buiten het SIS zijn gemaakt (handmatig, bulkbewerkingen, API, enz.). Als toewijzingen zijn uitgeschakeld, kunnen er duplicaten worden gemaakt.

Cursussen en secties

Cursussen en secties - Toewijzingen: Dit gedeelte bevat de specifieke organisatie-eenheden van OneRoster om SIS-organisaties toe te wijzen aan Brightspace®-organisatienamen.
Klik op + Type organisatie-eenheid toevoegen om extra namen van SIS-specifieke organisatie-eenheden toe te voegen. De volgende typen organisatie-eenheden zijn vereist voor ClassLink:
- SIS-organisaties
  - District
  - School
  - Lokaal, Nationaal, Staat en Afdeling zijn optioneel
- Type academische sessie
  - Semester
  - Term
  - SchoolYear
  - Scoreperiode
- SIS-groep
  - Cursuseditie
  - Cursussectie
  - Cursussjabloon
  - Sectiekoppeling
Verwijdering: Biedt twee opties voor de manier waarop een status tobedeleted (te verwijderen) van invloed is op een organisatie-eenheid in Brightspace®.
- Niets doen: de toewijzing van de organisatie-eenheid wordt verwijderd uit IPSIS-toewijzingen, maar de organisatie-eenheid blijft ongewijzigd in Brightspace
- Cursuseditie inactiveren: de toewijzing van organisatie-eenheid wordt verwijderd uit IPSIS-toewijzingen, de cursuseditie wordt als inactief gemarkeerd in Brightspace®, sectie en inschrijvingen blijven bestaan
SIS-vermeldingen toewijzen aan cursussen en secties: Biedt de mogelijkheid SIS-vermeldingen op basis van de code organisatie-eenheid toe te wijzen aan bestaande organisatie-eenheden die buiten het SIS zijn gemaakt (handmatig, bulkbewerkingen, API, enz.). Het wordt niet aanbevolen deze in te schakelen voor organisatie-eenheden die door uw SIS zijn gemaakt, tenzij u hebt bevestigd dat de codes uniek zijn voor scholen en schooljaren. Als ze niet uniek zijn, kan het SIS bestaande organisatie-eenheden overschrijven met gegevens van andere organisatie-eenheden.
Cursusinhoud: Biedt de mogelijkheid om cursusinhoud van een hoofdcursus of een cursussjabloon naar de nieuwe cursus te kopiëren. Selecteer Ja en kies een van de volgende opties:
- Als Een organisatie-eenheid zoeken om op basis van opgegeven criteria automatisch van te kopiëren? niet is geselecteerd, wordt de inhoud van een Hoofdcursuseditie naar de cursuseditie op hetzelfde niveau gekopieerd als de hoofdcursuseditie en de cursussjabloon dezelfde code voor de organisatie-eenheid hebben
- Als Een organisatie-eenheid zoeken om op basis van opgegeven criteria automatisch van te kopiëren? wel is geselecteerd, kunt u kiezen uit twee opties:
  - Sjabloon voor bovenliggende cursus van de nieuwe cursus
    - De inhoud wordt gekopieerd van de sjabloon voor de bovenliggende cursus naar de nieuwe cursuseditie op het onderliggende niveau
    - Cursus op hetzelfde niveau waarbij de code van de organisatie-eenheid overeenkomt met de bovenliggende sjabloon. Inhoud wordt van de broncursuseditie naar de nieuwe onderliggende cursuseditie gekopieerd op basis van de broncursus die handmatig aan Brightspace® wordt toegevoegd met dezelfde code van de organisatie-eenheid als de bovenliggende sjabloon.

Datums cursuseditie: Hiermee kunt u gegevens van academische sessies gebruiken voor de begin- en einddatums van de cursuseditie. Dit selectievakje is standaard ingesteld op uit. Met deze optie kunt u kiezen of datums van een academische sessie (semester, onderwijsperiode, schooljaar of beoordelingsperiode) worden gekoppeld aan de cursuseditie (deze optie wordt standaard ingesteld op onderwijsperiode). De start- en einddatum van een cursus kunnen ook worden verschoven met een opgegeven aantal dagen. Als er meerdere academische sessies zijn ingesteld voor één cursuseditie, wordt de eerste academische sessie die van het SIS is ontvangen, gebruikt voor de start- en einddatum.
Uitschrijving: Biedt de mogelijkheid om gebruikers uit te schrijven voor secties en cursussen op basis van de Einddatum van de inschrijving die door het SIS wordt verstrekt, en de mogelijkheid om gebruikers uit te schrijven voor SIS Orgs als zij niet meer aan deze zijn gekoppeld in het SIS.
Afdelingen, semesters en overig:
SIS-vermeldingen toewijzen aan bestaande organisatie-eenheden: Biedt de mogelijkheid SIS-vermeldingen op basis van de code organisatie-eenheid toe te wijzen aan bestaande organisatie-eenheden die buiten het SIS zijn gemaakt (handmatig, bulkbewerkingen, API, enz.). Het wordt niet aanbevolen deze in te schakelen voor organisatie-eenheden die door uw SIS zijn gemaakt, tenzij u hebt bevestigd dat de codes uniek zijn voor scholen en schooljaren.
Als u klaar bent, selecteert u Configuratie opslaan.
Als u klaar bent om gegevens te synchroniseren. Navigeer naar IPSIS-beheer - Dashboard en kies de pijl omlaag naast Update nu uitvoeren - Alle SIS-records opnieuw synchroniseren om de gekozen gegevens uit ClassLink te synchroniseren.
Opmerking: Mogelijk moet u dit twee keer doen als ClassLink het District verzendt nadat de Scholen in het organisatie-eindpunt zijn verzonden (naar verwachting wordt District eerst verzonden).

Problemen oplossen

Het dashboard geeft de verwerkingsstatus van de laatste batch weer. Op de pagina Dashboard en de pagina Batches wordt een eindindicator weergegeven als de batch met succes is voltooid of als er fouten zijn opgetreden. Elke batch heeft een snelkoppeling naar het controlelogboek en indien voltooid met fouten naar foutmeldingen.

Bekijk alle logboeken om te controleren of alle records zijn verwerkt zoals verwacht. Als er foutberichten zijn opgeslagen, vouwt u de fout uit om de vastgelegde metadata te bekijken om de fout te identificeren. Hierna corrigeert u de gegevens in uw SIS en wacht u tot de volgende dag op de geplande update of vraagt u een update aan via het dashboard. Het doel is om de uitvoeringen zonder fouten te laten voltooien.