OSO:2022/Specifieke Eisen: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
(Nieuwe pagina aangemaakt met '==Functionele eisen per type systeem== Hieronder wordt per 'rol' in de uitwisseling de functionaliteit van systemen beschreven. Hierbij wordt eerst een 'hoog nivea...')
 
k
 
(Een tussenliggende versie door dezelfde gebruiker niet weergegeven)
Regel 3: Regel 3:
 
Hieronder wordt per 'rol' in de uitwisseling de functionaliteit van systemen beschreven. Hierbij wordt eerst een 'hoog niveau' use case/story gegeven en vervolgens wordt deze per stap verder uitgewerkt in pseudocode. De volgende rollen/categorieën worden onderscheiden:
  
Hieronder wordt per 'rol' in de uitwisseling de functionaliteit van systemen beschreven. Hierbij wordt eerst een 'hoog niveau' use case/story gegeven en vervolgens wordt deze per stap verder uitgewerkt in pseudocode. De volgende rollen/categorieën worden onderscheiden:
 
* Functionaliteit voor alle typen systemen: Functionaliteit die ongeacht de rol door een systeem moet worden ingebouwd.
  
* Functionaliteit voor alle typen systemen: Functionaliteit die ongeacht de rol door een systeem moet worden ingebouwd.
−
* Functionaliteit voor Bronsystemen (exclusief ondersteuning SWV PaO): Functionaltiteit voor systemen die Dossiers leveren in POPO/POVO/VOVO en/of binnenBRIN overdrachten.
 +
* Functionaliteit voor Bronsystemen (exclusief ondersteuning SWV): Functionaltiteit voor systemen die Dossiers leveren in POPO/POVO/VOVO en/of binnenBRIN overdrachten.
−
* Use cases voor Doelsystemen (exclusief ondersteuning SWV PaO): Functionaltiteit voor systemen die Dossiers ophalen in POPO/POVO/VOVO en/of binnenBRIN overdrachten.
 +
* Use cases voor Doelsystemen (exclusief ondersteuning SWV): Functionaltiteit voor systemen die Dossiers ophalen in POPO/POVO/VOVO en/of binnenBRIN overdrachten.
−
* Aanvullende Use Cases voor LASsen PaO uitwisseling: Functionaltiteit voor systemen die Dossiers leveren in overdrachten in het kader van Passend Onderwijs (PaO).
 +
* Aanvullende Use Cases voor LASsen SWV uitwisseling: Functionaltiteit voor systemen die Dossiers leveren in overdrachten in het kader van Passend Onderwijs (PaO/SWV).
−
* Aanvullende Use Cases voor SWV's en RP's PaO uitwisseling: unctionaltiteit voor systemen die Dossiers ophalen in overdrachten in het kader van Passend Onderwijs (PaO).
 +
* Aanvullende Use Cases voor SWV's en RP's SWV uitwisseling: unctionaltiteit voor systemen die Dossiers ophalen in overdrachten in het kader van Passend Onderwijs (PaO/SWV).
   
 
==Foutmeldingen/terugkoppeling in OSO==
  
==Foutmeldingen/terugkoppeling in OSO==
   
−
Binnen OSO zijn 'referentie' terugkoppelingen en foutmeldingen naar eindgebruikers vastgesteld. Leveranciers kunnen deze toepassen, maar dit is niet verplicht (eigen varianten zijn toegestaan). Deze meldingen zijn per interactie in de wiki opgenomen; de complete lijst is [[:Bestand:Overzicht_foutmeldingen_OSO18.xlsx|hier]] te vinden.
 +
Binnen OSO zijn 'referentie' terugkoppelingen en foutmeldingen naar eindgebruikers vastgesteld. Leveranciers kunnen deze toepassen, maar dit is niet verplicht (eigen varianten zijn toegestaan). Deze meldingen zijn per interactie in de wiki opgenomen; de complete lijst is [[:Bestand:Overzicht_foutmeldingen_OSO22.xlsx|hier]] te vinden.
   
 
==Functionaliteit voor alle typen systemen==
  
==Functionaliteit voor alle typen systemen==
Regel 22: Regel 22:
 
|-
  
|-
 
| Aanroep voor het testen van de beschikbaarheid van het Traffic Center
  
| Aanroep voor het testen van de beschikbaarheid van het Traffic Center
−
| [[OSO:2018/Ping_Traffic_Center|Pingen van Traffic Center]]
 +
| [[OSO:2022/Ping_Traffic_Center|Pingen van Traffic Center]]
 
| Verplicht
  
| Verplicht
 
|
  
|
Regel 28: Regel 28:
 
|-
  
|-
 
| rowspan="3"|Registreren vanuit een Systeem van een Aanleverpunt bij het TC
  
| rowspan="3"|Registreren vanuit een Systeem van een Aanleverpunt bij het TC
−
| [[OSO:2018/Registreren_Aanleverpunt|Registreren van een Aanleverpunt]]
 +
| [[OSO:2022/Registreren_Aanleverpunt|Registreren van een Aanleverpunt]]
 
| Verplicht
  
| Verplicht
  +
| Aanleverpunten (endpoints) worden vanaf OSO'22 in OSR geregistreerd.
−
|Bij het registreren van een Aanleverpunt kan met het controleren van de APsleutel de invoer van de eindgebruiker gevalideerd worden.
 
   
 
|-
  
|-
−
| [[OSO:2018/Controleren_Aanleverpunt|Controleren van de AanleverpuntSleutel]]
 +
| [[OSO:2022/Controleren_Aanleverpunt|Controleren van de AanleverpuntSleutel]]
  +
|
−
| Optioneel
  
  +
| Aanleverpuntsleutels bestaan niet meer vanaf OSO'22.
−
| Valideren van de invoerde waarden in een Systeem bij een Aanleverpunt op basis van de Aanleverpuntsleutel.
  
   
 
|-
  
|-
−
| [[OSO:2018/Opvragen Aanleverpunten|Opvragen van Aanleverpunten]]
 +
| [[OSO:2022/Opvragen Aanleverpunten|Opvragen van Aanleverpunten]]
 
| Optioneel
  
| Optioneel
 
| Door te filteren op APsleutel kan met deze aanroep informatie over bewerkt Aanleverpunt worden opgehaald.
  
| Door te filteren op APsleutel kan met deze aanroep informatie over bewerkt Aanleverpunt worden opgehaald.
Regel 44: Regel 44:
 
|-
  
|-
 
| Aanroep voor het opvragen van informatie over AanleverPunten bij het Traffic Center
  
| Aanroep voor het opvragen van informatie over AanleverPunten bij het Traffic Center
−
| [[OSO:2018/Opvragen Aanleverpunten|Opvragen van Aanleverpunten]]
 +
| [[OSO:2022/Opvragen Aanleverpunten|Opvragen van Aanleverpunten]]
 
| Optioneel
  
| Optioneel
 
|
 
|
Regel 50: Regel 50:
 
|}
  
|}
   
−
==Functionaliteit voor Bronsystemen (exclusief ondersteuning SWV PaO)==
 +
==Functionaliteit voor Bronsystemen (exclusief ondersteuning SWV)==
   
 
{|class="wikitable"
  
{|class="wikitable"
Regel 60: Regel 60:
 
|-
  
|-
 
|rowspan="4"|Samenstellen en klaarzetten Dossier
  
|rowspan="4"|Samenstellen en klaarzetten Dossier
−
| [[OSO:2018/Uitvoeren_Inzage|Laten inzien Dossier]]
 +
| [[OSO:2022/Uitvoeren_Inzage|Laten inzien Dossier]]
−
| [[OSO:2018/Registreren_Inzage|Registreren van inzage Dossier]]
 +
| [[OSO:2022/Registreren_Inzage|Registreren van inzage Dossier]]
 
| Vindt plaats 'binnen' systeem, geen directe interactie met OSO
  
| Vindt plaats 'binnen' systeem, geen directe interactie met OSO
   
 
|-
  
|-
−
| rowspan="3"|[[OSO:2018/Samenstellen Dossier|Samenstellen van het Dossier]]
 +
| rowspan="3"|[[OSO:2022/Samenstellen Dossier|Samenstellen van het Dossier]]
−
| [[OSO:2018/Samenstellen Inhoud Dossier|Selectief samenstellen Dossier]]
 +
| [[OSO:2022/Samenstellen Inhoud Dossier|Selectief samenstellen Dossier]]
 
|
  
|
   
 
|-
  
|-
−
| [[OSO:2018/Valideren Dossier|Dossier controleren tegen OSO standaard]]
 +
| [[OSO:2022/Valideren Dossier|Dossier controleren tegen OSO standaard]]
 
| Voorafgaand aan versturen controleert Bronsysteem Dossier tegen Edustandaard Gegevensset OSO
  
| Voorafgaand aan versturen controleert Bronsysteem Dossier tegen Edustandaard Gegevensset OSO
   
 
|-
 
|-
−
| [[OSO:2018/Klaarzetten Dossier|Dossier klaarzetten voor Scholen]]
 +
| [[OSO:2022/Klaarzetten Dossier|Dossier klaarzetten voor Scholen]]
 
| Voordat Doelsysteem Dossier kan opvragen moet in Bronsysteem aangegeven worden dat Dossier gereed is en beschikbaar voor specifieke scho(o)l(en)
  
| Voordat Doelsysteem Dossier kan opvragen moet in Bronsysteem aangegeven worden dat Dossier gereed is en beschikbaar voor specifieke scho(o)l(en)
   
 
|-
  
|-
 
|rowspan="3"|Verwerken Verzoeken en Notificaties
  
|rowspan="3"|Verwerken Verzoeken en Notificaties
−
| [[OSO:2018/Verwerken_openstaande_verzoeken|Verwerken openstaande verzoeken]]
 +
| [[OSO:2022/Verwerken_openstaande_verzoeken|Verwerken openstaande verzoeken]]
−
| [[OSO:2018/Tonen_aanvragen|Tonen ontvangen verzoeken]]
 +
| [[OSO:2022/Tonen_aanvragen|Tonen ontvangen verzoeken]]
 
| Vindt plaats 'binnen' systeem, geen directe interactie met OSO
  
| Vindt plaats 'binnen' systeem, geen directe interactie met OSO
   
 
|-
  
|-
−
|rowspan="2"|[[OSO:2018/Notificeren van Doelsystemen|Versturen Notificatie]]
 +
|rowspan="2"|[[OSO:2022/Notificeren van Doelsystemen|Versturen Notificatie]]
−
| [[OSO:2018/Initiëren_notificatie|Versturen NotificatieMelding naar TC]]
 +
| [[OSO:2022/Initiëren_notificatie|Versturen NotificatieMelding naar TC]]
 
| Na klaarzetten Dossier voorafgaand aan verzenden van Notificatie
  
| Na klaarzetten Dossier voorafgaand aan verzenden van Notificatie
   
 
|-
  
|-
−
| [[OSO:2018/Versturen_Notificatie|Versturen Notificatie naar Doelsysteem]]
 +
| [[OSO:2022/Versturen_Notificatie|Versturen Notificatie naar Doelsysteem]]
 
| Melden aan Doelsysteem dat Dossier beschikbaar is gekomen
  
| Melden aan Doelsysteem dat Dossier beschikbaar is gekomen
   
Regel 95: Regel 95:
 
| rowspan="2"|Afhandelen verzoek levering Dossier
  
| rowspan="2"|Afhandelen verzoek levering Dossier
 
| rowspan="2"|
  
| rowspan="2"|
−
| [[OSO:2018/Controleren_Sessie|Controleren van een Sessie]]
 +
| [[OSO:2022/Controleren_Sessie|Controleren van een Sessie]]
 
| Na ontvangst van verzoek tot levering van Dossier
  
| Na ontvangst van verzoek tot levering van Dossier
   
 
|-
 
|-
−
| [[OSO:2018/Opvragen_dossier|Doorlopen Dossier verzoek]]
 +
| [[OSO:2022/Opvragen_dossier|Doorlopen Dossier verzoek]]
 
| Als antwoordende partij bij Opvragen Dossier
  
| Als antwoordende partij bij Opvragen Dossier
   
 
|}
  
|}
   
−
==Use cases voor Doelsystemen (exclusief ondersteuning SWV PaO)==
 +
==Use cases voor Doelsystemen (exclusief ondersteuning SWV)==
 
{|class="wikitable"
  
{|class="wikitable"
 
! style="text-align:left;"| Algemeen
  
! style="text-align:left;"| Algemeen
Regel 113: Regel 113:
 
|-
 
|-
 
| Verwerken Verzoeken en Notificaties
  
| Verwerken Verzoeken en Notificaties
−
| [[OSO:2018/Versturen_Notificatie|Ontvangen Notificatie naar Doelsysteem]]
 +
| [[OSO:2022/Versturen_Notificatie|Ontvangen Notificatie naar Doelsysteem]]
−
| [[OSO:2018/Tonen_Notificaties|Tonen ontvangen Notficaties]]
 +
| [[OSO:2022/Tonen_Notificaties|Tonen ontvangen Notficaties]]
 
| Reageren op binnenkomende Notificaties
  
| Reageren op binnenkomende Notificaties
   
 
|-
  
|-
 
| rowspan="5"|Uitvoeren opvraag Sessie
  
| rowspan="5"|Uitvoeren opvraag Sessie
−
| rowspan="5"|[[OSO:2018/Doorlopen_sessie|Doorlopen opvraag Sessie]]
 +
| rowspan="5"|[[OSO:2022/Doorlopen_sessie|Doorlopen opvraag Sessie]]
−
| [[OSO:2018/Initiëren_sessie|Initiëren van een Sessie]]
 +
| [[OSO:2022/Initiëren_sessie|Initiëren van een Sessie]]
 
| Geïnitieerd door eindgebruiker of ontvangst van Notificatie
  
| Geïnitieerd door eindgebruiker of ontvangst van Notificatie
   
 
|-
  
|-
−
| [[OSO:2018/Opvragen_dossier|Opvragen van een Dossier]]
 +
| [[OSO:2022/Opvragen_dossier|Opvragen van een Dossier]]
 
| Initiator/vragende partij bij Opvragen Dossier
  
| Initiator/vragende partij bij Opvragen Dossier
   
 
|-
  
|-
−
| [[OSO:2018/Controleren_Sessie|''Controleren van een Sessie'']]
 +
| [[OSO:2022/Controleren_Sessie|''Controleren van een Sessie'']]
 
| ''Functionaliteit voor Bronsysteem(!)''
 
| ''Functionaliteit voor Bronsysteem(!)''
   
 
|-
  
|-
−
| [[OSO:2018/Importeren Dossier|Importeren en tonen van een Dossier]]
 +
| [[OSO:2022/Importeren Dossier|Importeren en tonen van een Dossier]]
 
| Na een geslaagde overdracht
  
| Na een geslaagde overdracht
   
 
|-
 
|-
−
| [[OSO:2018/Afmelden_Sessie|Afmelden van een Sessie]]
 +
| [[OSO:2022/Afmelden_Sessie|Afmelden van een Sessie]]
 
| Na het ontvangen van een Dossier of het aflopen van alle Aanleverpunten
  
| Na het ontvangen van een Dossier of het aflopen van alle Aanleverpunten
   
 
|}
  
|}
   
−
==Aanvullende Use Cases voor LASsen PaO uitwisseling==
 +
==Aanvullende Use Cases voor LASsen SWV uitwisseling==
   
   
−
In onderstaande tabel is met '''vet''' aangegeven welke functionaliteiten voor de rol 'LAS' in een PaO uitwisseling geïmplementeerd moeten worden. [https://www.overstapserviceonderwijs.nl/hoe-werkt-oso/ Op de Overstap Service Onderwijs] en [[OSO:2018/Uitwisselen_PaO_berichten|hier]], [[:Bestand:Aansluiten_Samenwerkingsverbanden_Passend_Onderwijs.20170113.pdf|hier]] en [[:Bestand:Samenvatting_bijeenkomst_OSO_experts_20170213.v2.pdf|hier]] is meer informatie over deze uitwisseling en de rollen daarin te vinden.<br>
 +
In onderstaande tabel is met '''vet''' aangegeven welke functionaliteiten voor de rol 'LAS' in een SWV uitwisseling geïmplementeerd moeten worden. [https://www.overstapserviceonderwijs.nl/hoe-werkt-oso/ Op de Overstap Service Onderwijs] en [[OSO:2022/Uitwisselen_PaO_berichten|hier]], [[:Bestand:Aansluiten_Samenwerkingsverbanden_Passend_Onderwijs.20170113.pdf|hier]] en [[:Bestand:Samenvatting_bijeenkomst_OSO_experts_20170213.v2.pdf|hier]] is meer informatie over deze uitwisseling en de rollen daarin te vinden.<br>
   
 
{|class="wikitable"
  
{|class="wikitable"
Regel 153: Regel 153:
   
 
|-
  
|-
−
| rowspan="4"| [[OSO:2018/Uitwisselen_PaO_berichten|Uitwisseling voor Aanvraag bij SWV PaO]]
 +
| rowspan="4"| [[OSO:2022/Uitwisselen_PaO_berichten|Uitwisseling voor Aanvraag bij SWV]]
−
| rowspan="3"| |[[OSO:2018/Uitwisselen_PaO_berichten#Versturen_Dossier_tbv_Aanvraag|Initiëren Aanvraag vanuit LAS]]
 +
| rowspan="3"| |[[OSO:2022/Uitwisselen_PaO_berichten#Versturen_Dossier_tbv_Aanvraag|Initiëren Aanvraag vanuit LAS]]
−
| '''[[OSO:2018/Selecteren Aanleverpunt|Aanleverpunt selecteren voor Notificatie]]'''
 +
| '''[[OSO:2022/Selecteren Aanleverpunt|Aanleverpunt selecteren voor Notificatie]]'''
 
| Adressering naar SWV
  
| Adressering naar SWV
   
 
|-
  
|-
   
−
| '''[[OSO:2018/Initiëren_notificatie|Versturen NotificatieMelding naar TC]]'''
 +
| '''[[OSO:2022/Initiëren_notificatie|Versturen NotificatieMelding naar TC]]'''
 
| Aanvragen KoppelSleutel bij TC
  
| Aanvragen KoppelSleutel bij TC
   
 
|-
  
|-
−
| '''[[OSO:2018/Versturen_Notificatie|Versturen Notificatie naar Doelsysteem]]'''
 +
| '''[[OSO:2022/Versturen_Notificatie|Versturen Notificatie naar Doelsysteem]]'''
 
| ''Versturen KoppelSleutel naar SWV systeem''
  
| ''Versturen KoppelSleutel naar SWV systeem''
   
 
|-
  
|-
−
| [[OSO:2018/Uitwisselen_PaO_berichten#Versturen_Dossier_tbv_Aanvraag|''Opvragen Dossier met KoppelSleutel'']]
 +
| [[OSO:2022/Uitwisselen_PaO_berichten#Versturen_Dossier_tbv_Aanvraag|''Opvragen Dossier met KoppelSleutel'']]
−
| '''[[OSO:2018/Opvragen_dossier|Verwerken aanvraag van Dossier door SWV systeem]]'''
 +
| '''[[OSO:2022/Opvragen_dossier|Verwerken aanvraag van Dossier door SWV systeem]]'''
 
| ''Geïnitieerd door SWV systeem(!)''
  
| ''Geïnitieerd door SWV systeem(!)''
   
 
|-
 
|-
−
| rowspan="2"|[[OSO:2018/Uitwisselen_PaO_berichten|Terugkoppeling vanuit SWV naar School]]
 +
| rowspan="2"|[[OSO:2022/Uitwisselen_PaO_berichten|Terugkoppeling vanuit SWV naar School]]
−
| [[OSO:2018/Uitwisselen_PaO_berichten#Versturen_Terugkoppeling_over_Aanvraag|''Initiëren terugkoppeling'']]
 +
| [[OSO:2022/Uitwisselen_PaO_berichten#Versturen_Terugkoppeling_over_Aanvraag|''Initiëren terugkoppeling'']]
−
| [[OSO:2018/Initiëren Terugkoppeling|Versturen TerugkoppelingMelding naar TC]]
 +
| [[OSO:2022/Initiëren Terugkoppeling|Versturen TerugkoppelingMelding naar TC]]
 
| ''Functionaliteit voor SWV systeem(!)''
  
| ''Functionaliteit voor SWV systeem(!)''
   
 
|-
  
|-
−
| [[OSO:2018/Uitwisselen_PaO_berichten#Versturen_Terugkoppeling_over_Aanvraag|Ontvangen Terugkoppeling]]
 +
| [[OSO:2022/Uitwisselen_PaO_berichten#Versturen_Terugkoppeling_over_Aanvraag|Ontvangen Terugkoppeling]]
−
| '''[[OSO:2018/Versturen Terugkoppeling|Versturen en ontvangen Terugkoppeling naar Bronsysteem]]'''
 +
| '''[[OSO:2022/Versturen Terugkoppeling|Versturen en ontvangen Terugkoppeling naar Bronsysteem]]'''
 
| Als ontvangende partij
  
| Als ontvangende partij
   
 
|}
  
|}
   
−
==Aanvullende Use Cases voor SWV's en RP's PaO uitwisseling==
 +
==Aanvullende Use Cases voor SWV's en RP's SWV uitwisseling==
   
−
In onderstaande tabel is met '''vet''' aangegeven welke functionaliteiten voor de rol 'LAS' in een PaO uitwisseling geïmplementeerd moeten worden. [https://www.overstapserviceonderwijs.nl/hoe-werkt-oso/ Op de Overstap Service Onderwijs] en [[OSO:2018/Uitwisselen_PaO_berichten|hier]], [[:Bestand:Aansluiten_Samenwerkingsverbanden_Passend_Onderwijs.20170113.pdf|hier]] en [[:Bestand:Samenvatting_bijeenkomst_OSO_experts_20170213.v2.pdf|hier]] is meer informatie over deze uitwisseling en de rollen daarin te vinden.<br>
 +
In onderstaande tabel is met '''vet''' aangegeven welke functionaliteiten voor de rol 'LAS' in een SWV uitwisseling geïmplementeerd moeten worden. [https://www.overstapserviceonderwijs.nl/hoe-werkt-oso/ Op de Overstap Service Onderwijs] en [[OSO:2022/Uitwisselen_PaO_berichten|hier]], [[:Bestand:Aansluiten_Samenwerkingsverbanden_Passend_Onderwijs.20170113.pdf|hier]] en [[:Bestand:Samenvatting_bijeenkomst_OSO_experts_20170213.v2.pdf|hier]] is meer informatie over deze uitwisseling en de rollen daarin te vinden.<br>
   
 
{|class="wikitable"
  
{|class="wikitable"
Regel 196: Regel 196:
   
 
|-
  
|-
−
| rowspan="2"|[[OSO:2018/Uitwisselen_PaO_berichten|Uitwisseling voor Aanvraag bij SWV PaO]]
 +
| rowspan="2"|[[OSO:2022/Uitwisselen_PaO_berichten|Uitwisseling voor Aanvraag bij SWV]]
−
| [[OSO:2018/Uitwisselen_PaO_berichten#Versturen_Dossier_tbv_Aanvraag|Initiëren Aanvraag vanuit LAS]]
 +
| [[OSO:2022/Uitwisselen_PaO_berichten#Versturen_Dossier_tbv_Aanvraag|Initiëren Aanvraag vanuit LAS]]
−
| '''[[OSO:2018/Versturen_Notificatie|Ontvangen Notificatie door Doelsysteem]]'''
 +
| '''[[OSO:2022/Versturen_Notificatie|Ontvangen Notificatie door Doelsysteem]]'''
 
| Afhandelen ontvangst Notificatie met KoppelSleutel
  
| Afhandelen ontvangst Notificatie met KoppelSleutel
   
   
 
|-
  
|-
−
| [[OSO:2018/Uitwisselen_PaO_berichten#Versturen_Dossier_tbv_Aanvraag|Opvragen Dossier met KoppelSleutel]]
 +
| [[OSO:2022/Uitwisselen_PaO_berichten#Versturen_Dossier_tbv_Aanvraag|Opvragen Dossier met KoppelSleutel]]
−
| '''[[OSO:2018/Opvragen_dossier|Opvragen van een Dossier]]'''
 +
| '''[[OSO:2022/Opvragen_dossier|Opvragen van een Dossier]]'''
 
| Opvragen Dossier met KoppelSleutel. Automatisch gestart na ontvangst Notificatie(!)
  
| Opvragen Dossier met KoppelSleutel. Automatisch gestart na ontvangst Notificatie(!)
   
 
|-
 
|-
−
| rowspan="2"|[[OSO:2018/Uitwisselen_PaO_berichten|Terugkoppeling vanuit SWV naar School]]
 +
| rowspan="2"|[[OSO:2022/Uitwisselen_PaO_berichten|Terugkoppeling vanuit SWV naar School]]
−
| [[OSO:2018/Uitwisselen_PaO_berichten#Versturen_Terugkoppeling_over_Aanvraag|Initiëren terugkoppeling]]
 +
| [[OSO:2022/Uitwisselen_PaO_berichten#Versturen_Terugkoppeling_over_Aanvraag|Initiëren terugkoppeling]]
−
| '''[[OSO:2018/Initiëren Terugkoppeling|Versturen TerugkoppelingMelding naar TC]]'''
 +
| '''[[OSO:2022/Initiëren Terugkoppeling|Versturen TerugkoppelingMelding naar TC]]'''
 
| Opvragen url AP bij TC
  
| Opvragen url AP bij TC
   
 
|-
  
|-
−
| [[OSO:2018/Uitwisselen_PaO_berichten#Versturen_Terugkoppeling_over_Aanvraag|Versturen en ontvangen Terugkoppeling]]
 +
| [[OSO:2022/Uitwisselen_PaO_berichten#Versturen_Terugkoppeling_over_Aanvraag|Versturen en ontvangen Terugkoppeling]]
−
| '''[[OSO:2018/Versturen Terugkoppeling|Versturen Terugkoppeling naar Bronsysteem]]'''
 +
| '''[[OSO:2022/Versturen Terugkoppeling|Versturen Terugkoppeling naar Bronsysteem]]'''
 
| Als initiérende/verzenden partij
  
| Als initiérende/verzenden partij
   

Huidige versie van 25 feb 2022 om 14:58

Functionele eisen per type systeem

Hieronder wordt per 'rol' in de uitwisseling de functionaliteit van systemen beschreven. Hierbij wordt eerst een 'hoog niveau' use case/story gegeven en vervolgens wordt deze per stap verder uitgewerkt in pseudocode. De volgende rollen/categorieën worden onderscheiden:

  • Functionaliteit voor alle typen systemen: Functionaliteit die ongeacht de rol door een systeem moet worden ingebouwd.
  • Functionaliteit voor Bronsystemen (exclusief ondersteuning SWV): Functionaltiteit voor systemen die Dossiers leveren in POPO/POVO/VOVO en/of binnenBRIN overdrachten.
  • Use cases voor Doelsystemen (exclusief ondersteuning SWV): Functionaltiteit voor systemen die Dossiers ophalen in POPO/POVO/VOVO en/of binnenBRIN overdrachten.
  • Aanvullende Use Cases voor LASsen SWV uitwisseling: Functionaltiteit voor systemen die Dossiers leveren in overdrachten in het kader van Passend Onderwijs (PaO/SWV).
  • Aanvullende Use Cases voor SWV's en RP's SWV uitwisseling: unctionaltiteit voor systemen die Dossiers ophalen in overdrachten in het kader van Passend Onderwijs (PaO/SWV).

Foutmeldingen/terugkoppeling in OSO

Binnen OSO zijn 'referentie' terugkoppelingen en foutmeldingen naar eindgebruikers vastgesteld. Leveranciers kunnen deze toepassen, maar dit is niet verplicht (eigen varianten zijn toegestaan). Deze meldingen zijn per interactie in de wiki opgenomen; de complete lijst is hier te vinden.

Functionaliteit voor alle typen systemen

Beschrijving Use case Verplicht Opmerkingen
Aanroep voor het testen van de beschikbaarheid van het Traffic Center Pingen van Traffic Center Verplicht
Registreren vanuit een Systeem van een Aanleverpunt bij het TC Registreren van een Aanleverpunt Verplicht Aanleverpunten (endpoints) worden vanaf OSO'22 in OSR geregistreerd.
Controleren van de AanleverpuntSleutel Aanleverpuntsleutels bestaan niet meer vanaf OSO'22.
Opvragen van Aanleverpunten Optioneel Door te filteren op APsleutel kan met deze aanroep informatie over bewerkt Aanleverpunt worden opgehaald.
Aanroep voor het opvragen van informatie over AanleverPunten bij het Traffic Center Opvragen van Aanleverpunten Optioneel

Functionaliteit voor Bronsystemen (exclusief ondersteuning SWV)

Beschrijving (Deel)processtap Use case Opmerkingen
Samenstellen en klaarzetten Dossier Laten inzien Dossier Registreren van inzage Dossier Vindt plaats 'binnen' systeem, geen directe interactie met OSO
Samenstellen van het Dossier Selectief samenstellen Dossier
Dossier controleren tegen OSO standaard Voorafgaand aan versturen controleert Bronsysteem Dossier tegen Edustandaard Gegevensset OSO
Dossier klaarzetten voor Scholen Voordat Doelsysteem Dossier kan opvragen moet in Bronsysteem aangegeven worden dat Dossier gereed is en beschikbaar voor specifieke scho(o)l(en)
Verwerken Verzoeken en Notificaties Verwerken openstaande verzoeken Tonen ontvangen verzoeken Vindt plaats 'binnen' systeem, geen directe interactie met OSO
Versturen Notificatie Versturen NotificatieMelding naar TC Na klaarzetten Dossier voorafgaand aan verzenden van Notificatie
Versturen Notificatie naar Doelsysteem Melden aan Doelsysteem dat Dossier beschikbaar is gekomen
Afhandelen verzoek levering Dossier Controleren van een Sessie Na ontvangst van verzoek tot levering van Dossier
Doorlopen Dossier verzoek Als antwoordende partij bij Opvragen Dossier

Use cases voor Doelsystemen (exclusief ondersteuning SWV)

Algemeen (Deel)processtap Use case Opmerkingen
Verwerken Verzoeken en Notificaties Ontvangen Notificatie naar Doelsysteem Tonen ontvangen Notficaties Reageren op binnenkomende Notificaties
Uitvoeren opvraag Sessie Doorlopen opvraag Sessie Initiëren van een Sessie Geïnitieerd door eindgebruiker of ontvangst van Notificatie
Opvragen van een Dossier Initiator/vragende partij bij Opvragen Dossier
Controleren van een Sessie Functionaliteit voor Bronsysteem(!)
Importeren en tonen van een Dossier Na een geslaagde overdracht
Afmelden van een Sessie Na het ontvangen van een Dossier of het aflopen van alle Aanleverpunten

Aanvullende Use Cases voor LASsen SWV uitwisseling

In onderstaande tabel is met vet aangegeven welke functionaliteiten voor de rol 'LAS' in een SWV uitwisseling geïmplementeerd moeten worden. Op de Overstap Service Onderwijs en hier, hier en hier is meer informatie over deze uitwisseling en de rollen daarin te vinden.

Algemeen (Deel)processtap Use case Opmerkingen
Uitwisseling voor Aanvraag bij SWV |Initiëren Aanvraag vanuit LAS Aanleverpunt selecteren voor Notificatie Adressering naar SWV
Versturen NotificatieMelding naar TC Aanvragen KoppelSleutel bij TC
Versturen Notificatie naar Doelsysteem Versturen KoppelSleutel naar SWV systeem
Opvragen Dossier met KoppelSleutel Verwerken aanvraag van Dossier door SWV systeem Geïnitieerd door SWV systeem(!)
Terugkoppeling vanuit SWV naar School Initiëren terugkoppeling Versturen TerugkoppelingMelding naar TC Functionaliteit voor SWV systeem(!)
Ontvangen Terugkoppeling Versturen en ontvangen Terugkoppeling naar Bronsysteem Als ontvangende partij

Aanvullende Use Cases voor SWV's en RP's SWV uitwisseling

In onderstaande tabel is met vet aangegeven welke functionaliteiten voor de rol 'LAS' in een SWV uitwisseling geïmplementeerd moeten worden. Op de Overstap Service Onderwijs en hier, hier en hier is meer informatie over deze uitwisseling en de rollen daarin te vinden.

Algemeen (Deel)processtap Use case Opmerkingen
Uitwisseling voor Aanvraag bij SWV Initiëren Aanvraag vanuit LAS Ontvangen Notificatie door Doelsysteem Afhandelen ontvangst Notificatie met KoppelSleutel


Opvragen Dossier met KoppelSleutel Opvragen van een Dossier Opvragen Dossier met KoppelSleutel. Automatisch gestart na ontvangst Notificatie(!)
Terugkoppeling vanuit SWV naar School Initiëren terugkoppeling Versturen TerugkoppelingMelding naar TC Opvragen url AP bij TC
Versturen en ontvangen Terugkoppeling Versturen Terugkoppeling naar Bronsysteem Als initiérende/verzenden partij
Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=OSO:2022/Specifieke_Eisen&oldid=12342"