In gebruik nemen digitaal leermiddel

Titel	In gebruik nemen digitaal leermiddel
Scenario	#8 In gebruik nemen leermiddel
Status	In ontwikkeling ROSA-Architectuurscan BEsluitvorming IMPLEMENTATIE in beheer
Versie	0.9.0
Datum	27 Juni 2024
Auteur	Werkgroep Verwerven en in gebruik nemen
Acties	Geen openstaande acties

Op deze pagina is de functionele, operationele en technische specificatie te vinden voor het in gebruik nemen van een digitaal leermiddel.

De specificatie bestaat uit de volgende onderdelen:

1 Start: Leveren digitaal leermiddel voltooid
2 Interactieanalyse: In gebruik nemen digitaal leermiddel
3 Beslisboom in gebruik nemen digitaal leermiddel in Licentieregistratie
4 Technisch: APIs

Start: Leveren digitaal leermiddel voltooid

Dit scenario komt na het scenario van het Leveren digitaal leermiddel. Dit betekent dat is voldaan aan de volgende randvoorwaarden:

Het leermiddel is correct geleverd bij alle betrokken referentiecomponenten, zijnde:
- Aanspraakmanager
- Licentieregistratie
- Leermiddelenportaal
De aanspraak die behoort bij het digitaal leermiddel dat in gebruik genomen gaat worden door een onderwijsdeelnemer (of -medewerker) heeft de entitlementStatus entitled en is nog niet eerder in gebruik genomen. Indien gebruik wordt gemaakt van een Leermiddelenportaal is de urlStatus processed.
De activatie- en gebruiksperioden voor de aanspraak zijn geldig.
Er is voldaan aan de randvoorwaarden voor activering van gegevensuitwisselingen en de randvoorwaarden voor aansluitingen en brongegevens uit het proces leveren van digitaal leermiddel.
De Onderwijsorganisatie beschikt over een Identity provider die is aangesloten bij de Federatieve hub.
- De Onderwijsorganisatie heeft optioneel voor de Federatieve hub een ARP afgesloten met de leveranciers die de referentiecomponenten Leermiddelenportaal, Gebruiksomgeving digitaal leermateriaal of Digitaal toetssysteem aanbieden.
De Besteller logt in op de Bestelomgeving leermiddelen. Zodra de Besteller een onderwijsmedewerker van een onderwijsorganisatie is dan kan dit via de federatieve route gebeuren. Omwille van de leesbaarheid zijn deze stappen niet opgenomen in het proces.

Interactieanalyse: In gebruik nemen digitaal leermiddel

Na een succesvolle levering van het leermiddel kan een eindgebruiker het leermiddel in de activatieperiode in gebruik gaan nemen. Het in gebruik nemen van een leermiddel is een multilateraal proces vanuit de eindgebruiker met de referentiecomponenten:

Leermiddelenportaal
Gebruiksomgeving digitaal leermateriaal of Digitaal toetssysteem
Licentieregistratie
Aanspraakmanager
(Optioneel) Bestelomgeving leermiddelen

Dit proces is weergegeven in figuur 1.

Figuur 1. Interactieanalyse In gebruik nemen digitaal leermiddel

Het proces van in gebruik nemen van een digitaal leermiddel bestaat uit de volgende stappen:

Stap	Toelichting

Stap	Toelichting
1.	De eindgebruiker (onderwijsdeelnemer of onderwijsmedewerker) navigeert naar het Leermiddelenportaal en gaat hier inloggen.
2.	De eindgebruiker is in dit scenario niet ingelogd binnen de schoolomgeving. Het Leermiddelenportaal verwijst de onderwijsdeelnemer door naar een federatieve hub (bijvoorbeeld Basispoort, Kennisnet Entree of SURFconext) om in te loggen met een schoolaccount.
3.	De eindgebruiker kiest zijn of haar onderwijsorganisatie.
4.	De federatieve hub haalt de Identity provider gegevens van de onderwijsorganisatie op.
5.	De federatieve hub verwijst de eindgebruiker door naar de inlogpagina van de Identity provider van de onderwijsorganisatie.
6.	De eindgebruiker logt in met zijn credentials bij de Identity provider van de onderwijsorganisatie.
7.	De Identity provider van de onderwijsorganisatie controleert de credentials en authentiseert de eindgebruiker.
8.	De Identity provider van de onderwijsorganisatie stuurt de eindgebruiker met zijn digitale identiteit terug naar de Federatieve hub.
9.	De Federatieve hub haalt de attributen op uit de digitale identiteit van de eindgebruiker. De attributen zijn conform het ARP dat de onderwijsorganisatie heeft afgesloten met de leverancier van de referentiecomponent Leermiddelenportaal.
10.	De federatieve hub stuurt de eindgebruiker met zijn digitale identiteit en de attributen door naar het Leermiddelenportaal.
11.	Het Leermiddelenportaal autoriseert de eindgebruiker in zijn eigen applicatie. De eindgebruiker heeft is in dit voorbeeld succesvol geautoriseerd en kan de applicatie gaan gebruiken.
12.	De eindgebruiker navigeert naar het overzicht van zijn of haar leermiddelen in het Leermiddelenportaal.
13.	Het Leermiddelenportaal haalt voor de eindgebruiker alle leermiddelen op waarop de eindgebruiker een aanspraak heeft. Het Leermiddelenportaal toont de lijst met leermiddelen aan de eindgebruiker in het overzicht.
14.	De eindgebruiker klikt op de toegangslink van het leermiddel voor in gebruik name. Indien een leverancier de referentiecomponenten Leermiddelenportaal en Onderwijsleeromgeving combineert, dan kan ook de deeplink van leermaterialen uit het leermiddel worden gebruikt om het leermiddel in gebruik te nemen. Hiervoor is het van belang dat de deeplinks van de leermaterialen zijn voorzien van een parameter product van het leermiddel uit de aanspraak. Voor meer informatie over het technisch formaat van deeplinks is te vinden in de beschrijving van de praktijksituatie Combineren en arrangeren leermaterialen.
15.	Het Leermiddelenportaal navigeert de eindgebruiker naar de toegangslink en daarmee naar de Gebruiksomgeving digitaal leermateriaal (of het Digitaal toetssysteem).
16.	De Gebruiksomgeving digitaal leermateriaal (of het Digitaal toetssysteem) verzamelt de attributen van de eindgebruiker bij de Federatieve hub.
17.	De Federatieve hub haalt de attributen op uit de digitale identiteit van de eindgebruiker. De attributen zijn conform het ARP dat de onderwijsorganisatie heeft afgesloten met de leverancier van de referentiecomponent Gebruiksomgeving digitaal leermateriaal (of Digitaal toetssysteem).
18.	De Federatieve hub stuurt de digitale identiteit en de attributen van de eindgebruiker door naar de Gebruiksomgeving digitaal leermateriaal (of het Digitaal toetssysteem). In de attributen zitten minimaal het ECK iD en voor de hybride situatie een alternatief userId als unieke identifier van de onderwijsdeelnemer en het schoolId van de onderwijsorganisatie.
19.	De Gebruiksomgeving digitaal leermateriaal (of het Digitaal toetssysteem) autoriseert de eindgebruiker. Dit gebeurt in de volgende stappen.
20.	De component Gebruiksomgeving digitaal leermateriaal (of het Digitaal toetssysteem) doet een autorisatieverzoek bij de Licentieregistratie.
21.	In de Licentieregistratie worden alle relevante aanspraken op het leermiddel voor de eindgebruiker al dan niet i.c.m. de onderwijsorganisatie opgehaald. In dit scenario gaan we ervanuit dat er een geldige aanspraak is gevonden. De eindgebruiker voldoet aan de autorisatieregel van de aanspraak en kan het leermiddel in gebruik gaan nemen.
21ab.	Indien de eindgebruiker geen aanspraak heeft op het Leermiddel dan kan optioneel gevraagd worden om een activatiecode in te voeren. De eindgebruiker voert de activatiecode in. Deze additionele interactie betreft een uitzondering voor een Leermiddel en is als dusdanig als een optionele tussenstap 21a en 21b toegevoegd aan de interactieanalyse.
22	De Licentieregistratie verandert de entitlementStatus van de aanspraak naar `licensed`.
23.	De Licentieregistratie bevestigt aan de Gebruiksomgeving digitaal leermateriaal (of het Digitaal toetssysteem) dat de eindgebruiker het leermiddel mag gaan gebruiken.
24.	De Gebruiksomgeving digitaal leermateriaal (of het Digitaal toetssysteem) geeft de eindgebruiker toegang tot de leermaterialen uit het leermiddel.
25.	De Licentieregistratie stuurt een melding van de leermiddelactivatie naar de Aanspraakmanager.
26	De Aanspraakmanager verandert de entitlementStatus van de aanspraak naar `licensed`.
27.	De Aanspraakmanager verstuurt op basis van de eerste Leermiddelactivatie op een leveringsorder een terugmelding naar de Bestelomgeving leermiddelen dat de status van de leveringsorder is gewijzigd naar `licensed`. Deze terugmelding is van belang voor de Bestelomgeving omdat de Leveringsorder niet meer geannuleerd kan worden.
28.	De Bestelomgeving leermiddelen wijzigt de status van de leveringsorder naar `licensed`.
29.	De Besteller kan de nieuwe status van de leveringsorder inzien bij de Bestelomgeving leermiddelen.
30.	In de leermiddelactivatie kan de Licentieregistratie mee hebben gegeven dat de expirationDate is aangepast. Dit is bijvoorbeeld van toepassing op licenties die na in gebruik name een periode geldig zijn. In dat geval dient de Toegangslink ook tot de nieuwe expirationDate actief te zijn in het Leermiddelenportaal. De Aanspraakmanager initieert in dat geval de plaatsing van de toegangslink voor de aanspraak opnieuw richting het Leermiddelenportaal.

Beslisboom in gebruik nemen digitaal leermiddel in Licentieregistratie

In de Licentieregistratie wordt nagegaan of een eindgebruiker een aanspraak heeft op het leermiddel en deze al dan niet in gebruik mag nemen. Hierbij worden een aantal zaken gecontroleerd. Allereerst of de eindgebruiker bekend is, vervolgens of er al een licentie is en indien dit niet het geval is of de eindgebruiker een aanspraak op het leermiddel heeft. Dit proces van toegang verlenen is nader uitgewerkt in onderstaande beslisboom.

Figuur 2. Beslisboom Leermiddelactivatie en Leermiddelgebruik

Deze beslisboom is een voorbeeld die kan toegepast worden in een Licentieregistratie. In bovenstaand voorbeeld wordt eerst gecontroleerd of er een aanspraak is met de status licensed, daarna een aanspraak met de status entitled en daarna een leveringsorder van de variant School. Dit laatste veronderstelt dat ook de referentiecomponent Aanspraakmanager is geïmplementeerd. Zodra al deze drie varianten niet tot succes leiden is nog de optie van een aanspraak met een activatiecode opgenomen.

Technisch: APIs

Voor dit proces zijn de volgende brongegevens relevant:

De interactieanalyse maakt gebruik van de:

Release notes

Deze uitwerking is gebaseerd op basis van de volgende stappen:

0.0.1: Outline van de pagina is gemaakt op basis van bestaande content.
0.0.2: Verwijzingen naar Scenariobeschrijvingen Verwerven en in gebruik nemen bijgewerkt.
0.0.3: Tekst geactualiseerd op basis van herziening rollen en referentiecomponenten in het architectuurkader. Verwijzingen naar de POC scope zijn verwijderd.
0.0.4: Delivery API toegevoegd voor communicatie tussen Bestelomgeving leermiddelen en Aanspraakmanager.
0.0.5: Interactieanalyse aangepast op basis van herziening van het conceptueel model.
0.9.0: Het Bestuurlijk Overleg heeft tijdens de bijeenkomst van 27 juni 2024 het Afsprakenstelsel Edu-V als versie 0.9.0 goedgekeurd voor implementatie.