PortalData Export sendet Versanddaten von nShift an Ihre Systeme, wenn Ereignisse zu einer Sendung oder einem Paket auftreten. Sie legen fest, welche Ereignisse gesendet werden, wann sie gesendet werden, was die Datei enthält und wohin sie gesendet wird.
Wann sollten Sie diese Funktion verwenden?
Verwenden Sie PortalData Export, wenn ein externes System automatisch Sendungsereignisse von nShift empfangen muss, beispielsweise Buchungen, Sendungsverfolgungsaktualisierungen von Frachtführern oder Scans aus der Scan App.
Wichtige Begriffe
-
Export setting: die Konfiguration, die festlegt, welche Ereignisse exportiert werden, wann sie gesendet werden, was die Datei enthält und wohin sie gesendet wird.
-
Event origin: die Quelle eines Ereignisses, beispielsweise das Buchungssystem, ein Frachtführer oder die nShift Scan App.
-
Installation: die nShift-Installation, deren Sendungen exportiert werden.
-
Out-profile: das Ziel, an das Dateien weitergeleitet werden, beispielsweise ein FTP-Server, ein HTTP-Endpunkt, eine E-Mail-Adresse oder eine SMS-Nummer.
- Batching: das Sammeln von Ereignissen und deren gemeinsamer Versand nach einem Zeitplan, anstatt für jedes Ereignis eine separate Datei zu senden.
PortalData Export anfordern
Fordern Sie PortalData Export an, damit nShift eine Exporteinstellung erstellt, die Sendungsereignisse an Ihr System sendet.
Wichtig:
Nur Mitarbeiter von nShift können Exporteinstellungen erstellen und bearbeiten. Um eine Exporteinstellung zu erhalten, senden Sie eine Anfrage an den Kundenservice.
Schritte
- Legen Sie fest, welche Ereignisse exportiert werden sollen. Siehe Ereignisquellen, Ereignistypen und Filter.
- Legen Sie fest, wann die Dateien gesendet werden. Siehe Versandzeitpunkt.
- Legen Sie fest, was die Datei enthalten soll. Siehe Dateioptionen und Zusätzliche Angaben.
- Legen Sie fest, wohin die Dateien gesendet werden. Siehe Zieltypen und Versandmethoden.
- Senden Sie eine Anfrage an den Kundenservice mit den Angaben aus der Tabelle Erforderliche Anfrageinformationen.
nShift erstellt die Exporteinstellung und aktiviert sie, sobald Sie bestätigen, dass das Ziel bereit ist, Dateien zu empfangen. Es werden keine Daten exportiert, bevor die Einstellung aktiv ist.
Erforderliche Informationen für die Einrichtung
Informationen zu den Daten und Feldern im Standarddateiformat von nShift finden Sie unter Einrichtung von Standard Portal Export.
Folgende Angaben müssen Sie dem nShift-Kundenservice übermitteln:
| Angabe | Erforderliche Informationen |
|---|---|
| Benutzername | Ihr nShift Portal-Benutzername oder die UUID des Unternehmens |
| Installationen | Die ID jeder Installation, deren Daten exportiert werden sollen |
| Ereignisse | Die Ereignisquellen und Ereignistypen, die eine Datei auslösen |
| Frachtführer und Dienstleistungen | Optional. Die Frachtführer oder Dienstleistungen, die ein- oder ausgeschlossen werden sollen |
| Zeitplanung | Sofort pro Ereignis oder zu festen Uhrzeiten bzw. in festen Intervallen sowie Ihre Zeitzone |
| Dateiformat | Der Dateityp und ein Beispiel für das Layout oder eine XSLT-Datei, falls vorhanden, oder die Anforderung von unverarbeitetem XML |
| Dateiname | Die Namenskonvention, falls die Dateien bestimmte Namen benötigen |
| Ziel | Der Zieltyp und die zugehörigen Angaben. Geben Sie für E-Mail, SMS und Dateiausgabe ein Beispiel der Vorlage an. Geben Sie für HTTP die API-Dokumentation, ein Beispiel einer POST-Anfrage mit Headern und Payload, den Endpunkt und die Authentifizierungsmethode an: API-Schlüssel oder Token, OAuth mit Client-ID und Client-Secret oder JSON Web Token oder Basisauthentifizierung |
Ereignisquellen
Ereignisquellen bestimmen, welche Art von Ereignis eine Datei auslöst. Sie können mehrere Quellen auswählen.
| Wert | Bedeutung |
|---|---|
| ShipmentInsert | Ein Export, wenn eine Sendung erstellt wird |
| BookAndPrint | Ereignisse aus dem Buchungssystem, einschließlich Sendungsaktualisierungen nach dem Absenden. Dies ist die Standardeinstellung |
| CarrierData | Von Frachtführern empfangene Sendungsverfolgungsereignisse |
| ScanApp | Mit der nShift Scan App durchgeführte Scans. Erforderlich für die Filterung nach Action Center |
| ClientData | Vom Kunden übermittelte Ereignisse |
Wichtig:
ShipmentInsert und BookAndPrint können nicht gleichzeitig ausgewählt werden. Ein ShipmentInsert-Ereignis enthält bereits die Buchungsereignisse, sodass die Buchung andernfalls zweimal exportiert würde.
Ereignistypen
Ereignistypen beschränken den Export auf bestimmte Arten von Ereignissen. Ein Ereignis wird exportiert, wenn es einem der ausgewählten Typen entspricht. Wenn Sie keinen Typ auswählen, werden alle Typen exportiert.
| Wert | Bedeutung |
|---|---|
| TrackAndTrace | Sendungsverfolgungsstatusereignisse |
| Measurement | Ereignisse mit Gewichts- oder Maßangaben |
| Price | Preisereignisse |
Filter
Mit Filtern legen Sie fest, welche Ereignisse exportiert werden.
| Filter | Einschränkung |
|---|---|
| Installations | Für Kundenunternehmen erforderlich. Es werden nur Sendungen der ausgewählten Installationen exportiert |
| Event max age | Ereignisse, die älter als die angegebene Anzahl von Tagen sind, werden nicht exportiert. Der Standardwert beträgt 365 Tage. Gilt nicht für ShipmentInsert |
| Actors | Absenderkonten innerhalb der ausgewählten Installationen |
| Carriers | Die Frachtführer, die ein- oder ausgeschlossen werden sollen |
| Services | Die Dienstleistungen der ausgewählten Frachtführer, die ein- oder ausgeschlossen werden sollen. Werden in der Exporteinstellung als Products angezeigt |
| Action centers | Action Centers der Scan App. Nur mit der Ereignisquelle ScanApp verfügbar |
| Orphan shipments | Scans, die keiner Sendung zugeordnet werden konnten |
| Normalized categories and statuses | Nur Ereignisse mit diesen normalisierten Werten, beispielsweise alle Zustellereignisse verschiedener Frachtführer. Die Kategorien sind System, In transit, Delivered, Information, Carrier exception, Receiver exception und Sender exception |
| Status kind and status text | Ereignisse, die anhand einer numerischen Ereignistyp-ID oder eines exakten, zwischen Groß- und Kleinschreibung unterscheidenden Ereignisnamens pro Ereignisquelle abgeglichen werden |
| Advanced filtering | Ein benutzerdefinierter JavaScript-Filter für Anforderungen, die mit den anderen Filtern nicht umgesetzt werden können. nShift erstellt diesen Filter. Wird nicht auf ShipmentInsert angewendet |
Bei Actors, Carriers und Services kehrt der Schalter Exclude die Auswahl um, sodass alles außer den ausgewählten Einträgen exportiert wird.
Versandzeitpunkt
Die Einstellung für den Versandzeitpunkt bestimmt, wann Dateien gesendet werden.
| Option | Bedeutung |
|---|---|
| Immediately | Eine Datei pro Ereignis, die beim Auftreten des Ereignisses gesendet wird. Dies ist die Standardeinstellung |
| At fixed times | Ereignisse werden gesammelt und zu festgelegten Uhrzeiten in Ihrer Zeitzone gemeinsam gesendet, beispielsweise um 06:00 und 18:30 Uhr |
| At fixed intervals | Ereignisse werden gesammelt und in festgelegten Minutenintervallen gemeinsam gesendet |
| Grouped | Ereignisse werden gesammelt, anhand eines Schlüssels wie einer Kundenreferenz gruppiert und nach einem Zeitplan als eine Datei pro Gruppe gesendet. nShift richtet die Gruppierung mit benutzerdefiniertem JavaScript ein |
Zieltypen
| Typ | Hinweise |
|---|---|
| Nur reiner Text | |
| SMS | Nachrichten mit mehr als 160 Zeichen werden als zusätzliche SMS gesendet |
| FTP | Sowohl FTP als auch SFTP werden unterstützt. Dateien können im Standardformat, in einem angepassten Format oder unverarbeitet gesendet werden |
| HTTP | POST-Anfragen an einen einzelnen Endpunkt. Die Authentifizierung kann über Basisauthentifizierung, Bearer-Token oder einen benutzerdefinierten Header mit Schlüssel und Wert erfolgen |
Versandmethoden
| Methode | Bedeutung |
|---|---|
| Gateway | Jede Datei wird sofort an alle ausgewählten Out-Profile gesendet. Dies ist die Standardeinstellung |
| JobManager | Dateien werden in eine Warteschlange gestellt und pro Out-Profile in Aufträgen gesendet |
Hinweis: Out-Profile für E-Mail und SMS funktionieren weder mit unverarbeitetem XML noch mit JobManager.
Dateioptionen
| Option | Bedeutung |
|---|---|
| Standard format | Eine CSV- oder XML-Datei im Standardlayout von nShift. Siehe Einrichtung von Standard Portal Export |
| Customized format | Eine Datei, die mithilfe einer XSLT-Datei erstellt wird, welche das Layout definiert |
| Unprocessed XML | Die Export-XML-Datei von nShift wird unverändert und ohne Transformation gesendet |
| File type | xml, json, csv, edi oder lst. Muss dem von der Transformation erzeugten Format entsprechen |
| File name | Eine optionale Namensvorlage, die aus Platzhaltern wie der Einstellungs-ID, dem Ereignisbarcode oder dem Datum besteht. Die Vorlage muss die Dateierweiterung enthalten. Wenn das Feld leer ist, wird ein eindeutiger Name generiert |
| Compress files | Jede Datei wird als ZIP-Datei komprimiert. Nur bei Verwendung einer Transformation verfügbar |
| Single export | None exportiert jedes übereinstimmende Ereignis. Shipment sendet nur die erste Datei pro Sendung. EventLevel sendet nur die erste Datei pro Paket beziehungsweise pro Sendung bei Ereignissen auf Sendungsebene |
| Units | Länge, Volumen und Gewicht werden in die benötigten Einheiten mit 0 bis 4 Dezimalstellen umgerechnet. Intern werden die Werte in Millimetern, Gramm und Kubikmillimetern gespeichert |
Zusätzliche Angaben
Zusätzliche Angaben ergänzen die Export-XML-Datei vor der Transformation um weitere Daten.
| Wert | Hinzugefügte Informationen |
|---|---|
| Driver | Name, E-Mail-Adresse und Telefonnummer des Fahrers zum Ereignis |
| Base64Signature | Das als Base64 eingebettete Unterschriftsbild. Der Link ist immer vorhanden |
| Base64Image | Das Ereignisbild, beispielsweise ein Foto als Zustellnachweis, das als Base64 eingebettet wird |
| PriceCalculation | Das vollständige Preisberechnungsdokument des Frachtführers |
| ShipmentDetails | Zusätzliche Sammlungen von Sendungsdetails |
| ReturnLabelUrl | Öffentliche URLs und Dokumenttypen für Sendungs- und Paketdokumente, beispielsweise Rücksendeetiketten |
| Articles | Artikellisten auf Sendungs- und Paketebene |
Hinweis: Base64-Bilder und Unterschriften vergrößern die Dateien erheblich. Fordern Sie diese nur an, wenn das empfangende System sie benötigt.