Zum Inhalt

Erste Schritte

Diese Anleitung beschreibt, wie Sie die XJustiz-Werkzeuge zum ersten Mal lokal starten und ausprobieren — vom Entpacken des Downloadpaket bis zur ersten validierten XJustiz-Nachricht. Es sind keine Installation und keine Administratorenrechte erforderlich.

Voraussetzungen

  • Java ab Version 17 (JRE oder JDK). Ob Java installiert ist, prüfen Sie im Terminal bzw. in der Eingabeaufforderung:

    java -version

    Wird eine Version 17 oder höher angezeigt, sind Sie startklar. Andernfalls installieren Sie zunächst ein aktuelles Java (z. B. ein OpenJDK-Paket Ihrer Wahl).

  • Das Auslieferungspaket der XJustiz-Werkzeuge. Die für den Betrieb freigegebene Version der XJustiz-Werkzeuge finden Sie in dem öffentlich zugänglichen Code-Repository: gitlab.opencode.de.

Schritt 1: Entpacken

Laden Sie das Downloadpaket herunter und entpacken Sie es. Im entpackten Ordner finden Sie unter anderem:

XJustiz-Tools/
├── config/                        Konfigurationsdateien des Servers
├── doc/                           Dokumentation und Testdaten
├── fonts/                         Schriften für die PDF-Erzeugung
├── java/                          Java-Bibliothek mit Beispielcode
├── schematrons/                   Ablage für eigene Prüfregeln
├── tools/                         Demo-Webanwendungen und Loader
├── start.bat / start.sh           Start als reiner REST-Server
├── start_demo.bat / start_demo.sh Start der Demo-Anwendung mit Browser
└── xjustiz-tools-exec-1.4.0.jar   Die Anwendung selbst

Schritt 2: Demo-Anwendung starten

Sie können die Demo-Anwendung nutzen, um sich mit dem Werkzeug vertraut zu machen. Das Starten der Demo-Anwendung unterscheiden sich je nach Betriebssystem:

Windows

Im Installationsordner die Datei start_demo.bat per Doppelklick ausführen. Das Skript prüft, ob Java verfügbar ist und startet die XJustiz-Werzkzeuge im Browser. Im Hintergrund öffnet sich ein Konsolenfenster.

Linux und macOS

Um das Skript start_demo.sh nutzen zu könnnen, muss einmalig folgender Befehl in die Konsole eingegeben werden:

cd /pfad/zu/XJustiz-Tools
chmod +x start_demo.sh
./start_demo.sh

Das Skript startet den Server im Hintergrund (die Prozess-ID wird ausgegeben) und öffnet den Browser.

Was beim Start passiert

  1. Im Browser öffnet sich zunächst die lokale Ladeseite tools/loader.html mit einem Fortschrittsbalken.
  2. Die Ladeseite prüft in Intervallen, ob der Server auf Port 8888 erreichbar ist. Der erste Start kann einen Moment dauern.
  3. Sobald der Server bereit ist, werden Sie automatisch auf die Startseite mit den Werkzeug-Kacheln weitergeleitet (http://localhost:8888/index.html).

Demo-Modus ist nur für Test und Erprobung gedacht

Die Demo-Startskripte starten die Anwendung mit dem Parameter -DdemoMode. Dabei sind die Sicherheitsfeatures SSL und CORS deaktiviert. Für den Produktivbetrieb nutzen Sie start.bat / start.sh mit konfigurierter Transportverschlüsselung (siehe Konfiguration).

Schritt 3: Erster Funktionstest

Im Lieferumfang sind Testdaten enthalten (Ordner doc/testdaten/), mit denen sich die Werkzeuge sofort ausprobieren lassen.

Eine XJustiz-Nachricht validieren

  1. Auf der Startseite die Kachel XJustiz-Validierung öffnen.
  2. Die Testdatei doc/testdaten/Validator/xjustiz-Akte-Teilakte-362.xml per Drag & Drop hochladen.
  3. Die Validierung starten — als Ergebnis erhalten Sie einen Validierungsreport und eine interaktive Baumansicht der Nachricht.

Eine XJustiz-Nachricht als PDF ausgeben

  1. Auf der Startseite die Kachel XJustiz → PDF öffnen.
  2. Die Testdatei doc/testdaten/Konverter/XJustiz_nach_PDF/xjustiz_nachricht_mitAkte_Teilakten.xml hochladen.
  3. Die Konvertierung starten — das erzeugte PDF wird direkt in der Vorschau angezeigt und kann heruntergeladen werden.

Anwendung beenden

  • Windows: Das Konsolenfenster schließen (oder darin Strg+C drücken).

  • Linux/macOS: Der Server läuft im Hintergrund; das Skript gibt beim Start die Prozess-ID (PID) aus. Beenden mit:

    kill <PID>

    Falls die PID nicht mehr bekannt ist, lässt sie sich über den Port ermitteln: lsof -ti :8888.

Start als reiner REST-Server

Wer die Werkzeuge nicht über die Demo-Oberfläche, sondern als REST-Schnittstelle für eine Fachanwendung nutzen möchte, startet stattdessen start.bat / start.sh. In dieser Betriebsart:

  • öffnet sich kein Browser — die Anwendung stellt nur die REST-Schnittstelle bereit,
  • ist SSL aktiv; für den Produktivbetrieb muss zuvor ein eigenes Zertifikat hinterlegt werden (siehe Konfiguration),
  • beschreibt die Datei doc/xjustiz-tools.yaml (OpenAPI) alle verfügbaren Endpunkte.

Für erste Tests der Schnittstelle kann die Anwendung auch hier im Demo-Modus (-DdemoMode, ohne SSL) gestartet und z. B. mit einem Swagger-/OpenAPI-Editor erprobt werden.

Wenn etwas nicht klappt

Problem Ursache und Lösung
Meldung „Java nicht gefunden" Java ist nicht installiert oder nicht im PATH. Java 17+ installieren und mit java -version prüfen.
Fehler „Port 8888 already in use" Auf dem Port läuft bereits ein anderes Programm (häufig z. B. Jupyter). Entweder das andere Programm beenden (macOS/Linux: lsof -i :8888, Windows: netstat -ano \| findstr 8888) oder den Werkzeuge-Port ändern (siehe Konfiguration).
Der Browser öffnet sich nicht automatisch Die Datei tools/loader.html manuell im Browser öffnen — oder direkt http://localhost:8888/index.html aufrufen, sobald der Server läuft.
Die Ladeseite wartet endlos Prüfen, ob der Server läuft (Konsolenfenster bzw. Protokolldatei xjustiz-tools.log im Installationsordner) und ob der Port in tools/loader-config.js zum Server-Port passt.
Warnungen zu Codelisten beim Start Die Werkzeuge laden Typ-3-Codelisten aus dem XRepository nach. Ohne Internetzugang bzw. hinter einem Proxy siehe die Hinweise zu Codelisten und Proxy unter Konfiguration.

Nächste Schritte