PortalData Export sender forsendelsesdata fra nShift til dine systemer, når der opstår hændelser på en forsendelse eller pakke. Du vælger, hvilke hændelser der sendes, hvornår de sendes, hvad filen indeholder, og hvor den sendes hen.
Hvornår skal du bruge dette?
Brug PortalData Export, når et eksternt system automatisk skal modtage forsendelseshændelser fra nShift, f.eks. bookinger, sporingsopdateringer fra transportører eller scanninger fra Scan App.
Centrale begreber
-
Export setting: konfigurationen, der definerer, hvilke hændelser der eksporteres, hvornår de sendes, hvad filen indeholder, og hvor den sendes hen.
-
Event origin: kilden til en hændelse, f.eks. bookingsystemet, en transportør eller nShift Scan App.
-
Installation: den nShift-installation, hvis forsendelser eksporteres.
-
Out-profile: destinationen, som filerne videresendes til, f.eks. en FTP-server, et HTTP-endpoint, e-mail eller SMS.
- Batching: indsamling af hændelser, som sendes samlet efter en tidsplan i stedet for at sende én fil pr. hændelse.
Anmod om PortalData Export
Anmod om PortalData Export for at få nShift til at oprette en eksportindstilling, der sender forsendelseshændelser til dit system.
Vigtigt:
Kun nShift-medarbejdere kan oprette og redigere eksportindstillinger. Du skal sende en anmodning til kundeservice for at få oprettet en.
Trin
- Beslut, hvilke hændelser der skal eksporteres. Se Hændelseskilder, Hændelsestyper og Filtre.
- Beslut, hvornår filerne skal sendes. Se Tidspunkt for afsendelse.
- Beslut, hvad filen skal indeholde. Se Filindstillinger og Yderligere oplysninger.
- Beslut, hvor filerne skal sendes hen. Se Destinationstyper og Afsendelsesmetoder.
- Send en anmodning til kundeservice med oplysningerne i tabellen Oplysninger til anmodningen.
nShift opretter eksportindstillingen og aktiverer den, når du bekræfter, at destinationen er klar til at modtage filer. Der eksporteres ikke noget, før indstillingen er aktiv.
Oplysninger, der kræves til opsætning
Se Opsætning af Standard Portal Export for at se data og felter i nShifts standardfilformat.
Oplysninger, der skal sendes til nShifts kundeservice:
| Element | Hvad skal medtages? |
|---|---|
| Brugernavn | Dit brugernavn til nShift Portal eller virksomhedens UUID |
| Installationer | ID'et for hver installation, der skal eksporteres fra |
| Hændelser | De hændelseskilder og hændelsestyper, der skal udløse en fil |
| Transportører og tjenester | Valgfrit. De transportører eller tjenester, der skal medtages eller udelades |
| Tidspunkt | Straks for hver hændelse eller på faste tidspunkter eller med faste intervaller samt din tidszone |
| Filformat | Filtypen og et eksempel på layoutet eller en XSLT-fil, hvis du har en, eller en anmodning om ubehandlet XML |
| Filnavn | Navngivningskonventionen, hvis filerne skal have bestemte navne |
| Destination | Destinationstypen og de tilhørende oplysninger. For e-mail, SMS og filoutput skal du medtage et eksempel på skabelonen. For HTTP skal du medtage API-dokumentationen, et eksempel på en POST-anmodning med headers og payload, endpointet og godkendelsesmetoden: API-nøgle eller token, OAuth med klient-id og klienthemmelighed eller JSON Web Token eller basisgodkendelse |
Hændelseskilder
Hændelseskilder bestemmer, hvilken type hændelse der udløser en fil. Du kan vælge mere end én.
| Værdi | Betydning |
|---|---|
| ShipmentInsert | Én eksport, når en forsendelse oprettes |
| BookAndPrint | Hændelser fra bookingsystemet, herunder opdateringer af forsendelser efter indsendelse. Dette er standardindstillingen |
| CarrierData | Sporingshændelser modtaget fra transportører |
| ScanApp | Scanninger foretaget med nShift Scan App. Påkrævet for at filtrere efter action center |
| ClientData | Hændelser indsendt af kunden |
Vigtigt:
ShipmentInsert og BookAndPrint kan ikke vælges samtidig. En ShipmentInsert-hændelse indeholder allerede bookinghændelserne, så bookingen ville blive eksporteret to gange.
Hændelsestyper
Hændelsestyper begrænser eksporten til bestemte typer hændelser. En hændelse eksporteres, hvis den har en af de valgte typer. Hvis du ikke vælger nogen, eksporteres alle typer.
| Værdi | Betydning |
|---|---|
| TrackAndTrace | Sporingsstatushændelser |
| Measurement | Hændelser med vægt eller dimensioner |
| Price | Prishændelser |
Filtre
Filtre begrænser, hvilke hændelser der eksporteres.
| Filter | Hvad begrænser det? |
|---|---|
| Installations | Påkrævet for kundevirksomheder. Kun forsendelser fra de valgte installationer eksporteres |
| Event max age | Hændelser, der er ældre end dette antal dage, eksporteres ikke. Standardværdien er 365 dage. Gælder ikke for ShipmentInsert |
| Actors | Afsenderkonti inden for de valgte installationer |
| Carriers | De transportører, der skal medtages eller udelades |
| Services | De tjenester fra de valgte transportører, der skal medtages eller udelades. Vises som Products i eksportindstillingen |
| Action centers | Action centers i Scan App. Kun tilgængeligt med hændelseskilden ScanApp |
| Orphan shipments | Scanninger, der ikke kunne knyttes til en forsendelse |
| Normalized categories and statuses | Kun hændelser med disse normaliserede værdier, f.eks. alle leverede hændelser på tværs af transportører. Kategorierne er System, In transit, Delivered, Information, Carrier exception, Receiver exception og Sender exception |
| Status kind and status text | Hændelser, der matches ud fra et numerisk hændelsestype-id eller det nøjagtige hændelsesnavn med forskel på store og små bogstaver, pr. hændelseskilde |
| Advanced filtering | Et tilpasset JavaScript-filter til krav, som de øvrige filtre ikke kan håndtere. nShift skriver det. Anvendes ikke på ShipmentInsert |
For Actors, Carriers og Services vender en Exclude-kontakt listen om, så alt undtagen det valgte eksporteres.
Tidspunkt for afsendelse
Indstillingen for afsendelsestidspunkt bestemmer, hvornår filerne sendes.
| Indstilling | Betydning |
|---|---|
| Immediately | Én fil pr. hændelse, som sendes, når hændelsen opstår. Dette er standardindstillingen |
| At fixed times | Hændelser indsamles og sendes samlet på bestemte tidspunkter af dagen i din tidszone, f.eks. kl. 06.00 og 18.30 |
| At fixed intervals | Hændelser indsamles og sendes samlet med et fast interval i minutter |
| Grouped | Hændelser indsamles, grupperes efter en nøgle som f.eks. en kundereference og sendes som én fil pr. gruppe efter en tidsplan. nShift konfigurerer grupperingen med tilpasset JavaScript |
Destinationstyper
| Type | Bemærkninger |
|---|---|
| Kun ren tekst | |
| SMS | Beskeder på over 160 tegn sendes som en ekstra SMS |
| FTP | Både FTP og SFTP understøttes. Filer kan være i standardformat, et tilpasset format eller ubehandlede |
| HTTP | POST-anmodninger til ét endpoint. Godkendelse kan ske med basisgodkendelse, bearer-token eller en tilpasset header med nøgle og værdi |
Afsendelsesmetoder
| Metode | Betydning |
|---|---|
| Gateway | Hver fil sendes straks til alle valgte out-profiles. Dette er standardindstillingen |
| JobManager | Filer sættes i kø og sendes i jobs pr. out-profile |
Bemærk: Out-profiles til e-mail og SMS fungerer ikke med ubehandlet XML eller med JobManager.
Filindstillinger
| Indstilling | Betydning |
|---|---|
| Standard format | En CSV- eller XML-fil i nShifts standardlayout. Se Opsætning af Standard Portal Export |
| Customized format | En fil, der genereres ved hjælp af en XSLT-fil, som definerer layoutet |
| Unprocessed XML | nShifts eksport-XML sendes, som den er, uden transformation |
| File type | xml, json, csv, edi eller lst. Skal svare til det format, som transformationen genererer |
| File name | En valgfri navneskabelon, der opbygges af tokens som f.eks. indstillings-id, hændelsesstregkode eller dato. Skabelonen skal indeholde filtypenavnet. Hvis feltet er tomt, genereres et entydigt navn |
| Compress files | Hver fil komprimeres til en ZIP-fil. Kun tilgængeligt med en transformation |
| Single export | None eksporterer alle matchende hændelser. Shipment sender kun den første fil pr. forsendelse. EventLevel sender kun den første fil pr. pakke eller pr. forsendelse for hændelser på forsendelsesniveau |
| Units | Længde, volumen og vægt konverteres til de enheder, du har brug for, med 0 til 4 decimaler. Internt er værdierne angivet i millimeter, gram og kubikmillimeter |
Yderligere oplysninger
Yderligere oplysninger tilføjer ekstra data til eksport-XML'en, før den transformeres.
| Værdi | Tilføjer |
|---|---|
| Driver | Chaufførens navn, e-mail og telefonnummer til hændelsen |
| Base64Signature | Underskriftsbilledet indlejret som base64. Linket er altid til stede |
| Base64Image | Hændelsesbilledet, f.eks. et billede som leveringsbevis, indlejret som base64 |
| PriceCalculation | Det komplette dokument med transportørens prisberegning |
| ShipmentDetails | Yderligere samlinger af forsendelsesoplysninger |
| ReturnLabelUrl | Offentlige URL'er og dokumenttyper for forsendelses- og pakkedokumenter, f.eks. returlabels |
| Articles | Varelinjelister på forsendelses- og pakkeniveau |
Bemærk: Base64-billeder og underskrifter gør filerne betydeligt større. Anmod kun om dem, når det modtagende system har brug for dem.