V1_0

Event-Out-Schnittstelle

Automatisches Versenden von Ereignisdaten bei Erreichen von Meilensteinen der Sendungen.

Top Features

Die Event-Out-Schnittstelle sendet Ereignisdaten von Scope, sobald Tracking-Meilensteine abgeschlossen sind, eine Ausnahme (Exception) auftritt oder ein Alarm ausgelöst wird.
Event Out Interface_milestones_v3

Voraussetzung und technische Informationen

Zwischen dem Riege-Rechenzentrum und dem Empfänger der Ereignisdaten wird ein technischer Datenkommunikationskanal benötigt. Dieser Kanal bekommt von Riege eine recipientID zugewiesen. Die recipientID wird für die Einrichtung in Scope benötigt.

Alle Scope Niederlassungen sind potenzielle Absender von Ereignismeldungen und bekommen eine senderID zugewiesen. Der Standardwert der senderID ist der Code des entsprechenden Geschäftspartners. Die senderIDs sollten auch für das Setup im Riege-internen Nachrichtenclearing mit Riege abgeglichen werden.
  • Die Schnittstelle kann keine Aktualisierungen oder Stornierungen senden.
  • Jede Erfüllung eines Meilensteins, das Auftreten einer Ausnahme oder eines Alarms löst eine neue Übertragung aus.
  • Die Beschreibung des Scope Events Message Formats ist verfügbar unter
    https://riege.github.io/xml-event

Scope Setup - EDI Profile

Für die Event-Out-Schnittstelle wird ein EDI-Profil benötigt. Dabei kann es sich um ein bestehendes EDI-Profil handeln, z. B. wenn die Event-Out-Schnittstelle als Rückkanal für eingehende Sendungsaufträge verwendet wird, oder um ein neues EDI-Profil, das ausschließlich für den Zweck des Versands von Ereignisdaten an einen externen Empfänger verwendet wird. Für das EDI-Profil selbst gelten die folgenden Regeln:

  • Der Code ist frei wählbar
  • Referenztyp-Code spielt keine Rolle, typische Werte sind 'ptt' oder 'shipmentPtt' oder 'usi'
  • Typ der Schnittstelle sollte 'Generic' sein
  • Die Adresszuordnung muss die eigene Niederlassung oder alle Niederlassungen enthalten, damit die Schnittstelle ausgelöst wird (jede externe ID muss hier mit einer senderID übereinstimmen).
  • Sofern keine statische recipientID verwendet wird, müssen die Adresszuordnungen den Empfängerpartner mit der externen ID enthalten, die mit der recipientID übereinstimmt.

Beispiel:
event-out-interface_edi-profile-png

Scope Setup: Tracking-Vorlagen

Der Umfang wird durch das Erreichen von Meilensteinen in Tracking-Vorlagen, durch das Auftreten von Ausnahmen oder das Erreichen von Alarmzeitpunkten ausgelöst. Die Konfiguration ist sehr ähnlich. So lässt sich konfigurieren, welche Milestones mit welchen externen Codes zu welchen EDI-Profilen auslösen sollen.

Eine Tracking-Vorlage (Stammdaten > Spedition > Tracking-Vorlagen) in Scope kann sich entweder auf
  • ein dynamisches EDI-Profil, das durch das EDI-Profil bestimmt wird, das Scope bei der Verarbeitung der eingehenden Sendungsauftragsdaten auswählt, oder
  • ein vorbestimmtes EDI-Profil.
Für einen Meilenstein in der Tracking-Schnittstelle werden die auslösenden Details auf der Registerkarte Aktionen konfiguriert:
  • Typ 'Ereignismeldung'
  • Event-Code kann übernommen werden - dies ist der Event-Code, der im Outbound-Interface verwendet wird
  • Empfänger: Verwenden Sie entweder recipientID als statischen Empfänger (wenn die Empfänger nicht unterschieden werden müssen) oder wählen Sie eine Auftragseigenschaft, wie z. B. Absender oder Auftraggeber; diese sollten eine entsprechende recipientID-Zuordnung im oben erstellten EDI-Profil haben.

Beispiel:
event-out-interface_miilestone-action-png
Die Einrichtung sollte für jeden Meilenstein, jede Ausnahme oder jeden Alarm wiederholt werden, der eine Event-Out-Nachricht auslösen soll.