Leveren van digitaal leermiddel

Titel

Leveren van digitaal leermiddel

Scenario

#5 Leveren leermiddelen

#6 Monitoren status levering

Status

In ontwikkeling BEsluitvorming in beheer

Versie

0.0.5

Datum

9 Januari 2023

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 Leveren van leermiddelen en het monitoren van de status van de levering.

De specificatie bestaat uit de volgende onderdelen:

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 deze leveranciers activeert. Meer informatie over het activeren van gegevensuitwisselingen is te vinden in de sectie Regie op gegevens.

Van:

Gegevensdienst

Gegevenssoort

Gegevens

Naar:

Van:

Gegevensdienst

Gegevenssoort

Gegevens

Naar:

Administratiesysteem onderwijsdeelnemer

Onderwijs-organisatie

Schoolinfo

 

SchoolPeriode

SchoolVak

Aanspraakmanager

Leermiddelenportaal

Licentieregistratie

Leermiddelendashboard

Schoolorganisatie

OnderwijsdeelnemerSchoolPeriode

OnderwijsmedewerkerSchoolPeriode

StamgroepSchoolPeriode

LesgroepSchoolPeriode

Aanspraakmanager

Leermiddelenportaal

Licentieregistratie

Leermiddelendashboard

Adresgegevens fijndistributie

Fijndistributie

OnderwijsdeelnemerAdresgegevens

Bestelomgeving leermiddelen

Aanspraakmanager

Aanspraken

Aanspraken

Aanspraak

Leermiddelenportaal

Leermiddelendashboard

Licentieregistratie

Leermiddelactivatie

Leermiddelactivatie

Leermiddelactivatie

Leermiddelenportaal

Leermiddelendashboard

Geen Regie op gegevens bij bilaterale samenwerkingen tussen leveranciers

Indien de leverancier die leermiddelen aanbiedt bilateraal samenwerkt met andere leveranciers (die bijvoorbeeld de verkoop en/of distributie verzorgt), dan is voor de gegevensuitwisseling tussen deze leveranciers 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.

    • De uitwisseling van Schoolinfo en Schoolorganisatie gegevenssoorten naar de Licentieregistratie is geactiveerd indien gebruik gemaakt wordt van de Aanspraakvarianten SchoolVak of SchoolGroep. Dit is aangeduid met een * in de kruistabel.

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

    • Het betreft de gegevenssoorten:

      • Onderwijsadministratie

      • Aanspraken

      • Leermiddelactivatie

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

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 leverancier die de leermiddelen aanbiedt, de verkoop laat verzorgen door een andere leverancier, 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 referentiecomponent Leveranciersspecfieke leermiddelencatalogus.

    • De leverancier die de leermiddelen aanbiedt 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 Aanspraakmanager, het Leermiddelenportaal en het Leermiddelendashboard beschikken over actuele informatie uit het Administratiesysteem onderwijsdeelnemer van de onderwijsorganisatie.

    • Voor het Leermiddelenportaal gelden specifieke verwerkingsregels ten aanzien van het verwerken van wijzigingen in Onderwijsdeelnemer of Lesgroep/Stamgroep 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 SchoolGroep correct te laten werken.

  • Indien de leermiddelen aangeboden worden in de aanspraakvarianten SchoolVak of SchoolGroep dan beschikt de referentiecomponent Licentieregistratie over actuele informatie uit het Administratiesysteem onderwijsdeelnemers van de onderwijsorganisatie.

Start: Bestelling voltooid en Leveringsorder bekend

Dit scenario start op het moment dat een Besteller (onderwijsorganisatie of een particulier) een bestelling heeft geplaatst bij een Bestelomgeving leermiddelen. Een enkele bestelling kan bestaan uit meerdere bestelregels voor 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 dit scenario 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 door de betrokken referentiecomponenten Aanspraakmanager, Licentieregistratie, Leermiddelenportaal en Leermiddelendashboard.

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 Leveringsorder:

  • 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) Leveringsorderregelnummer indien er in één leveringsorder meerdere producten worden geleverd.

  • (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 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 worden gespecificeerd.

    • Indien er voor een persoonlijke aanspraak gebruik wordt gemaakt van activatiecodes, dan wordt er een nog geldige en niet eerder verkochte activatiecode toegevoegd aan de aanspraak. Een activatiecode kan door de Bestelomgeving leermiddelen worden aangevraagd bij de Licentieregistratie.

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
quantity

SchoolVak

Open

Onderwijsdeelnemers die bij in gebruik name het SchoolVak volgen

schoolId
schoolSubjectId
quantity

SchoolGroep

Open

Onderwijsdeelnemers die bij in gebruik name in een Lesgroep of Stamgroep zitten

schoolId
groupId of classId
quantity

SchoolOnderwijs-deelnemer

Individueel

Gespecificeerde onderwijsdeelnemer(s)

schoolId
eckId, userId OF activatiecode

SchoolOnderwijs-medewerker

Individueel

Gespecificeerde lera(a)r(en)

schoolId
eckId, userId OF activatiecode

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 Besteller een leermiddel heeft geselecteerd en besteld in de referentiecomponent 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 Figuur 9 is het interactiediagram voor dit leverproces weergegeven.

Figuur 1. Interactieanalyse Leveren van digitaal leermiddel

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

Stap

Toelichting

Stap

Toelichting

1.

De Leveringsorder wordt door de Bestelomgeving Leermiddelen verstuurd naar de Aanspraakmanager.

2.

De Aanspraakmanager verwerkt de Leveringsorder en maakt een aanspraak aan voor het bestelde digitale leermiddel. Iedere Aanspraak wordt conform de volgende stappen verstuurd.

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

3.

De Aanspraakmanager verstuurt de aanspraak met de status Entitled naar alle betrokken componenten in de levering van het leermiddel. Dit zijn de componenten:

  • Licentieregistratie

  • Leermiddelenporta(a)l(en)

  • Leermiddelendashboard(s)

De aanspraak wordt alleen verstuurd naar de Leermiddelenportalen en Leermiddelendashboard(s) waar de onderwijsorganisatie de gegevensuitwisseling van de gegevensdienst aanspraken voor heeft geactiveerd.

4.

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

5.

De Besteller kan in de Bestelomgeving 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 Leermiddelendashboard, dan kan een onderwijsmedewerker van de onderwijsorganisatie de status van de levering in dit dashboard volgen. Dit heeft als voordeel voor de onderwijsorganisatie dat de levering van leermiddelen die besteld zijn bij meerdere Bestelomgevingen leermiddelen in één totaaloverzicht gecombineerd kunnen worden.

6.

De Licentieregistratie 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.

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

7.

De Licentieregistratie bevestigt aan de Aanspraakmanager dat de leermiddelen klaar zijn gezet met een terugmelding Provisioned.

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

8.

De Aanspraakmanager 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.

9.

De Aanspraakmanager verstuurt een terugmelding naar de Bestelomgeving leermiddelen dat de leveringsorder nu de status van Provisioned heeft.

.10.

De Besteller kan de nieuwe status inzien bij de Bestelomgeving leermiddelen. Tevens kan een onderwijsmedewerker van de onderwijsorganisatie ook de nieuwe status inzien in het Leermiddelendashboard.

11.

De statuswijzing van een Aanspraak naar Provisioned is de trigger voor het Leermiddelenportaal 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 aAanspraakvariant.

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

12.

Het Leermiddelenportaal bevestigt aan de Aanspraakmanager dat de toegangslinks klaar zijn gezet met een terugmelding LinkReady.

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

13.

De Aanspraakmanager 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.

14.

De Aanspraakmanager verstuurt een terugmelding naar de Bestelomgeving leermiddelen dat de leveringsorder nu de status van LinkReady heeft.

15.

De Besteller kan de nieuwe status inzien bij de Bestelomgeving leermiddelen. Tevens kan een onderwijsmedewerker van de onderwijsorganisatie ook de nieuwe status inzien in het Leermiddelendashboard.

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 en de besteller.

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:

  1. 0.0.1: Outline van de pagina is gemaakt op basis van bestaande content.

  2. 0.0.2: Verwijzingen naar Scenariobeschrijvingen Verwerven en in gebruik nemen bijgewerkt.

  3. 0.0.3: Tekst geactualiseerd op basis van herziening rollen en referentiecomponenten in het architectuurkader. Verwijzingen naar de POC scope zijn verwijderd.

  4. 0.0.4: Delivery API toegevoegd voor communicatie tussen Bestelomgeving leermiddelen en Aanspraakmanager.

  5. 0.0.5: Gegevensdiensten van SIS API opgesplitst in:

    • Onderwijsorganisatie

    • Adresgegevens fijndistributie