Zum Hauptinhalt springen

Webfrontend

Das PVOG stellt ein Webfrontend als Benutzungsoberfläche für den Validator-Dienst zur Verfügung, welches mit Firefox und Chrome Browsern getestet wurde. Für die Nutzung des Webfrontend und der REST API ist ein Anwenderkonto erforderlich. Die Zugangsdaten können per Mail an dataportpvogsupport@dataport.de vom Support des PVOG erfragt werden. Im Konto hinterlegt sind unter anderem auch die Berechtigungen für den Zugriff auf die Daten einzelner Redaktionssysteme. So kann der Kontoinhaber z. B. auf die Daten des Redaktionssystems Hamburg zugreifen, aber nicht auf die Daten des Redaktionssystems Hessen.

Zur Anmeldung am Webfrontend muss ein Anwender seinen Kontonamen und sein Passwort angeben. Einmal angemeldet, gibt es im Webfrontend eine Schaltfläche zum Abmelden des Anwenders. Da die Sitzung nach kurzer Inaktivität automatisch beendet wird, ist eine manuelle Abmeldung in der Regel nicht notwendig. Sollte ein Anwender aber über mehrere Konten verfügen, kann er sich so von der aktuellen Sitzung ab- und dann mit einem anderen Konto wieder anmelden.

Nach dem Anmelden präsentiert das Webfrontend zuerst den Reiter zur Validation von Datenbeständen, die der Anwender bereitstellen muss.

Benutzeroberfläche des Validators vom Portalverbund Online-Gateway. Das Formular zeigt Eingabefelder für die URL einer Indexdatei, optionale Login-Daten für geschützte Redaktionssysteme, eine Systemauswahl sowie einen Button zum Starten der Validierung.Validator Frontend

Reiter Validation​

In diesem Reiter können Datenbestände validiert werden, die unter einer zu spezifizierenden URL zur Verfügung gestellt wurden. Der Validator-Dienst wird diesen Datenbestand dann herunterladen und validieren und stellt dem Anwender dann das Prüfergebnis und einen Validationsreport zur Verfügung.

URL-Eingabe und Authentifizierung​

Die zu überprüfenden Verwaltungsleistungen und Organisationseinheiten werden in der im PVOG etablierten Form zur Verfügung gestellt. Eine Index-Datei (z. B. im .txt-Format) verweist zeilenweise durch relative oder absolute Pfadangaben auf die zu validierenden Dokumente. Die URL zur Indexdatei kann dann in das dafür vorgesehene Textfeld eingetragen werden. Unterstützte Protokolle sind http und https.

Eingabebereich des Validator-Formulars zur Angabe der URL einer Indexdatei, mit dem Platzhalter-Hinweis auf die unterstützten Protokolle http und https.Die URL zu einer Indexdatei

Ist die Indexdatei passwortgeschützt, können Benutzername und Passwort zur Entschlüsselung dieser Datei im Bereich Authentifizierung angegeben werden. Dabei handelt es sich in der Regel nicht um die Kontoinformationen, mit denen sich der aktuelle Anwender am Webfrontend angemeldet hat.

Optionaler Login-Bereich für zugangsgeschützte Redaktionssysteme. Enthält einen erklärenden Hinweistext sowie zwei Eingabefelder für Benutzername und Passwort.Authentifizierung

Auswahl des Bundeslandes/Redaktionssystems​

Die Zuständigkeiten von Organisationseinheiten für Verwaltungsleistungen sind immer an ein oder mehrere anzugebende Gebiete gebunden, die durch die Angabe der entsprechenden amtlichen Regionalschlüssel (ARS) festgelegt werden. Der Validator überprüft diese auf Konformität zum jeweils zuständigen Bundesland bzw. Redaktionssystem. Nach Beschluss des IT-Planungsrates wird diese Zuständigkeit auf der Länderebene geklärt (die zwei führenden Ziffern des ARS). Daher ist vor dem Start der Validierung das verantwortliche Bundesland bzw. Redaktionssystem aus einer Liste auszuwählen.

Unter „Redaktionssystem spezifische Konfiguration“ wird zu dem ausgewählten Bundesland bzw. Redaktionssystem das Gebiet (2-stelliger Länder-ARS bzw. bei einigen Redaktionssystemen auch mehrere ARS), die Redaktionssystem-ID (schemeAgencyId) sowie die erlaubten Leika Typen angezeigt. Diese Daten stammen vom Sammlerdienst und werden vom Validator automatisch abgerufen. Sollte der Sammlerdienst nicht erreichbar sein, wird eine Standard-Liste der Redaktionssysteme angezeigt, die keine Einschränkungen bei den Leika-Typen hat.

Dropdown-Menü zur Auswahl eines Redaktionssystems und eine Übersicht der spezifischen Konfigurationsdaten des gewählten Systems, wie ARS und erlaubte Leika-Typen.Redaktionssystem

Validierung abbrechen​

Sobald die Validierung gestartet wurde, besteht die Möglichkeit mit dem Button „Validierung abbrechen“ den Validierungsprozess abzubrechen.

Fortschritt und Ergebnis der Validierung​

Unterhalb des Eingabeformulars wird der aktuelle Validierungsfortschritt angezeigt. Bei abgeschlossener Validierung erscheint dort entweder eine Erfolgsmeldung.

Erfolgsmeldung: Validierung beendet (548 Dokumente). Alle überprüften Dokumente entsprechen den Vorgaben.Erfolgsmeldung

oder eine Liste der gefundenen Validierungsfehler.

Ergebnismeldung einer abgeschlossenen Validierung mit Warnungen. Die Ansicht zeigt eine kurze Zusammenfassung mit Warnungen und Fehlern in einm scrollbaren Textfeld mit dem detaillierten Prüfprotokoll sowie zwei Buttons zum Herunterladen oder Kopieren des vollständigen Reports.Validierungsfehler

Über die Schaltflächen am oberen rechten Rand kann der Report entweder in die Zwischenablage kopiert oder, falls der Report zu groß ist, als Text-Datei heruntergeladen werden. Falls der Virenscanner in der Index-Datei einen Virus entdeckt, werden keine weiteren Dateien geprüft und die Validierung sofort abgebrochen. Bei einem Virusfund in einem XZuFi-Dokument, wird dies als Fehler dokumentiert, die Validierung dieses Dokuments abgebrochen und mit dem nächsten Dokument fortgefahren. Alle Virenfunde sind mit entsprechender Fehlermeldung in dem abgeschlossenen Validierungsreport aufgeführt.

Reiter Validierungsstatistiken​

Im Reiter Statistiken werden die Ergebnisse der täglichen Gesamtbestandsvalidierung angezeigt. Bei der Umstellung auf den Push-Betrieb war es nicht mehr möglich, die Validation jeder Push- Nachricht im gleichen Umfang durchzuführen wie beim bisher genutzten Pull-Betrieb oder wie bei der manuellen Validation aller Daten eines Redaktionssystems hier im Validator-Dienst. Deshalb werden im PVOG-System täglich die Datenbestände jedes Redaktionssystems automatisch validiert und die Ergebnisse hier dargestellt.

Hier kann ein Anwender einen statistischen Überblick über die Ergebnisse der Gesamtbestandsvalidierung erhalten sowie pro Redaktionssystem den letzten Report herunterladen. Dabei hat ein Anwender nur Zugriff auf die Daten derjenigen Redaktionssysteme, für die in seinem Konto die notwendigen Berechtigungen hinterlegt sind.

Ansicht „Validierungsstatistiken“. Im oberen Bereich zeigt eine Tabelle die Ergebnisse automatischer Validierungen, sortiert nach Bundesländern und Datum, aufgeschlüsselt nach Gesamtanzahl, Fehlern, Warnungen und Hinweisen. Darunter befindet sich ein Bereich mit verfügbaren Downloads des Reports für jedes Bundesland wahlweise im JSON- oder CSV-Format.Validierungsergebnisse für freigeschaltete Redaktionssysteme

Reiter Info: Anzeige der Fachvalidatorkonfiguration​

Im Reiter Info sind alle Prüfregeln des Validator-Dienstes aufgelistet. Neben der Bezeichnung, einer Beschreibung und dem Datum des Inkrafttretens einer Prüfregel wird angegeben, ob sie aktiv ist und in welchem Modus die Regel läuft. Die Einhaltung von inaktiven Regeln wird bei der Validierung des Datenbestandes nicht überprüft. Der Modus bestimmt, ob Verletzungen der Regel als Fehler, Warnung oder Hinweis gemeldet werden. Die Modi Warnung und Hinweis dienen dazu, die fachliche Qualität des Datenbestandes zu verbessern. Verletzungen einer Regel im Modus Fehler, die vom Validator-Dienst nur entsprechend protokolliert werden, würden im Sammlerdienst zu einer Ablehnung des Imports solcher Daten führen.

Zusätzlich finden sich im Reiter Info die unterstützten XZuFi-Versionen sowie die Versionen der aktuell aktiven Fachvalidator-Bibliothek und des Validator-Dienstes.

Ansicht „Weitere Informationen“ auf dem Portalverbund Online-Gateway mit Systemdetails. Die Seite listet die aktuellen Versionsnummern von Backend und Fachvalidator auf, nennt die unterstützte XZuFi-Version und zeigt eine detaillierte Auflistung der spezifischen Prüfregeln zur Validierung der Dokumente.Anzeige der Validatorkonfiguration