Servicekonfigurationen

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.

Oberfläche

Das Menü zur Servicekonfigurationen muss manuell erfasst werden. Hierzu können neue Profile erfasst werden.

Menü Aufruf: System - Datenschnittstelle - Servicekonfigurationen

Menü Servicekonfigurationen:

• Schaltfläche [Servicekonfiguration hinzufügen] = Erfassung neuen Eintrag.

• Erweiterte Suche = Suche nach Feldwerten und Einschränkungen.

• Anzeige diverser bereits angelegter Konfigurationsprofile. Angezeigt werden die Felder Name, Mandant, Service Url und der Status Deaktiviert (Ja/Nein).

Eingabemöglichkeiten

Nachrichtentypkonfigurationen:

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.

• Im kundeneigenen Webserver bspw. IIS kann eine rewrite URL hinterlegt werden, wenn der Endpunkt anders aussieht. Beispiel:

<system.webServer>
  <rewrite>
    <rules>
      <rule name="Coglas2xxxer">
        <match url="^(?:api/datainterface/processmessagetype$"/>
        <action type="Rewrite" url="xxx/yyyy"/>
      </rule>
    </rules>
  </rewrite>
</system.webServer>

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.

Host Rückmeldung für den erfolgreichen Empfang:

Für den korrekten Dateneingang beim Host wird vom Host eine HTTP 200 Erfolgreich Status Meldung erwartet. Hierfür wird ein vorgegebenes Format erwartet.

Ist das Format in Ordnung, dann der Schnittstellenhistorie auf “erfolgreich” gesetzt.
Ist das Format nicht in Ordnung oder fehlt komplett, dann wird die Schnittstellenhistorie auf “nicht erfolgreich” gesetzt.

Erwartetes Format vom Host für den erfolgreichen Empfang der Rückmeldung:

{
     return Ok(new { received = data, message = "Data received successfully!", Success = true });
}

Beispiel

Beispiel #1: Standard Ausgabe in eine Datei. Zur Warenausgangsbuchung soll zum Kundenauftrag mit Erreichen des Status “Erledigt” der Nachrichtentyp DeliveryOrderOut_v1 an die Schnittstellen Ausgabe in eine XML Datei ausgegeben werden.

Beispiel #2: Zum Abruf das Nachrichtentyps ArticleStockSum soll die Version v1 beibehalten werden. In der Servicekonfiguration wird hierzu der Eintrag zum Mandanten und der Nachrichtentypkonfiguration zugewünschten Version erfasst.

Warnmeldung

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