Titel | Leveren van digitaal leermiddel | ||||||||||||||
Scenario | |||||||||||||||
Status |
| ||||||||||||||
Versie | 0.0.56 | ||||||||||||||
Datum9 Januari 2023 | 8 Maart 2024 | ||||||||||||||
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 leveringeen digitaal leermiddel.
De specificatie bestaat uit de volgende onderdelen:
| Table of Contents | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
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:
...
Administratiesysteem onderwijsdeelnemer
...
Onderwijs-organisatie
Schoolinfo
...
SchoolPeriode
SchoolVak
...
Aanspraakmanager
Leermiddelenportaal
Licentieregistratie
Leermiddelendashboard
...
Schoolorganisatie
...
OnderwijsdeelnemerSchoolPeriode
OnderwijsmedewerkerSchoolPeriode
StamgroepSchoolPeriode
LesgroepSchoolPeriode
Aanspraakmanager
...
Licentieregistratie
Leermiddelendashboard
...
Adresgegevens fijndistributie
...
Fijndistributie
...
OnderwijsdeelnemerAdresgegevens
...
Bestelomgeving leermiddelen
...
Aanspraakmanager
...
Aanspraken
...
Aanspraken
...
Aanspraak
...
Leermiddelenportaal
Leermiddelendashboard
...
Licentieregistratie
...
Leermiddelactivatie
...
Leermiddelactivatie
...
Leermiddelactivatie
...
Leermiddelenportaal
Leermiddelendashboard
| Info |
|---|
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 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 leermiddel (of set 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 door de betrokken referentiecomponenten Bestelomgeving leermiddelen, Aanspraakmanager, Licentieregistratie , en 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.
...
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 levervariant en 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
...
geldende leverspecificatie zoals ook toegelicht op de pagina Leveringsorders, aanspraken, leermiddelorders en contracten.
Proces: Interactieanalyse Leveren
...
digitaal leermiddel
Het leveren van Leermiddelen een digitaal eermiddel 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.
...
Het proces van leveren van een digitaal leermiddel bestaat uit de volgende stappen:
Stap | Toelichting | ||
|---|---|---|---|
1.De Leveringsorder . | 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 | ||
4. | De Besteller kan in de Bestelomgeving leermiddelen zien dat de leveringsorders aangemaakt. | ||
25. | De Aanspraakmanager verwerkt de Leveringsorder en maakt een aanspraak aan voor het bestelde digitale leermiddel. Iedere Aanspraak wordt conform de volgende stappen verstuurden richt het beheer van aanspraken conform de levervariant en de leverspecificatie in.
| ||
36. | De Aanspraakmanager 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 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 |
57. | De Besteller kan in de Bestelomgeving leermiddelen zien wat de status is van de levering. De status van Entitled betekent dat de bestelling leveringsorders verwerkt 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 activatieperiodein 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 | ||
9. | De Aanspraakmanager verstuurt de aanspraak met de entitlementStatus | ||
10. | De Licentieregistratie registreert de aanspraak zodat de eindgebruiker het leermiddel in gebruik kan gaan nemen conform de autorisatieregels van de aanspraak.
| ||
711. | De Licentieregistratie bevestigt aan de Aanspraakmanager dat de leermiddelen klaar zijn gezet met een terugmelding Provisionedvan de entitlementStatus
| ||
812. | De Aanspraakmanager verandert de status entitlementStatus van de aanpraak van Entitled naar Provisioned en stuurt deze nieuwe status toe aan alle betrokken componenten in de levering van het leermiddel.9 | ||
13. | 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 wijzigt de urlStatus van de aanspraak naar | ||
14. | Het Leermiddelenportaal verwerkt de aanspraak en plaatst de toegangslink voor het leermiddel op het overzicht van leermiddelen voor de onderwijsdeelnemers (of -medewerkers). De toegangslinks worden geplaatst conform de autorisatieregels van de aAanspraakvarianteindgebruiker.
| ||
1215. | Het Leermiddelenportaal bevestigt aan de Aanspraakmanager dat de toegangslinks klaar zijn gezet met een terugmelding LinkReadyop de urlStatus van
| ||
1316. | De Aanspraakmanager verandert de status urlStatus 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
...
| |
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 |
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 | ||||
|---|---|---|---|---|
|
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: |
|---|---|---|---|
Administratiesysteem onderwijsdeelnemer | Onderwijsorganisatie | SchoolPeriode Onderwijsdeelnemer Onderwijsmedewerker Stamgroep Lesgroep | Bestelomgeving leermiddelen Aanspraakmanager Leermiddelenportaal |
Onderwijsaanbod | Opleidingsjaar Vak | Bestelomgeving leermiddelen Aanspraakmanager Leermiddelenportaal | |
Aanspraakmanager | Aanspraken | Aanspraak | Leermiddelenportaal |
Bestelomgeving leermiddelen | Leveringsorders | Leveringsorder | Leermiddelenportaal |
| 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:
De Aanspraakmanager dient toestemming te hebben voor de gegevensdienst:
Onderwijsadministratie voor de levervarianten School, Opleiding, Vak, Groep, Onderwijsdeelnemers en Onderwijsmedewerkers.
Onderwijsaanbod voor de levervarianten Opleiding en Vak.
De Bestelomgeving leermiddelen dient toestemming te hebben voor de gegevensdienst:
Onderwijsadministratie voor de levervarianten Onderwijsdeelnemers en Onderwijsmedewerkers.
Onderwijsaanbod voor de levervarianten Opleiding en Vak.
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:
...
...
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.