Titel | Leveren van digitaal leermiddel |
Use case | |
Status | DRAFT WERKGROEP KLANKBORDGROEP ARCHITECTENRAAD REDACTIE BESLUITVORMING CONCEPT |
Stadium | POC PILOT BEHEER |
Versie | 0.0.2 |
Datum | 26 Mei 2023 |
Auteur | Werkgroep Verwerven en in gebruik nemen |
Acties |
|
Op deze pagina is de functionele, operationele en technische specificatie te vinden voor het Leveren van leermiddelen en het monitoren van de status van de levering.
De specificatie bestaat uit de volgende onderdelen:
Randvoorwaarden: activering gegevensuitwisselingen door Onderwijsorganisaties
Om Leermiddelen succesvol te kunnen laten leveren tussen de betrokken Leveranciers is het van belang dat de onderwijsorganisatie de gegevensuitwisselingen tussen deze Leveranciers activeert.
Bron | Gegevenssoort | Gegevens | Leermiddelenshop | Leerportaalaanbieder | Leermiddelenaanbieder | Dashboardaanbieder | |
|---|---|---|---|---|---|---|---|
Administratiesysteem-aanbieder | Administratiesysteem onderwijsdeelnemer | Schoolinfo | SchoolPeriode SchoolVak | Faciliteit voor leveren (of arrangeren) van digitale leermiddelen | Mijn leermiddelen Learning Management System | Licentiekantoor* | Overkoepelend dashboard gebruik |
Schoolorganisatie | OnderwijsdeelnemerSchoolPeriode OnderwijsmedewerkerSchoolPeriode LesgroepSchoolPeriode | Faciliteit voor leveren (of arrangeren) van digitale leermiddelen | Mijn leermiddelen Learning Management System | Licentiekantoor* | Overkoepelend dashboard gebruik | ||
Fijndistributie | OnderwijsdeelnemerAdresgegevens | Distributiefaciliteit voor levering van fysieke leermiddelen | – | – | – | ||
Leermiddelenshop | Faciliteit voor leveren (of arrangeren) van digitale leermiddelen | Aanspraken | Aanspraak | – | Mijn leermiddelen Learning Management System | Licentiekantoor | Overkoepelend dashboard gebruik |
Geen Activering tussen Leermiddelenshop en Leermiddelenaanbieder
De onderwijsorganisatie hoeft de uitwisseling van Aanspraken tussen de Leermiddelenshop en de Leermiddelenaanbieder niet te activeren. Als gevolg van de bilaterale overeenkomst tussen de Leermiddelenaanbieder en de Leermiddelenshop is er reeds doelbinding om de gegevens uit te wisselen tussen de partijen.
Voor dit proces betreft het de volgende eisen:
De Onderwijsorganisatie heeft de uitwisseling van gegevens geactiveerd conform bovenstaande tabel.
De uitwisseling van Schoolinfo en Schoolorganisatie gegevenssoorten naar het Licentiekantoor van de Leermiddelenaanbieder is geactiveerd indien gebruik gemaakt wordt van de Aanspraakvarianten SchoolVak of SchoolGroep. Dit is aangeduid met een * in de kruistabel.
Een aantal gegevenssoorten zijn vertrouwelijk en vereisen een Verwerkersovereenkomst tussen de Onderwijsorganisatie en de Leverancier.
Het betreft de gegevenssoorten:
Schoolorganisatie
Fijndistributie
Aanspraken
De Onderwijsorganisatie heeft derhalve een Verwerkersovereenkomst gesloten met de Leverancier in de rollen van:
Leermiddelenshop
Leermiddelenaanbieder
Leerportaalaanbieder
Dashboardaanbieder
De Verwerkersovereenkomst heeft geresulteerd in een geldig mandaat in het Mandatenregister van de Onderwijsorganisatie.
Randvoorwaarden: aansluiting en beschikbare brongegevens
Leveranciers beschikken afhankelijk van de Business Rol die ze vervullen over actuele brongegevens en/of hebben onderling overeenkomsten afgesloten:
De Leermiddelenshop en de Leermiddelenaanbieder hebben een overeenkomst gesloten.
Indien een Leverancier zowel de rol van Leermiddelenshop als Leermiddelenaanbieder vervult is deze overeenkomst vanzelfsprekend niet nodig.
Alle betrokken Business rollen (Leermiddelenshop, Leermiddelenaanbieder, Leerportaalaanbieder en Dashboardaanbieder) in de levering zijn technisch op elkaar aangesloten.
De Leermiddelenshop, de Leerportaalaanbieder(s) en de Dashboardaanbieder(s) beschikken over actuele informatie uit de Leveranciersspecfieke leermiddelencatalogus van de Leermiddelenaanbieder.
De Leermiddelenaanbieder is verantwoordelijk voor actuele informatie in de Leveranciersspecifieke leermiddelencatalogus voor alle Producten die verworven kunnen worden. Dit betekent dat is voldaan aan de vullingsregels zoals toegelicht op de pagina Producten, Aanspraken en Licenties.
De Leermiddelenshop en de Leerportaalaanbieder beschikken over actuele informatie uit het Administratiesysteem onderwijsdeelnemer van de Administratiesysteemaanbieder van de Onderwijsorganisatie.
Voor de Leerportaalaanbieder gelden specifieke verwerkingsregels ten aanzien van het verwerken van wijzigingen in Onderwijsdeelnemer of Lesgroep informatie. Dit is nader toegelicht in de technische specificatie van de SIS API.
De verwerkingsregels zijn er op gericht om de open aanspraakvarianten SchoolVak en SchoolLesgroep correct te laten werken.
Indien de Leermiddelenaanbieder Leermiddelen aanbiedt in de Aanspraakvarianten SchoolVak of SchoolGroep dan beschikt de Leermiddelenaanbieder over actuele informatie uit het Administratiesysteem onderwijsdeelnemer van de Administratiesysteemaanbieder van de Onderwijsorganisatie.
Start: Bestelling voltooid en Leverspecificatie bekend
Deze use case start op het moment dat een Onderwijsorganisatie of een Particulier een bestelling heeft geplaatst bij een Bestelomgeving leermiddelen van een Leermiddelenshop. Een enkele bestelling kan bestaan uit meerdere Producten. Hierbij dient opgemerkt te worden dat ook een Product kan bestaan uit meerdere deelproducten. In dat geval spreken we van een Set. Tot slot zijn er Producten die bestaan uit folio en digitale componenten. In dat geval spreken we van een Combi product.
Voor deze Use case gaan we er van uit dat er een Product (of Set) is besteld. De specificatie op deze pagina licht toe op welke wijze dit Product geleverd gaat worden bij de betrokken Business Rollen Leermiddelenshop, Leermiddelenaanbieder, Leerportaalaanbieder en Leerdashboardaanbieder.
Hierbij maakt het proces direct onderscheid tussen het type Product: Fysiek, Digitaal of Combi. Deze uitwerking gaat uit van de levering van digitale leermiddelen die onderdeel zijn van een Digitaal of Combi product. De levering van Fysieke producten is buiten scope van deze uitwerking. De levering van Fysieke deelproducten uit een Combi-product is ook buiten scope van deze uitwerking.
Als gevolg van bovenstaande scope start het proces van Leveren met de volgende Leverspecificatie:
De Besteller, zijnde een Onderwijsorganisatie of een Particulier
(Optioneel) Bestelnummer ter referentie aan de bestelling die door de Besteller is gedaan. Zo kan de verwerking van de Leverspecificatie terug herleid worden naar een daadwerkelijke bestelling door een Besteller.
(Optioneel) Contractnummer ter referentie tussen de Leverancier in de rol van Leermiddelenshop en de Leverancier rol van Leermiddelenaanbieder.
Dit is vanzelfsprekend niet van toepassing indien een Leverancier beide rollen vervult.
Het hanteren van een contractnummer is niet verplicht en Leveranciers kunnen hier bilaterale afspraken over maken.
Tevens staat het Leveranciers vrij om een eigen aggregatieniveau voor contracten te hanteren, zoals een contractnummer per Leverancier, Onderwijsorganisatie, Boekjaar, Product, of anderszins.
Het Product, zijnde een combi of digitaal leermiddel of een set van digitale leermiddelen
De Activatieperiode gespecificeerd met een startdatum (startDate) en einddatum (activationUntilDate)
De Aanspraakvariant, inclusief de hiervoor vereiste autorisatiegegevens zoals opgenomen in onderstaande tabel
De individuele aanspraakvarianten kunnen op basis van een identifier (eckId of userId) of met een activatiecode BUITEN SCOPE POC worden gespecificeerd.
Besteller | Aanspraakvariant | Autorisatieregel: wie mag leermiddel in gebruik nemen? | Minimaal vereiste gegevens | |
Particulier | Persoonlijk | Individueel | Gespecificeerde onderwijsdeelnemer | eckId, userId OF activatiecode |
Onderwijs-organisatie | School | Open | Alle onderwijsdeelnemers van de school | schoolId |
SchoolVak | Open | Onderwijsdeelnemers die bij in gebruik name het SchoolVak volgen | schoolId | |
SchoolLesgroep | Open | Onderwijsdeelnemers die bij in gebruik name in een Lesgroep zitten | schoolId | |
SchoolOnderwijs-deelnemer | Individueel | Gespecificeerde onderwijsdeelnemer(s) | schoolId | |
SchoolOnderwijs-medewerker | Individueel | Gespecificeerde lera(a)r(en) | schoolId | |
Aanspraken en licenties
Bij het leveren van Leermiddelen wordt gebruik gemaakt van de entiteiten Aanspraak en Licentie. De definities, levenscyclus en statussen van deze entiteiten zijn toegelicht op de pagina Producten, Aanspraken en Licenties.
Proces: Interactieanalyse Leveren van digitaal leermiddel
Het leveren van Leermiddelen vindt plaats nadat een Koper een Leermiddel heeft geselecteerd en besteld in de component Bestelomgeving van een Leermiddelenshop. De bestelling wordt vervolgens door de Leermiddelenshop naar de component Faciliteit voor leveren (of arrangeren) van digitale leermiddelen van de Leermiddelenshop gestuurd. Deze component is verantwoordelijk voor de levering van alle digitale leermiddelen uit de leverspecificatie. In Figuur 9 is het interactiediagram voor de levering van digitale leermiddelen weergegeven.
Leverancier vervult zowel de rol van Leermiddelenshop als Leermiddelenaanbieder
Indien een Leverancier zowel de component Faciliteit voor leveren (of arrangeren) van digitale leermiddelen in de rol van Leermiddelenshop als de component van Licentiekantoor in de business rol van Leermiddelenaanbieder vervult dan kunnen een aantal stappen worden overgeslagen. Dit is in de toelichting aangeduid met de aanduiding NVT GECOMBINEERDE ROL
Het proces van leveren van een digitaal leermiddel bestaat uit de volgende stappen:
Stap | Toelichting |
|---|---|
1. | De Leverspecificatie wordt door de component Bestelomgeving Leermiddelen van een Leermiddelenshop verstuurd naar de component Faciliteit voor leveren (of arrangeren) van digitale leermiddelen van de Leermiddelenshop. In dit proces gaan we er niet vanuit dat de Leverancier die de Faciliteit voor leveren (of arrangeren) van digitale leermiddelen aanbiedt ook de Bestelomgeving leermiddelen aanbiedt. Dit kunnen verschillende Leveranciers zijn. |
2. | De Faciliteit voor leveren (of arrangeren) van digitale leermiddelen verwerkt de Leverspecificatie en maakt een Aanspraak aan voor het bestelde Leermiddel. Iedere Aanspraak wordt conform de volgende stappen verstuurd.
|
3. | NVT GECOMBINEERDE ROL De Faciliteit voor leveren (of arrangeren) van digitale leermiddelen verstuurt de Aanspraak met de status Entitled naar alle betrokken componenten in de levering van het Leermiddel. Dit zijn de componenten:
De Aanspraak wordt alleen verstuurd naar de Leerportaalaanbieder(s) en Dashboardaanbieder(s) waar de Onderwijsorganisatie de gegevensuitwisseling van de gegevenssoort Aasnspraak voor heeft geactiveerd. |
4. | NVT GECOMBINEERDE ROL De Besteller kan in de component Faciliteit voor leveren (of arrangeren) van digitale leermiddelen zien wat de status is van de levering. De status van Entitled betekent dat de bestelling is verwerkt en de levering naar de betrokken componenten is gestart. Indien de Onderwijsorganisatie de gegevensuitwisseling van de gegevenssoort Aanspraak heeft geactiveerd voor een Overkoepelend dashboard gebruik, dan kan een Onderwijsmedewerker van de Onderwijsorganisatie de status van de levering volgen. Dit heeft als voordeel voor de Onderwijsorganisatie dat de levering van Leermiddelen die besteld zijn bij meerdere Leermiddelenshops in één statusoverzicht gecombineerd kunnen worden. |
5. | Het Licentiekantoor van de Leermiddelenaanbieder krijgt een Aanspraak op een Leermiddel binnen en zet het Leermiddel, conform de autorisatieregels van de Aanspraakvariant, klaar voor in gebruik name in de activatieperiode.
|
6. | NVT GECOMBINEERDE ROL Het Licentiekantoor van de Leermiddelenaanbieder bevestigt aan de Faciliteit voor leveren (of arrangeren) van digitale leermiddelen van de Leermiddelenshop dat de Leermiddelen klaar zijn gezet met een terugmelding Provisioned.
|
7. | De Faciliteit voor leveren (of arrangeren) van digitale leermiddelen van de Leermiddelenshop verandert de status van de Aanpraak van Entitled naar Provisioned en stuurt deze nieuwe status toe aan alle betrokken componenten in de levering van het Leermiddel. |
8. | De Besteller kan de nieuwe status inzien bij de Faciliteit voor leveren (of arrangeren) van digitale leermiddelen van de Leermiddelenshop. Tevens kan een Onderwijsmedewerker van de Onderwijsorganisatie ook de nieuwe status inzien in het Overkoepelend dashboard gebruik van de Dashboardaanbieder(s). |
9a. | De statuswijzing van een Aanspraak naar Provisioned is de trigger voor de component Mijn leermiddelen van een Leerportaalaanbieder om de Toegangslink op te nemen in het overzicht van leermiddelen voor de Onderwijsdeelnemers (of -medewerkers). De Toegangslinks worden geplaatst conform de autorisatieregels van de Aanspraakvariant.
|
9b | BUITEN SCOPE POC Indien de School gebruik maakt van een Portaal met de component Learning Management System dan kan het Leermiddel inclusief de onderliggende Leermaterialen en Toetsen voorzien worden van een label dat deze zijn verworven door de school. Ook kunnen de Deeplinks van Leermaterialen worden geplaatst in een persoonlijke studiewijzer voor Onderwijsdeelnemers en -medewerkers. Dit maakt het voor Onderwijsmedewerkers gemakkelijker om relevante Leermaterialen en Toetsen te selecteren voor hun lesvoorbereiding.
|
10. | De component Mijn leermiddelen van de Leerportaalaanbieder bevestigt aan de Faciliteit voor leveren (of arrangeren) van digitale leermiddelen van de Leermiddelenshop dat de Toegangslinks klaar zijn gezet met een terugmelding LinkReady.
|
11. | De Faciliteit voor leveren (of arrangeren) van digitale leermiddelen van de Leermiddelenshop verandert de status van de Aanspraak van Provisioned naar LinkReady en stuurt deze nieuwe status toe aan alle betrokken componenten in de levering van het Leermiddel. |
12. | De Besteller kan de nieuwe status inzien bij de Faciliteit voor leveren (of arrangeren) van digitale leermiddelen van de Leermiddelenshop. Tevens kan een Onderwijsmedewerker van de Onderwijsorganisatie ook de nieuwe status inzien in het Overkoepelend dashboard gebruik van de Dashboardaanbieder(s). |
Communicatie statusuwijziginen naar alle betrokken componenten
In het proces is ervoor gekozen om de nieuwe status naar alle betrokken referentiecomponenten te sturen. Zo beschikken alle betrokken Leveranciers en de Onderwijsorganisatie altijd over dezelfde informatie. Door deze transparantie kunnen alle betrokken Leveranciers adequate support leveren aan de Onderwijsorganisatie.
Technisch: formaat Deeplink
Buiten scope POC
Het gebruik van Deeplinks voor Leermaterialen die behoren tot een Leermiddel is buiten scope van de eerste POC. De werking hiervan wordt op een later moment toegevoegd.
De Leermiddelenaanbieder bepaalt de opbouw van de Deeplink. Om in gebruik name via een Deeplink mogelijk te maken kan de component Learning Management System van een Leerportaalaanbieder een optionele parameter product toevoegen aan een Deeplink. Hierdoor krijgt de Leermiddelenaanbieder een suggestie voor het Leermiddel waarop de Onderwijsdeelnemer (of -medewerker) een Aanspraak heeft om het Leermiddel in gebruik te nemen.
Dit voorkomt dat een Onderwijsdeelnemer (of -medewerker) allereerst de Toegangslink dient te gebruiken om een Leermiddel in gebruik te nemen. Dit kan dan ook via één van de Deeplinks van de Leermaterialen uit het Leermiddel. Ook ondersteunt het een Learning Management System in het beheer van relevante Deeplinks voor Onderwijsdeelnemers (of -medewerkers).
Een Deeplink krijgt in dat geval het volgende formaat:
www.uitgever.nl/leermateriaal?product=12345678
Hierbij is het onderdeel www.uitgever.nl/leermateriaal de deeplink die geplaatst staat in de Course API. De identifier (veelal het EAN) – in dit voorbeeld 12345678 – betreft de productId van het Leermiddel van een geldige Aanspraak voor de Onderwijsdeelnemer (of -medewerker). De component Learning Management System heeft deze informatie verkregen via de Entitlement API.
Het hanteren van deze parameter is optioneel. Zo kan het bijvoorbeeld voorkomen dat een Onderwijsdeelnemer via meerdere Leermiddelen een gebruiksrecht heeft op hetzelfde Leermateriaal. In dat geval kan een Portaal twee deeplinks tonen, aan de Onderwijsdeelnemer vragen welk product te gebruiken of de parameter niet hanteren.
Technisch: APIs
Voor dit proces zijn de volgende brongegevens relevant:
De interactieanalyse maakt gebruik van de 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.