stadt-bielefeld / auik

Das freie Anlagen- und Indirekteinleiterkataster (AUI-K) erfasst standortbezogene Informationen zu Anlagen zum Umgang mit wassergefährdenden Stoffen (AwsV) und Indirekteinleitern.
https://stadt-bielefeld.github.io/auik/
GNU Lesser General Public License v2.1
4 stars 6 forks source link

Willkommen zu AUI-K

License Build GitHub release (latest by date including pre-releases)

Das freie Anlagen- und Indirekteinleiterkataster

Das freie Anlagen- und Indirekteinleiterkataster (AUI-K) erfasst standortbezogene Informationen zu Anlagen zum Umgang mit wassergefährdenden Stoffen (AwsV) und Indirekteinleitern. Durch die gemeinsame Datenbasis mit geografischen Daten können Sachdaten mit den erfassten Informationen verschnitten werden. Darüber hinaus können automatisch Einträge in Datensätze aufgrund ihrer räumlichen Zugehörigkeit zu beispielsweise Entwässerungsgebieten, Wasserschutzgebieten etc. generiert werden.

Entwicklungsumgebung

Aufsetzen der Datenbank

Für das Aufsetzen einer Entwicklungsumgebung wird zuerst eine PostgreSQL-Datenbank benötigt. Diese kann über das vorhandene Dockerfile erstellt werden:

docker build -t auik/db -f docker/Dockerfile .
docker run --name auik_db -p15432:5432 -v $PWD/data/db:/opt/auik_db -d auik/db

Die Datenbank ist dann unter Port 15432 mit dem Datenbanknamen fisumwelt erreichbar. Ein Login ist möglich als Nutzer auikadmin mit dem Passwort secret.

Alternativ kann die Datenbank über die Skripte in data/db manuell erstellt werden.

cd data/db
psql --command "CREATE DATABASE fisumwelt;"
psql -d fisumwelt --command "CREATE EXTENSION postgis;"
psql -d fisumwelt --command "CREATE USER auikadmin with password 'secret';"
psql -d fisumwelt -f version1_0_schema.sql
psql -d fisumwelt -f updateTo_1_1_0.sql

Optional können Beispiel-Daten importiert werden. Im Docker-Setup erfolgt das automatisch.

Konfigurieren der Anwendung

Vor dem Starten der Anwendung muss in der auik.properties der Eintrag auik.system.dburl gesetzt werden um die Verbindung mit der Datenbank zu ermöglichen.

Beispielweise mit einer Datenbank erreichbar unter localhost:15432 mit dem Datenbank-Namen fisumwelt:

auik.system.dburl=jdbc\:postgresql\://localhost\:15432/fisumwelt

Starten der Anwendung

Für die Anwendung selbst müssen maven und ein passendes JDK ab Version 11 (bspw. OpenJDK 11) installiert sein.

Kompilieren und Starten der Anwendung:

mvn clean compile exec:java

Für die Anmeldung kann der Datenbankbenutzer verwendet werden:

auikadmin, Passwort: secret

Aufsetzen der Anwendung

Wie für die Entwicklungsumgebung wird eine Datenbank benötigt. Grundsätzlich funktioniert das Aufsetzen wie unter Aufsetzen der Datenbank angegeben, es sollten aber die jeweiligen Anforderungen für den produktiven Betrieb berücksichtigt werden.

Erstellen eines JAR:

mvn clean package

Das JAR ist im Ordner target zu finden und kann von dort an sein Ziel bewegt werden.

Die Konfiguration erfolgt wie unter Konfigurieren der Anwendung angegeben. Die Konfigurationsdatei muss sich zum starten der Anwendung im selben Verzeichnis befinden wie das JAR.

Starten der Anwendung:

java -jar auik_prod-*.jar

Für die Anmeldung kann der Datenbankbenutzer verwendet werden.

AUI-K Handbuch

Das AUI-K Handbuch ist als pdf-Datei unter doc/AUI-K_Handbuch.pdf zu finden.

Datenimport

Mithilfe des mitgelieferten SQL-Skripts können Adressdaten als CSV in die Datenbank importiert werden. Die entsprechende CSV-Datei muss eine Titel-Zeile und folgende Spalten enthalten:

namezus,wirtschaftszweig,name,namebetrbeauf,vornamebetrbeauf,email,telefon,telefax,plz,ort,strasse,hausnr,hausnrzus,bemerkungen

Tatsächlich wird die erste Zeile der CSV-Datei ignoriert, aber der Inhalt der Spalten muss den genannten Spalten im Datenbank-Schema entsprechen.

Die CSV Beispieldatei kann hier als Vorlage dienen.

Der Import selbst lässt sich bspw. über eine Kommandozeile auslösen:

cd data/db
psql -d fisumwelt -f import_csv.sql <import.csv

fisumwelt ist hier der Datenbankname, je nach Datenbank-Setup müssen ggf. weitere Parameter ergänzt werden.

Manche der importierten Daten werden nur beim Start der Anwendung geladen, so dass ein Neustart der Anwendung nach dem Import erforderlich ist, damit alle Daten korrekt dargestellt werden.

Anpassen von Feldbeschriftungen

Mithilfe von .properties Dateien können die Beschriftungen von Feldern angepasst werden. Die verfügbaren Einträge finden sich in der auik_de_DE.properties. Eine Anpassung kann entweder in der genannten Datei erfolgen oder über eine separate Datei. Letztere kann dann in der auik.properties ohne Sprachkürzel und Dateiendung angegeben werden.

Bspw. wäre der Eintrag in der auik.properties für eine Datei exampleFile_de_DE.properties:

auik.i18n_file=exampleFile