Dokumentation Vereinfachtes Routing in der Testumgebung
Dokumentationsseiten (Pflichtfeld)
-
Neue Dokumentationsseite -
Bestehende Dokumentationsseiten (Link: https://docs.fitko.de/fit-connect/docs/sending/get-destination/#zustellpunkte bzw. https://docs.fitko.de/fit-connect/docs/organisation-tasks/routing) anpassen
User Story
Als Nutzer des FIT-Connect Routings möchte ich verstehen, wie das vereinfachte Routing in der Testumgebung funktioniert und wie es sich vom vom regluär mit Landesredaktionssystemen/PVOG konfiguriertem Routing unterscheidet.
Warum
Mit dem vereinfachten Routing in der Testumgebung (#2396 (closed)) wurde der Konfigurationsaufwand für Anbindungsprojekte reduziert. Diese Funktion wurde jedoch bisher nicht ausreichend dokumentiert.
Erkenntnis --> Was muss dokumentiert werden? (Pflichtfeld)
Seite „Zustellpunkt ermitteln“ (Textvorschlag -> bitte überarbeiten)
https://docs.fitko.de/fit-connect/docs/sending/get-destination/#zustellpunkte
Der Text im blauen Kasten „WICHTIG“ wird durch folgenden Text ersetzt: „Der Routingdienst verwendet das Portalverbund Online-Gateway (PVOG) zur Ermittlung der der Routen (vgl. „Exkurs: Technischer Hintergrund des Routingdienstes“ unten). Damit ein Zustellpunkt gefunden werden kann, müssen über die Landesredaktionssysteme dessen Adressierungsinformationen ins PVOG eingepflegt werden. Der Routingdienst der FIT-Connect Testumgebung verwendet das Stage-PVOG. In einigen Bundesländern gibt es Schulungs-Landesredaktionssysteme, über die Adressierungsinformationen in diese PVOG-Instanz eingepflegt werden können. Um Ihnen das Testen der Routingfunktionen zu erleichtern, greift der Routingdienst der Testumgebung jedoch zusätzlich direkt auf die im Self-Service-Portal von FIT-Connect bei den Zustellpunkten eingepflegten Informationen zu. Die Routen werden nicht nur anhand der Daten aus dem PVOG sondern auch anhand der Verwaltungsleistungen und der Regionen ermittelt, die ein Zustellpunkt aufgrund seiner Konfiguration unterstützt. Sie müssen also in der Testumgebung nicht zwingend die Adressierungsinformationen Ihres Zustellpunktes über ein Landesredaktionssystem in das Stage-PVOG einpflegen. Bei jeder Route weist das Feld "origin" daraufhin, aufgrund welcher Informationsquelle sie ermittelt wurde. Der Routingdienst ergänzt die über das Stage-PVOG gefundenen Routen lediglich, er fügt keine Duplikate hinzu.
In der Produktivumgebung ist das Einpflegen der Adressierungsinformationen hingegen zwingend erforderlich.“
Seite „Antragsrouting konfigurieren“ (Textvorschlag -> bitte überarbeiten)
https://docs.fitko.de/fit-connect/docs/organisation-tasks/routing
Unten wird ein neuer Abschnitt hinzugefügt: „Vereinfachtes Routing in der FIT-Connect Testumgebung“ „Der Routingdienst der FIT-Connect Testumgebung verwendet das Stage-PVOG. In einigen Bundesländern gibt es Schulungs-Landesredaktionssysteme, über die Adressierungsinformationen in diese PVOG-Instanz eingepflegt werden können. Um Ihnen das Testen der Routingfunktionen zu erleichtern, greift der Routingdienst der Testumgebung jedoch zusätzlich direkt auf die im Self-Service-Portal von FIT-Connect bei den Zustellpunkten eingepflegten Informationen zu. Die Routen werden nicht nur anhand der Daten aus dem PVOG sondern auch anhand der Verwaltungsleistungen und der Regionen ermittelt, die ein Zustellpunkt aufgrund seiner Konfiguration unterstützt. Sie müssen also in der Testumgebung nicht zwingend die Adressierungsinformationen Ihres Zustellpunktes über ein Landesredaktionssystem in das Stage-PVOG einpflegen. Bei jeder Route weist das Feld "origin" daraufhin, aufgrund welcher Informationsquelle sie ermittelt wurde. Der Routingdienst ergänzt die über das Stage-PVOG gefundenen Routen lediglich, er fügt keine Duplikate hinzu.“
Links, Hinweise, Bemerkungen
Ansprechperson (Pflichtfeld)
- Zuständige PO:
- Technische Ansprechperson: @Andreas_Aschauer
Akzeptanzkriterien (Pflichtfeld)
-
Die Textvorschläge unter "Erkenntnis --> Was muss dokumentiert werden?" wurden qualitätsgesichert und ggf. hinsichtlich der Verständlichkeit verbessert. -
Die Funktion des Vereinfachten Routings in der Testumgebung wurde dokumentiert.
Mögliche Folgeaktivitäten (vom Entwickler zu ergänzen)
-
... -
... -
... -
Definition of Done was checked.