GIP Datenbank

Vorrausetzungen

• Java 8 mit installierter Java Cryptography Extension
  • Muss auch nach jedem Update neu installiert werden
• Windows (für das Startskript; muss für Linux angepasst werden)

Installation

• Aktuelle Version herunterladen: http://web.informatik.uni-mannheim.de/joschoen/gipdb/
• Eventuell laufende Instanz der Anwendung beenden
• ZIP-Datei in den gewünschten Installationsordner entpacken

Installation der Java Cryptography Extension (JCE)

• Aktuelle Version der JCE herunterladen: http://www.oracle.com/technetwork/java/javase/downloads/index.html
• JAR-Dateien aus dem Archiv nach <java-home>\lib\security kopieren

Zertifikate importieren

• Zertifikate können mit dem Java-keytool importiert werden
• Es müssen alle 3 Stammzertifikate der Uni Mannheim/des DFN mit unterschiedlichem Alias in den Keystore importiert werden
• Der private key der zur Erstellung des certificate request verwendet wird muss sich im Keystore befinden
• Das ausgestellte Zertifikat muss mit dem gleichen Alias wie der private ke importiert werden
• Sonst sollte sich kein Zertifikat im Keystore befinden

Anwendung starten

• Die Konfigurationsdateien conf/application-prod.conf und conf/logback-prod.xml müssen in den übergeordneten Ordner der Anwendung kopiert werden.
• Hierfür muss der Pfad zum Zertifikatspeicher, die Passwörter für diesen und das Mailkonto, und der Speicherort des geheimen PGP-Schlüssel angegeben werden:
• gip-database.bat -Dplay.server.https.keyStore.path=PATH/TO/KEYSTORE -Dplay.server.https.keyStore.password=KEYSTORE-PASSWORD -Dplay.mailer.password=MAIL-PASSWORD -Dapp.gpg.secret=SECRET-PGP-KEY-LOCATION
• siehe auch HTTPS einrichten
• Bei erfolgreichem Start sollte die letzte Zeile ungefähr lauten: [info] p.c.s.NettyServer - Listening for HTTP on /0:0:0:0:0:0:0:0:443
• Die Eingabeaufforderung bleibt geöffnet so lange der Server läuft. Die Anwenung lässt sich durch STRG + C stoppen.

Nach dem ersten Starten (Datenbank noch leer; einmalig, wird nicht nach Updates benötigt)

• Anwendung über den Link [SERVER-URL]/init initialisieren (z.B. https://localhost/init)
• Login-Daten werden dort angezeigt
• Mitarbeiter-Login verwenden um einen neuen Benutzer mit sicherem Passwort anzulegen
• Standardbenutzer löschen

Backup der Datenbank und Anhänge

• Die Datenbank befindet sich im Ordner db innerhalb des Installationsordners
  • Es handelt sich um eine H2 Datenbank mit Standardbenutzer
• Dateianhänge befinden sich im Ordner attachments innerhalb des Installationsordners (noch nicht Teil der Anwendung)

Zurücksetzen der Datenbank

• Hierfür muss das Skript reset_database.bat im Installationsordner der Anwendung gestartet werden. Die Anwendung darf hierbei nicht laufen. ACHTUNG: Es wird kein Backup erstellt!

Rudimentäres SQL-Interface

• Unter [SERVER-URL]/sql befindet sich ein einfaches SQL-Interface zum Ausführen von Abfragen.

Anpassung der Mailadressen und Mailtexte

ACHTUNG! DIESE EINSTELLUNGEN WERDEN BEIM INSTALLIEREN EINER NEUEN VERSION ÜBERSCHRIEBEN! VORHER SICHERUNG ERSTELLEN UND DANACH WIEDER HERSTELLEN!

• Mailadressen
  • Die Mailadressen können in der Datei [INSTALLATIONSORDNER]/conf/application-prod.conf angepasst werden
  • Die entsprechenden Parameter können unter app.mail gesetzt werden
  • Die to-Adresse muss genau eine EMailadresse sein
  • Im cc sind mehrere Adressen durch ; getrennt erlaubt
• Mailtexte
  • Die Mailtexte können in der Datei [INSTALLATIONSORDNER]/conf/messages angepasst werden
  • Format/Syntax:
    • Ein Zeilenumbruch kann durch \n\ erzeugt werden.
    • {0}, {1}, … sind Platzhalter für Daten oder Namen, die automatisch eingefügt werden. Diese dürfen nicht entfernt oder hinzugefügt werden.
    • Leerzeichen oder Tabs am Anfang einer Zeile werden genau so in die Mail übernommen.

Automatischer Import von Spreadsheets aus Emails und Weiterleitung von Emails

Emails die an die konfigurierte Adresse (gipdatab@mail.uni-mannheim.de) geschickt werden, können über die Oberfläche abgeholt und automatisiert importiert oder an Cervis bzw. Link weitergeleitet werden.

Automatischer Import

Mails die im Betreff die Schlüsselworte “Wochenbericht” oder “DOKU” enthalten werden dementsprechend in die Datenbank importiert. Groß-/Kleinschreibung ist irrelevant.

Automatische Weiterleitung

Für die Weiterleitung an Cervis und Link weitergeleitet mit den jeweils für diese richtig abgeänderten IDs, gibt es die folgenden Schlüsselwörter:

• “Austritt” oder “Deinstallation”
• “Entstörung” oder “Technikerkontakt”

Versionierung

• Neue Major Version (z.B. 2.3.1 -> 3.0.0): API-/ Datenbankänderungen, neue Features, Bugfixes
  • Unbedingt ein Backup der Datenbank durchführen!
• Neue Minor Version (z.B. 2.3.1 -> 2.4.0): Neue Features, Bugfixes
• Neue Patch Version (z.B. 2.3.1 -> 2.3.2): Bugfixes

Dokumentation der Implementierung

Technologien

• Source Code & Issue Management: https://gitlab.dws.informatik.uni-mannheim.de/gip-datenbank/gip-database
  • Ansprechpartner für Zugang: Jörg Schönfisch oder WIM-Support
• Web-Framework: Play 2.4.x
  • Java 8
• Datenbankzugriff (EBean ORM-Mapper, ähnlich zu Hibernate): https://ebean-orm.github.io/
• Datenbank: H2 Datenbank
  • Standardbenutzer, Embedded, In-Memory, Persistenz in einer Datei
• Entwicklung: Jörg Schönfisch

How-Tos

Datenbanktabellen hinzufügen

• Neues SQL-Skript mit fortlaufender Nummer in conf/evolutions/default anlegen
• Unter dist/reset_databases.sql die neuen Tabellen einfügen