Updateanleitung Version 4.47 auf Version 4.49 für Windows

WICHTIGER HINWEIS

Mit der Version 4.49.0 gibt es eine neue Update-Anleitung. Bitte folgen Sie den neuen Update-Schritten.

Update-Reihenfolge

Das Einspielen der Versionen 4.3.0, 4.7.6, 4.11.1, 4.44.1 und 4.49.0 ist zwingend erforderlich und darf nicht übersprungen werden, bevor Sie das Update auf die aktuelle Version vornehmen. Jede Version muss einmal komplett erfolgreich starten und Sie müssen sich einmal an der FTAPI Weboberfläche einloggen, bevor Sie die nächste Version einspielen.

Wenn Ihr FTAPI System derzeit noch auf einer Version < 4.44.1 ist, dann führen Sie bitte zunächst ein Update auf Version 4.44.1 durch.
-> Zur Installationsdatei & Update-Anleitung.

Sollten Sie die FTAPI-Server-Komponenten oder eine Updateanleitung für vorherige Versionen zum Download benötigen, nutzen Sie hierfür bitte das Support-Formular: https://www.ftapi.com/supportanfrage/

Vorbereitung zur Einspielung des Updates

Um sicherzustellen, dass Ihr lokal installierter Dienst Zugriff auf den externen Dienst cdn.ftapi.com hat, führen Sie bitte folgende Schritte durch:

Überprüfen Sie zunächst mit nslookup cdn.ftapi.com die korrekte DNS-Auflösung der Adresse.
Stellen Sie dann sicher, dass Ihre Firewall ausgehende Verbindungen auf den Port 443 (HTTPS) zulässt.
Überprüfen Sie gegebenenfalls die Konfiguration eines eventuell verwendeten Proxy-Servers.
Führen Sie abschließend einen Test durch, um die erfolgreiche Verbindung zu bestätigen.

Der Zugriff auf cdn.ftapi.com wird unter anderem benötigt, um die sicherheitsrelevante Benachrichtigung zu veralteten Outlook Add-In-Versionen bereitzustellen.

Die Update-Schritte

Stoppen Sie den FTAPI Server und erstellen Sie ein komplettes Backup des Systems.
Sichern Sie nun bitte die Datei server.xml im Installationsverzeichnis ftapi-server/tomcat/conf/
Bitte de-installieren Sie den FTAPI Dienst mittels ftapi-server/tomcat/ftapi-service-uninstall.bat
Verschieben oder benennen Sie nun den gesamten Ordner /ftapi-server z. B. in ftapi-server-old.
WICHTIG: der Ordner .ftapi/ darf nicht gelöscht oder verschoben werden.
Kopieren Sie nun aus dem Downloadpaket den Ordner ftapi-server ins Installationsverzeichnis
Legen Sie eine Sicherung ihrer Konfigurationsdateien an. Diese Sicherung sollte folgende Ordner enthalten:
1. .ftapi/config
2. .ftapi/certificate (falls vorhanden)
3. .ftapi/saml (falls vorhanden)
Falls Sie HTTPS am FTAPI-Server verwenden: Migrieren Sie die alte KeyStore-Konfiguration aus der Tomcat-Konfiguration.
1. Extrahieren Sie die folgenden Werte aus ftapi-server-old/tomcat/conf/server.xml
  1. In server.xml finden Sie den Connector
    1. <Connector [...] keystoreFile="../../domain.pfx" keystorePass="secret" />
    2. Übernehmen Sie die Werte von keystoreFile und keystorePass
    3. Wandeln Sie den Pfad keystoreFile in einen absoluten Pfad um,
      z.B. C:/ftapi/.ftapi/certificate/domain.pfx
2. Fügen Sie diese Werte zur secutransfer.yml hinzu, achten Sie bitte stets auf korrekte Einrückungen.

server:
 port: 443
 ssl:
   key-store: <absolute-keystoreFile>
   key-store-password: <keystorePass>
   enabled: true

8. Migrieren Sie die alte Datenbank-Konfiguration

a. Extrahieren Sie die folgenden Werte aus ftapi/.ftapi/config/properties.xml

ftapi.jdbc.url
ftapi.jdbc.driver
ftapi.jdbc.password
ftapi.jdbc.username
ftapi.hibernate.dialect

<config-definition>
    <group name="config.group.database" hidden="true">
        <property name="ftapi.jdbc.url" value="jdbc:mysql://database:3306/ftapi?useUnicode=yes&amp;characterEncoding=UTF-8&amp;useJDBCCompliantTimezoneShift=true&amp;useLegacyDatetimeCode=false&amp;serverTimezone=UTC&amp;driver=com.mysql.cj.jdbc.Driver" />
        <property name="ftapi.jdbc.driver" value="net.bull.javamelody.JdbcDriver" />
        <property name="ftapi.jdbc.password" value="secret" type="password"/>
        <property name="ftapi.jdbc.username" value="user" />
        <property name="ftapi.hibernate.dialect" value="com.ftapi.server.dao.hibernate.FTAPIMySQL8Dialect" />
    </group>
</config-definition>

b. Fügen Sie diese Werte zur secutransfer.yml hinzu

In der Property "ftapi.jdbc.url" ändern Sie bitte &amp in &

ftapi:
 jdbc:
   url: "<ftapi.jdbc.url>"
   driver: "<ftapi.jdbc.driver>"
   username: "<ftapi.jdbc.username>"
   password: "<ftapi.jdbc.password>"
   hibernate:
     dialect: "<ftapi.hibernate.dialect>"

09. Lösen Sie die mysql-connector-j*.jar-Abhängigkeit auf:

Laden Sie den den MySQL-Connector über https://dev.mysql.com/downloads/connector/j/ herunter (Plattform-unabhängig)
entpacken Sie die *.jar-Datei in das Verzeichnis ftapi/additional-lib/

10. Installieren und starten Sie den neuen Dienst 4.48:

Navigieren Sie zu <BASE_DIR>/ftapi/ftapi-server
Führen Sie ftapi-server.exe install aus, um den Dienst zu installieren
Führen Sie ftapi-server.exe start aus, um den Dienst zu starten
ftapi-server.exe stop stoppt den Dienst
ftapi-server.exe uninstall deinstalliert den Dienst

Troubleshooting

Versuchen Sie zunächst immer, die Server-URL aufzurufen. Es sollte die Anmeldeseite angezeigt werden.
Wenn dies nicht funktioniert, überprüfen Sie bitte die Logdateien auf Fehler.
Secutransfer speichert alle Logs in folgendem Verzeichnis: <BASE_DIR>/.ftapi/logs

Die Dienstprotokolle werden gespeichert in: <BASE_DIR>/ftapi-server/service-logs

Outlook Add-in

Sollten Sie das Outlook Add-in nutzen, so empfiehlt FTAPI die aktuellste Version 4.8.6 des Add-ins zu verwenden: zum Download-Bereich

Insbesondere bei der Nutzung von Single-Sign-On und "Passwort Speichern" für das Add-in, können Komplikationen mit älteren Versionen des Add-ins auftreten.

Weboberfläche

Falls die FTAPI Weboberfläche nach dem erstmaligen Start nach der Durchführung des Updates einen Fehler ausgibt, durchsuchen sie das aktuelle ftapi-stderr.log (zu finden unter ftapi/ftapi-server/tomcat/logs) nach folgendem Fehler:

META-INF/config/db/db-changelog-pre-all-versions.xml::1.0.0-pre-all-mysql-primary-key-dbchangelog::jdietrich was: 8:aac6a5dc3e82735ef2fecbeaff535dfc but is now: 8:222b93d12a3606a2f8e40bfa69ef063f

Falls dieser Fehler im Log auftauchen sollte, führen Sie in der FTAPI MySQL Datenbank die folgende Query aus und starten sie anschließend den FTAPI Dienst neu:

UPDATE DATABASECHANGELOG SET MD5SUM='8:222b93d12a3606a2f8e40bfa69ef063f' WHERE ID='1.0.0-pre-all-mysql-primary-key-dbchangelog';

Eröffnen Sie alternativ ein Ticket bei unserem Support, dieser wird Sie bei der Durchführung unterstützen.