OSO:2018/Notificeren van Doelsystemen

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken

Overstapservice Onderwijs-symbol.png Overstapservice Onderwijs: 2018/Notificeren van Doelsystemen

Context

Na het klaarzetten van een Dossier verstuurt een Bronsysteem een Notificatie naar een Bronsysteem* dat eerder een DocumentRequest voor het specifieke Dossier heeft verstuurd. Voorafgaand aan het versturen van de Notificatie stuurt het Bronsysteem eerst een Notificatiemelding aan het Traffic Center. Het Traffic Center registreert de Notificatiemelding en geeft de actuele url van het Aanleverpunt van het Doelsysteem terug aan het Bronsysteem.

* Het klaarzetten van het Dossier 'triggert' de Notificatie maar staat verder 'los' van deze interactie. Ongeacht of de Notificatie slaagt of niet wordt het 'klaarzetten' uitgevoerd.

Juridische randvoorwaarden

  • De Bronschool is verantwoordelijk voor het verzenden van de Notificatie; daarom mag deze alleen verzonden worden als aan de volgende voorwaarden is voldaan:
  • Een Notificatie mag alléén verzonden worden als het Doelsysteem dit dossier eerder heeft aangevraagd.
  • Notificatie MOET naar het specifieke Doelsysteem dat aanvraag heeft gedaan (niet naar alle Aanleverpunten bij een School)
  • Zenden van notificatie moet een ‘bewuste gebruikershandeling’ in het Bronsysteem zijn. Het zenden mag een onderdeel zijn van het klaarzetten van het dossier. In het laatste geval betekent dit, dat als er in het Bronsyteem met een checkbox voor notificatie wordt gewerkt, het veld niet vooraf al 'aangevinkt' mag zijn. De gebruiker moet zelf het vinkje zetten. Ook moet een duidelijke uitleg worden gegeven welk gevolg het zetten van het vinkje heeft. Dit kan bijvoorbeeld door een vraagteken erachter met een 'mouse over tekst' zoals: "door dit vinkje aan te zetten zet u dit overstapdossier klaar voor de uitwisseling en wordt een notificatie verstuurd aan het Doelsysteem."
  • Het opvragen van een dossier op basis van een Notificatie moet (ook) een ‘bewuste gebruikershandeling’ in het Doelsysteem zijn.

Overige randvoorwaarden

  • Notificatie is verplicht voor alle typen uitwisseling, met uitzondering voor de binnenBRIN uitwisseling. Bij binnenBRIN uitwisselingen is het Notificeren optioneel.
  • De termijn die in OSO ’17 gehanteerd gaat worden voor de geldigheid van documentRequests is 6 (kalender)maanden. Verzoeken tot Dossier die ouder zijn dan zes maanden mogen niet leiden tot Notificaties.
    • Bronsystemen moeten alle documentRequests met een aanvraagDatum tot drie maanden geleden bewaren voor notificatie doeleinden.
    • Bronsystemen mogen geen notificatie versturen op basis van een documentRequest met een aanvraagDatum ouder dan drie maanden.

Context

Als een Dossier gereed wordt gezet in een Bronsysteem controleert het Bronsysteem of er aanvagen zijn geweest voor dit Dossier van Doelsystemen die niet zijn uitgeleverd. Als dit het geval is en de Eindgebruiker van het Bronsysteem toestemming geeft, verstuurt het Bronsysteem een Notificatie naar deze Doelsyste(e)men.

Onderliggende use cases


Notificatie mechanisme

OSO Notificatie aanroepen.png

In de figuur worden de stappen en berichten weergegeven die bij een succesvolle Notificatie worden doorlopen. Deze worden hieronder beschreven:

  • Een Doelsysteem stuurt een DocumentRequest. Wanneer het Bronsysteem het gevraagde dossier niet kan leveren, wordt de relevante informatie uit het documentRequest opgeslagen door het Bronsysteem.
    • De aanvraagDatum bij het Dossier wordt door het Bronsysteem ingesteld met het tijdstip waarop het (laatste) documentRequest voor dit Dossier werd ontvangen.
    • Als er al een documentRequest voor het desbetreffende dossier is ontvangen, dan wordt de aanvraagDatum bijgewerkt met de datum uit het laatste documentRequest. Ook wordt het sessieID vervangen met het sessieID uit dit laatste Documentrequest.
    • Het sessieID is het sessieID zoals het Doelsysteem die meegeeft in het documentRequest. Dit sessieID wordt door het Bronsysteem doorgegeven aan het TC bij het melden van de Notificatie en heeft geen ander doel dan bij het loggen van het verkeer door het TC.
  • Op het moment dat een bronSysteem een dossier klaarzet voor een doelschool (BRIN(4)) controleert het bronSysteem of er voor dit dossier documentRequests afkomstig zijn geweest van deze doelschool.
    • Meerdere aanleverpunten van een School (BRIN(4)) kunnen documentRequests hebben gestuurd. Voor één dossier wordt maximaal één notificatie naar hetzelfde Aanleverpunt gestuurd.
    • Omdat er documentRequests kunnen zijn van meerdere aanleverpunten onder één BRIN, kan het klaar zetten van een dossier leiden tot meerdere Notificaties.
    • Het Bronsysteem stuurt een Notificatie als de verlooptermijn van het documentRequest niet is verstreken
  • Het Bronsysteem vraagt haar eindgebruiker voor een bevestiging voor het versturen van een Notificatie.
  • Na bevestiging van de eindgebruiker meldt het Bronsysteem de Notificatie aan het Traffic Center.
    • Het Traffic Center controleert of het Aanleverpunt valide is
    • Het Traffic Center geeft de url van het valide Aanleverpunt terug
  • Het bronsysteem verstuurt (na een positieve respons van het TC op het NotificatieMelding) een Notificatie naar het doelsysteem van het aanleverpunt. Het doelsysteem bevestigt de ontvangst.
    • Het bronsysteem doet één poging per notificatie om deze te versturen na het doelsysteem; er volgen geen nieuwe pogingen wanneer de aflevering faalt.
    • Het bronsysteem toont haar eindgebruiker informatie over het wel of niet succesvol versturen van de notificatie.
  • Het doelsysteem toont de informatie uit de notificatie aan de eindgebruiker. De eindgebruiker kan een dossier hierna opvragen (waarna een normale uitvraag volgt.)