Leveringsorders, aanspraken, leermiddelorders en contracten

Titel

Leveringsorders, aanspraken, leermiddelorders en contracten

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

Bij het Verwerven en in gebruik nemen wordt gebruik gemaakt van Leveringsorders en Aanspraken. Op deze pagina worden deze entiteiten inclusief hun levenscyclus en statussen nader toegelicht. De pagina bestaat uit de volgende paragrafen:

Leveringsorders

Een leveringsorder is een opdracht om één digitaal leermiddel (of een digitale leermiddel uit een combi product) te gaan leveren conform de gespecificeerde levervariant. Een leveringsorder wordt verstuurd vanuit de Bestelomgeving leermiddelen naar de Aanspraakmanager en is door de Bestelomgeving leermiddelen terug te herleiden naar een bestelling door een besteller (onderwijsorganisatie of particulier).

Levervarianten

Binnen Edu-V onderscheiden we een aantal verschillende levervarianten. Hierbij kan op hoofdlijnen onderscheid worden gemaakt in:

  • De besteller:

    • Onderwijsorganisatie

    • Particulier

  • Het type:

    • Individueel: Een levering voor één eindgebruiker.

    • Open: Een levering voor meerdere eindgebruikers waarbij toekenning plaatsvindt op basis van een kenmerk waaraan alle eindgebruikers voldoen.

In onderstaand overzicht zijn op basis van deze kenmerken negen verschillende levervarianten uitgewerkt.

Naam

Technische naam

Besteller

Type

Autorisatieregel

School

school-all

Onderwijsorganisatie

Open

Alle onderwijsdeelnemers van de school.

Opleiding

school-studies

Onderwijsorganisatie

Open

Alle onderwijsdeelnemers die ingeschreven zijn op een gespecificeerd opleidingsjaar.

Vak

school-subjects

Onderwijsorganisatie

Open

Alle onderwijsdeelnemers die een gespecificeerd vak volgen.

Groep

school-groups

Onderwijsorganisatie

Open

Alle onderwijsdeelnemers die ingeroosterd zijn in een gespecificeerde stamklas of lesgroep.

Onderwijsdeelnemers

school-students

Onderwijsorganisatie

Individueel

De gespecificeerde onderwijsdeelnemer.

Onderwijsmedewerkers

school-employees

Onderwijsorganisatie

Individueel

De gespecificeerde onderwijsmedewerker.

Activatiecodes

school-activationcodes

Onderwijsorganisatie

Individueel

De eindgebruiker die een gespecificeerde en niet gebruikte activatiecode gebruikt.

Particulier met ID

customer-student

Particulier

Individueel

De gespecificeerde onderwijsdeelnemer.

Particulier met activatiecode

customer-activationcode

Particulier

Individueel

De eindgebruiker die een gespecificeerde en niet gebruikte activatiecode gebruikt.

Statussen

Een leveringsorder heeft afhankelijk van de stap waarin het leveringsproces zich bevindt een bepaalde status. De statussen van een leveringsorder zijn weergegeven in onderstaande figuur. Hierbij zijn ook de toegestane statusovergangen weergegeven.

EDUV_levenscycli-leveringsorder_iteratie_1.png
Figuur 1. Statussen van een leveringsorder

De statussen hebben de volgende definities:

  • Ordered: de Bestelomgeving leermiddelen heeft een leveringsorder aangemaakt op basis van de bestelling en deze verstuurd naar de Aanspraakmanager.

  • Processed: de Aanspraakmanager heeft een terugmelding gedaan bij de Bestelomgeving leermiddelen dat de leveringsorder is verwerkt en het proces van aanmaken en beheren van aanspraken op basis van de levervariant voor de leveringsorder is gestart.

    • Voor open levervarianten geldt dat het daadwerkelijk toekennen van aanspraken aan eindgebruikers gebeurt op basis van informatie verkregen uit het administratiesysteem onderwijsdeelnemers. Deze informatie wijzigt en kan ook pas later beschikbaar zijn. Hierdoor is niet mogelijk om aan te geven of alle aanspraken zijn aangemaakt. Er is om deze reden ook niet een status entitled toegevoegd aan een leveringsorder.

  • Licensed: op de leveringsorder is tenminste één aanspraak in gebruik genomen door een eindgebruiker. Voor de individuele levervarianten betekent dit dat de leveringsorder volledig gelicenseerd is. Voor de open levervarianten betekent dit dat er tenminste één eindgebruiker is die op basis van de autorisatieregel het digitale leermiddel in gebruik heeft genomen.

  • Cancelled: de leveringsorder is door de Bestelomgeving leermiddelen geannuleerd. De Aanspraakmanager heeft deze annulering ook bevestigd en het proces van aanmaken en beheren van aanspraken voor de leveringsorder is geannuleerd.

    • Alleen leveringsorders met de status Ordered of Processed kunnen geannuleerd worden. Leveringsorders met de status Licensed kunnen niet meer geannuleerd worden.

Aanspraken

Een Aanspraak geeft het recht om een digitaal leermiddel in gebruik te nemen en te gaan gebruiken. Een aanspraak wordt gebruikt om de levering van het leermiddel tussen meerdere referentiecomponenten te organiseren.

Activatie- en gebruiksperiode

In een Aanspraak staat gespecificeerd wat de activatie- en gebruiksperiode is. De relevante datumvelden in de activatie- en gebruiksperiode zijn toegelicht in onderstaande figuur.

Figuur 2. Datumvelden van een Aanspraak en een Licentie

Een Aanspraak wordt aangemaakt op basis van een leveringsorder voor een digitaal leermiddel. De datum van creatie wordt door de referentiecomponent Aanspraakmanager vastgelegd in het datumveld creationDate.

Bij de creatie worden nog twee andere velden door de Aanspraakmanager vastgelegd: startDate en activationUntilDate. Deze twee datumvelden definiëren het begin en het einde van de activatieperiode. De beoogde eindgebruiker kan in deze activatieperiode het leermiddel in gebruik gaan nemen.

Zodra het leermiddel in gebruik wordt genomen door de eindgebruiker wordt de aanspraak een licentie op het leermiddel. In het bericht van de leermiddelactivatie legt de referentiecomponent Licentieregistratie de datum van eerste keer gebruik vast in het datumveld firstUsed. Op basis van de gebruiksvoorwaarden en de productbeschrijving wordt door de Licentieregistratie ook de laatste datum van gebruik vastgelegd in het datumveld expirationDate. De Leerling (of Leraar) kan het leermiddel gebruiken in de gebruiksperiode: tussen firstUsed en expirationDate.

Indien het leermiddel door een andere leverancier verkocht wordt, dan kunnen afhankelijk van de bilaterale afspraken tussen leveranciers gegevens over leermiddelgebruik gedeeld worden. In het Leermiddelgebruik kan de Licentieregistratie bijvoorbeeld de laatste keer dat het leermiddel gebruikt is delen in het datumveld lastUsed.

Een aanspraak kan geannuleerd of geblokkeerd worden door de Aanspraakmanager. In dat geval komt het recht op in gebruik name en gebruik te vervallen. De Aanspraakmanager legt de datum van annuleren of blokkeren vast in de aanspraak in het datumveld endDate.

Type aanspraken

Binnen Edu-V onderscheiden we een aantal verschillende typen aanspraken. Hierbij kan op hoofdlijnen onderscheid worden gemaakt in:

  • De besteller:

    • Onderwijsorganisatie

    • Particulier

  • De autorisatie:

    • ID: autorisatie vindt plaats op basis van de identifier van een eindgebruiker.

    • Activatiecode: autorisatie vindt plaats op basis van een activatiecode die een eindgebruiker invoert tijdens de activatie.

In onderstaand overzicht zijn op basis van deze kenmerken vijf verschillende aanspraakvarianten uitgewerkt.

Naam

Technische naam

Besteller

Autorisatie

Licentieregistratie staat activering toe zodra:

Onderwijsdeelnemer

school-student

Onderwijsorganisatie

ID

De gespecificeerde onderwijsdeelnemer vanuit de gespecificeerde onderwijsorganisatie het leermiddel in gebruik gaat nemen.

Onderwijsmedewerker

school-employee

Onderwijsorganisatie

ID

De gespecificeerde onderwijsmedewerker vanuit de gespecificeerde onderwijsorganisatie het leermiddel in gebruik gaat nemen.

Activatiecode

school-activationcode

Onderwijsorganisatie

Activatiecode

Een eindgebruiker vanuit de gespecificeerde onderwijsorganisatie het leermiddel in gebruik gaat nemen en hierbij de gespecificeerd en niet gebruikte activatiecode gebruikt.

Particulier met ID

customer-student

Particulier

ID

De gespecificeerde onderwijsdeelnemer het leermiddel in gebruik gaat nemen.

Particulier met activatiecode

customer-activationcode

Particulier

Activatiecode

Een eindgebruiker die de gespecificeerde en niet gebruikte activatiecode gebruikt.

Statussen

Een Aanspraak wordt bij het leveren van digitale leermiddelen gebruikt voor de registratie in de Licentieregistratie alsook voor het plaatsen van de toegangslink in het Leermiddelenportaal. Voor ieder van deze processen heeft de Aanspraak een eigen status;

  • Status van de aanspraak: entitlementStatus

  • Status van het plaatsingsproces van de toegangslink: urlStatus

De statussen van een Aanspraak zijn weergegeven in onderstaande figuur. Hierbij zijn ook de toegestane statusovergangen weergegeven.

 

De statussen van een Aanspraak (entitlementStatus) hebben de volgende definities:

  • Created: de referentiecomponent Aanspraakmanager heeft een aanspraak op een leermiddel aangemaakt op basis van een leveringsorder.

  • Entitled: de Aanspraak is verwerkt in de referentiecomponent Licentieregistratie. Hierna zijn eindgebruikers die voldoen aan de autorisatieregels van de aanspraak in staat om het leermiddel in gebruik te nemen.

  • Licensed: het leermiddel is door de eindgebruiker in gebruik genomen. De referentiecomponent Licentieregistratie heeft hiervan melding gemaakt bij de Aanspraakmanager.

  • Expired: het recht op in gebruik name en gebruik is verlopen. Deze status wordt niet uitgewisseld en is af te leiden van de activationUntilDate voor de activatieperiode en de expirationDate voor de gebruiksperiode.

    • Een aanspraak die de status van Licensed heeft kan niet geannuleerd worden.

  • Cancelled: de aanspraak is geannuleerd door de Aanspraakmanager. De Licentieregistratie heeft de status gewijzigd en terugmelding gedaan bij de Aanspraakmanager.

    • De eindgebruiker kan het leermiddel niet meer in gebruik nemen.

  • Blocked: de aanspraak is geblokkeerd door de Aanspraakmanager. De Licentieregistratie heeft de status gewijzigd en terugmelding gedaan bij de Aanspraakmanager.

    • Zodra de status van een aanspraak Blocked is, kan het leermiddel niet gebruikt worden door de eindgebruiker. De aanbieder van het leermiddel toont in dit geval een passende melding aan de eindgebruiker dat de toegang tot het Leermiddel is geblokkeerd.

    • Een aanspraak kan worden gedeblokkeerd en gaat hierbij terug naar zijn originele status van Entitled of Licensed.

De statussen van het plaatsingsproces van de toegangslink zijn weergegeven in onderstaande figuur. Hierbij zijn ook de toegestane statusovergangen weergegeven.

De statussen van het plaatsen van de toegangslink (urlStatus) hebben de volgende definities:

  • Uninitialized: het plaatsen van de toegangslink is nog niet gestart door de Aanspraakmanager.

  • Initialized: de Aanspraakmanager heeft een melding naar het Leermiddelenportaal gestuurd om de toegangslink te plaatsen.

  • Processed: het Leermiddelenportaal heeft de toegangslink geplaatst, of hier de voorbereidingen voor getroffen, en een terugmelding gedaan naar de Aanspraakmanager.

    • De toegangslink is actief in de activatie- en gebruiksperiode zoals gespecificeerd in de aanspraak.

  • Expired: het recht op in gebruik name en gebruik is verlopen. De toegangslink is niet meer actief voor de eindgebruiker.

  • Cancelled: de aanspraak is geannuleerd door de Aanspraakmanager. Het Leermiddelenportaal heeft het plaatsten van de toegangslink ongedaan gemaakt en terugmelding gedaan bij de Aanspraakmanager.

    • De eindgebruiker kan het leermiddel niet meer in gebruik nemen

  • Blocked: de aanspraak is geblokkeerd door de Aanspraakmanager. Het Leermiddelenportaal heeft het plaatsten van de toegangslink ongedaan gemaakt en terugmelding gedaan bij de Aanspraakmanager.

    • Zodra de status Blocked is, kan het leermiddel niet gebruikt worden door de eindgebruiker. Het Leermiddelenportaal toont in dit geval een passende melding aan de eindgebruiker dat de toegang tot het Leermiddel is geblokkeerd.

    • Een aanspraak kan worden gedeblokkeerd. De status van de plaatsing van de toegangslink start dan opnieuw en gaat terug naar Initialized.

Leermiddelorders

Een leermiddelorder is een B2B inkooporder vanuit een leermiddelenverkoper aan een leermiddelenaanbieder voor een leermiddel (of set van leermiddelen). Een leermiddelorder wordt gestuurd vanuit een Bestelomgeving leermiddelen van de leermiddelenverkoper naar het Ordersysteem leermiddelen van de leermiddelenaanbieder.

Statussen

Een leermiddelorder bevat een status waaruit de acceptatie van het orderverzoek vanuit de leermiddelenaanbieder is af te lezen. De statussen van een leermiddelorder zijn weergegeven in onderstaande figuur. Hierbij zijn ook de toegestane statusovergangen weergegeven.

De statussen van een leermiddelorder hebben de volgende definities:

  • Pending: de leermiddelenaanbieder heeft het orderverzoek (of het creditorderverzoek) ontvangen en in behandeling genomen.

    • Deze status wordt bijvoorbeeld gehanteerd indien er handmatige controles uitgevoerd dienen te worden voordat een order wordt geaccepteerd.

  • Approved: de leermiddelenaanbieder heeft het orderverzoek (of het creditorderverzoek) geaccepteerd.

  • Declined: de leermiddelenaanbieder heeft het orderverzoek (of het creditorderverzoek) afgewezen.

Contracten

Een contract is een bilaterale overeenkomst tussen een leermiddelenverkoper en een leermiddelenaanbieder. In deze overeenkomst kunnen afspraken zijn vastgelegd ten aanzien van de businesslogica die toegepast dient te worden bij de levering. Voorbeelden zijn:

  • De levervarianten die ondersteund worden

  • De leverancier die de referentiecomponent aanspraakmanager vervult

  • De beschikbare gegevens over leermiddelgebruik ten behoeve van betalingen

  • Het inkopen van leermiddelen middels leermiddelorders

  • Het werken met maximale tegoeden

  • Afspraken over financiële en juridische voorwaarden

Leveringsorders, aanspraken en leermiddelorders bevatten allen het attribuut contractId waardoor deze businesslogica toegepast kan worden.

Tegelijkertijd biedt het contract de mogelijkheid om rapportages te creëren waarin inzicht wordt verkregen in:

  • De ingekochte leermiddelen vanuit leermiddelorders.

  • De verkochte leermiddelen vanuit leveringsorders.

  • De geactiveerde leermiddelen en het leermiddelgebruik vanuit aanspraken.

Deze informatie kan worden benut om een gesloten geld-goederenstroom te realiseren.

 


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: Tekst geactualiseerd op basis van herziening rollen en referentiecomponenten in het architectuurkader. Daarnaast is er een status Licensed toegevoegd aan de Aanspraak om duidelijk te maken dat de Aanspraak niet meer geannuleerd kan worden.

  • 0.0.3: De inhoud over Aanspraken is overgenomen uit een vorige pagina over Producten en Aanspraken. Hieraan zijn definities en statussen toegevoegd over leveringsorders, leermiddelorders en contracten. De inhoud is opnieuw beschreven op basis van een herziening van het conceptueel model zoals besproken in de werkgroep Verwerven en in gebruik nemen leermiddelen. Informatie over Producten is te vinden op een separate pagina over Levenscyclus en statussen Leermiddelen.

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