Installationsanleitung

Diese Anleitung richtet sich an Administratorinnen und Administratoren, die den eNoVA-Editor für ihre Kommune bereitstellen möchten.

1. eNoVA-Editor herunterladen

Laden Sie die aktuelle Version des eNoVA-Editors von der GitHub-Releases-Seite herunter.

Zu den GitHub Releases

Laden Sie die Datei eNoVA-editor-<Version>.zip herunter.

Windows-Sicherheitswarnung vermeiden

Windows kann heruntergeladene ZIP-Dateien als Dateien aus dem Internet markieren. Um eine mögliche Sicherheitswarnung beim Start zu vermeiden, entsperren Sie die ZIP-Datei vor dem Entpacken mit PowerShell:

Unblock-File -LiteralPath ".\eNoVA-editor-0.9.2.zip"

Passen Sie den Dateinamen an die heruntergeladene Version an. Entpacken Sie die ZIP-Datei anschließend wie gewohnt.

2. Installation

Entpacken Sie die ZIP-Datei in das gewünschte Installationsverzeichnis. Bei Windows ist dies üblicherweise das neu zu erstellende Verzeichnis C:\Program Files\eNoVA-Editor

Die Verzeichnisstruktur darf dabei nicht verändert werden.

eNoVA-editor/
├── app/
├── codelists/
├── Input.htm
├── Output.htm
├── sender-config.xml
├── caseworkers.xml
├── decision-config.xml
├── xml-output-config.xml
├── codelists.properties
├── help-config.properties
├── answer-transform.xsl
├── schriftgutobjekte.xml
└── eNoVA-editor.cmd
    

Eine separate Java-Installation ist nicht erforderlich. Die benötigte Java-Laufzeitumgebung ist Bestandteil des eNoVA-Editor-Pakets.

Online-Hilfe konfigurieren (optional)

Über den Link Hilfe rechts oben öffnet sich die Online-Hilfe im Standardbrowser. Die IT kann die Adresse in der UTF-8-Datei help-config.properties im Hauptverzeichnis neben eNoVA-editor.cmd anpassen:

help.url=https://enova-editor.oss.muenchen.de/

Fehlen Datei oder help.url, oder ist der Eintrag leer, wird die Standard-Hilfeseite https://enova-editor.oss.muenchen.de/ verwendet. Eine ungültige Adresse oder nicht lesbare Konfiguration wird beim Start gemeldet; der Editor bleibt nutzbar.

3. Absender konfigurieren

Öffnen Sie die Datei sender-config.xml.

Tragen Sie dort den Namen Ihrer Kommune bzw. Behörde ein.

Beispiel:

<sender>
    <name>Gemeinde Musterstadt</name>
</sender>
    

Dieser Name wird vom eNoVA-Editor unter anderem bei der Erzeugung der XJustiz-Antwort verwendet.

4. Sachbearbeiter konfigurieren

Die im eNoVA-Editor auswählbaren Sachbearbeiterinnen und Sachbearbeiter werden in einer Datei caseworkers.xml gespeichert.

Ist im Installationsverzeichnis eine caseworkers.xml vorhanden, wird ausschließlich diese verwendet. Die Kontaktdaten werden dann zentral gepflegt, die Schaltfläche „Kontaktdaten“ wird nicht angezeigt.

Ist im Installationsverzeichnis keine caseworkers.xml vorhanden, zeigt das Feld „Sachbearbeiter*in“ den eigenen Kontakt mit Vor- und Nachnamen an, daneben erscheint die Schaltfläche „Kontaktdaten“. Darüber legt jede Benutzerin und jeder Benutzer genau einen eigenen Kontakt an und kann ihn anschließend bearbeiten. Ein Löschen ist nicht vorgesehen. Der Kontakt wird im Benutzerverzeichnis gespeichert: %APPDATA%\eNoVA-Editor\caseworkers.xml. Änderungen stehen sofort ohne Neustart zur Verfügung.

Ist die Datei im Benutzerverzeichnis fehlerhaft oder enthält sie mehr als einen Eintrag, wird sie in caseworkers.xml.ungueltig umbenannt und der Kontakt muss über „Kontaktdaten“ neu angelegt werden.

5. Sachentscheidungen konfigurieren

In der Datei decision-config.xml wird festgelegt, welche Sachentscheidungen für ein bestimmtes Ersuchen ausgewählt werden können.

Für jeden Request-Code werden die erlaubten Decision-Codes angegeben.

Beispiel:

<request code="011">
    <decision code="019"/>
    <decision code="020"/>
    <decision code="031"/>
</request>
    

6. XML-Ausgabe konfigurieren

In der Datei xml-output-config.xml wird festgelegt, welche Zeilenenden beim Speichern der erzeugten XML-Datei verwendet werden.

Erlaubte Werte sind CRLF, LF, CR und NONE.

Beispiel:

<xmlOutput>
    <lineEnding>LF</lineEnding>
</xmlOutput>
    

7. Anpassbare Dateien

Folgende Dateien können bei Bedarf angepasst werden:

Änderungen an diesen Dateien betreffen die Darstellung im Browser. Die eigentliche XJustiz-Antwort-XML wird dadurch nicht direkt definiert.

8. Technische Dateien

Die folgenden Dateien und Verzeichnisse gehören zur technischen Konfiguration bzw. Programmlogik und sollten normalerweise nicht verändert werden.

app/

Enthält die Anwendung, ihre benötigten Bibliotheken und die mitgelieferte Java-Laufzeitumgebung.

Dateien in diesem Verzeichnis sollten nicht manuell verändert, verschoben oder gelöscht werden.

codelists/

Enthält die XML-Dateien der vom eNoVA-Editor verwendeten XJustiz-Codelisten.

Verwendung: Codelisten übersetzen technische Codes in verständliche Bezeichnungen oder liefern die zulässigen Werte für Auswahlfelder.

Beispielsweise wird die Auswahl „Sachentscheidung“ aus einer Codelist dieses Verzeichnisses aufgebaut.

Auch bei der Darstellung einer XJustiz-Nachricht können technische Codes, beispielsweise Rollen- oder Telekommunikationsarten, mit Hilfe dieser Dateien in ihre Bezeichnungen aufgelöst werden.

Konfiguration: Welche konkrete Codelist-Datei für einen bestimmten Zweck verwendet wird, legt die Datei codelists.properties fest.

Die Dateien sollten nicht einzeln ersetzt oder verändert werden, ohne zu prüfen, ob Codelist-Version und Konfiguration weiterhin zusammenpassen.

codelists.properties

Diese Datei verbindet die im eNoVA-Editor verwendeten Codelist-Namen mit den dazugehörigen XML-Dateien im Verzeichnis codelists/.

Beispiel: sachentscheidung.file legt fest, welche Datei ENOVA.Sachentscheidung-*.xml für das Auswahlfeld „Sachentscheidung“ verwendet wird.

Zusätzlich beschreibt die Datei, wie die Codelist-XML-Dateien technisch aufgebaut sind. Dazu gehört beispielsweise, welche Spalte den technischen Code und welche Spalte die sichtbare Bezeichnung enthält.

Der Ablauf ist vereinfacht:

codelists.properties
        ↓
legt die verwendete Codelist-Datei fest
        ↓
codelists/*.xml
        ↓
technischer Code → sichtbare Bezeichnung
    

Änderungen an codelists.properties können dazu führen, dass eine andere Codelist-Version oder eine nicht passende Datei verwendet wird. Änderungen sollten daher nur gezielt vorgenommen werden.

answer-transform.xsl

Diese Datei enthält die XSLT-Transformation zur Erzeugung der XJustiz-Antwort.

Verwendung: Beim Erzeugen einer Antwort übergibt der eNoVA-Editor die zuvor eingelesene XJustiz-XML zusammen mit den Eingaben aus der Anwendung an diese XSLT-Datei.

Dazu gehören aktuell unter anderem:

Die XSLT-Datei legt anschließend fest, an welchen Stellen diese Werte in der erzeugten XJustiz-Antwort verwendet werden und welche Inhalte der ursprünglichen Nachricht übernommen oder verändert werden.

Der Ablauf ist vereinfacht:

eingehende XJustiz-XML
        +
Benutzereingaben
        ↓
answer-transform.xsl
        ↓
XJustiz-Antwort-XML
    

Änderungen wirken sich direkt auf die erzeugte XJustiz-Antwort aus. Fehlerhafte Änderungen können dazu führen, dass falsche Inhalte erzeugt werden oder die Antwort nicht mehr dem erwarteten XJustiz-Format entspricht. Änderungen sollten daher nur mit entsprechenden XSLT- und XJustiz-Kenntnissen vorgenommen und anschließend getestet werden.

schriftgutobjekte.xml

Diese Datei enthält den vorgegebenen Schriftgutobjekte-Bereich für die erzeugte XJustiz-Antwort.

Die answer-transform.xsl ersetzt den vorhandenen Schriftgutobjekte-Bereich aus der Eingabe-XML vollständig durch den Inhalt dieser Datei.

Die Datei muss sich im Installationsverzeichnis neben answer-transform.xsl befinden. Sollen weitere Dateien mit der beBPo-Nachricht übermittelt werden, müssen diese ebenfalls in dieser XML-Datei eingetragen werden.

eNoVA-editor.cmd

Startet den eNoVA-Editor unter Windows.

Die Datei setzt beim Start das Installationsverzeichnis als Anwendungsverzeichnis und startet anschließend die mitgelieferte Java-Laufzeitumgebung aus dem Verzeichnis app/.

Die Datei sollte normalerweise nicht verändert werden.

9. Berechtigungen

Der eNoVA-Editor erzeugt die HTML-Ansichten und die Antwortdateien im selben Verzeichnis wie die geöffnete XML-Datei.

Für die normale Nutzung sind keine Schreibrechte auf das Installationsverzeichnis erforderlich. Ist im Installationsverzeichnis keine caseworkers.xml vorhanden, werden für die Kontaktdaten Schreibrechte auf das Benutzerverzeichnis %APPDATA%\eNoVA-Editor benötigt.
Sollen die Konfigurationsdateien wie sender-config.xml, caseworkers.xml, decision-config.xml, xml-output-config.xml, Input.htm oder Output.htm administrativ geändert werden, hat das nicht durch die Sachbearbeiter zu erfolgen, sondern durch die zentrale IT, die die entsprechenden Rechte hat.

10. Anwendung starten

Starten Sie den eNoVA-Editor über:

eNoVA-editor.cmd

Nach dem Start kann eine XJustiz-XML-Datei über die Anwendung geöffnet und verarbeitet werden.

Für einen ersten Test kann die Datei xjustiz_nachricht_beispiel_ersuchenSachentscheidung_mehrfach.xml aus dem Verzeichnis demo-output heruntergeladen und verwendet werden.

Wichtig: Die heruntergeladene XML-Datei muss in einem Verzeichnis abgelegt werden, in dem der Benutzer Schreibrechte besitzt, beispielsweise in einem Unterverzeichnis von Dokumente. Sie darf keinesfalls im Installationsverzeichnis C:\Program Files\eNoVA-Editor abgelegt werden, da der eNoVA-Editor die erzeugten Dateien im selben Verzeichnis wie die geöffnete XML-Datei speichert.