Aanspraak blokkeren of deblokkeren

Titel	Aanspraak blokkeren of deblokkeren
Use case	#15 Aanspraak blokkeren of deblokkeren
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 blokkeren of activeren van een licentie.

De specificatie bestaat uit de volgende onderdelen:

1 Randvoorwaarden
2 Start: Leverancier blokkeert aanspraak
3 Proces: Interactieanalyse Aanspraak blokkeren
4 Proces: Interactieanalyse Aanspraak deblokkeren
5 Technisch: APIs

Randvoorwaarden

Dit scenario komt na het scenario van het Leveren van 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.
Indien de leermiddelenaanbieder de verkoop laat verzorgen door een leermiddelenverkoper, dan hebben beide leveranciers bilaterale afspraken gemaakt en een overeenkomst gesloten.
- In deze overeenkomst zijn afspraken gemaakt over het blokkeren en deblokkeren van aanspraken.

Start: Leverancier blokkeert aanspraak

Dit scenario start op het moment dat een leverancier opdracht geeft om een aanspraak te blokkeren of te deblokkeren. Er kunnen diverse redenen zijn voor het blokkeren van een aanspraak:

Een Besteller heeft een bestelling geannuleerd maar het leermiddel is in gebruik genomen. De leverancier is coulant en gaat akkoord met de annulering. Het annuleren van de bestelling zal leiden tot een foutmelding. In dat geval kan de leverancier de aanspraak blokkeren.
Een leverancier wil voorkomen dat er nog verder gebruik wordt gemaakt van het leermiddel door de eindgebruiker.
Een leverancier wil een eerdere blokkade op een aanspraak ongedaan maken en een eindgebruiker weer gebruik laten maken van het leermiddel.

De blokkade op een aanspraak wordt geïnitieerd vanuit de Aanspraakmanager.

Proces: Interactieanalyse Aanspraak blokkeren

De Aanspraakmanager kan een aanspraak blokkeren. Na deze blokkade kan de eindgebruiker die op basis van de aanspraak het leermiddel in gebruik kunnen nemen of dit reeds gedaan hadden het leermiddel niet meer gebruiken. Dit proces is weergegeven in Figuur 1.

Figuur 1. Interactieanalyse Aanspraak blokkeren

Het proces van het blokkeren van een aanspraak bestaat uit de volgende stappen:

Stap	Toelichting

Stap	Toelichting
1.	Voor de aanspraak wordt er door de Aanspraakmanager een melding gestuurd naar de Licentieregistratie en het Leermiddelenportaal. In de melding is de entitlementStatus en de urlStatus gewijzigd in `blocked`.
2.	De Licentieregistratie verwerkt de blokkering van de aanspraak. Het leermiddel is niet langer te gebruiken bij een blokkade. Indien een eindgebruiker desondanks een poging doet om toegang te krijgen tot het leermiddel dan wordt een passende melding getoond.
3.	De Licentieregistratie stuurt een terugmelding naar de Aanspraakmanager dat de Licentie is geblokkeerd. Indien er een fout optreedt bij het blokkeren van de licentie door de Licentieregistratie dan kan er een afgesproken foutcode worden verstuurd.
4.	Het Leermiddelenportaal verwijdert bij een blokkade de Toegangslinks uit het overzicht van leermiddelen van de eindgebruiker. Indien een leverancier de referentiecomponenten Leermiddelenportaal en Onderwijsleeromgeving combineert en ook gebruik maakt van deeplinks naar leermaterialen dan worden ook de deeplinks die zijn klaargezet voor de onderwijsdeelnemers verwijderd.
5.	Het Leermiddelenportaal stuurt een terugmelding naar de Aanspraakmanager dat de Toegangslinks zijn verwijderd. Indien er een fout optreedt kan er een afgesproken foutcode worden verstuurd naar de Aanspraakmanager.
6.	De Aanspraakmanager wijzigt de entitlementStatus en de urlStatus van de aanspraak naar `blocked.`
7.	De Besteller kan de nieuwe status van de leveringsorder en de nieuwe statussen van de aanspraken, waaronder de geblokkeerde aanspraak, inzien bij de Bestelomgeving leermiddelen.

Proces: Interactieanalyse Aanspraak deblokkeren

De Aanspraakmanager kan een aanspraak deblokkeren. Na het opheffen van de blokkade kan de eindgebruiker weer in gebruik nemen of gaan gebruiken. Dit proces is weergegeven in Figuur 1.

Figuur 1. Interactieanalyse Aanspraak deblokkeren

Het proces van het deblokkeren van een aanspraak bestaat uit de volgende stappen:

Stap	Toelichting

Stap	Toelichting
1.	Voor de aanspraak wordt er door de Aanspraakmanager een melding gestuurd naar de Licentieregistratie en het Leermiddelenportaal. In de melding is de entitlementStatus teruggewijzigd naar de originele status `licensed` of `entitled` en de urlStatus gewijzigd in `initialized`. De urlStatus van de aanspraak wordt gewijzigd naar `initialized`.
2.	De Licentieregistratie verwerkt de deblokkering van de aanspraak. De originele status wordt weer hersteld op de aanspraak en de eindgebruiker kan het leermiddel weer in gebruik gaan nemen of gebruiken.
3.	De Licentieregistratie stuurt een terugmelding naar de Aanspraakmanager dat de Licentie is geblokkeerd. Indien er een fout optreedt bij het blokkeren van de licentie door de Licentieregistratie dan kan er een afgesproken foutcode worden verstuurd.
4.	Het Leermiddelenportaal plaatst bij het opheffen van de blokkade de Toegangslinks opnieuw op het overzicht van leermiddelen van de eindgebruiker. Indien een leverancier de referentiecomponenten Leermiddelenportaal en Onderwijsleeromgeving combineert en ook gebruik maakt van deeplinks naar leermaterialen dan worden ook de deeplinks die zijn klaargezet voor de onderwijsdeelnemers opnieuw toegevoegd.
5.	Het Leermiddelenportaal stuurt een terugmelding naar de Aanspraakmanager dat de Toegangslinks zijn toegevoegd. Indien er een fout optreedt kan er een afgesproken foutcode worden verstuurd naar de Aanspraakmanager.
6.	De Aanspraakmanager wijzigt de entitlementStatus terug naar `entitled` of `licensed` en de urlStatus van de aanspraak naar `processed.`
7.	De Besteller kan de nieuwe status van de leveringsorder en de nieuwe statussen van de aanspraken, waaronder de geblokkeerde aanspraak, inzien bij de Bestelomgeving leermiddelen.

Technisch: APIs

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: Delivery API toegevoegd voor communicatie tussen Bestelomgeving leermiddelen en Aanspraakmanager.
0.0.3: De interactieanalyse is aangepast op basis van de 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.