Technische Rahmenbedingungen
Dieses Dokument richtet sich an IT-Fachpersonal, das die XJustiz-Werkzeuge in Fachanwendungen oder E-Akten-Systeme einbinden oder als eigenständige Anwendung in einer Behörde bereitstellen möchte. Es beschreibt die technischen Rahmenbedingungen für Einbindung und Betrieb. Eine detaillierte Schnittstellenbeschreibung steht als YAML-Datei (OpenAPI) im Lieferumfang der XJustiz-Werkzeuge zur Verfügung.
Bereitstellung und Dokumentation
Bezug und Versionierung
Die Distribution der XJustiz-Werkzeuge steht im Download-Portal der Governikus GmbH & Co. KG zum Download bereit. Sie erhalten Zugang zum Download-Portal, indem Sie sich zum XJustiz-Werkzeuge-Newsletter anmelden.
In der Anfangsphase ist ein Veröffentlichungsrhythmus von etwa einer neuen Version pro Monat geplant. Langfristig richtet sich die Häufigkeit nach den eingehenden Anforderungen und Änderungsanfragen.
Die Aktualisierung erfolgt durch einfaches Ersetzen der vorhandenen Dateien durch die neue Version — eine gesonderte Installation ist nicht erforderlich.
Dokumentationsumfang
Im Downloadpaket sind folgende Dokumente enthalten:
- Schnittstellenspezifikation im YAML- und HTML-Format
- Release-Notes zur jeweiligen Version
- README mit Hinweisen zur Inbetriebnahme und Konfiguration
Alle für Integration und Betrieb relevanten Informationen sind in den genannten Unterlagen enthalten.
Deployment und Abhängigkeiten
Die XJustiz-Werkzeuge müssen nicht installiert werden. Die Dateien werden lediglich am gewünschten Ort abgelegt; weitere Konfigurationen werden über Startparameter vorgenommen. Hinweise zum Start der Werkzeuge finden Sie in der README-Datei.
Die Formulare können nach dem Start der Werkzeuge im Browser geöffnet und ausgefüllt werden.
Für die Ausführung wird mindestens Java JRE 17 benötigt. Darüber hinaus ist geplant, die XJustiz-Werkzeuge künftig auch als Docker-Container anzubieten.
Die für XJustiz-Nachrichten benötigten Codelisten (Wertelisten vom Typ 3, d. h. kein fester Bestandteil des XJustiz-Standards) werden standardmäßig täglich nachts automatisch aus dem XRepository heruntergeladen. Dieses Verhalten sowie Uhrzeit, Zielverzeichnis und gegebenenfalls Proxy-Parameter können über Startparameter gesteuert oder vollständig deaktiviert werden.
Offline-Betrieb
Für einen Offline-Betrieb können die Codelisten manuell aus dem XRepository heruntergeladen werden, beispielsweise über folgenden Endpunkt (Beispiel für XJustiz 3.6.2):
Architektur und Systemumgebung
Es gibt zwei Möglichkeiten, die XJustiz-Werkzeuge zu betreiben:
- Die Werkzeuge werden zum einen als Spring-Boot-Applikation ausgeliefert und stellen eine REST-Schnittstelle bereit. Der Server wird typischerweise lokal zur einbindenden Fachanwendung betrieben, kann aber auch zentral innerhalb der Behörde oder in einer Cloud-Umgebung laufen.
- Zum anderen steht auch eine Java-Bibliothek zur direkten Integration zur Verfügung.
Die Anwendung ist auf allen Plattformen lauffähig, für die ein Java JRE ab Version 17 verfügbar ist. Unterstützt werden insbesondere Windows und Linux. Die XJustiz-Werkzeuge sind für den Einsatz in Fachanwendungen konzipiert, die den elektronischen Rechtsverkehr unterstützen.
Bei Fragen oder Problemen im Zusammenhang mit der Integration stehen wir Ihnen gerne zur Verfügung. Vorzugsweise ist hierfür das JIRA-System EFEVER der XJustiz-Pflegestelle zu nutzen. Falls Sie keinen Zugang zu diesem System haben, können Sie sich auch direkt an die XJustiz-Pflegestelle wenden.
Hardware und Ressourcen (Produktivbetrieb)
Systemlast und Performance
Die Systemlast im Produktiveinsatz hängt in erster Linie von der Anzahl der zu verarbeitenden Nachrichten ab; die Nachrichtengröße spielt eine nachgeordnete Rolle. Da diese Parameter von der jeweiligen Fachanwendung abhängen, können allgemeingültige Richtwerte nicht angegeben werden.
Belastbare Lasttestwerte liegen noch nicht vor und werden im weiteren Projektverlauf ergänzt. Sollte die Performance in Ihrem Anwendungsfall nicht den Anforderungen genügen, nehmen Sie bitte Kontakt mit uns auf — wir prüfen gemeinsam mögliche Optimierungsmaßnahmen.
Skalierung und Load Balancing
Für den Betrieb der XJustiz-Werkzeuge ist keine Load-Balancing-Architektur erforderlich. Die Verarbeitung erfolgt zustandslos, weshalb keine Session Stickiness benötigt wird. Die Übergabe der Eingabedaten und die Rückgabe der Ergebnisse erfolgt synchron.
Netzwerk und Sicherheit
Die XJustiz-Werkzeuge können auf einen beliebigen Port konfiguriert werden. Setzen Sie dafür in der Datei start_demo.bat den Parameter SERVER_PORT auf den gewünschten Wert.
Für den automatischen Abruf der Codelisten aus dem XRepository muss die folgende URL aus dem Betriebsnetz erreichbar sein:
Detaillierte Hinweise zur Konfiguration der Transportverschlüsselung sowie zur optionalen Einrichtung eines Proxys finden Sie in der README und der YAML-Datei im Lieferumfang der XJustiz-Werkzeuge.
Integration und Umsysteme
Konfiguration und Formate
Falls Sie die XJustiz-Werkzeuge in Ihrer Fachanwendung per REST-Schnittstelle verwenden möchten, muss die Fachanwendung in der Lage sein, diese Schnittstelle anzusprechen. Der Datenaustausch über die REST-Schnittstelle erfolgt im JSON-Format.
Bei der PDF-Visualisierung wird das Ergebnis Base64-kodiert zurückgegeben und muss von der aufrufenden Anwendung dekodiert werden. Die erzeugten PDF-Dateien entsprechen dem Format PDF/A-2b.
Schnittstellen-Design
Die REST-Schnittstelle ist gemäß OpenAPI im YAML-Format spezifiziert; die vollständige Beschreibung ist im Lieferumfang enthalten.
Die Versionierung der Schnittstelle folgt dem Prinzip der Semantischen Versionierung (SemVer). Da die Schnittstelle weitgehend unabhängig von fachlichen Anforderungen ist, wird sie voraussichtlich stabiler bleiben als die Gesamtanwendung. Breaking Changes werden mit einem Vorlauf von ca. 3–6 Monaten im Changelog angekündigt.