DokuWiki - ISSP FTP4ELO/DDI

Diese Seite ist nicht editierbar. Sie können den Quelltext sehen, jedoch nicht verändern. Kontaktieren Sie den Administrator, wenn Sie glauben, dass hier ein Fehler vorliegt.
====== SimpleDataGateway (SDG) ======

Das Simple Data Gateway ist eine WebApplikation, die auf dem Datenquellenkonzept von FTP4ELO/DDI aufbaut, resp. mit diesem kompatibel ist. Es handelt sich um eine WebApp, die mittels JDBC Datenverbindungen aufbaut, das parametrierte ausführen von Queries ermöglicht und diese in Form einer JSON Notation oder in Form einer XML Notation zurückgibt. Die WebApplikation hat im Grunde eine Standalone Variante, wurde aber im Zuge von Anpassungen so erweitert, dass sie die Konfigurationen von DDI lesen und verarbeiten kann.

===== Konfigurationshierarchie =====

  * Workspace: der Workspace enthält alle Konfigurationen (in DDI Datenquellen) und Queries
      * Config: ident mit der Datenquelle in DDI/FTP4ELO, hier sollen unterschiedliche Datenquellen angesteuert werden könne (bspw. TEST/PROD etc.)
        * Query: eine Query ist eine SQL-Query. Jede SQL-Query kann mit Parametern ausgestattet werden.

===== Konfiguration =====

  - Konfigurieren Sie die Datenquellen im Config-Tool
    - Achtung: die dataSources.json Datei im Konfigurationsverzeichnis ist ausschließlich für die WebApp gedacht, zzt. werden die Datenquellen immer noch in der server.xml Datei führend gespeichert.
  - Konfigurieren Sie die Abfragen mittels Config-Tool oder im Dateisystem (Config-Verzeichnis Queries)
  - In den Queries kann mit Platzhalter gearbeitet werden. Folgende Formatierungen sind zulässig
    - {Platzhalter} (DDI Notation)
    - {$Platzhalter} (alternative Notation)
    - %Platzhalter% (BLP Formatierung)

===== Installation =====

  - Installieren Sie eine Java Version (8+) oder nehmen Sie jene von DDI/FTP4ELO
  - Installieren Sie eine aktuelle Tomcat Version von Version 10+ (alle Versionen vor Dezember 2023 benötigen Version 9!). Wichtig ist hier, dass mit Tomcat 10 auf die neue ServletAPI 5.0 umgestellt worden ist und sich die Namespaces von javax.servlet alle auf jakarta.servlet verschoben haben
  - Kopieren Sie die benötigten Java Libraries in den Lib-Pfad des Tomcat Verzeichnisses. Vermeiden Sie die DB2 Library vor allem dann, wenn Sie sie nicht benötigen. Ansonsten schlagen hier immer Fehlermeldungen im Error-Log rund um die nicht vorhandene Library "pdq.jar" auf. Bei den ELO Tomcats werden hier Konfigurationsdateien angepasst, die das JAR Scanning für den JDBC Treiber von DB2 unterbinden.
    - SQL-Server: sqljdbc-7.4.jar (ELO 20/ELO 23)
    - Oracle: ojdbc11-23.2.0.0.jar (ELO 20/ELO 23)
    - PostGre-SQL: postgresql-42.6.0.jar
    - MariaDB: [[https://mariadb.com/kb/en/about-mariadb-connector-j/|Downloadlink für MariaDB Connector/J]]
    - MySQL: [[https://dev.mysql.com/downloads/connector/j/]|Downloadlink für MySQL/J]]

===== Embedded Betrieb des SDG in DDI/FTP4ELO =====

Ab Version 3.80 ist das SDG Bestandteil des DDI Pakets. Es ist somit hier nicht mehr notwendig einen eigenen Tomcat aufzusetzen, um das SDG zu betreiben, es steht einfacherweise direkt über den URI /sdg/sdg zur Verfügung. Wenn also der DDI/FTP4ELO hier auf Port 8040 (Default) lauscht dann ist das SDG über den URL http://localhost:8040/sdg/sdg erreichbar. Zusätzliche JAR-Dateien zur Datenbanktreiber müssen somit in das Lib-Verzeichnis des DDI/FTP4ELO eingespeist werden. Anders als bei der Web-Applikation gibt es hier keine echte Statusseite, da hier direkt das Servlet in den Hauptkontext des Dienstes eingespielt wird.