Skip to content

Integrationsleitfaden

Technisches

Eigenschaften

  • Stateless: Ja
  • Skalierbar/Multiinstanzfähig: Ja
  • Mehrmandantenfähig: Ja
  • Proxyfähig: Ja
  • Laufzeitverhalten: Web-Anwendung - Die Anwendung wird durch http-Anfragen aktiviert, es gibt keine selbständig ablaufenden internen Prozesse.

Abhängigkeiten

Folgende Services verwendet die Komponente:

Service Version Anbindung Protokoll Standardports Verfügbarkeit Fehlertoleranzklasse Bemerkung
CMI Server >= 22.0 on request (Bidirektional) http/s CMI Server Owin Private Port Muss Reconnect
STS 3.0 >= 3.0.1 on request https 443 Muss Reconnect

Fehlertoleranz

Die CMI API läuft an sich unabhängig von den anderen Services. Fehlerhafte Request werden ins Logfile geschrieben und die API ist weiterhin verfügbar.

Statuscodes

Falls der CMI Server Service nicht erreichbar ist, gibt die API entsprechende 5xx Statuscodes zurück. Bei fehlerhaften Request werden 4xx Statuscodes zurückgegeben. Bei erfolgreichen Requests werden 2xx Statuscodes zurückgegeben.

Technologiestack

Folgende Technologien wurden verwendet: * ASP.NET Core 6.0

Health-Endpoint / Überwachung

CMI API bietet einen Health-Endpunkt an. Details sind hier zu finden: Health-Endpoint.pdf

Integrationsleitfaden CMI API

Diese Anleitung fasst die anderen Anleitungen zusammen und bildet einen Integrationsleitfaden ab.

1. Voraussetzung

Die CMI-API muss installiert sein. Unter Installation.pdf ist die detaillierte Anleitung zur Installation zu finden.

2. Konfiguration

Es muss eine gültige Konfiguration hinterlegt werden (insbesondere Umsysteme wie CMI oder STS.). Unter Konfiguration.pdf ist die detaillierte Anleitung zur Konfiguration zu finden.

Hinweise: - PathApiConfig: Das File muss nicht existieren. Es muss jedoch sichergestellt werden, dass genügend Rechte vorhanden sind damit die API das File selbst erstellen kann. Wird die API in einem IIS betrieben, so muss der ApplicationPool genügend Rechte haben um im jeweiligen Ordner ein File zu erstellen. - Das mitgelieferte appsettings.json beinhaltet bereits ein gültiges JSON mit Platzhaltern.

3. URL's und UI's

4. Aufbau CMI API

Die CMI API besteht aus zwei Modulen: dem Model-Modul und dem Prozess-Modul.

Das Model-Modul ist ein generisches Modul, bei dem Typdefinitionen und Felder zusammengeklickt werden, um Endpunkte generisch aufzubauen. Für jede ausgewählte Typdefinition werden automatisch passende Endpunkte generiert. Hier ist ein detaillierter Artikel zu finden: Beschreibung Model Modul (Beschreibung-Model-Modul.pdf)

Im Prozess-Modul können Prozess-Layers ausgewählt werden, die vordefinierte Gruppen von Endpunkten zur Verfügung stellen. Dadurch können spezielle Geschäftsprozesse abgebildet werden, indem die passenden Endpunkte ausgewählt werden. Hier ist ein detaillierter Artikel zu finden: Beschreibung Prozess Modul (Beschreibung-Prozess-Modul.pdf)

5. Testen

Die API kann mittels Swagger getestet werden (siehe Swagger.pdf).