Servicekonfiguration: Datenschnittstellenkonfiguration

Allgemein

Die Servicekonfiguration spielt eine zentrale Rolle bei der Integration der Datenschnittstelle mit den COGLAS-Nachrichtentypen. Sie definiert die grundlegenden Einstellungen und Parameter, die benötigt werden, um eine reibungslose Kommunikation zwischen den Systemen sicherzustellen.

Eingabemöglichkeiten

Pflichtfelder

Beschreibung

Name

Name der Servicekonfiguration

Mandant

Mandant der für die Nachrichtentypen verwendet wird

Service URL

URL des Datainterface Ordners mit Hostname als Prefix

z.B.: “https://xxx.coglas.com/datainterface_xml/”

Optionale Felder	Beschreibung
Beschreibung	Eine kurze Beschreibung der Servicekonfiguration
Deaktiviert	Checkbox zum deaktivieren der Servicekonfiguration
Timeout	Zeit nachdem die Abfrage auf einen Timeout läuft
Authentifizierungsverfahren	Authentifizierungsverfahren nach API oder Benutzer & Passwort
Message type configurations	Konfiguration der Nachrichtentypen mit Verionsnummer, automatische versendung oder abruf per CURL

(Weitere Eingabemöglichkeiten)	Beschreibung
Message type configurations: Version	Legt die Version des Nachrichtentyps fest
Message type configurations: is auto send	Automatisches versenden des Nachrichtentyps
Message type configurations: is calloff	Abruf per CURL Befehl
Authentication Basic	Authentifizierung auf einer Benutzername & Passwort Ebene. Zugangsdaten werden werden in den Feldern Authentication username und Authentication password gepflegt.
Authentication Web API	Authentifizierung über einen API Key und einen Secret. API Key & API Secret werden über Authentication Key & Value gepflegt.

Rückmeldungen von COGLAS → ITSYSTEM

Seitens COGLAS wird eine Kundenseitige API Schnittstelle mit dem Namen „**/api/DataInterface/ProcessMessageType“ erwartet.
„**/api/DataInterface/ProcessMessageType“ wird von COGLAS beim direkten ansprechen eines Endpunkts der Web-API automatisch angehängt.

Systemrolle Web-API

Für den Zugriff auf die Datenschnittstelle wird ein User im COGLAS benötigt, welcher die Rolle “Web-API” zugewiesen bekommen hat.
Dieser Benutzer wird für das Authentifizierungsverfahren verwendet. Passwort sowie Rolle des Users werden im COGLAS gepflegt. Zusätzlich wird der Service-User mit seinem Benutzernamen und Passwort in der datainterface web.config hinterlegt, um den Zugriff zu ermöglichen.

Nachrichtentypen Konfiguration

Unter dem Punkt Message Type Configurations kann der zu verwendende Nachrichtentyp sowie dessen Version festgelegt werden.

Da bei neueren Versionen eines Nachrichtentyps Änderungen vorgenommen werden können, die die Struktur der Nachricht beeinflussen, besteht die Möglichkeit, gezielt eine bestimmte Version auszuwählen. Dies ermöglicht die kontinuierliche Nutzung älterer Nachrichtentypen und gewährleistet gleichzeitig die Kompatibilität mit bestehenden Systemen.

Detailerklärung:

Über den Punkt “Auto Send” wird die automaische Versendung des Nachrichtentyps festgelegt.
Über den Punkt “Is Calloff” wird festgelegt ob der Nachrichtentyp über den CURL Befehl abgerufen werden kann.
Das “+” Symbol ermöglicht das hinzufügen mehrerer Nachrichtentypen für die einzelne Servicekonfiguration.

Warnmeldung

Warnmeldung	Beschreibung
Ungültige URL	Die URL welche eingegeben worden ist entspricht nicht einer gültigen URL. z.B. https://xyz.coglas.com/datainterface_json/

→ zurück zu COGLAS Prozessen
→ zurück zu COGLAS Menü