HVS32 PSI REST Schnittstelle (Automatik-Polling) - Versionsgeschichte

Odelice: /* Notwendige Konfigurationsparameter */

2022-06-10T11:53:32Z

Notwendige Konfigurationsparameter

Odelice am 10. Juni 2022 um 11:44 Uhr

2022-06-10T11:44:47Z

Odelice am 10. Juni 2022 um 11:39 Uhr

2022-06-10T11:39:57Z

Odelice am 2. Juni 2022 um 10:33 Uhr

2022-06-02T10:33:53Z

Odelice am 2. Juni 2022 um 10:26 Uhr

2022-06-02T10:26:43Z

Odelice am 2. Juni 2022 um 10:15 Uhr

2022-06-02T10:15:28Z

Odelice am 1. Juni 2022 um 13:16 Uhr

2022-06-01T13:16:30Z

Odelice am 1. Juni 2022 um 13:06 Uhr

2022-06-01T13:06:28Z

Odelice am 1. Juni 2022 um 13:04 Uhr

2022-06-01T13:04:35Z

Odelice am 1. Juni 2022 um 12:56 Uhr

2022-06-01T12:56:02Z

@@ Zeile 53: / Zeile 53: @@
 {| class="wikitable"
 |-
-!Parameter
+!Parameter!!Beschreibung
 |-
-|DGS REST-Server Port
+|DGS REST-Server Port||Der Port, unter welchem der DGS den REST-Server zur Verfügung stellt, welcher vom PSI-System angesprochen wird. Im Standard verwenden wir hierfür den Port '''8082'''.
 |-
-|PSI-Schnittstellenversionsnr.
+|PSI-Schnittstellenversionsnr.||Die Versionsnr., welche in jedem Telegram aus dem PSI-System übermittelt wird.
 |-
-|PSI Endport
+|PSI Endport||Der REST-Endpoint, unter welcher das PSI-System für die asynchrone Rückmeldung erreichbar ist.
 |}

@@ Zeile 32: / Zeile 32: @@
 = Ablauf=
 *Das PSI-System bereitet das Telegramm vor und übermittelt dieses über die REST-Schnittstelle an den DataGatewayServer (DGS)
-*Der DGS quittiert den Erhalt des Telegrammes
+*Der DGS quittiert den Erhalt des Telegrammes, wodurch die Kommunikation geschlossen wird.
 *Im DGS wird das Telegramm für die Verarbeitung im HVS32 vorbereitet. Bei einer Druckanfrage wird jedes Packstück in eine separate Verbuchungsanfrage gesplittet und sequenziell verarbeitet.
 *Bei einer Verbuchungsanfrage werden die Daten im HVS32 zuerst nur verbucht. Es wird noch kein Etikett erzeugt.
@@ Zeile 41: / Zeile 41: @@
 * Erst nachdem alle Verbuchungsanfragen erfolgreich verarbeitet worden sind, werden Druckanfragen erzeugt und erneut an das HVS32 gesendet. Erst hier werden die Etiketten gedruckt. Dies verhindert, die Ausgabe von Etiketten, welche im Fehlerfall automatisiert storniert werden müssten.
 *Sollte in diesem Druck-Prozess ein Fehler auftreten, erfolgt eine Alarmmeldung. An dieser Stelle werden keine Packstücke mehr storniert, da diese bereits gedruckt und auf einem Packstück aufgebracht sein könnten.
-*Der DGS sammelt die Rückmeldungen der einzelnen Anfragen innerhalb eines Telegrammes und meldet die Rückmeldedaten aus dem HVS32 gesammelt in dem vorgesehenen Telegramm ans PSI-System zurück.
+*Der DGS sammelt die Rückmeldungen der einzelnen Anfragen innerhalb eines Telegrammes und meldet die Rückmeldedaten aus dem HVS32 gesammelt in dem vorgesehenen Telegramm ans PSI-System zurück. Dabei wird eine neue Verbindung zum PSI-System aufgebaut.
 <gallery>

@@ Zeile 28: / Zeile 28: @@
 Es handelt sich dabei um eine Sendungsschnittstelle, in welcher n-Packstücke in einer Anfrage übergeben werden können. Die Rückmeldung ans PSI-System erfolgt asynchron, nachdem das komplette Telegram verarbeitet worden ist.
-Der DGS ist die zentrale Kommunikationseinheit, über die sämtliche Daten zwischen dem Versandsystem und dem SAP-System ausgetauscht werden. Er läuft in Form eines Dienstes auf einem Windows-Server.
+Der DGS ist die zentrale Kommunikationseinheit, über die sämtliche Daten zwischen dem Versandsystem und dem Hostsystem ausgetauscht werden. Er läuft in Form eines Dienstes auf einem Windows-Server.
 = Ablauf=

@@ Zeile 8: / Zeile 8: @@
-Die PSI-Schnittstelle wurde anhand den vorgaben der [https://www.psi.de/de/home/ PSI Software AG] umgesetzt. Es standen dabei folgende Dokumentationen zur Verfügung:
+Die PSI-Schnittstelle wurde anhand den zur Verfügung gestellten Dokumentationen der [https://www.psi.de/de/home/ PSI Software AG] umgesetzt. Es standen dabei folgende Dokumente zur Verfügung:
 {| class="wikitable"
 !Dokument-Identifikator
@@ Zeile 24: / Zeile 24: @@
 = Funktionsbeschreibung =
-Bei der PSI-REST-Schnittstelle stellt der DataGatewayServer (DGS) einen REST-Server mit nur einer Funktion ( '''http://<Servername>:<Port>/heidler_psi_rest/request''' ) zur Verfügung. Über diese Funktion kann das PSI-System verschiedene Telegramme übermitteln. Die auszuführende HVS32-Funktion wird dabei über den Parameter ''MsgNam'' gesteuert, welcher in jedem Telegram vorhanden ist. Die Rückmeldung ans PSI-System erfolgt asynchron.
+Bei der PSI-REST-Schnittstelle stellt der DataGatewayServer (DGS) einen REST-Server mit nur einer Funktion ( '''http://<Servername>:<Port>/heidler_psi_rest/request''' ) zur Verfügung. Über diese Funktion kann das PSI-System verschiedene Telegramme übermitteln. Die auszuführende [[#Verfügbare HVS32 Funktionen|HVS32-Funktion]] wird dabei über den Parameter ''MsgNam'' gesteuert, welcher in jedem Telegram vorhanden ist.
 Der DGS ist die zentrale Kommunikationseinheit, über die sämtliche Daten zwischen dem Versandsystem und dem SAP-System ausgetauscht werden. Er läuft in Form eines Dienstes auf einem Windows-Server.
-= Ablauf =
+= Ablauf=
-* Das PSI-System bereitet das Telegramm vor und übermittelt dieses über die REST-Schnittstelle an den DataGatewayServer (DGS)
+*Das PSI-System bereitet das Telegramm vor und übermittelt dieses über die REST-Schnittstelle an den DataGatewayServer (DGS)
-* Der DGS quittiert den Erhalt des Telegrammes
+*Der DGS quittiert den Erhalt des Telegrammes
-* Im DGS wird das Telegramm für die Verarbeitung im HVS32 vorbereitet. Bei einer Druckanfrage wird jedes Packstück in eine separate Verbuchungsanfrage gesplittet und sequenziell verarbeitet.
+*Im DGS wird das Telegramm für die Verarbeitung im HVS32 vorbereitet. Bei einer Druckanfrage wird jedes Packstück in eine separate Verbuchungsanfrage gesplittet und sequenziell verarbeitet.
-* Bei einer Verbuchungsanfrage werden die Daten im HVS32 zuerst nur verbucht. Es wird noch kein Etikett erzeugt.
+*Bei einer Verbuchungsanfrage werden die Daten im HVS32 zuerst nur verbucht. Es wird noch kein Etikett erzeugt.
 * Bei jeder Anfrage wird geprüft, ob eine HVS32 Station mit dem DGS verbunden ist. Sollte keine Station verbunden sein, so wird die Anfrage mit einem Fehler quittiert und somit auch das komplette Telegramm.
-* Bei einer Verbuchungsanfrage werden alle bereits verbuchten Packstücke aus diesem Telegramm im HVS32 storniert und das Hostsystem mittels einer Alarmmeldung (Telegram von PSI für Fehlernachrichten) benachrichtigt.
+*Bei einer Verbuchungsanfrage werden alle bereits verbuchten Packstücke aus diesem Telegramm im HVS32 storniert und das Hostsystem mittels einer Alarmmeldung (Telegram von PSI für Fehlernachrichten) benachrichtigt.
 * Wenn eine HVS32 Station verbunden ist, so wird die Anfrage an die nächste freie Station weitergeleitet, in welcher die Anfrage verarbeitet wird.
-* Sollte es sich um eine Verbuchungsanfrage handeln und in diesem Prozess ein Fehler auftreten, so werden wie oben beschrieben alle Packstücke aus diesem Telegramm storniert und es erfolgt eine Alarmmeldung.
+*Sollte es sich um eine Verbuchungsanfrage handeln und in diesem Prozess ein Fehler auftreten, so werden wie oben beschrieben alle Packstücke aus diesem Telegramm storniert und es erfolgt eine Alarmmeldung.
 * Erst nachdem alle Verbuchungsanfragen erfolgreich verarbeitet worden sind, werden Druckanfragen erzeugt und erneut an das HVS32 gesendet. Erst hier werden die Etiketten gedruckt. Dies verhindert, die Ausgabe von Etiketten, welche im Fehlerfall automatisiert storniert werden müssten.
-* Sollte in diesem Druck-Prozess ein Fehler auftreten, erfolgt eine Alarmmeldung. An dieser Stelle werden keine Packstücke mehr storniert, da diese bereits gedruckt und auf einem Packstück aufgebracht sein könnten.
+*Sollte in diesem Druck-Prozess ein Fehler auftreten, erfolgt eine Alarmmeldung. An dieser Stelle werden keine Packstücke mehr storniert, da diese bereits gedruckt und auf einem Packstück aufgebracht sein könnten.
-* Der DGS sammelt die Rückmeldungen der einzelnen Anfragen innerhalb eines Telegrammes und meldet die Rückmeldedaten aus dem HVS32 gesammelt in dem vorgesehenen Telegramm ans PSI-System zurück.
+*Der DGS sammelt die Rückmeldungen der einzelnen Anfragen innerhalb eines Telegrammes und meldet die Rückmeldedaten aus dem HVS32 gesammelt in dem vorgesehenen Telegramm ans PSI-System zurück.
 <gallery>
@@ Zeile 46: / Zeile 48: @@
 </gallery>
-= Notwendige Konfigurationsparameter =
+=Notwendige Konfigurationsparameter=
 Folgende Parameter werden für die Einrichtung der PSI-REST-Schnittstelle benötigt:
 {| class="wikitable"
 |-
-! Parameter
+!Parameter
-!verwaltende Partei!! Beschreibung
+! verwaltende Partei!!Beschreibung
 |-
-| DGS REST-Server Port
+|DGS REST-Server Port
-|Kunde / IT-Dienstleister|| Der Port, unter welchem der DGS den REST-Server zur Verfügung stellt, welcher vom PSI-System angesprochen wird. Im Standard verwenden wir hierfür den Port '''8082'''.
+|Kunde / IT-Dienstleister||Der Port, unter welchem der DGS den REST-Server zur Verfügung stellt, welcher vom PSI-System angesprochen wird. Im Standard verwenden wir hierfür den Port '''8082'''.
 |-
-| PSI-Schnittstellenversionsnr.
+|PSI-Schnittstellenversionsnr.
-|PSI Software AG|| Die Versionsnr., welche in jedem Telegram als VersionsNr aus dem PSI-System übermittelt wird.
+|PSI Software AG||Die Versionsnr., welche in jedem Telegram als VersionsNr aus dem PSI-System übermittelt wird.
 |-
-| PSI Endport
+|PSI Endport
-|PSI Software AG|| Der REST-Endpoint, unter welcher das PSI-System für die asynchrone Rückmeldung erreichbar ist.
+|PSI Software AG||Der REST-Endpoint, unter welcher das PSI-System für die asynchrone Rückmeldung erreichbar ist.
 |}
-= Verfügbare HVS32 Funktionen =
+= Verfügbare HVS32 Funktionen=
 Bitte beachten Sie, dass die Feld-Beschreibungen sich nur auf einen Standard beziehen, welcher als Vorschlag für die Schnittstelle dienen soll. Funktionsnamen, Feldnamen /-längen /-formate können prinzipiell abweichen, müssen in diesem Fall jedoch individuell betrachtet/analysiert werden.<br>
-=== Packstück-Verarbeitung (VersandDatenAnfrage) [Telegram=Auftrag] ===
+===Packstück-Verarbeitung (VersandDatenAnfrage) [Telegram=Auftrag] ===
 Die Gatewayfunktion VersandDatenAnfrage wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort ein Etikett für ein Packstück zu erzeugen und verbuchen. Ein Etikett wird für alle weiteren Funktionen wie Storno, Verladefreigabe, etc. anhand der hostseitigen Packstück-ID identifiziert. Diese wird im Feld PackstueckID übergeben und muss dementsprechend innerhalb des Versandsystems eindeutig sein.
 <br><br>
 [[HVS32_Automatik-Polling_Funktionen#Packst.C3.BCck-Verarbeitung_.28VersandDatenAnfrage.29|'''Schnittstellen-Feld-Beschreibung''']]
-=== Packstück nachdrucken (VersandDatenWdhDruck) [Telegram=Nachdruck] ===
+===Packstück nachdrucken (VersandDatenWdhDruck) [Telegram=Nachdruck]===
 Die Gatewayfunktion VersandDatenWdhDruck wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort ein Etikett für ein Packstück nachzudrucken. Ein Etikett wird anhand der hostseitigen Packstück-ID nachgedruckt. Diese wird im Feld PackstueckID übergeben. Bei manchen Frachtführern (z.B. DPD) werden beim Nachdruck neue Trackingnummern vergeben. Somit ist die alte Trackingnummer nicht mehr gültig und das alte Versandetikett muss vernichtet werden. Die neue Trackingnummer kann in der Rückmeldung zurückgemeldet werden.
 <br><br>
 [[HVS32_Automatik-Polling_Funktionen#Etikett_nachdrucken_.28VersandDatenWdhDruck.29|'''Schnittstellen-Feld-Beschreibung''']]
-=== Packstück verladen/freigeben (VerladeVersandDaten) [Telegram=Verlademeldung] ===
+===Packstück verladen/freigeben (VerladeVersandDaten) [Telegram=Verlademeldung]===
 Die Gatewayfunktion VerladeVersandDaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort Packstücke für den Ausgang frei zu geben. Nur Packstücke, welche für den Ausgang freigegeben wurden, werden bei einem Tagesabschluss berücksichtigt.
 <br><br>
 [[HVS32_Automatik-Polling_Funktionen#Packst.C3.BCck_verladen.2Ffreigeben_.28VerladeVersandDaten.29|'''Schnittstellen-Feld-Beschreibung''']]
-=== Packstück stornieren (StornoVersandDaten) [Telegram=Auftrag Storno] ===
+===Packstück stornieren (StornoVersandDaten) [Telegram=Auftrag Storno]===
 Die Gatewayfunktion StornoVersandDaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort bestehende Packstücke zu stornieren, die noch nicht auf einer Ausgangsliste sind. In der Regel wird ein Packstück anhand der hostseitigen Packstück-ID storniert. Diese wird im Feld PackstueckID übergeben. Zusätzlich zur hostseitigen Packstück-ID kann auch die TrackingNr zur Identifikation des Packstücks beitragen, für den Fall, dass die hostseitige Packstück-ID keine Eindeutigkeit garantieren kann.
 <br><br>
 [[HVS32_Automatik-Polling_Funktionen#Packst.C3.BCck_stornieren_.28StornoVersandDaten.29|'''Schnittstellen-Feld-Beschreibung''']]

@@ Zeile 6: / Zeile 6: @@
 | Plugins DataGatewayServer || HVS32Client, PSI-Server
 |}
 Die PSI-Schnittstelle wurde anhand den vorgaben der [https://www.psi.de/de/home/ PSI Software AG] umgesetzt. Es standen dabei folgende Dokumentationen zur Verfügung:
@@ Zeile 33: / Zeile 34: @@
 * Bei einer Verbuchungsanfrage werden die Daten im HVS32 zuerst nur verbucht. Es wird noch kein Etikett erzeugt.
 * Bei jeder Anfrage wird geprüft, ob eine HVS32 Station mit dem DGS verbunden ist. Sollte keine Station verbunden sein, so wird die Anfrage mit einem Fehler quittiert und somit auch das komplette Telegramm.
-* Bei einer Verbuchungsanfrage werden alle bereits verbuchten Packstücke aus diesem Telegramm im HVS32 storniert und das Hostsystem mittels einer Alarmmeldung (Telegramname von PSI für Fehlernachrichten) benachrichtigt.
+* Bei einer Verbuchungsanfrage werden alle bereits verbuchten Packstücke aus diesem Telegramm im HVS32 storniert und das Hostsystem mittels einer Alarmmeldung (Telegram von PSI für Fehlernachrichten) benachrichtigt.
 * Wenn eine HVS32 Station verbunden ist, so wird die Anfrage an die nächste freie Station weitergeleitet, in welcher die Anfrage verarbeitet wird.
 * Sollte es sich um eine Verbuchungsanfrage handeln und in diesem Prozess ein Fehler auftreten, so werden wie oben beschrieben alle Packstücke aus diesem Telegramm storniert und es erfolgt eine Alarmmeldung.
@@ Zeile 50: / Zeile 51: @@
 {| class="wikitable"
 |-
-! Parameter !! Beschreibung
+! Parameter
 |-
-| Port || Der Port, unter welchem der DGS den REST-Server zur Verfügung stellt
+| DGS REST-Server Port
 |-
-| PSI-Schnittstellenversionsnr. || Die Versionsnr., welche in jedem Telegram als VersionsNr von PSI übermittelt wird
+| PSI-Schnittstellenversionsnr.
 |-
-| PSI Endport || Der REST-Endpoint, unter welcher das PSI-System für die asynchrone Rückmeldung erreichbar ist
+| PSI Endport
 |}