Umstellung von PPP ab 3.23.x nach PPP 3.26.x - Debian 12.x
Auf dieser Seite erfahren Sie Schritt für Schritt, wie Sie eine Installation der PICTURE-Prozessplattform ab der Version 3.23.x auf die Versionslinie 3.26.x aktualisieren können.
Diese Anleitung bezieht sich auf die Referenzumgebung für den Betrieb der PICTURE-Prozessplattform (Debian Linux Version 12, Codename "Bookworm"). Sie lässt sich sinngemäß auch für alle weiteren Plattformen, auf welchen die PPP einsetzbar ist, anwenden. Die dazu nötige Anpassung der entsprechenden Arbeitsschritte an die konkrete Zielumgebung liegt jedoch ausschließlich in der Verantwortung des Betreibers. Anspruch auf Unterstützung durch die PICTURE GmbH besteht nicht.
Die Umstellung auf das neue Release kann aus technischen Gründen nicht im Live-Betrieb durchgeführt werden und erfordert daher zwingend ein Wartungsfenster, innerhalb dessen die Software für die Anwender nicht zur Verfügung steht. Teilen Sie Ihren Anwendern daher die geplante Ausfallzeiten im Vorfeld mit und planen Sie angemessene Zeit-Reserven ein.
Inhaltsverzeichnis
Voraussetzungen prüfen
Prüfen Sie, ob Sie derzeit eine Version der PICTURE-Prozessplattform in Betrieb haben, für welche ein direkter Migrationspfad zur neuesten für Selbsthoster vorliegenden Version 3.26.5 angeboten wird.
Das Migrationswerkzeug (und diese Anleitung) unterstützt folgende Migrationspfad:
v3.23.3 → v3.26.5
v3.24.4 → v3.26.5
v3.25.6 → v3.26.5
v3.26.4 → v3.26.5
Falls Sie bisher noch Version 3.19.x oder 3.21.x einsetzen, führen Sie zunächst das Update auf Version 3.23.3 durch. Hierzu können Sie den Migrationsleitfaden Umstellung von PPP ab 3.19.x nach PPP 3.23.x - Debian 12.x nutzen.
Sollten Sie eine ältere Version im Einsatz haben, wenden Sie sich gerne an unseren Support (support@picture-gmbh.de), um eine individuelle Unterstützung abzustimmen.
Achtung: Für den o.g. Update-Pfad wird eine Migration der bestehenden (Nutz-)Daten benötigt. Bitte führen Sie bei der Umstellung unbedingt die Arbeitsschritte "Probelauf der Bestandsdatenmigration durchführen" und "Bestandsdatenmigration durchführen" aus.
Download-Paket herunterladen und entpacken
Laden Sie das Download-Paket zur aktuellen Version der Prozessplattform aus unserem Download-Bereich herunter (https://download.prozessplattform.de/ppp/current.zip). Der Download-Bereich ist passwortgeschützt. Als registrierter On-Premise-Kunde verfügen Sie über einen individuellen Download-Zugang. Sollten Ihnen die Zugangsdaten hierfür nicht bekannt sein, wenden Sie sich bitte an support@picture-gmbh.de.
Das Download-Paket besteht aus einem ZIP-Archiv, das alle relevanten Programme, Tools und Daten zur Aktualisierung der PICTURE-Prozessplattform enthält. Entpacken Sie dieses nach dem Download in ein temporäres Arbeitsverzeichnis:
cd ~
wget --user BENUTZERNAME --password PASSWORT https://download.prozessplattform.de/ppp/current.zip
unzip current.zip
Nach dem Auspacken sollten im Verzeichnis "ppp_[Version]" (z.B. "ppp_3-26-5") folgende Unterverzeichnisse existieren:
config_templates: Vorlagen für die Konfigurationsdateien der PICTURE-Prozessplattform-Webanwendung (wird für das Update eines vorhandenen Mandanten nicht benötigt)
db_template: Datenbankvorlage zum Einrichten eines neuen, "leeren" Mandanten (wird für das Update eines vorhandenen Mandanten nicht benötigt)
program_files: PPP-Webanwendung sowie Unterverzeichnis mit Datenbankmigrationstool für die Umstellung einer vorhandenen älteren PPP-Version
Probemigration durchführen
Datenbank, Dokumente und Versionshistorie für Probemigration sichern
Für die Probemigration der Produktivdaten ist es notwendig, Kopien der folgender Daten anzufertigen:
Datenbank-Schema
Dateiuploads & Versionshistorie
Im Folgenden ist das Vorgehen zur Anfertigung der Kopien beschrieben.
Führen Sie die folgenden Befehle aus um die Kopien anzufertigen:
In das Home-Verzeichnis wechseln und ein Backup-Verzeichnis anlegen:
cd ~
mkdir backup
cd backup
Datenbank sichern:
mysqldump -uroot -p ppp > db_vor_upgrade.sql
Dokumente und Versionshistorie sichern:
Probelauf der Bestandsdatenmigration durchführen
Zur Durchführung der Bestandsdatenmigration steht ein Datenmigrationswerkzeug zur Verfügung. Mit dessen Hilfe können sämtliche mit der zuvor installierten Version der PICTURE-Prozessplattform verwalteten Daten ohne Informationsverlust in die neuen Datenstrukturen überführt werden.
Das Migrationsprogramm verfügt über einen integrierten Selbsttest, der im Anschluss an die Migration eine Konsistenzprüfung der Datenbank durchführt. Die ordnungsgemäße Funktionsfähigkeit des Releases können wir nur sicherstellen, wenn diese Konsistenzprüfung ohne Fehler abgeschlossen werden kann. Sollten bei der Prüfung Fehler gefunden werden, empfehlen wir Ihnen daher eine Rücksprache mit unserem Support zwecks Problembehebung.
Datenbank, Dokumente und Versionshistorie für Probelauf einspielen
An der Datenbank anmelden:
Neues, leeres Datenbank-Schema anlegen und ausloggen:
Datenbank-Snapshot in das neue Datenbank-Schema einspielen:
Dokumente und Versionshistorie aus den zuvor gesicherten Dateien einspielen:
Datenbank-Migrationstool für den Probelauf konfigurieren
Zur Vereinfachung der Ausführung der Migration wurde das Skript "on-premise-db-migration.sh" dem Download-Paket hinzugefügt. Vor dem Starten des Skripts müssen folgende Anpassungen für Ihr System vorgenommen werden.
Datenbank-Einstellung eintragen (db.config)
Öffnen Sie die Datenbank Konfigurations-Datei im Texteditor:
Folgende Werte müssen in der "db.config" enthalten sein und auf Ihre Gegebenheiten angepasst werden:
Variable | Bedeutung | Beispiel |
---|---|---|
db.driver | Der Datenbank-Treiber, der verwendet werden soll | org.mariadb.jdbc.Driver |
db.host | Hostname des MySQL-Datenbank-Servers, auf dem das zu migrierende Datenbank-Schema betrieben wird | localhost |
db.port | Portnummer des MySQL-Servers auf dem o.g. Host | 3306 |
db.user | Name eines MySQL-Benutzerkontos, welches volle Privilegien für das o.g. Datenbank-Schema besitzt | ppp |
db.password | Passwort des o.g. MySQL-Benutzerkontos | StrengGeheim |
Datenbankschema in Datei databases.list eintragen
In der "databases.list" muss das zu migrierende Datenbank Schema eingetragen werden. Hier muss darauf geachtet werden, dass nur das Datenbank Schema in der ersten Zeile eingetragen wird:
Variable | Bedeutung | Beispiel |
---|---|---|
DB_SCHEMA | Name des zu migrierenden Datenbankschemas (Achtung: Hier die Kopie für den Probelauf eintragen!) | ppp_probemigration |
Migrations-Skript anpassen (on-premise-db-migration.sh)
Im ersten Abschnitt des Scripts (gekennzeichnet durch den Kommentar "Skript Variablen - bitte passen Sie diese für Ihre individuelle Umgebung an") befinden sich Variablen, die Sie zur Vorbereitung der Probemigration ggf. an Ihre konkreten Gegebenheiten anpassen müssen. Öffnen Sie hierzu die o.g. Datei in einem Texteditor und passen Sie die u.g. Variablen an:
Ggfs. müssen folgende Variablen angepasst werden:
Variable | Bedeutung | Beispiel |
---|---|---|
SOURCE_PPP_VERSION | Versionsnummer der zu migrierenden PPP-Installation | 3.26.4 |
TARGET_PPP_VERSION | Versionsnummer der Ziel-PPP-Installation | 3-26-5 |
JAR_PATH | Der Pfad unter dem die Jar-Dateien für die Migration abgelegt sind | /home/picture/ppp_${TARGET_PPP_VERSION}/program_files/migration |
TOMCAT_UPLOADS_DIR | Der Pfad unter dem die Uploads der Prozessplattform abgelegt werden | /srv/picture/ppp_probemigration/documents |
Migration ausführen
Machen Sie das Migrations-Skript anschließend ausführbar:
Nun können Sie das Skript ausführen und somit die Probemigration starten:
Während der Migration protokolliert das Migrations-Skript per Konsolenausgabe den Bearbeitungsfortschritt:
Log-Auszug
Protokolldatei des Probelaufs der Datenbank-Migration auswerten
Während der Migration wird die Log-Datei "migration_to_3-26-5.log" für die Migration angelegt. Sichten Sie diese Datei nach Abschluss des Migrationslaufs indem Sie den Inhalt der Datei auf der Konsole ausgeben
Prüfen Sie, ob sich hier Hinweise auf Fehler bei der Datenmigration bzw. der anschließenden Konsistenzprüfung finden. Falls ein Migrationsschritt erfolgreich durchgeführt wurde, finden Sie in den Logdateien keine Java-Stacktraces und am Anfang bzw. Ende der Datei finden sich Log-Ausgaben folgender Art:
Auszug migration_to_3-26-5.log
Update der Produktiv-Installation durchführen
Tomcat-Server herunterfahren
Falls der Probelauf der Datenbank-Migration erfolgreich abgeschlossen werden konnte, können Sie mit der Bestandsdatenmigration der Nutzdaten des Produktivsystems beginnen. Fahren Sie hierzu zunächst den Tomcat-Server herunter (erfordert root-Berechtigung):
Bestandsdatenmigration durchführen
Datenbank-Schema der Produktiv-Datenbank eintragen (databases.list)
In der "databases.list" muss das zu migrierende Datenbank-Schema eingetragen werden (Hier muss darauf geachtet werden, dass nur das Datenbank-Schema in der ersten Zeile eingetragen wird):
Variable | Bedeutung | Beispiel |
---|---|---|
DB_SCHEMA | Name des zu migrierenden Datenbank-Schemas | ppp |
Migrations-Skript an Produktiv-Umgebung anpassen (on-premise-db-migration.sh)
In der "on-premise-db-migration.sh" muss das zu migrierende Verzeichnis der Dokumente und Versionshistorie eingetragen werden:
Variable | Bedeutung | Beispiel |
---|---|---|
TOMCAT_UPLOADS_DIR | Der Pfad unter dem die Uploads der Prozessplattform abgelegt werden | /srv/picture/ppp/documents |
Nun können Sie das Script ausführen und somit die Migration starten:
Protokolldatei der Bestandsdatenmigration auswerten
Während der Bestandsdatenmigration wird die Log-Datei "migration_to_3-26-5.log" für die Migration fortgeschrieben. Sichten Sie diese Datei nach Abschluss des Migrationslaufs nochmals mit einem Texteditor. Prüfen Sie, ob sich hier Hinweise auf Fehler bei der Bestandsdatenmigration bzw. der anschließenden Konsistenzprüfung finden.
WAR-Datei der Webanwendung austauschen
Löschen Sie nun die alte WAR-Datei der PPP und ersetzen Sie diese durch die WAR-Datei der PPP 3.26.x. Führen Sie hierzu folgende Befehle aus:
Tomcat-Server starten
Die Vorbereitungen zum Update der PPP sind damit abgeschlossen. Starten Sie nun den Tomcat-Server:
"Smoke-Test" durchführen
Ca. 10 - 30 Sekunden nach dem Start des Tomcat-Servers sollte der Tomcat-Server das Deployment der PPP-Webanwendung abgeschlossen haben und Beim Aufruf der URL der Webanwendung im Webbrowser sollte der Login-Bildschirm zur Verfügung stehen.
Falls bereits das Deployment der Webanwendung fehlschlagen sollte, sodass der Login-Bildschirm gar nicht erst aufgerufen werden kann, finden Sie in den folgenden Log-Dateien möglicherweise erste Ansätze zur Fehlersuche:
/var/lib/tomcat10/logs/ppp/PPP.log (Logdatei der PPP-Webanwendung; Pfad wird definiert in der Datei logback.xml im Konfigurationsverzeichnis der PPP-Webanwendung)
/var/lib/tomcat10/logs/catalina.{yyyy-mm-dd}.log (Logdatei des Tomcat-Servers)
/var/lib/tomcat10/logs/localhost.{yyyy-mm-dd}.log (enthält i.d.R. Hinweise auf schwerwiegende Fehler, derentwegen der Tomcat-Server so früh fehlschlägt, dass in die o.g. Log-Dateien gar nicht erst geschrieben wird).
/var/lib/tomcat10/logs/localhost_access_log.{yyyy-mm-dd}.txt (enthält die Informationen zu jeder Anfrage, die den Server erreicht. Es kann zum Verfolgen von Seitenzugriffszahlen, Benutzersitzungsaktivitäten usw. verwendet werden, da alle eingehenden Anforderungen zusammen mit Zeitstempel, HTTP-Anforderungsmethode und HTTP-Antwortcode protokolliert werden.)
Erscheint erwartungsgemäß der Login-Bildschirm, dann loggen Sie sich in die PPP ein und prüfen Sie deren prinzipielle Funktionsfähigkeit, in dem Sie zentrale Features stichprobenartig testen:
Suche nach Prozessnamen im Prozessregister
Öffnen eines Prozesssteckbriefs zur Ansicht
Exportieren des Steckbriefs als PDF-Datei (=> Kann die heruntergeladene PDF-Datei in einem PDF-Reader geöffnet werden und enthält sie keine offensichtlichen Fehler?)
Öffnen eines Prozess-Detailmodells (Kopie eines "echten" Prozesses bzw. Testdaten) zum Bearbeiten, Änderung durchführen, anschließend speichern
Ausführen einer Analyse-App und Durchführung eines Excel-Exports (=> Kann die heruntergeladene Excel-Datei in Excel geöffnet werden?)
Aufräumarbeiten durchführen
Wenn alle Schritte durchgeführt wurden und die PICTURE-Prozessplattform - wie gewünscht - läuft, nehmen Sie sich nun noch die Zeit das Home-Verzeichnis des User “picture” wieder aufzuräumen. Führen Sie dazu folgende Befehle aus: