Pradtke.API Updateanleitung

Wenn Sie ein TIMEOFFICE-Update durchgeführt haben, müssen Sie - sofern diese bereits installiert ist - auch die Pradtke.API aktualisieren, damit die Version der Pradtke.API wieder mit der Version der Datenbank übereinstimmt.

Hinweis:

Mit der Pradtke.API Version 9.10.6 wurde eine grafische Konfigurationsoberfläche eingeführt. In vorherigen Versionen wurde die Pradtke.API mittels JSON-Dateien konfiguriert.

Wenn Sie ein Update der Pradtke.API von einer Version niedriger als 9.10.6 auf eine aktuelle Version durchführen, müssen Sie einmalig alle relevanten Einstellungen aus den JSON-Konfigurationsdateien in die neue Konfigurationsübersicht übernehmen.

Lesen Sie mehr dazu hier.

Hinweis:

Wenn Sie mehrere Pradtke.APIs auf dem gleichen Server betreiben wollen, beispielsweise für eine Testinstanz, dann gehen Sie beim Update bitte wie folgt vor.

Standard-Updateanleitung für ein Update von einer Version 9.10.6 und höher

Die aktuellen Versionen können Sie aus dem Kundenportal herunterladen.

Alle Updatetätigkeiten müssen Sie auf dem Server ausführen, auf dem die Pradtke.API gehosted wird.

Sie benötigen Zugriff auf den dort installierten Internetinformationsdienste-Manager (IIS-Manager).
Für das Update empfehlen wir die folgende Vorgehensweise:

Stoppen Sie die Pradtke.API-Website im IIS-Manager.
Sichern Sie alle Dateien der Pradtke.API, d.h. das gesamte Basisverzeichnis der Website.
Löschen Sie alle Inhalte aus dem Basisverzeichnis der alten Installation.
Installieren Sie nun das Installationspaket “Pradtke API 10.x.x.msi” in den selben Ordner der alten Installation. Standardmäßig ist dies der Pfad:
NONE
```
C:\inetpub\pradtke\api
```
Starten Sie die Website im IIS-Server.

Im Folgenden werden die einzelnen Schritte ausführlich beschrieben.

Website stoppen

Öffnen Sie den IIS-Manager über Start > Systemsteuerung > Verwaltung > IIS-Manager.

Markieren Sie im Ordner "Sites" den Eintrag "pradtke.api".

Über das Kontextmenü können Sie nun die Website beenden.

Danach ist die Pradtke.API nicht mehr erreichbar, bis Sie die Website wieder starten.

Website sichern

Die Dateien der Pradtke.API finden Sie in dem bei der Installation gewählten Verzeichnis. In der Regel ist dies der folgende Ordner:

NONE

C:\inetpub\pradtke\api

Sichern Sie den ganzen Ordner, indem Sie ihn kopieren. Speichern Sie die Kopie auf dem gleichen Rechner.

Basisverzeichnis der alten Version löschen

Löschen Sie nach der Sicherung alle Inhalte aus dem Basisverzeichnis der alten Installation.

Installieren des aktuellen Programmstandes

Aus dem TIMEOFFICE-Kundenportal haben Sie sich die aktuellen Programmdateien heruntergeladen. Installieren Sie das Installationspaket, wie in der Installationsanleitung beschrieben und beachten Sie die Hinweise.

Website starten

Öffnen Sie den IIS-Server (Start > Systemsteuerung > Verwaltung) und starten Sie die Pradtke.API.

Update der Pradtke.API von einer Version kleiner als 9.10.6

Wenn Sie das Update von einer Version niedriger als 9.10.6 vornehmen, ist eine spezielle Vorgehensweise notwendig, welche im folgenden Abschnitt erläutert wird.

Mit der Version 9.10.6 wurde eine grafische Konfigurationsoberfläche eingeführt. In vorherigen Versionen der API wurde die API über JSON-Dateien konfiguriert; die Einstellungen dieser Konfigurationsdateien müssen nun über die neue Konfigurationsoberfläche vorgenommen werden. Dazu sollten sie die bisherigen Einstellungen aus den JSON-Konfigurationsdateien übertragen.

Alle Updatetätigkeiten müssen Sie auf dem Server ausführen, auf dem die Pradtke.API gehosted wird.

Sie benötigen Zugriff auf den dort installierten Internetinformationsdienste-Manager (IIS-Manager).
Für das Update von einer Version kleiner 9.10.6 empfehlen wir die folgende Vorgehensweise:

Stoppen Sie die Pradtke.API-Website im IIS-Manager.
Sichern Sie alle Dateien der alten Pradtke.API Installation, insbesondere alle Konfigurationsdateien mit der Endung „.json“. Welche Konfigurationsdateien vorhanden sind, ist von den einzelnen Anwendungen abhängig. Durch das Kopieren der Konfigurationsdateien sichern Sie sich die Einstellungen, die an den entsprechenden Konfigurationsparametern vorgenommen wurden. Sie können so jederzeit nachträglich auf diese zurückgreifen.
Löschen Sie die ursprünglichen Programmdateien aus dem Basisverzeichnis der Pradkte.API-Website.
Installieren Sie den neuen Programmstand.
Initialisieren Sie der Pradtke.API erneut.
Starten Sie die Website im IIS-Server.

Im Folgenden werden die einzelnen Schritte ausführlich beschrieben.

Website stoppen

Öffnen Sie den IIS-Manager über Start > Systemsteuerung > Verwaltung > IIS-Manager.

Markieren Sie im Ordner "Sites" den Eintrag "pradtke.api".

Über das Kontextmenü können Sie nun die Website beenden.

Danach ist die Pradtke.API nicht mehr erreichbar, bis Sie die Website wieder starten.

Website sichern

Die Dateien der Pradtke.API finden Sie in dem bei der Installation gewählten Verzeichnis. In der Regel ist dies der folgende Ordner:

NONE

C:\inetpub\pradtke\api

Sichern Sie den ganzen Ordner, indem Sie ihn kopieren. Speichern Sie die Kopie auf dem gleichen Rechner, da Sie einige der Dateien während des Updates noch benötigen werden. Der Ordner sollte alle relevanten Konfigurationsdateien Ihrer einzelnen Anwendungen enthalten.

Beispiel für Ihre Konfigurationsdateien:

Konfigurationsdatei	Konfiguration
TimeofficeConfiguation.json	Enthält Parameter für die Konfiguration von TIMEOFFICE, z. B. Benutzername und Passwort.
appsettings.json	Enthält Parameter für die Konfiguration im Bereich „Einstellungen“.
appsettings.Production.json	Enthält Parameter für die Konfiguration im Bereich „CORS“.
Weitere Konfigurationsdateien für bestimmte Module	Diese finden Sie im Bereich „Einstellungen“.

Basisverzeichnis der alten Version löschen

Löschen Sie nach der Sicherung alle Inhalte aus dem Basisverzeichnis der alten Installation.

Installieren des aktuellen Programmstandes

Aus dem TIMEOFFICE-Kundenportal haben Sie sich die aktuellen Programmdateien heruntergeladen. Installieren Sie das Installationspaket, wie in der Installationsanleitung beschrieben und beachten Sie die Hinweise.

Initialisierung der Pradtke.API

Nach dem Update ist eine erneute Initialisierung der Pradtke.API notwendig. Diese finden Sie hier in der Installationsanleitung.

Update bei einem Betrieb von mehreren APIs auf dem gleichen Server

Wenn Sie mehrere APIs auf einem Server betreiben, verfügen Sie - wie hier beschrieben - über zwei Ordner mit den Dateien der Pradtke.API. Die beiden Instanzen verfügen über unterschiedliche Konfigurationsdatenbanken, welche jeweils im IIS unter “System.webServer/aspNetCore” als “environmentVariable” sowie in der Konfigurationsdatei “appsettings.json” unter “var_logdir” hinterlegt sind.

Um in dieser Konstellation beide Instanzen der Pradtke.API zu aktualisieren, gehen Sie wie folgt vor:

Stoppen Sie beide Instanzen der Pradtke.API im IIS, wie hier beschrieben.
Sichern Sie sicherheitshalber beide Webseiten, wie hier beschrieben.
Installieren Sie den aktuellen Programmstand der Pradtke.API aus dem Kundenportal jeweils einmal in das Zielverzeichnis beider API-Instanzen, wie hier beschrieben. Beachten Sie dabei die Hinweise für den Parallelbetrieb mehrerer API-Instanzen.
Starten Sie beide Instanzen der Pradtke.API im IIS, wie hier beschrieben.