diff --git a/AntwortSenden.jpg b/AntwortSenden.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3e14417198861e3955e8ec4366e97bed2810a0ba Binary files /dev/null and b/AntwortSenden.jpg differ diff --git a/Bearbeiten.jpg b/Bearbeiten.jpg index 47c18eef50ad6dc9cdb6bc7bf6b4d41f2a7a74f1..9ace3d4ca052a7ff993ea683636b21cf0cb8b49f 100644 Binary files a/Bearbeiten.jpg and b/Bearbeiten.jpg differ diff --git a/Bearbeitungsfehler.jpg b/Bearbeitungsfehler.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6ca160b7af0b09a77d3aa6f5684c545d2ff1364b Binary files /dev/null and b/Bearbeitungsfehler.jpg differ diff --git a/Einstellungen.jpg b/Einstellungen.jpg index c3e200fa716e8c1f424dbfb0909ed6531096eb46..0411825a72c27974736ea82ccae8c5899807dd1b 100644 Binary files a/Einstellungen.jpg and b/Einstellungen.jpg differ diff --git a/ElementEinfuegen.jpg b/ElementEinfuegen.jpg new file mode 100644 index 0000000000000000000000000000000000000000..16607219884239502d29756f554bba2636f047b1 Binary files /dev/null and b/ElementEinfuegen.jpg differ diff --git a/ElementKopieren.jpg b/ElementKopieren.jpg new file mode 100644 index 0000000000000000000000000000000000000000..6dc20df6381090705076e40c492fe307261a2bc8 Binary files /dev/null and b/ElementKopieren.jpg differ diff --git a/FIT-Connect-Konto.jpg b/FIT-Connect-Konto.jpg new file mode 100644 index 0000000000000000000000000000000000000000..938f070f2d5b17fbea6cfa208b53fe156148da18 Binary files /dev/null and b/FIT-Connect-Konto.jpg differ diff --git a/Kontenverzeichnis.jpg b/Kontenverzeichnis.jpg new file mode 100644 index 0000000000000000000000000000000000000000..80af98a511f94f1cf4f60eed5628efda5de5efcd Binary files /dev/null and b/Kontenverzeichnis.jpg differ diff --git "a/Men\303\274Nachricht.jpg" "b/Men\303\274Nachricht.jpg" index b4a4783d78f29dbc72edf54641dd0298328904fe..7caab86dde75d5be97a99afcd6c4c3e2042da753 100644 Binary files "a/Men\303\274Nachricht.jpg" and "b/Men\303\274Nachricht.jpg" differ diff --git a/Nachricht.jpg b/Nachricht.jpg index c39f9ba7575de9c835ea874cf2e40f7a29142412..c968d414c7dd3b4a6c248692833f7e174fb4ceca 100644 Binary files a/Nachricht.jpg and b/Nachricht.jpg differ diff --git a/NachrichtSenden.jpg b/NachrichtSenden.jpg index 42b51693d36d8211c4030806129afd45a68ea235..51e92ed436a67f4d7c485f74ad983ddf903599d5 100644 Binary files a/NachrichtSenden.jpg and b/NachrichtSenden.jpg differ diff --git a/README.md b/README.md index 61bf0af1d6bc72e1a040fd96cc87084d33537800..c823d4eeafe0af77da336098df8c7133bb2b1207 100644 --- a/README.md +++ b/README.md @@ -1,100 +1,127 @@ -## XML-Nachrichten-Tool -Das Nachrichten-Tool ist ein Java-basiertes Programm, mit dem - auf Grundlage von XÖV-Standards - Testnachrichten erzeugt, angezeigt, bearbeitet, validiert und versendet bzw. empfangen werden können. -Dieses multifunktionale Testwerkzeug der XLeitstelle und BSW Hamburg kann dementsprechend in unterschiedlichen Anwendungsszenarien genutzt werden: -- XML-Nachrichten von XÖV-Standards wie XBau und XBreitband werden in strukturierter (baumartiger) Form angezeigt. Dabei lassen sich Äste ein- und ausklappen, um eine übersichtliche Darstellung der verschachtelten Nachrichteninhalte zu erhalten. -- Die Schemavalidität der Nachrichten wird untersucht, evtl. vorhandene Fehler werden angezeigt. Bei der Verwendung von Codelisten werden die in XML-Nachrichten genutzten Codes nach Möglichkeit aufgelöst. -- Änderungen an den Schemata eines Standards wie XBau und XBreitband lassen sich über Testnachrichten überprüfen, die "auf Knopfdruck" mit validen Daten (für Textfelder, Codelistenwerte etc.) ausgefüllt werden. -- Die erzeugten Nachrichten können innerhalb des Tools oder mit einem externen Editor bearbeitet werden, um fachlich korrekte Nachrichten zu erstellen. Es lässt sich z.B. zu überprüfen, ob sich alle Daten eines analogen Antrags in das digitale Format übertragen lassen. -- Die Funktionalität des Standards lässt sich im Detail testen (z.B. die korrekte Einbindung externer Schemata und Codelisten). Die Nachrichten werden nach jeder Änderung automatisch validiert. -- Die Nachrichten können über die XTA-Infrastruktur oder über FIT-Connect versendet werden, sofern die entsprechen Zugangsdaten vorhanden sind. Damit lassen sich reale Anwendungsfälle der XÖV-Nachrichten simmulieren, indem z.B. Anträge an Behörden abgeschickt und Antworten empfangen werden (entweder innerhalb des Tools oder zwischen zwei NutzerInnen, die jeweils eine Rolle übernehmen). - - -## Installation -Das Programm wird als ZIP-Archiv zusammen mit Java 11 ausgeliefert und kann in einem beliebigen Verzeichnis entpackt werden. Es lässt sich über die EXE-Datei _XML-Nachrichten-Tool_XX.exe_ starten. -Innerhalb der Verwaltungsnetze müssen ausreichende Nutzerrechte vorhanden sein. -Im Benutzerverzeichnis wird ein Ordner "xtaviewer" angelegt, wo Einstellungen und Konten abgelegt sind. Neue Versionen des Tools greifen ebenso auf diesen Benutzerordner zu. - -## Erste Schritte -Über den Button "Neu Ordner" wird ein Ordner mit XML-Nachrichten und -Schemata sowie Codelisten (im Genericode-Format) eines XÖV-Standards importiert. Anschließend liest das Tool diese und ggf. alle referenzierten externen Schemata ein bzw. speichert diese im Unterordner "offline" ab. In diesem Unterordner erhält man somit eine vollständige Offline-Kopie aller verwendeten Schemata und Codelisten, der für Analyse- oder Debug-Zwecke eingesetzt (oder einfach ignoriert) werden kann. Wenn der Einlese-Prozess abgeschlossen ist, wird die entsprechende Ordnerstruktur mit allen relevanten XML-Dateien im Verzeichnisbaum des Tools angezeigt. Die Schemata lassen sich über das Dreieck am linken Rand aufklappen. - -In gleicher Weise lassen sich über "Neues XTA-Konto" bzw. "Neues FIT-Connect-Konto" Ordner importieren, die als Postfächer zum Senden und Empfangen von Nachrichten über die jeweilige Transportinfrastruktur verwendet werden. Unterordner für den Nachrichtentransfer werden automatisch angelegt (u.a. Posteingang, Postausgang, Gesendet). - -## Nachrichtenansicht konfigurieren - -Die Art der Generierung der Testnachrichten sowie ihre Darstellung lassen sich über einige Einstellungen steuern. Dafür wird die oberste Ebene im Verzeichnisbaum ("Alle Quellen") angeklickt, auf der rechten Seite werden anschließend die Optionen angezeigt. - - - -Der Umfang der Testnachrichten lässt sich über die Auswahl von optionalen Elementen und Attributen steuern. - -Die Einstellung "Knoten expandieren bis ..." legt fest, inwieweit die verschachtelten Datentypen der Nachrichten ein- bzw. ausgeklappt werden. Die Anzahl der Ebenen bezieht sich auf das jeweilige Element. - -Das Präfix des Standards (z.B. "xbau-tiefbau") lässt sich in der strukturierten Nachrichtenansicht ausblenden (in der Textansicht wird es angezeigt). - -Änderungen müssen mit dem Button "Übernehmen" bestätigt werden. - -## Nachrichten erstellen - -Im links abgebildeten Verzeichnisbaum wird das Schema der Nachricht ausgewählt. Anschließend wird der Button "Instanz erzeugen" angeklickt. - - - -Die erzeugte XML-Nachricht ist innerhalb des Verzeichnisbaums auffindbar. Sie wird also im gleichen Ordner wie die Schemata gespeichert. - - - -## Nachrichten bearbeiten -Es stehen verschiedene Bearbeitungsmöglichkeiten zur Auswahl: - -- Um die Struktur der Nachricht regelkonform zu verändern, wird der Button "XML bearbeiten" ausgewählt. Ein Dreieck am rechten Rand öffnet ein Menü, das die Bearbeitungsmöglichkeiten des jeweiligen Elements anzeigt: Die in hellgrauer Schrift dargestellten optionalen Elemente lassen sich z.B. löschen; ist die Multiplizität größer eins, kann das Element erneut hinzugefügt werden. Dabei ist auf die Bearbeitungsebene zu achten: Um in der oben gezeigten Nachricht das Element "trassenführung" zu löschen, muss (im hier nicht gezeigten Bearbeitungsmodus) das Dreieck im übergeordneten Element "bauabschnitte" ausgewählt werden. - - - -- Mit "XML bearbeiten" werden ebenso die fachlichen Inhalte der Nachricht bearbeitet, z.B. lassen sich so die Zufallstexte in den String-Datentypen ersetzen. Für die in den Standard eingebundenen Typ-1-Codelisten werden die zutreffenden Werte über Pulldown-Menüs ausgewählt. Bei Typ-3-Codelisten muss zunächst die zutreffende Versionsnummer (*listVersionID*) ausgewählt bzw. überprüft werden, für die externen Typ-4-Codelisten sind sowohl die URN- oder Link-Adressen als auch die Versionsnummer einzutragen. (Hinweis: nur lokal verfügbare Typ-3-Codelisten müssen im gleichen Verzeichnis wie die Schemata liegen.) Die Validierung der Bearbeitung erfolgt - je nach Datentyp - sofort nach der Eingabe oder über den Button "Speichern". In einem Fenster unter der Nachricht werden die Fehler angezeigt, in der Nachricht sind sie farblich hervorgehoben. Fehlerhafte Nachrichten werden ebenso im Verzeichnisbaum markiert. - -- Über "Öffnen" wird ein externer Editor zur Bearbeitung der XML-Datei gestartet. Eine mögliche Anwendung für den Editor ist die Hinzufügung von Nachrichten(teilen), um z.B. einen Antrag in eine Beteiligungsnachricht zu integrieren. Nach dem Sichern der Datei im Editor wird über "Neu analysieren" die Validierung der Nachricht angestoßen. - -- Über "Text bearbeiten" wird ein interner Editor geöffnet. Auf diesem Weg wird die Nachricht in der XML-Struktur angezeigt. Die Validierung von Änderungen im Code erfolgt über "Speichern". - - -## Schemata aktualisieren - -Die XML-Schemata können in dem vorhandenen Ordner überschrieben werden. Anschließend müssen sie im Tool neu eingelesen werden. Dafür wird der entsprechende Ordner im Verzeichnisbaum ausgewählt, im rechten Fenster wird anschließend am unteren Rand der Button "Übernehmen" gedrückt (oder das Kreissymbol zur Aktualisierung). Die zuvor erzeugten Nachrichteninstanzen des Ordners werden anschließend auf Grundlage der aktualisierten Schemata validiert. - -## Nachrichten über FIT-Connect senden und empfangen - -Nach der Registrierung auf der FIT-Connect-Testumgebung lassen sich IDs für den Zustellpunkt (der Genehmigungsbehörde), Sender-Client (= Antragssteller) und Subscriber-Client (= Antragsbearbeiter) angelegen ([Anleitung](https://docs.fitko.de/fit-connect/docs/getting-started/account)). Im Tool werden die IDs in die entsprechende Eingabemaske für das FIT-Connect-Konto eingetragen. Erreichbar ist diese Maske über die Auswahl des Kontos im Verzeichnisbaum. Sofern noch kein Konto angelegt wurde, muss zunächst ein Ordner importiert werden (s. "Erste Schritte"). - -Um für die Testumgebung public und private keys zu erzeugen, kann das [hier](https://git.fitko.de/fit-connect/fit-connect-tools) verfügbare Python-Script "createSelfSignedJwks.py" genutzt werden ([Anleitung](https://docs.fitko.de/fit-connect/docs/details/jwk-creation/)). - -Nach der Einrichtung eines FIT-Connect-Sender-Kontos lassen sich erzeugte Nachrichten über die Submission-API verschicken. Im Hauptfenster der Nachricht wird zunächst auf "Senden..." geklickt, anschließend öffnet sich ein Auswahlbereich für Sender und Empfänger. - - - -In diesem Auswahlbereich werden ebenso die Anhänge zur Nachricht hinzugefügt. Handelt es sich um Nachrichten der Standards XBau und XBreitband, erfolgt für die ausgewählten Anhänge die Eintragung des Dateinamens und einer UUID in den zugehörigen Metadaten der jeweiligen Nachricht. - -Über "Senden" wird die Nachricht abgeschickt. - -Ist ein Subscriber-Konto eingerichtet, lassen sich Nachrichten über das Hauptmenü "Extras" abrufen. - -Gesendete und empfangene Nachrichten lassen sich im Verzeichnisbaum wie in einem Email-Programm für das jeweilige FIT-Connect-Konto anzeigen. Alternativ dazu kann in den Einstellungen des Kontos eine fallbasierte Sortierung der Nachrichten ausgewählt werden: die Zuordnung von gesendeten und empfangenen Nachrichten erfolgt dann über die von der Submission API zugewiesenen Case-ID. Für jeden Vorgang eines Senders sind damit die eigene Nachrichten (z.B. Antrag und Überarbeitung) und die empfangenen Antworten der Behörde in einem Ordner zusammengefasst. (Anmerkung: dieses Feature ist erst mit der Integration des Rückkanals vollständig funktionsfähig.) - -## Roadmap - -Nutzer und Nutzerinnen des Tool sind aufgerufen, Vorschläge zur Implementierung weiter Features und Funktionalitäten einzureichen. - -Von Seiten der XLeitstelle ist die Implementierung des Rückkanals von FIT-Connect 1.3 geplant, durch den Anträge mit der entsprechenden Nachricht der Behörde beantwortet werden können. Es fehlt weiterhin die Bearbeitungsmöglichkeit des Metadatensatzes der FIT-Connect-Einreichung. - -Bislang sind die Erfahrung mit der Nutzung von XTA-Konten begrenzt. Wer Interesse an der Nutzung dieser Funktion hat, möge sich bei der XLeitstelle melden. - -## Neue Features der Versionen 1.1 ff - -- Elemente können per "Copy and Paste" in eine andere Nachricht oder an anderer Stelle eingefügt werden. Das Symbol "Kopieren" lässt sich in der Nachrichtenansicht nutzen, beim "Einfügen" wird automatisch in den Bearbeitungsmodus gewechselt und eine valide Position innerhalb der Nachricht vorgeschlagen. Mit dieser Funktion kann u.a. das Weiterleiten von Anträgen getestet werden (z.B. das Element "breitbandvorhaben" in XBreitband-Nachrichten 3000/4000, oder das Element "bauvorhaben" in einer XBau-Nachricht 0300). - -- Codelisten im XML-Format, die nicht im XRepository verfügbar sind, lassen sich als Typ-4-Codelisten in die Nachrichten einbinden (d.h. Ermöglichung der Werteauswahl über Pulldown-Menüs und Validierung der Adressen bzw. Versionsnummern). Ein Beispiel für eine externe Codeliste ist "Planarten" aus der GDI-Registry: - https://registry.gdi-de.org/codelist/de.xleitstelle.inspire_plu/LandUse/LandUse.de.xml -- Validierungsfehler werden in der XML- und Textansicht der Nachricht jeweils farblich hervorgehoben. -- Fehlermeldungen im unteren Fenster lassen sich anklicken (und die entsprechende Stelle wird im Nachrichtenfenster angezeigt). -- Die Textansicht hat eine Zeilenummerierung. - -Aufgrund des laufenden Bugfixing wird empfohlen, die jeweils aktuellste Version zu nutzen. +## XML-Nachrichten-Tool + +Das Nachrichten-Tool ist ein Java-basiertes Programm, mit dem - auf Grundlage von XÖV-Standards - Testnachrichten erzeugt, angezeigt, bearbeitet, validiert und versendet bzw. empfangen werden können. +Dieses multifunktionale Testwerkzeug der XLeitstelle und BSW Hamburg kann dementsprechend in unterschiedlichen Anwendungsszenarien genutzt werden: + +- XML-Nachrichten von XÖV-Standards wie XBau und XBreitband werden in strukturierter (baumartiger) Form angezeigt. Dabei lassen sich Äste ein- und ausklappen, um eine übersichtliche Darstellung der verschachtelten Nachrichteninhalte zu erhalten. +- Die Schemavalidität der Nachrichten wird untersucht, evtl. vorhandene Fehler werden angezeigt. Bei der Verwendung von Codelisten werden die in XML-Nachrichten genutzten Codes nach Möglichkeit aufgelöst. +- Änderungen an den Schemata eines Standards wie XBau und XBreitband lassen sich über Testnachrichten überprüfen, die "auf Knopfdruck" mit validen Daten (für Textfelder, Codelistenwerte etc.) ausgefüllt werden. +- Die erzeugten Nachrichten können innerhalb des Tools oder mit einem externen Editor bearbeitet werden, um fachlich korrekte Nachrichten zu erstellen. Es lässt sich z.B. zu überprüfen, ob sich alle Daten eines analogen Antrags in das digitale Format übertragen lassen. +- Die Funktionalität des Standards lässt sich im Detail testen (z.B. die korrekte Einbindung externer Schemata und Codelisten). Die Nachrichten werden nach jeder Änderung automatisch validiert. +- Die Nachrichten können über die XTA-Infrastruktur oder über FIT-Connect versendet werden, sofern die entsprechen Zugangsdaten vorhanden sind. Damit lassen sich reale Anwendungsfälle der XÖV-Nachrichten simulieren, indem z.B. Anträge an Behörden abgeschickt und deren Antworten empfangen werden (entweder innerhalb des Tools oder zwischen zwei Nutzenden, die jeweils eine Rolle übernehmen). + +## Installation + +Das Programm wird als ZIP-Archiv zusammen mit Java 11 ausgeliefert und kann in einem beliebigen Verzeichnis entpackt werden. Es lässt sich über die EXE-Datei _XML-Nachrichten-Tool_XX.exe_ starten. +Innerhalb der Verwaltungsnetze müssen ausreichende Nutzerrechte vorhanden sein. +Im Benutzerverzeichnis wird ein Ordner "xtaviewer" angelegt, wo Einstellungen und Konten abgelegt sind. Neue Versionen des Tools greifen ebenso auf diesen Benutzerordner zu. + +## Erste Schritte + +Über den Button **"Neuer Ordner"** wird ein Ordner mit XML-Schemata sowie Codelisten (im Genericode-Format) eines XÖV-Standards importiert. Anschließend liest das Tool diese und ggf. alle referenzierten externen Schemata ein bzw. speichert diese im Unterordner "offline" ab. In diesem Unterordner erhält man somit eine vollständige Offline-Kopie aller verwendeten Schemata und Codelisten, der für Analyse- oder Debug-Zwecke eingesetzt (oder einfach ignoriert) werden kann. Wenn der Einlese-Prozess abgeschlossen ist, wird die entsprechende Ordnerstruktur mit allen relevanten XML-Dateien im Verzeichnisbaum des Tools angezeigt. Die Schemata lassen sich über das Dreieck am linken Rand aufklappen. + +## Nachrichtenansicht konfigurieren + +Die Art der Generierung der Testnachrichten sowie ihre Darstellung lassen sich über einige Einstellungen steuern. Dafür wird die oberste Ebene im Verzeichnisbaum **"Alle Quellen"** angeklickt, auf der rechten Seite werden anschließend die Optionen angezeigt. + + + +Der Umfang der Testnachrichten lässt sich über die Auswahl von optionalen Elementen und Attributen steuern. + +Die Einstellung "Knoten expandieren bis ..." legt fest, inwieweit die verschachtelten Datentypen der Nachrichten ein- bzw. ausgeklappt werden. Die Anzahl der Ebenen bezieht sich auf das jeweilige Element. + +Das Präfix des Standards (z.B. "xbau-tiefbau") lässt sich in der strukturierten Nachrichtenansicht ausblenden (in der Textansicht wird es angezeigt). + +Über die Farbschemata werden u.a. obligatorischen und optionalen Elementen unterschiedliche Schriftfarben zugewiesen. Schriftart und -größe sind ebenfalls konfigurierbar. + +Änderungen müssen mit dem Button **"Übernehmen"** bestätigt werden. + +## Nachrichten erstellen + +Im links abgebildeten Verzeichnisbaum wird das Schema der Nachricht ausgewählt. Anschließend wird oben rechts der Button **"Instanz erzeugen"** angeklickt. + + + +Die erzeugte XML-Nachricht ist innerhalb des Verzeichnisbaums auffindbar. Sie wird also im (zuvor importierten) Ordner der Schemata gespeichert. + + + +In der Nachricht ist unterhalb des obligatorischen Elements *breitbandvorhaben* im Pflichtattribut *vorhabenart* die blau dargestellt URI in der Version 2.0 referenziert. Die Auswahl des Codewertes dieser XÖV-Typ-1-Codeliste erfolgt bei der Nachrichtengenerierung zunächst zufällig und lässt sich im Bearbeitungsmodus verändern. Das Element *trassenführung* ist ebenso wie seine Attribute optional. Wenn die Attribute *bauweise* oder *legeverfahren* genutzt werden, müssen sie jeweils einen der zulässigen Codewerte enthalten. + +## Nachrichten bearbeiten + +Es stehen über die in der Abbildung oben dargestellten Buttons verschiedene Bearbeitungsmöglichkeiten zur Auswahl: + +Um die Struktur der Nachricht regelkonform zu verändern, wird der Button **"XML bearbeiten"** ausgewählt. In diesem Modus öffnet der Klick auf ein Dreieck am rechten Rand des Elements ein Kontextmenü, das die jeweiligen Bearbeitungsmöglichkeiten anzeigt: Die optionalen Elemente lassen sich z.B. löschen; ist die Multiplizität größer eins, kann das Element erneut hinzugefügt werden. Dabei ist auf die Bearbeitungsebene zu achten: Um in der unten gezeigten Nachricht einen weiteren *bauabschnitt* hinzufügen, muss das Dreieck im übergeordneten Element *breitbandvorhaben* ausgewählt werden. Um das Kindelement *trassenfuehrung* zu löschen, wird das Dreieck an diesem Element gewählt. + + + +Mit **"XML bearbeiten"** werden ebenso die fachlichen Inhalte der Nachricht bearbeitet, z.B. lassen sich so die Zufallstexte in den String-Datentypen ersetzen. Für die in den Standard eingebundenen Typ-1-Codelisten werden wie oben dargestellt die zutreffenden Werte über Pulldown-Menüs ausgewählt. Bei Typ-3-Codelisten[^1] muss zunächst die zutreffende Versionsnummer (*listVersionID*) ausgewählt bzw. überprüft werden, für die externen Typ-4-Codelisten [^2] sind sowohl die URN- oder Link-Adresse als auch die Versionsnummer einzutragen. Die Validierung der Bearbeitung erfolgt - je nach Datentyp - sofort nach der Eingabe oder über den Button **"Speichern"**. + +Über **"Text bearbeiten"** wird ein interner Editor geöffnet. Auf diesem Weg wird die Nachricht in der XML-Struktur angezeigt. Die Validierung von Änderungen im Code erfolgt über **"Speichern"**. In einem Fenster unter der Nachricht werden die Fehler angezeigt und mit der farblich hervorgehobenen Stelle innerhalb der Nachricht verlinkt. Fehlerhafte Nachrichten werden ebenso im Verzeichnisbaum markiert. + + + +Ein spezieller Arbeitsschritt betrifft den Umgang mit "ausgefüllten" Elementen per *Copy and Paste*. Hierfür wird - ohne zuvor in einen Bearbeitungsmodus zu schalten - ein Element wie z.B *bauabschnitt* in der Nachrichtenansicht ausgewählt, anschließend wird das Symbol "Kopieren" in der obersten Leiste angeklickt. + + + + Über das benachbarte Symbol "Einfügen" wird automatisch in den XML-Bearbeitungsmodus gewechselt und eine valide Position innerhalb der Nachricht vorgeschlagen. + +  + + Mit dieser Funktion kann auch die Weiterleitung von zentralen Antragselementen in dafür vorgesehenen Nachrichten getestet werden (z.B. das Element *breitbandvorhaben* in XBreitband-Nachrichten 3000/4000, oder das Element *bauvorhaben* in einer XBau-Nachricht 0300). + + Über **"Öffnen"** wird ein *externer* Editor zur Bearbeitung der XML-Datei gestartet. Nach dem Speichern der Datei im Editor wird über den Button **"Neu analysieren"** die Validierung der Nachricht im Tool angestoßen. + +## Schemata aktualisieren + +Die XML-Schemata können in dem vorhandenen Ordner überschrieben werden. Anschließend müssen sie im Tool neu eingelesen werden. Dafür wird der entsprechende Ordner im Verzeichnisbaum ausgewählt, im rechten Fenster wird anschließend am unteren Rand der Button **"Übernehmen"** gedrückt (oder das Kreissymbol zur Aktualisierung). Die zuvor erzeugten Nachrichteninstanzen des Ordners werden anschließend auf Grundlage der aktualisierten Schemata validiert. + +## Nachrichten über FIT-Connect senden und empfangen + +Das Tool kann Nachrichten über die FIT-Connect Submission-API in der Rolle der Antragsstellung verschicken und in der Rolle der Genehmigungsbehörde empfangen. Über den Rückkanal der API werden von beiden Akteuren jeweils Antwortnachrichten verschickt bzw. empfangen. + +Voraussetzung ist die Registrierung auf der FIT-Connect-Testumgebung ([Anleitung](https://docs.fitko.de/fit-connect/docs/getting-started/account)). Um für die Testumgebung *public* und *private keys* zu erzeugen, kann das [hier](https://git.fitko.de/fit-connect/fit-connect-tools) verfügbare Python-Script "createSelfSignedJwks.py" genutzt werden ([Anleitung](https://git.fitko.de/fit-connect/docs/-/blob/1028_Dokumentation_der_Nutzung_des_Java-SDKs/docs/details/jwk-creation.md)). + + +Im Tool werden die Daten aus der Registrierung und die Schlüssel in einer Eingabemaske für das FIT-Connect-Konto eingetragen. Erreichbar ist diese Maske über die Auswahl des Kontos im Verzeichnisbaum. Sofern noch kein Konto angelegt wurde, muss zunächst ein (leerer) Ordner über den Button **"Neues FIT-Connect-Konto"** importiert werden. In diesem Ordner werden auch die über FIT-Connect verschickten Nachrichten und Anhänge abgelegt. + +Der Zustellpunkt des Verwaltungssystems ist in der Eingabemaske die *Subscriber-Destination-ID*, die zugeordnete Antragsbearbeitung hat die *Subscriber-ID*, das sendende System eines Antragsstellers die *FIT-Connect-Sender-ID*. Zwingend notwendig ist auch eine korrekte Angabe der Registrierungsdaten in dem Feld *URN der Leistung*. + + + + +Nach der Einrichtung eines FIT-Connect-Sender-Kontos lassen sich erzeugte Nachrichten über die Submission-API verschicken. Im Hauptfenster der Nachricht wird zunächst auf "Senden..." geklickt, anschließend öffnet sich ein Auswahlbereich für Sender, Empfänger und den "Fall" (*Case-ID*). Eine Antragsnachricht legt einen neuen Fall an. + + + +In diesem Auswahlbereich werden ebenso die Anhänge zur Nachricht hinzugefügt. Handelt es sich um Nachrichten der Standards XBau und XBreitband, werden für die ausgewählten Anhänge der Dateiname und eine UUID als Metadaten in die jeweilige Nachricht eingetragen (im Element *anhangOderVerlinkung*). Dateiname und UUID werden ebenso in der Submission-API dem Metadatensatz der Einreichung übergeben. + +Über "Senden" wird die Nachricht abgeschickt. Ist ein Subscriber-Konto eingerichtet, lassen sich Nachrichten über das Hauptmenü "Extras" abrufen. + +Die Behörde als Subscriber ("Tiefbauamt") kann aus dem passenden Nachrichtenschema eine Antwort generieren und den zugehörigen Fall referenzieren. + + + +Im Verzeichnisbaum werden unterhalb des FIT-Connect-Konto für den Sender ("Antragsteller") und Empfänger ("Tiefbauamt") die jeweils gesendeten und empfangenen Nachrichten fallbasiert in einem Ordner angezeigt. + + + +## Roadmap + +Nutzer und Nutzerinnen des Tool sind aufgerufen, Vorschläge zur Implementierung weiter Features und Funktionalitäten einzureichen. + +Bislang sind die Erfahrung mit der Nutzung von XTA-Konten begrenzt. Wer Interesse an der Nutzung dieser Funktion hat, möge sich bei der XLeitstelle melden. + +## Neue Features der Versionen 1.3 + +- Integration des Rückkanals von FitConnect in die Java-Bibliotheken und Anpassung der Darstellung bzw. Benutzerführung zur Beantwortung von Nachrichten. + +- Einführung einer Suchfunktion. + +- Aufgrund des laufenden Bugfixing wird empfohlen, die jeweils aktuellste Version zu nutzen. + +[^1]: Wenn Typ-3-Codelisten noch nicht im XRepository verfügbar sind oder nur lokal getestet werden sollen, müssen sie im gleichen Verzeichnis wie die Schemata liegen. + +[^2]: Codelisten im XML-Format, die nicht zum XRepository gehören, lassen sich als Typ-4-Codelisten in die Nachrichten einbinden. Ein Beispiel für eine externe Codeliste ist "Planarten" aus der GDI-Registry: https://registry.gdi-de.org/codelist/de.xleitstelle.inspire_plu/LandUse/LandUse.de.xml (die *listVersionID* ist hier nicht relevant). diff --git a/installer/Testing/XML-Nachrichtentool_1.2.3.exe b/installer/Testing/XML-Nachrichtentool_1.2.3.exe deleted file mode 100644 index cbae0e382dc6f2f060649f0fe0e2eec292e15173..0000000000000000000000000000000000000000 Binary files a/installer/Testing/XML-Nachrichtentool_1.2.3.exe and /dev/null differ diff --git a/installer/Testing/XML-Nachrichtentool_1.2.5.exe b/installer/Testing/XML-Nachrichtentool_1.2.5.exe deleted file mode 100644 index 43e60c08c4304787ef706c036d78183a272ca07a..0000000000000000000000000000000000000000 Binary files a/installer/Testing/XML-Nachrichtentool_1.2.5.exe and /dev/null differ diff --git a/installer/Testing/XML-Nachrichtentool_1.2.6.exe b/installer/Testing/XML-Nachrichtentool_1.2.6.exe deleted file mode 100644 index fdedc08c259684650b3d1fd173db10682492b11a..0000000000000000000000000000000000000000 Binary files a/installer/Testing/XML-Nachrichtentool_1.2.6.exe and /dev/null differ diff --git a/installer/XML-Nachrichtentool_1.1.5.3.zip b/installer/XML-Nachrichtentool_1.1.5.3.zip deleted file mode 100644 index e9561166637dbe4df33d77d778591b38329885c4..0000000000000000000000000000000000000000 Binary files a/installer/XML-Nachrichtentool_1.1.5.3.zip and /dev/null differ diff --git a/installer/XML-Nachrichtentool_1.2.6.2.zip b/installer/XML-Nachrichtentool_1.2.6.2.zip deleted file mode 100644 index ed48726fa6f06a88e0a496ab3bc98562c377c3fe..0000000000000000000000000000000000000000 Binary files a/installer/XML-Nachrichtentool_1.2.6.2.zip and /dev/null differ