OSO:2017/Initiëren Terugkoppeling: verschil tussen versies

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
k (Basis scenario)
k
 
(11 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 3: Regel 3:
 
! style="text-align:left;"| Goal(s)
 
! style="text-align:left;"| Goal(s)
 
|-
 
|-
  +
| Bronsysteem
| Doelsysteem
 
| Melden dat Doelsysteem Terugkoppeling aan Bronsysteem wil versturen en adres van Aanleverpunt ontvangen.
+
| Melden dat Bronsysteem Terugkoppeling aan Doelsysteem wil versturen en adres van Aanleverpunt ontvangen.
 
|-
 
|-
 
| Traffic Center
 
| Traffic Center
Regel 10: Regel 10:
 
|}
 
|}
   
'''NB:''' Bij deze beschrijving wordt Doelsysteem gebruikt als:
+
'''NB:''' Bij deze beschrijving wordt Bronsysteem gebruikt als het SWV- of RP-systeem dat een Terugkoppeling wil versturen.
* Doelsysteem: Het SWV/RP systeem dat (voorafgaand aan deze uitwisseling) een Dossier heeft ontvangen
+
* Bronsysteem: Het SWV/RP systeem dat (voorafgaand aan deze uitwisseling) een Dossier heeft ontvangen
Dit betekent dat de richting van de Dossier uitwisseling wordt aangehouden en wordt afgeweken(!) van de richting van de Terugkoppeling.
+
Dit betekent dat de richting van de Terugkoppeling wordt aangehouden en wordt afgeweken(!) van de richting van de Dossier uitwisseling .
   
 
==Preconditie==
 
==Preconditie==
*Doelsysteem is aangesloten op OSO keten
+
*Bronsysteem is aangesloten op OSO keten
*Doelsysteem heeft Koppelsleutel ontvangen via Notificatie
+
*Bronsysteem heeft Koppelsleutel ontvangen via Notificatie
*Doelsysteem heeft Dossier opgevraagd bij Bronsysteem met behulp van KoppelSleutel
+
*Bronsysteem heeft Dossier opgevraagd bij Doelsysteem met behulp van KoppelSleutel
   
 
==Postconditie==
 
==Postconditie==
 
*Traffic Center heeft Terugkoppeling Melding geregistreerd
 
*Traffic Center heeft Terugkoppeling Melding geregistreerd
*Doelsysteem heeft correcte url van Bronsysteem ontvangen
+
*Bronsysteem heeft correcte url van Doelsysteem ontvangen
   
 
==Basis scenario==
 
==Basis scenario==
# Doelsysteem verstuurt Terugkoppeling Melding naar Traffic Center
+
# Bronsysteem verstuurt Terugkoppeling Melding naar Traffic Center
# '''IF''' DoelAanleverpunt is actief AND DoelAanleverpunt heeft 'doel' ingesteld op 'PaO'
+
# '''IF''' DoelAanleverpunt is actief AND DoelAanleverpunt heeft 'doel' ingesteld op 'OV'
 
## '''IF''' KoppelSleutel valide is<sup>*</sup>
 
## '''IF''' KoppelSleutel valide is<sup>*</sup>
 
### Traffic Center registreert de Notificatie Melding
 
### Traffic Center registreert de Notificatie Melding
### Traffic Center geeft url van het Bronaanleverpunt terug
+
### Traffic Center geeft url van het Doelaanleverpunt terug
 
## '''ELSE'''
 
## '''ELSE'''
 
### Traffic Center geeft foutmelding
 
### Traffic Center geeft foutmelding
Regel 47: Regel 47:
 
| <url van AP>
 
| <url van AP>
 
| TC geeft url van (bron)AP (LAS) terug aan Doelsysteem (SWV/RP).
 
| TC geeft url van (bron)AP (LAS) terug aan Doelsysteem (SWV/RP).
| Doelsysteem (SWV/RP) kan nu Terugkoppeling versturen naar Bronsysteem (LAS).
+
| Bronsysteem (SWV/RP) kan nu Terugkoppeling versturen naar Bronsysteem (LAS).
 
| Zie opmerking boven over gebruik doel- en bron- systeem.
 
| Zie opmerking boven over gebruik doel- en bron- systeem.
  +
 
|-
 
|-
  +
| AanvragerNietBekend
| OnbekendeKoppelsleutel
 
  +
| Het bronsysteem (aanleverpunt dat de notificatie meldt) is niet bekend bij het Traffic Center. De aanvrager is niet gerechtigd om de overstapservice te gebruiken.
| De Koppelsleutel of de complete combinatie BronAP--KoppelSleutel-DoelAP komt niet bekend bij het TC.
 
  +
| In het Traffic Center register is de combinatie van bronBrin en bronAanleverpuntIndex niet aanwezig.
  +
| De aanvrager is niet gerechtigd om de overstapservice te gebruiken. Neem contact op met je leverancier.
  +
|-
  +
| AanvragerAanleverpuntNietBekend
  +
| Het bronAanleverpuntIndex is niet geregistreerd voor deze aanvrager (bronBrin).
 
|
 
|
  +
| Het bron aanleverpunt is niet bekend in het OSO systeem, hierdoor kan geen notificatie melding worden aangevraagd.
| Er heeft zich een interne fout voorgedaan tijdens de SWV aanvraag. Neem contact op met je software leverancier.
 
 
|-
 
|-
  +
| AanvragerNietBeschikbaar
 
  +
| De aanvrager (bronBrin) is niet gerechtigd om de overstapservice te gebruiken.
|OngeautoriseerdAanleverpunt
 
|Doelsysteem (aanvragend AP) is in het Register geregistreerd met andere Leverancier.
 
 
|
 
|
|Er heeft zich een interne fout voorgedaan tijdens de SWV aanvraag. Neem contact op met je software leverancier.
+
| Je school is niet aangesloten op OSO. Neem contact op met de servicedesk van OSO.
 
|-
 
|-
  +
| OngeautoriseerdAanleverpunt
  +
| Het OIN van het certificaat komt niet overeen met die van de geregistreerde leverancier. Het bronsysteem (aanleverpunt dat Notificatie meldt) is in het Traffic Center register geregistreerd door een andere leverancier.
  +
| Het aanleverpunt (bronBrin/bronAanleverpuntIndex) is bekend bij OSO, maar het aanleverpunt staat geregistreerd bij een andere leverancier.
  +
| Interne fout bij OSO systeem. Neem contact op met de servicedesk van OSO.
   
  +
|-
| AanvragerNietBekend
 
  +
| VerstrekkerNietBekend
| De Doelschool (BRIN) is niet bekend bij het Traffic Center
 
  +
| De verstrekker (het doelsysteem waar de notificatie naartoe verstuurd moet worden) is niet bekend bij het Traffic Center.
 
|
 
|
| Er heeft zich een interne fout voorgedaan tijdens de SWV aanvraag. Neem contact op met je software leverancier.
+
| Het aanleverpunt van de school waarmee je wilt uitwisselen, is nog niet bekend bij OSO. Neem contact op met de betreffende school.
 
|-
 
|-
  +
| VerstrekkerAanleverpuntNietBekend
  +
| Het meegegeven aanleverpunt is niet geregistreerd voor deze verstrekker. Het opgegeven Aanleverpunt (DoelBRIN/APindex) van het Doelsysteem is niet bekend.
  +
| Het opgegeven Aanleverpunt van het Doelsysteem is (nog) niet opgenomen in het Register.
  +
|Het aanleverpunt van de school waarmee je wilt uitwisselen, is nog niet bekend bij OSO. Neem contact op met de betreffende school.
  +
|-
  +
| VerstrekkerNietBeschikbaar
  +
| De verstrekker is niet gerechtigd om de overstapservice te gebruiken. Het opgegeven Aanleverpunt van het Doelsysteem is (nog) niet gerechtigd om de overstapservice te gebruiken.
  +
| De Doelschool is bekend in het Register, maar het opgegeven Aanleverpunt is (nog) niet actief. Dit kan bijvoorbeeld veroorzaakt worden doordat de URL van dit Aanleverpunt niet (goed) is geregistreerd
  +
| De school waarmee je wilt uitwisselen, heeft geen actieve aanleverpunten bij OSO. Neem contact op met de betreffende school.
   
| AanvragerAanleverpuntNietBekend
 
| Doelaanleverpunt (BRIN + APindex) is niet bekend bij het Traffic Center
 
|
 
| Er heeft zich een interne fout voorgedaan tijdens de SWV aanvraag. Neem contact op met je software leverancier.
 
 
|-
 
|-
  +
| OnbekendeKoppelsleutel
 
  +
| De combinatie van KoppelSleutel-BronAP--KoppelSleutel-DoelAP is niet bekend bij het TC.
| AanvragerNietBeschikbaar
 
  +
| De KoppelSleutel geldt voor een specifieke Bronaanleverpunt-Doelaanleverpunt combinatie. Deze is niet gevonden in het TC register.
| Bronsysteem (aanvragend AP) is (nog) niet gerechtigd om gebruik te maken van de overstapservice
 
|
 
 
| Er heeft zich een interne fout voorgedaan tijdens de SWV aanvraag. Neem contact op met je software leverancier.
 
| Er heeft zich een interne fout voorgedaan tijdens de SWV aanvraag. Neem contact op met je software leverancier.
 
|-
 
|-
   
  +
|<Geen response>
  +
| Technische fout
  +
| Het meldende Bronsysteem staakt de verdere Notificatie en geeft de eindgebruiker hierover een foutmelding.
  +
| Er kan geen verbinding gemaakt worden met het OSO systeem. Probeer het later nog eens.
 
|}
 
|}
   
Regel 100: Regel 118:
 
|-
 
|-
 
| doelBrin
 
| doelBrin
| Dit is het brinnummer van het Bronsysteem dat de Terugkoppeling aanmeldt. Het TC controleert of het Bronsysteem bekend en actief is in het deelnemersregister.
+
| Dit is het brinnummer van het Doelsysteem dat de Terugkoppeling aanmeldt. Het TC controleert of het Doelsysteem bekend en actief is in het deelnemersregister.
  +
| Zie opmerking boven over gebruik doel- en bron- systeem.
|
 
   
 
|-
 
|-
 
| doelAanleverpuntIndex
 
| doelAanleverpuntIndex
| Dit is de index van het Aanleverpunt van het Bronsysteem dat de Terugkoppeling aanmeldt.
+
| Dit is de index van het Aanleverpunt van het Doelsysteem dat de Terugkoppeling aanmeldt.
  +
| Zie opmerking boven over gebruik doel- en bron- systeem.
|
 
   
 
|-
 
|-
Regel 116: Regel 134:
   
 
[[Categorie:Overstapservice Onderwijs]]
 
[[Categorie:Overstapservice Onderwijs]]
[[Category:Book OSO|671]]
 

Huidige versie van 11 dec 2017 om 11:30

Actor(s) Goal(s)
Bronsysteem Melden dat Bronsysteem Terugkoppeling aan Doelsysteem wil versturen en adres van Aanleverpunt ontvangen.
Traffic Center Controleren of Terugkoppeling verstuurd kan worden en zorgen dat Terugkoppeling bij juist Aanleverpunt wordt afgeleverd.

NB: Bij deze beschrijving wordt Bronsysteem gebruikt als het SWV- of RP-systeem dat een Terugkoppeling wil versturen.

  • Bronsysteem: Het SWV/RP systeem dat (voorafgaand aan deze uitwisseling) een Dossier heeft ontvangen

Dit betekent dat de richting van de Terugkoppeling wordt aangehouden en wordt afgeweken(!) van de richting van de Dossier uitwisseling .

Preconditie

  • Bronsysteem is aangesloten op OSO keten
  • Bronsysteem heeft Koppelsleutel ontvangen via Notificatie
  • Bronsysteem heeft Dossier opgevraagd bij Doelsysteem met behulp van KoppelSleutel

Postconditie

  • Traffic Center heeft Terugkoppeling Melding geregistreerd
  • Bronsysteem heeft correcte url van Doelsysteem ontvangen

Basis scenario

  1. Bronsysteem verstuurt Terugkoppeling Melding naar Traffic Center
  2. IF DoelAanleverpunt is actief AND DoelAanleverpunt heeft 'doel' ingesteld op 'OV'
    1. IF KoppelSleutel valide is*
      1. Traffic Center registreert de Notificatie Melding
      2. Traffic Center geeft url van het Doelaanleverpunt terug
    2. ELSE
      1. Traffic Center geeft foutmelding
  3. ELSE
    1. Traffic Center geeft foutmelding
  4. ENDIF

*Valide Koppelsleutel betekent dat de combinatie BronAP--KoppelSleutel--DoelAP is geregistreerd in het TC.

Uitzonderingen en meldingen

Hieronder worden alternatieve scenario's en de bijbehorende melding opgesomd:
.

Resultaat Omschrijving Toelichting Melding aan Eindgebruiker
<url van AP> TC geeft url van (bron)AP (LAS) terug aan Doelsysteem (SWV/RP). Bronsysteem (SWV/RP) kan nu Terugkoppeling versturen naar Bronsysteem (LAS). Zie opmerking boven over gebruik doel- en bron- systeem.
AanvragerNietBekend Het bronsysteem (aanleverpunt dat de notificatie meldt) is niet bekend bij het Traffic Center. De aanvrager is niet gerechtigd om de overstapservice te gebruiken. In het Traffic Center register is de combinatie van bronBrin en bronAanleverpuntIndex niet aanwezig. De aanvrager is niet gerechtigd om de overstapservice te gebruiken. Neem contact op met je leverancier.
AanvragerAanleverpuntNietBekend Het bronAanleverpuntIndex is niet geregistreerd voor deze aanvrager (bronBrin). Het bron aanleverpunt is niet bekend in het OSO systeem, hierdoor kan geen notificatie melding worden aangevraagd.
AanvragerNietBeschikbaar De aanvrager (bronBrin) is niet gerechtigd om de overstapservice te gebruiken. Je school is niet aangesloten op OSO. Neem contact op met de servicedesk van OSO.
OngeautoriseerdAanleverpunt Het OIN van het certificaat komt niet overeen met die van de geregistreerde leverancier. Het bronsysteem (aanleverpunt dat Notificatie meldt) is in het Traffic Center register geregistreerd door een andere leverancier. Het aanleverpunt (bronBrin/bronAanleverpuntIndex) is bekend bij OSO, maar het aanleverpunt staat geregistreerd bij een andere leverancier. Interne fout bij OSO systeem. Neem contact op met de servicedesk van OSO.
VerstrekkerNietBekend De verstrekker (het doelsysteem waar de notificatie naartoe verstuurd moet worden) is niet bekend bij het Traffic Center. Het aanleverpunt van de school waarmee je wilt uitwisselen, is nog niet bekend bij OSO. Neem contact op met de betreffende school.
VerstrekkerAanleverpuntNietBekend Het meegegeven aanleverpunt is niet geregistreerd voor deze verstrekker. Het opgegeven Aanleverpunt (DoelBRIN/APindex) van het Doelsysteem is niet bekend. Het opgegeven Aanleverpunt van het Doelsysteem is (nog) niet opgenomen in het Register. Het aanleverpunt van de school waarmee je wilt uitwisselen, is nog niet bekend bij OSO. Neem contact op met de betreffende school.
VerstrekkerNietBeschikbaar De verstrekker is niet gerechtigd om de overstapservice te gebruiken. Het opgegeven Aanleverpunt van het Doelsysteem is (nog) niet gerechtigd om de overstapservice te gebruiken. De Doelschool is bekend in het Register, maar het opgegeven Aanleverpunt is (nog) niet actief. Dit kan bijvoorbeeld veroorzaakt worden doordat de URL van dit Aanleverpunt niet (goed) is geregistreerd De school waarmee je wilt uitwisselen, heeft geen actieve aanleverpunten bij OSO. Neem contact op met de betreffende school.
OnbekendeKoppelsleutel De combinatie van KoppelSleutel-BronAP--KoppelSleutel-DoelAP is niet bekend bij het TC. De KoppelSleutel geldt voor een specifieke Bronaanleverpunt-Doelaanleverpunt combinatie. Deze is niet gevonden in het TC register. Er heeft zich een interne fout voorgedaan tijdens de SWV aanvraag. Neem contact op met je software leverancier.
<Geen response> Technische fout Het meldende Bronsysteem staakt de verdere Notificatie en geeft de eindgebruiker hierover een foutmelding. Er kan geen verbinding gemaakt worden met het OSO systeem. Probeer het later nog eens.

Aanroep en antwoord

Element Uitleg Opmerkingen
bronBRIN Dit is het brinnummer van de Bronschool waar de Terugkoppeling aan verstuurd wordt. De Bronschool kan meerdere Aanleverpunten hebben.
bronAanleverpuntIndex Dit is de index van het specifieke Aanleverpunt waar de Terugkoppeling aan verstuurd wordt. Een Terugkoppeling wordt altijd naar één specifiek Aanleverpunt verstuurd.
doelBrin Dit is het brinnummer van het Doelsysteem dat de Terugkoppeling aanmeldt. Het TC controleert of het Doelsysteem bekend en actief is in het deelnemersregister. Zie opmerking boven over gebruik doel- en bron- systeem.
doelAanleverpuntIndex Dit is de index van het Aanleverpunt van het Doelsysteem dat de Terugkoppeling aanmeldt. Zie opmerking boven over gebruik doel- en bron- systeem.
koppelsleutel De koppelsleutel zoals ontvangen in de Notificatie vanuit het Doelsysteem De koppelsleutel is verplicht voor dit type uitwisseling