Installations- und Updateanleitung CMI Webapi ContactSync

Es folgt eine Zusammenfassung, die den Betrieb der ContactSync API mit IIS beschreibt. Grundsätzlich kann der IIS gemäss der Dokumentation von Microsoft für eine ASP.NET Core konfiguriert werden.

Fachwörter (wie Application Pool) beziehen sich auf ein Windows mit englischem Sprachpaket. Diese Anleitung beschreibt eine Basis IIS Application Installation und kann daher an das eigene Deployment angepasst werden.

Voraussetzungen

• .NET Core Runtime (Version 8.0.0) vorinstalliert (Download).
• CMI STS 3 in Betrieb (siehe CMI STS).
• Technischen Benutzer eingerichtet, siehe benötigte Rechte.
• Ein freier Port zur ContactSync API.
• Webserver IIS, sofern CMI ContactSync nicht als CMI Cloud Service bezogen wird.
• Service-URL des EWK-Providers (siehe EWK-Provider) muss für die Nutzung von CMI ContactSync als CMI Cloud Service erreichbar sein.

Abhängigkeiten

Die ContactSync API muss den MetaTool Service unter dem OWIN Private Port erreichen können und der MetaTool Service die ContactSync API unter den oben definierten Port.

[API]<--Port API----------------------Port OWIN Private-->[METATOOL]

Installation

Die API wird als eine IIS Applikation installiert.

Application Pool

1. Unter "Application Pools" einen neuen Application Pool hinzufügen
2. Folgende Parameter befüllen:
   • Name: Frei wählbar (Bsp. cmi-webapi-contactsync)
   • .NET CLR Version: No Managed Code
   • Managed pipeline mode: Integrated
   • Start application pool immediately: Aktiviert
3. Mit OK bestätigen.

Website

1. Im IIS unter Sites eine neue Website hinzufügt
2. Folgende Parameter befüllen:
   • Site name: Beliebig wählbar (Bsp. cmi-webapi-contactsync)
   • Application pool: Den erstellen Application pool vom Schritt 2.1 auswählen
   • Physical path: Beliebiger Pfad, unter welchem sich die Installationsdateien der API-Applikation befinden werden
   • Binding type: Https
   • IP-Adresse: All Unassigned
   • Port: Frei wählbar
   • Hostname: Domäne eintragen
   • SSL certificate: Ein gültiges SSL-certificate, welches auf dem Host name gebunden ist
   • Start Website: immediately
3. Das ausgelieferte ZIP auf dem Server kopieren und den Inhalt unter \Installationsdateien im Zielverzeichnis kopieren.
   • Zielverzeichnis ist das Verzeichnis was beim Physical path eingetragen wurde
   • Appsettings.json Konfiguration wird von der CMI konfiguriert und ausgeliefert
   • Den Application Pool recyclen
4. Das Appsettings.json wird von der CMI ausgeliefert. Folgende Anpassungen müssen aber gemacht werden:
   • Unter Serilog.WriteTo.Args.Path den Pfad zum Log-Ordner inkl. Dateiname und Endung angeben (Beispiel.: C:\\temp\\logs.log). Die Application Pool Identity muss genügend Rechte haben um in diesem Ordner Dateien anzulegen.

Datenbank

Die Datenbank muss initial erstellt werden. Die Anleitung ist hier zu finden.

Validierung

Wird die Website aufgerufen, so sollte eine Swagger-Seite mit der API Definition sichtbar sein.

Update

Anleitung

1. Die IIS-Website stoppen
2. Alle Dateien und Ordner bis auf die folgenden löschen:
   • (Datei) appsettings.json
   • (Datei) *.settings.json
3. Das ausgelieferte ZIP auf dem Server kopieren und den Inhalt unter \Installationsdateien im Zielverzeichnis kopieren (Achtung! Die obig aufgelisteten Dateien und Ordner nicht überschreiben)
4. Datenbank updaten (Anleitung)
5. Die IIS-Website wieder starten

Validierung

Wird die Website aufgerufen, so sollte eine Swagger-Seite mit der API Definition sichtbar sein.