OSO:2018/Specifieke Eisen

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken

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 PaO): 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.
  • 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 SWV's en RP's PaO uitwisseling: unctionaltiteit voor systemen die Dossiers ophalen in overdrachten in het kader van Passend Onderwijs (PaO).

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 Bij het registreren van een Aanleverpunt kan met het controleren van de APsleutel de invoer van de eindgebruiker gevalideerd worden.
Controleren van de AanleverpuntSleutel Optioneel Valideren van de invoerde waarden in een Systeem bij een Aanleverpunt op basis van de Aanleverpuntsleutel.
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 PaO)

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 PaO)

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 PaO uitwisseling

In onderstaande tabel is met vet aangegeven welke functionaliteiten voor de rol 'LAS' in een PaO 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 PaO |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 PaO uitwisseling

In onderstaande tabel is met vet aangegeven welke functionaliteiten voor de rol 'LAS' in een PaO 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 PaO 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