PortalData Export skickar försändelsedata från nShift till dina system när händelser inträffar för en försändelse eller ett paket. Du väljer vilka händelser som skickas, när de skickas, vad filen innehåller och vart den skickas.
När ska du använda detta?
Använd PortalData Export när ett externt system automatiskt behöver ta emot försändelsehändelser från nShift, till exempel bokningar, spårningsuppdateringar från transportörer eller skanningar från Scan App.
Viktiga begrepp
-
Export setting: konfigurationen som anger vilka händelser som exporteras, när de skickas, vad filen innehåller och vart den skickas.
-
Event origin: källan till en händelse, till exempel bokningssystemet, en transportör eller nShift Scan App.
-
Installation: den nShift-installation vars försändelser exporteras.
-
Out-profile: destinationen som filerna vidarebefordras till, till exempel en FTP-server, en HTTP-slutpunkt, e-post eller SMS.
- Batching: att samla in händelser och skicka dem tillsammans enligt ett schema i stället för att skicka en fil per händelse.
Begär PortalData Export
Begär PortalData Export för att få nShift att skapa en exportinställning som skickar försändelsehändelser till ditt system.
Viktigt:
Endast nShifts medarbetare kan skapa och redigera exportinställningar. Skicka en förfrågan till kundtjänst för att få en exportinställning skapad.
Steg
- Bestäm vilka händelser som ska exporteras. Se Händelsekällor, Händelsetyper och Filter.
- Bestäm när filerna ska skickas. Se Tidpunkt för överföring.
- Bestäm vad filen ska innehålla. Se Filalternativ och Ytterligare information.
- Bestäm vart filerna ska skickas. Se Destinationstyper och Överföringsmetoder.
- Skicka en förfrågan till kundtjänst med uppgifterna i tabellen Uppgifter för förfrågan.
nShift skapar exportinställningen och aktiverar den när du bekräftar att destinationen är redo att ta emot filer. Ingenting exporteras förrän inställningen är aktiv.
Information som krävs för konfigurationen
Information om data och fält i nShifts standardfilformat finns i Konfigurera Standard Portal Export.
Uppgifter som ska skickas till nShifts kundtjänst:
| Uppgift | Vad ska anges? |
|---|---|
| Användarnamn | Ditt användarnamn för nShift Portal eller företagets UUID |
| Installationer | ID för varje installation som data ska exporteras från |
| Händelser | Händelsekällorna och händelsetyperna som utlöser en fil |
| Transportörer och tjänster | Valfritt. De transportörer eller tjänster som ska inkluderas eller exkluderas |
| Tidpunkt | Omedelbart per händelse eller vid fasta tidpunkter eller intervall samt din tidszon |
| Filformat | Filtypen och ett exempel på layouten eller en XSLT-fil om du har en, eller en begäran om obearbetad XML |
| Filnamn | Namngivningskonventionen om filerna behöver specifika namn |
| Destination | Destinationstypen och tillhörande uppgifter. För e-post, SMS och filutdata ska du inkludera ett exempel på mallen. För HTTP ska du inkludera API-dokumentationen, ett exempel på en POST-begäran med headers och payload, slutpunkten och autentiseringsmetoden: API-nyckel eller token, OAuth med klient-ID och klienthemlighet eller JSON Web Token, eller grundläggande autentisering |
Händelsekällor
Händelsekällor avgör vilken typ av händelse som utlöser en fil. Du kan välja flera.
| Värde | Betydelse |
|---|---|
| ShipmentInsert | En export när en försändelse skapas |
| BookAndPrint | Händelser från bokningssystemet, inklusive uppdateringar av försändelser efter att de skickats in. Detta är standardinställningen |
| CarrierData | Spårningshändelser som tas emot från transportörer |
| ScanApp | Skanningar som utförs med nShift Scan App. Krävs för att filtrera efter action center |
| ClientData | Händelser som skickas in av kunden |
Viktigt:
ShipmentInsert och BookAndPrint kan inte väljas samtidigt. En ShipmentInsert-händelse innehåller redan bokningshändelserna, vilket innebär att bokningen annars skulle exporteras två gånger.
Händelsetyper
Händelsetyper begränsar exporten till vissa typer av händelser. En händelse exporteras om den har någon av de valda typerna. Om du inte väljer någon typ exporteras alla typer.
| Värde | Betydelse |
|---|---|
| TrackAndTrace | Händelser för spårningsstatus |
| Measurement | Händelser med vikt eller mått |
| Price | Prishändelser |
Filter
Filter begränsar vilka händelser som exporteras.
| Filter | Vad begränsas? |
|---|---|
| Installations | Krävs för kundföretag. Endast försändelser från de valda installationerna exporteras |
| Event max age | Händelser som är äldre än det angivna antalet dagar exporteras inte. Standardvärdet är 365 dagar. Gäller inte ShipmentInsert |
| Actors | Avsändarkonton inom de valda installationerna |
| Carriers | Transportörerna som ska inkluderas eller exkluderas |
| Services | Tjänsterna från de valda transportörerna som ska inkluderas eller exkluderas. Visas som Products i exportinställningen |
| Action centers | Action centers i Scan App. Endast tillgängligt med händelsekällan ScanApp |
| Orphan shipments | Skanningar som inte kunde kopplas till en försändelse |
| Normalized categories and statuses | Endast händelser med dessa normaliserade värden, till exempel alla leveranshändelser från olika transportörer. Kategorierna är System, In transit, Delivered, Information, Carrier exception, Receiver exception och Sender exception |
| Status kind and status text | Händelser som matchas med ett numeriskt händelsetyps-ID eller ett exakt händelsenamn där stora och små bokstäver skiljs åt, per händelsekälla |
| Advanced filtering | Ett anpassat JavaScript-filter för krav som inte kan hanteras med de andra filtren. nShift skriver filtret. Används inte för ShipmentInsert |
För Actors, Carriers och Services vänder reglaget Exclude på urvalet så att allt utom de valda objekten exporteras.
Tidpunkt för överföring
Inställningen för överföringstidpunkt avgör när filerna skickas.
| Alternativ | Betydelse |
|---|---|
| Immediately | En fil per händelse, som skickas när händelsen inträffar. Detta är standardinställningen |
| At fixed times | Händelser samlas in och skickas tillsammans vid bestämda tider på dagen i din tidszon, till exempel kl. 06.00 och 18.30 |
| At fixed intervals | Händelser samlas in och skickas tillsammans med ett fast intervall på ett visst antal minuter |
| Grouped | Händelser samlas in, grupperas efter en nyckel som till exempel en kundreferens och skickas som en fil per grupp enligt ett schema. nShift konfigurerar grupperingen med anpassad JavaScript |
Destinationstyper
| Typ | Kommentarer |
|---|---|
| Endast ren text | |
| SMS | Meddelanden som är längre än 160 tecken skickas som ett extra SMS |
| FTP | Både FTP och SFTP stöds. Filer kan skickas i standardformat, ett anpassat format eller obearbetade |
| HTTP | POST-begäranden till en enda slutpunkt. Autentisering kan ske med grundläggande autentisering, bearer-token eller en anpassad header med nyckel och värde |
Överföringsmetoder
| Metod | Betydelse |
|---|---|
| Gateway | Varje fil skickas omedelbart till alla valda out-profiles. Detta är standardinställningen |
| JobManager | Filer placeras i kö och skickas som jobb per out-profile |
Obs! Out-profiles för e-post och SMS fungerar inte med obearbetad XML eller med JobManager.
Filalternativ
| Alternativ | Betydelse |
|---|---|
| Standard format | En CSV- eller XML-fil i nShifts standardlayout. Se Konfigurera Standard Portal Export |
| Customized format | En fil som skapas med en XSLT-fil som definierar layouten |
| Unprocessed XML | nShifts export-XML skickas som den är, utan omvandling |
| File type | xml, json, csv, edi eller lst. Måste motsvara formatet som omvandlingen producerar |
| File name | En valfri namnmall som byggs upp av platshållare som inställnings-ID, händelsens streckkod eller datum. Mallen måste innehålla filändelsen. Om fältet är tomt genereras ett unikt namn |
| Compress files | Varje fil komprimeras till en ZIP-fil. Endast tillgängligt vid användning av en omvandling |
| Single export | None exporterar alla matchande händelser. Shipment skickar endast den första filen per försändelse. EventLevel skickar endast den första filen per paket, eller per försändelse för händelser på försändelsenivå |
| Units | Längd, volym och vikt konverteras till de enheter du behöver, med 0 till 4 decimaler. Internt lagras värdena i millimeter, gram och kubikmillimeter |
Ytterligare information
Ytterligare information lägger till extra data i export-XML-filen innan den omvandlas.
| Värde | Vad läggs till? |
|---|---|
| Driver | Förarens namn, e-postadress och telefonnummer för händelsen |
| Base64Signature | Signaturbilden inbäddad som base64. Länken finns alltid med |
| Base64Image | Händelsebilden, till exempel ett foto som leveransbevis, inbäddad som base64 |
| PriceCalculation | Det fullständiga prisberäkningsdokumentet från transportören |
| ShipmentDetails | Ytterligare samlingar med försändelseuppgifter |
| ReturnLabelUrl | Offentliga URL:er och dokumenttyper för försändelse- och paketdokument, till exempel returetiketter |
| Articles | Artikelradlistor på försändelse- och paketnivå |
Obs! Base64-bilder och signaturer gör filerna betydligt större. Begär dem endast när det mottagande systemet behöver dem.