IMS Customer Interfaces - Schnittstellen Dokumentation
Schnittstelle Order Inbound
Siehe auch Sende Feedback
Schnittstelle Order Inbound > Schnittstelle Order Inbound

Glossary Item Box

Die Schnittstelle Order Inbound dient zur Übermittlung von Aufträgen von Kunden an IMS.

 

Das Schnittstellensystem umfasst folgende Datenformate:

Schnittstellentyp aktuelle Version Freigabedatum Beschreibung
IMS_CI_Order IMS_Schemas_Ext.PxB_CI_OI.V3130 14.04.2017 XML-Schema für Auftragsdaten
IMS_CI_ACK IMS_Schemas.PxB_CI_ACK.V1-2-0-1 01.02.2011 XML-Schema für Acknowledgedaten

 

Zur Anmeldung für diese Schnittstelle siehe Anmeldung zum elektronischen Datenaustausch

 

Um die einwandfreie Funktion der gemeinsamen Schnittstelle zu gewährleisten, wird am Beginn ein Testbetrieb durchgeführt, während dessen die Daten geprüft werden, ohne dass die übermittelten Aufträge tatsächlich in das Produktionssystem der IMS übernommen werden.

 

Showtechnische Spezifikationen

Spezifikation Beschreibung
Dateiname

CI_OI_3-1-3-0_xxxxxxxxxxx.XML

Platzhalter Inhalt
xxxxxxxxxxx

eindeutige Kennung der Schnittstellendatei, vom Kunden generiert.

Eine Schnittstellendatei (Dateiname) muss eindeutig sein. Auch im Fehlerfall abgewiesene Daten dürfen nicht mit identen Dateinamen nochmals gesendet werden.

encoding "utf-8"
Inhalt
Eine Schnittstellendatei kann immer nur einen Auftrag enthalten.

 

 

ShowKommunikation

Es stehen in der aktuellen Version zwei Kommunikationsarten zur Verfügung.

Kommunikationsart Beschreibung
FTP

Sie erhalten Zugang zum FTP-Server der IMS. Dort sind zwei Verzeichnisse vorhanden

Verzeichnis Beschreibung
inbound

Dieses Verzeichnis stellt das Empfangsverzeichnis der IMS für Ihre Datensendungen dar. In der aktuellen Version sind in diesem Verzeichnis die Aufträge abzulegen.

Beim Übertragen der Dateien ist darauf zu achten, dass der entgültige Dateiname (laut Vorgabe) erst vergeben wird, wenn die Datenübertragung abgeschlossen ist. Damit wird vermieden, dass durch zeitliche Überschneidungen eine Datei von IMS verarbeitet wird, die noch nicht vollständig übertragen wurde.

Wir empfehlen dies durch die Verwendung einer alternativen Dateiendung (z.B. ".tmp") während der Übertragung. Nach Abschluss der Übertragung ist die Datei vom Sender am FTP-Server in ".xml" umzubenennen.
outbound Dieses Verzeichnis stellt das Ausgabeverzeichnis der IMS dar. In der aktuellen Version werden von IMS in diesem Verzeichniss die Acknowledge-Meldungen (siehe) als Antwort auf erhaltene Aufträge abgelegt.

eMail

Sie erhalten von IMS eine eMail-Adresse genannt, an die sie eMails mit der Schnittstellendatei als Anhang senden können. IMS benötigt vom Kunden eine eMail-Adresse, an die Outbounds gesendet werden.

Feld Beschreibung

 

Inbound

Bitte versenden Sie Ihre eMails immer als Plain-Text eMails.
Empfänger

Als eMail-Empfänger ist immer folgende eMail-Adresse anzugeben:

"interfaces.at@imscargo.com"

Senden Sie keine anderen eMails an diese eMail-Adresse außer eMails mit Schnittstellendateien. Die eMails werden ausschließlich elektronisch verarbeitet und nicht an natürliche Personen weitergeleitet!
Betreff

Der Eintrag in der Betreffzeile muss mit dem Text "IMS Order-Inbound" beginnen. Der restliche Text kann frei vergeben werden.
Text Der Text im Textteil der eMail wird vom Schnittstellensystem ignoriert. Da diese eMails ausschließlich vom Schnittstellensystem gelesen werden, dürfen im Textbereich keine wichtigen Informationen übergeben werden.
Anhang Die Schnittstellendatei muss im vorgegebenen Dateinamenformat als Anhang der eMail beiliegen (siehe technische Spezifikation oben)
Bestätigung Der IMS eMail-Server sendet für erhaltene eMails an diesem Mailaccount keine Empfangs- und/oder Lesebestätigungen. Der Erhalt der Daten wird alleinig über die Zusendung des Acknowldege (siehe) bestätigt.

 

Outbound
Absender

Der Absender für eMails generiert durch das IMS Schnittstellensystem lautet immer:

"CustomerInterfaceRobot@imscargo.com"

Senden sie keine Antworten an diesen Absender. Diese eMails werden vom eMail-Server ignoriert.
Betreff

Der Text im Feld Betreff für den Versand von Acknowledge-Meldungen lautet:

"Customer-Interfaces Order-Inbound ACK für File ID nnnnnn"

wobei "nnnnnnn" = GUID (der Message-Ident der zugrundeliegenden Datensendung (Inbound) )
Text Im Textbereich wird der Inhalt der Datensendung angeführt und dient nur zu Informationszwecken.
Anhang Als Anhang erhalten Sie die Schnittstellendatei gemäß deren technischer Spezifikation (siehe oben)
Bestätigung Das Schnittstellensystem versendet die eMails ohne Anforderung von Empfangs- und/oder Lesebestätigungen.

Inhalt
Eine Schnittstellendatei zur Auftragsübermittlung kann immer nur einen Auftrag enthalten.

 

ShowAblaufdiagramm

Ablaufdiagramm

 

ShowLegende

Sendungsnummer Beschreibung
1

Versand des Auftrags an IMS

Schnittstellentyp Richtung
IMS_CI_Order Outbound

2

Versand des "technical acknowledge" von IMS an Kunden

Schnittstellentyp Richtung
IMS_CI_ACK Outbound

Mit dem Versand eines technical acknowledge bestätigt IMS den Erhalt der Datensendung (in diesem Fall des Order Inbounds).

Das technische ACK bestätigt nur den Erhalt der Datensendung, nicht deren Gültigkeit und erfolgreiche Verarbeitung !

Treten beim Empfang der Datensendung Fehler auf, wird kein technical acknowledge erstellt!

Aufgrund der vielen Systeme, die bei der Datenübertragung aktiv sind (z.B.: FTP Server offline, Kopiervorgang abgebrochen, Schnittstellensystem nicht online, ...) ist es nicht möglich, ein negatives technical ACk zu senden. Bitte stellen Sie in Ihrem System sicher, dass Datensendungen, für die Sie innerhalb von 30 Minuten kein technical ACK erhalten, als fehlerhaft gemeldet werden. In diesem Fall muss eine Fehlersuche im Übertragungsweg vorgenommen werden.
3

Information über Fehler in der XML-Struktur und/oder Fehler im Inhalt von einzelnen Knoten/Felder.

Versand des data acknowledge an den Kunden mit Informationen über Fehler in der Datenstruktur oder den enthaltenen Werten.

Schnittstellentyp Richtung
IMS_CI_ACK Outbound

Das Auftreten von Fehlern in den Datenfeldern und/oder der Struktur des XML-Dokuments beendet die Verarbeitung der Datesendung bei IMS. Die nachfolgende, logische Prüfung kann nicht durchgeführt werden. Es kann also durchaus vorkommen, dass Ihre Datensendung nach Korrektur der in diesem ACK angeführten Fehler bei erneuter Sendung bei der logischen Prüfung abgelehnt wird.

siehe IMS_CI_ACK
4

Information über logische Fehler in der Datensendung (z.B.: Gefahrengüter ohne Gefahrengutdefinitionen, Angabe von Schiffsdaten in falscher Relation, ...)

Versand des data acknowledge an den Kunden mit Informationen über Fehler bei der Verarbeitung des order inbounds.

Schnittstellentyp Richtung
IMS_CI_ACK Outbound

siehe IMS_CI_ACK
5

Information über logische Fehler beim Import des order inbounds.

Versand des data acknowledge an den Kunden mit Informationen über Fehler bei der Verarbeitung des order inbounds.

Schnittstellentyp Richtung
IMS_CI_ACK Outbound

siehe IMS_CI_ACK
6

Versand des data acknowledge an den Kunden als Bestätigung über die erfolgreiche Übernahme des order inbounds als Kundenauftrag in das Produktionssystem der IMS.

Schnittstellentyp Richtung
IMS_CI_ACK Outbound

Das data ACK enthält auch die Referenznummern der Auftragsdaten im Produktionssystem der IMS.

siehe auch IMS_CI_ACK
7 Die von IMS im data acknowledge gesendeten IMS-Referenzen müssen von Ihnen nicht in Ihr System übernommen werden. Evtl. nachfolgende Informationen durch Schnittstellen des Systems Customer Interfaces sind immer mit den von Ihnen im Order Inbound angegebenen Referenzen versehen.

 

Siehe auch

©IMS CARGO Austria GmbH 2017. Alle Rechte vorbehalten