Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Titel

Leveren van digitaal leermiddel

Scenario

#5 Leveren leermiddelen

Status

Status

colourGreen

title

DRAFT

In ontwikkeling
Status
title

WERKGROEP
Status
titleARCHITECTenraad
Status
titleREDACTIE
Statustitle

ROSA-Architectuurscan
Status
title

KLANKBORDgroep

BEsluitvorming

Status
titleCONCEPT
Stadium

Status
colour

Blue

Yellow
title

POC
Status
titleBEHEER

IMPLEMENTATIE
Status
title

PILOT

in beheer

Versie

0.9.0

.1

Datum

17 Mei 2023

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 de use case: #5 Leveren leermiddelen, monitoren status leveringhet Leveren van een digitaal leermiddel.

De specificatie bestaat uit de volgende onderdelen:

Table of Contents
minLevel2
maxLevel2
include
outlinefalse
indent
excludeRelease
typelist
class
printablefalse

Randvoorwaarden

Het proces vereist een aantal zaken die van tevoren (precondities) ingericht zijn:

  • 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 Leermiddelenshop en de Leerportaalaanbieder beschikken over actuele informatie uit het Administratiesysteem onderwijsdeelnemer van de Administratiesysteemaanbieder van de Onderwijsorganisatie.

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

  • De Onderwijsorganisatie heeft de gegevensuitwisselingen tussen de betrokken Leveranciers geactiveerd conform de richtlijn zoals opgenomen in de paragraaf Activering van gegevensuitwisselingen.

...

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

...

Licentiekantoor*

...

Overkoepelend dashboard gebruik

...

Schoolorganisatie

...

OnderwijsdeelnemerSchoolPeriode

OnderwijsmedewerkerSchoolPeriode

LesgroepSchoolPeriode

...

Faciliteit voor leveren (of arrangeren) van digitale leermiddelen

...

Mijn leermiddelen

...

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

...

Licentiekantoor

...

Overkoepelend dashboard gebruik

...

Leermiddelenaanbieder

...

Licentiekantoor

...

In gebruik name

...

In gebruik name

...

Faciliteit voor leveren (of arrangeren) van digitale leermiddelen

...

Mijn leermiddelen

...

...

Overkoepelend dashboard gebruik

Info

Geen Activering tussen Leermiddelenshop en Leermiddelenaanbieder

De onderwijsorganisatie hoeft de uitwisseling van Aanspraken en In gebruik name gegevens 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 Tabel 1.

    • 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

      • In gebruik name

    • 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 van het Mandatenregister van de Onderwijsorganisatie.

Start: Leveren digitale leermiddelen op basis van Bestelgegevens

...

Start: Bestelling voltooid en Leveringsorder bekend

Dit scenario start op het moment dat een Onderwijsorganisatie besteller (onderwijsorganisatie of een Particulier particulier) een bestelling heeft geplaatst bij een Bestelomgeving leermiddelen van een Leermiddelenshop. Een enkele bestelling kan bestaan uit meerdere Productenbestelregels voor meerdere producten. Hierbij dient opgemerkt te worden dat ook een Product product kan bestaan uit meerdere deelproducten. In dat geval spreken we van een Set. Tot slot zijn er Producten producten die bestaan uit folio en digitale componenten. In dat geval spreken we van een Combi product. Een Product is altijd een (Set) van Leermiddelen. Een Leermiddel kan bestaan uit meerdere Leermaterialen en/of Toetsen. Deze hiërarchie in begrippen is nader toegelicht op de pagina Gegevensmodel en -definities.Voor deze Use case combi product.

Voor dit scenario gaan we er van uit dat er een Product leermiddel (of Setset van leermiddelen) is besteld. De specificatie op deze pagina licht toe op welke wijze dit Product de digitale leermiddelen (of de digitale componenten uit een set of combiproduct) geleverd gaat worden bij door de betrokken Business Rollen Leermiddelenshop, Leermiddelenaanbieder, Leerportaalaanbieder en Leerdashboardaanbiederreferentiecomponenten Bestelomgeving leermiddelen, Aanspraakmanager, Licentieregistratie en Leermiddelenportaal.

Hierbij maakt het proces direct onderscheid tussen het type Productproduct: Fysiekfysiek, Digitaal digitaal of Combicombi. De beschrijving Deze uitwerking gaat uit van de levering van digitale leermiddelen die onderdeel zijn van een Digitaal digitaal of Combi combi product. De levering van Fysieke fysieke producten is buiten scope van deze beschrijvinguitwerking. De levering van Fysieke fysieke deelproducten uit een Combi-product is ook buiten scope van deze beschrijvinguitwerking.

Als gevolg van bovenstaande scope start het proces van Leveren met de volgende bestelgegevensLeveringsorder:

  • De Besteller, zijnde een Onderwijsorganisatie of een Particulier

  • Leveringsordernummer als unieke identifier voor de leveringsorder. Dit nummer kan door de Bestelomgeving leermiddelen worden gebruikt om de status van de levering te volgen.

  • (Optioneel) Contractnummer ter referentie tussen de leverancier met de referentiecomponent Bestelomgeving leermiddelen en de leverancier met de referentiecomponent Licentieregistratie.

    • Dit is vanzelfsprekend niet van toepassing indien een Leverancier beide referentiecomponenten vervult.

    • Het aggregatieniveau voor contracten wordt bilateraal afgesproken en kan afhankelijk van de ketensamenwerking een ander niveau zijn. Voorbeelden zijn: contractnummer per leverancier, onderwijsorganisatie, bestelling, raamcontract, product, of anderszins.

    • Het contractnummer kan worden gebruikt door de Bestelomgeving leermiddelen om gegevens over Leermiddelactivatie en leermiddelgebruik op te vragen bij de Licentieregistratie.

  • Het Product, zijnde een (Set van) combi of digitaal leermiddel (en)of een set van digitale leermiddelen

  • De Activatieperiode gespecificeerd met een startdatum (startDate) en einddatum (activationUntilDate)

  • De Aanspraakvariant, inclusief levervariant en de hiervoor vereiste gegevens zoals opgenomen in onderstaande tabel

...

Besteller

...

Aanspraakvariant

...

Autorisatieregel: wie mag leermiddel in gebruik nemen?

...

Minimaal vereiste gegevens

...

Particulier

...

Persoonlijk

...

Individueel

...

Gespecificeerde onderwijsdeelnemer

...

eckId, userId

...

School

...

School

...

Open

...

Alle onderwijsdeelnemers van de school

...

schoolId
quantity

...

SchoolVak

...

Open

...

Onderwijsdeelnemers die bij in gebruik name het SchoolVak volgen

...

schoolId
schoolSubjectId
quantity

...

SchoolLesgroep

...

Open

...

Onderwijsdeelnemers die bij in gebruik name in een Lesgroep zitten

...

schoolId
groupId
quantity

...

SchoolOnderwijs-deelnemer

...

Individueel

...

Gespecificeerde onderwijsdeelnemer(s)

...

schoolId
eckId, userId

...

SchoolOnderwij-smedewerker

...

Individueel

...

Gespecificeerde lera(a)r(en)

...

schoolId
eckId, userId

Info

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 Aanspraken en Licenties.

...

Proces: Interactieanalyse Leveren digitaal leermiddel

Het leveren van een digitaal leermiddel vindt plaats nadat een Besteller een leermiddel heeft geselecteerd en besteld in de Bestelomgeving leermiddelen. De bestelling wordt door de Bestelomgeving leermiddelen omgezet in één of meerdere leveringsorders. De levering van fysieke en digitale producten wordt op dit moment in het proces gesplitst. De leveringsorder voor fysieke leermiddelen wordt verstuurd naar de referentiecomponent Distributiefaciliteit. Zoals hierboven toegelicht is het leveren van fysieke leermiddelen buiten scope van dit scenario.

De leveringsorders voor de digitale producten worden door de Bestelomgeving leermiddelen naar de referentiecomponent Aanspraakmanager gestuurd. De Aanspraakmanager is verantwoordelijk voor de levering van de digitale leermiddelen uit de leveringsorder. In onderstaande figuur is het interactiediagram voor dit proces weergegeven.

...

Het proces van leveren van een digitaal leermiddel bestaat uit de volgende stappen:

Stap

Toelichting

1.

Een Besteller bestelt een leermiddel bij de Bestelomgeving leermiddelen.

2.

De Bestelomgeving leermiddelen zet een bestelling om in leveringsorders voor alle producten uit de bestelling. Alle leveringsorders betreffende digitale leermiddelen worden verder verwerkt in dit proces.

3.

De leveringsorder wordt door de Bestelomgeving Leermiddelen verstuurd naar de Aanspraakmanager met een status ordered.

4.

De Besteller kan in de Bestelomgeving leermiddelen zien dat de leveringsorders aangemaakt.

5.

De Aanspraakmanager verwerkt de Leveringsorder en richt het beheer van aanspraken conform de levervariant en de leverspecificatie in.

  • Voor een individuele levervariant kan direct een aanspraak toegekend worden.

  • Voor de open levervarianten Opleiding, Vak en Groep wordt een proces ingericht om aanspraken toe te kennen op basis van de leverspecificatie.

  • Voor de open levervariant School worden vooraf geen aanspraken toegekend.

  • Voor een combiproduct of een set van digitale leermiddelen geldt dat aanspraken op het niveau van de combi of de set wordt opgesteld.

6.

De Aanspraakmanager verstuurt een terugmelding naar de Bestelomgeving leermiddelen dat de leveringsorder is verwerkt en nu de status van processed heeft.

7.

De Besteller kan in de Bestelomgeving leermiddelen zien dat de leveringsorders verwerkt is en in het proces zoals uitgewerkt in de figuur dat er nog geen aanspraken zijn aangemaakt.

8.

De Aanspraakmanager creëert de aanspraak of de aanspraken voor de eindgebruikers op basis van de levervariant en de leverspecificatie. Hierbij worden de volgende statussen gehanteerd: entitlementStatus created en urlStatus uninitialized

9.

De Aanspraakmanager verstuurt de aanspraak met de entitlementStatus creatednaar de Licentieregistratie.

10.

De Licentieregistratie registreert de aanspraak zodat de eindgebruiker het leermiddel in gebruik kan gaan nemen conform de autorisatieregels van de aanspraak.

  • Voor een combiproduct of een set van digitale leermiddelen geldt dat de Licentieregistratie alle onderliggende digitale leermiddelen klaarzet voor in gebruik name.

11.

De Licentieregistratie bevestigt aan de Aanspraakmanager dat de leermiddelen klaar zijn gezet met een terugmelding van de entitlementStatus entitled.

  • Indien de Licentieregistratie niet in staat is om de leermiddelen klaar te zetten dan stuurt de Licentieregistratie een terugmelding met een afgesproken foutcode terug.

12.

De Aanspraakmanager verandert de entitlementStatus van de aanpraak van created naar entitled.

13.

De Aanspraakmanager wijzigt de urlStatus van de aanspraak naar initialized en stuurt de aanspraak naar het Leermiddelenportaal.

14.

Het Leermiddelenportaal verwerkt de aanspraak en plaatst de toegangslink voor het leermiddel op het overzicht van leermiddelen voor de eindgebruiker.

  • Voor een combiproduct of een set van digitale leermiddelen geldt dat de overall toegangslink die leidt naar een pagina met alle onderliggende digitale producten wordt geplaatst op het overzicht van leermiddelen.

  • Optioneel worden ook alle toegangslinks van alle onderliggende digitale leermiddelen uit het combiproduct of de set van digitale leermiddelen geplaatst op de het overzicht van leermiddelen. Bij het plaatsen van een toegangslink van een onderliggend digitaal leermiddel wordt een relatie gelegd naar de toegangslink van het hoofdproduct (de set).

  • Indien een leverancier de referentiecomponenten Leermiddelenportaal en Onderwijsleeromgeving combineert, dan kunnen de aanspraken ook worden benut om deeplinks naar leermaterialen klaar te zetten, bijvoorbeeld in persoonlijke studiewijzers.

    • Optioneel kunnen de deeplinks van de leermaterialen worden voorzien van een parameter product van het leermiddel uit de aanspraak. De deeplink kan in dat geval gebruikt worden om het leermiddel in gebruik te nemen. De onderwijsdeelnemer kan dan het leermiddel in gebruik nemen middels de toegangslink van het leermiddel of de deeplinks van de leermaterialen uit het leermiddel. De technische afspraken met betrekking tot het formaat van deeplinks is beschreven in de paragraaf formaat deeplink.

15.

Het Leermiddelenportaal bevestigt aan de Aanspraakmanager dat de toegangslinks klaar zijn gezet met een terugmelding op de urlStatus van processed.

  • Indien het Leermiddelenportaal niet in staat is om de toegangslinks klaar te zetten dan stuurt het Leermiddelenportaal een terugmelding met een afgesproken Foutcode terug.

16.

De Aanspraakmanager verandert de urlStatus van de aanspraak van initialized naar processed.

15.

De Besteller kan bij de Bestelomgeving leermiddelen de statusinformatie van de aanspraken op de leveringsorder inzien. Na voltooiing van alle stappen ziet de Besteller dat er een aanspraak is met de entitlementStatus entitled en de urlStatus processed.

Randvoorwaarden: aansluiting en beschikbare brongegevens

Leveranciers beschikken afhankelijk van de referentiecomponent die ze vervullen over actuele brongegevens en/of hebben onderling overeenkomsten afgesloten:

  • Indien de leermiddelenaanbieder, de verkoop laat verzorgen door een leermiddelenverkoper, dan hebben beide leveranciers bilaterale afspraken gemaakt en een overeenkomst gesloten.

  • Alle betrokken referentiecomponenten in de levering zijn technisch op elkaar aangesloten.

  • De referentiecomponenten Bestelomgeving leermiddelen, Aanspraakmanager, Leermiddelenportaal en Leermiddelendashboard 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 Levenscyclus en statussen Leermiddelen.

  • De Aanspraakmanager beschikt over actuele informatie uit het Administratiesysteem onderwijsdeelnemer van de onderwijsorganisatie.

    • Voor de Aanspraakmanager gelden specifieke verwerkingsregels ten aanzien van het verwerken van wijzigingen in Onderwijsdeelnemer of Lesgroep/Stamgroep informatie.

    • De verwerkingsregels zijn er op gericht om de open levervarianten Opleiding, Vak en Groep correct te laten werken.

  • De Bestelomgeving leermiddelen beschikt over actuele informatie uit het Administratiesysteem onderwijsdeelnemer van de onderwijsorganisatie indien een onderwijsorganisatie de Besteller is.

Anchor
activering
activering
Randvoorwaarden: regie op gegevens door onderwijsorganisaties

Om Leermiddelen succesvol te kunnen laten leveren tussen de betrokken leveranciers is het van belang dat de onderwijsorganisatie de gegevensuitwisselingen tussen de betrokken referentiecomponenten autoriseert. Meer informatie over het activeren van gegevensuitwisselingen is te vinden in de sectie Regie op gegevens.

Van:

Gegevensdienst

Gegevens

Naar:

Levervarianten

Administratiesysteem onderwijsdeelnemer

Onderwijsaanbod

Onderwijsorganisatie

AangebodenOpleiding

AangebodenVak

Bestelomgeving leermiddelen

School
Opleiding
Vak
Groep
Onderwijsdeelnemers
Onderwijsmedewerkers

Aanspraakmanager

Opleiding
Vak
Groep

Onderwijsinrichting

SchoolPeriode

Inschrijving

Groep

Bestelomgeving leermiddelen

Onderwijsdeelnemers

Aanspraakmanager

Opleiding
Vak
Groep

Onderwijsdeelnemers

Onderwijsdeelnemers

Bestelomgeving leermiddelen

Onderwijsdeelnemers

Onderwijsmedewerkers

Onderwijsmedewerkers

Bestelomgeving leermiddelen

Onderwijsmedewerkers

Aanspraakmanager

Aanspraken

Aanspraak

Leermiddelenportaal

Allen

Bestelomgeving leermiddelen

Leveringsorders

Leveringsorder

Leermiddelenportaal

School

Info

Geen Regie op gegevens tussen leermiddelenverkoper en leermiddelenaanbieder

Voor de uitwisseling van gegevens tussen referentiecomponenten van de leermiddelenverkoper en de leermiddelenaanbieder is geen toestemming nodig vanuit de onderwijsorganisatie. Als gevolg van de bilaterale overeenkomst tussen de leveranciers is er reeds doelbinding om de gegevens uit te wisselen.

Voor dit proces betreft het de volgende eisen:

  • De onderwijsorganisatie heeft de uitwisseling van gegevens geactiveerd conform bovenstaande tabel.

  • Het delen van informatie vanuit het Administratiesysteem onderwijsdeelnemer is afhankelijk van de gekozen levervariant. In de kolom Levervarianten is aangegeven voor welke levervarianten de gegevensdienst noodzakelijk is.

    • Voor de levervarianten Persoon met ID en Persoon met activatiecode is geen informatie uit het Administratiesysteem onderwijsdeelnemer vereist.

  • Een aantal gegevensdiensten bevatten persoonsgegevens en vereisen een verwerkersovereenkomst tussen de onderwijsorganisatie en de leverancier.

    • Het betreft de gegevenssoorten:

      • Onderwijsadministratie

      • Leveringsorders

      • Aanspraken

    • De Onderwijsorganisatie heeft derhalve een Verwerkersovereenkomst gesloten met alle betrokken leveranciers.

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.

  • 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: Gegevensdiensten van SIS API opgesplitst in:

    • Onderwijsorganisatie

    • Adresgegevens fijndistributie

  • 0.0.6: De interactieanalyse is bijgewerkt 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.