PortalData Export sender forsendelsesdata fra nShift til systemene dine når det oppstår hendelser knyttet til en forsendelse eller pakke. Du velger hvilke hendelser som sendes, når de sendes, hva filen inneholder, og hvor den sendes.
Når skal du bruke dette?
Bruk PortalData Export når et eksternt system automatisk må motta forsendelseshendelser fra nShift, for eksempel bestillinger, sporingsoppdateringer fra transportører eller skanninger fra Scan App.
Sentrale begreper
-
Export setting: konfigurasjonen som definerer hvilke hendelser som eksporteres, når de sendes, hva filen inneholder, og hvor den sendes.
-
Event origin: kilden til en hendelse, for eksempel bestillingssystemet, en transportør eller nShift Scan App.
-
Installation: nShift-installasjonen som forsendelsene eksporteres fra.
-
Out-profile: destinasjonen som filene videresendes til, for eksempel en FTP-server, et HTTP-endepunkt, e-post eller SMS.
- Batching: å samle hendelser og sende dem samlet etter en tidsplan i stedet for å sende én fil per hendelse.
Be om PortalData Export
Be om PortalData Export for å få nShift til å opprette en eksportinnstilling som sender forsendelseshendelser til systemet ditt.
Viktig:
Bare nShift-ansatte kan opprette og redigere eksportinnstillinger. Send en forespørsel til kundeservice for å få opprettet en eksportinnstilling.
Trinn
- Bestem hvilke hendelser som skal eksporteres. Se Hendelseskilder, Hendelsestyper og Filtre.
- Bestem når filene skal sendes. Se Tidspunkt for sending.
- Bestem hva filen skal inneholde. Se Filalternativer og Tilleggsopplysninger.
- Bestem hvor filene skal sendes. Se Destinasjonstyper og Sendemetoder.
- Send en forespørsel til kundeservice med opplysningene i tabellen Opplysninger til forespørselen.
nShift oppretter eksportinnstillingen og aktiverer den når du bekrefter at destinasjonen er klar til å motta filer. Ingenting eksporteres før innstillingen er aktiv.
Opplysninger som kreves for oppsett
Se Oppsett av Standard Portal Export for informasjon om dataene og feltene i nShifts standardfilformat.
Opplysninger som skal sendes til nShifts kundeservice:
| Element | Hva skal inkluderes? |
|---|---|
| Brukernavn | Brukernavnet ditt i nShift Portal eller bedriftens UUID |
| Installasjoner | ID-en til hver installasjon det skal eksporteres fra |
| Hendelser | Hendelseskildene og hendelsestypene som utløser en fil |
| Transportører og tjenester | Valgfritt. Transportørene eller tjenestene som skal inkluderes eller ekskluderes |
| Tidspunkt | Umiddelbart per hendelse, eller faste tidspunkter eller intervaller, samt tidssonen din |
| Filformat | Filtypen og et eksempel på oppsettet eller en XSLT-fil hvis du har en, eller en forespørsel om ubehandlet XML |
| Filnavn | Navnekonvensjonen hvis filene må ha bestemte navn |
| Destinasjon | Destinasjonstypen og tilhørende opplysninger. For e-post, SMS og filutdata må du inkludere et eksempel på malen. For HTTP må du inkludere API-dokumentasjonen, et eksempel på en POST-forespørsel med headere og payload, endepunktet og autentiseringsmetoden: API-nøkkel eller token, OAuth med klient-ID og klienthemmelighet eller JSON Web Token, eller grunnleggende autentisering |
Hendelseskilder
Hendelseskilder bestemmer hvilken type hendelse som utløser en fil. Du kan velge flere enn én.
| Verdi | Betydning |
|---|---|
| ShipmentInsert | Én eksport når en forsendelse opprettes |
| BookAndPrint | Hendelser fra bestillingssystemet, inkludert oppdateringer av forsendelser etter innsending. Dette er standardinnstillingen |
| CarrierData | Sporingshendelser mottatt fra transportører |
| ScanApp | Skanninger utført med nShift Scan App. Kreves for å filtrere etter action center |
| ClientData | Hendelser sendt inn av kunden |
Viktig:
ShipmentInsert og BookAndPrint kan ikke velges samtidig. En ShipmentInsert-hendelse inneholder allerede bestillingshendelsene, så bestillingen ville blitt eksportert to ganger.
Hendelsestyper
Hendelsestyper begrenser eksporten til bestemte typer hendelser. En hendelse eksporteres hvis den har en av de valgte typene. Hvis du ikke velger noen typer, eksporteres alle typer.
| Verdi | Betydning |
|---|---|
| TrackAndTrace | Hendelser knyttet til sporingsstatus |
| Measurement | Hendelser med vekt eller dimensjoner |
| Price | Prishendelser |
Filtre
Filtre begrenser hvilke hendelser som eksporteres.
| Filter | Hva begrenses? |
|---|---|
| Installations | Påkrevd for kundebedrifter. Bare forsendelser fra de valgte installasjonene eksporteres |
| Event max age | Hendelser som er eldre enn dette antallet dager, eksporteres ikke. Standardverdien er 365 dager. Gjelder ikke ShipmentInsert |
| Actors | Avsenderkontoer innenfor de valgte installasjonene |
| Carriers | Transportørene som skal inkluderes eller ekskluderes |
| Services | Tjenestene fra de valgte transportørene som skal inkluderes eller ekskluderes. Vises som Products i eksportinnstillingen |
| Action centers | Action centers i Scan App. Bare tilgjengelig med hendelseskilden ScanApp |
| Orphan shipments | Skanninger som ikke kunne knyttes til en forsendelse |
| Normalized categories and statuses | Bare hendelser med disse normaliserte verdiene, for eksempel alle leveringshendelser på tvers av transportører. Kategoriene er System, In transit, Delivered, Information, Carrier exception, Receiver exception og Sender exception |
| Status kind and status text | Hendelser som samsvarer med en numerisk hendelsestype-ID eller et nøyaktig hendelsesnavn der store og små bokstaver skilles, per hendelseskilde |
| Advanced filtering | Et tilpasset JavaScript-filter for krav som ikke kan uttrykkes med de andre filtrene. nShift skriver filteret. Brukes ikke på ShipmentInsert |
For Actors, Carriers og Services snur bryteren Exclude utvalget slik at alt unntatt de valgte elementene eksporteres.
Tidspunkt for sending
Innstillingen for tidspunkt bestemmer når filene sendes.
| Alternativ | Betydning |
|---|---|
| Immediately | Én fil per hendelse, sendt når hendelsen oppstår. Dette er standardinnstillingen |
| At fixed times | Hendelser samles inn og sendes samlet på bestemte tidspunkter i løpet av dagen i din tidssone, for eksempel kl. 06.00 og 18.30 |
| At fixed intervals | Hendelser samles inn og sendes samlet med et fast intervall på et bestemt antall minutter |
| Grouped | Hendelser samles inn, grupperes etter en nøkkel som for eksempel en kundereferanse og sendes som én fil per gruppe etter en tidsplan. nShift konfigurerer grupperingen med tilpasset JavaScript |
Destinasjonstyper
| Type | Merknader |
|---|---|
| Kun ren tekst | |
| SMS | Meldinger på over 160 tegn sendes som en ekstra SMS |
| FTP | Både FTP og SFTP støttes. Filer kan sendes i standardformat, et tilpasset format eller ubehandlet |
| HTTP | POST-forespørsler til ett endepunkt. Autentisering kan bruke grunnleggende autentisering, bearer-token eller en tilpasset header med nøkkel og verdi |
Sendemetoder
| Metode | Betydning |
|---|---|
| Gateway | Hver fil sendes umiddelbart til alle valgte out-profiles. Dette er standardinnstillingen |
| JobManager | Filer legges i kø og sendes i jobber per out-profile |
Merk: Out-profiles for e-post og SMS fungerer ikke med ubehandlet XML eller med JobManager.
Filalternativer
| Alternativ | Betydning |
|---|---|
| Standard format | En CSV- eller XML-fil i nShifts standardoppsett. Se Oppsett av Standard Portal Export |
| Customized format | En fil som genereres ved hjelp av en XSLT-fil som definerer oppsettet |
| Unprocessed XML | nShifts eksport-XML sendes som den er, uten transformasjon |
| File type | xml, json, csv, edi eller lst. Må samsvare med formatet som transformasjonen produserer |
| File name | En valgfri navnemal som bygges opp av plassholdere som innstillings-ID, hendelsesstrekkode eller dato. Malen må inneholde filtypen. Hvis feltet er tomt, genereres et unikt navn |
| Compress files | Hver fil komprimeres til en ZIP-fil. Bare tilgjengelig med en transformasjon |
| Single export | None eksporterer alle samsvarende hendelser. Shipment sender bare den første filen per forsendelse. EventLevel sender bare den første filen per pakke, eller per forsendelse for hendelser på forsendelsesnivå |
| Units | Lengde, volum og vekt konverteres til enhetene du trenger, med 0 til 4 desimaler. Internt lagres verdiene i millimeter, gram og kubikkmillimeter |
Tilleggsopplysninger
Tilleggsopplysninger legger til ekstra data i eksport-XML-en før den transformeres.
| Verdi | Hva legges til? |
|---|---|
| Driver | Sjåførens navn, e-postadresse og telefonnummer for hendelsen |
| Base64Signature | Signaturbildet innebygd som base64. Lenken er alltid tilgjengelig |
| Base64Image | Hendelsesbildet, for eksempel et bilde som leveringsbevis, innebygd som base64 |
| PriceCalculation | Det fullstendige prisberegningsdokumentet fra transportøren |
| ShipmentDetails | Ekstra samlinger med forsendelsesdetaljer |
| ReturnLabelUrl | Offentlige URL-er og dokumenttyper for forsendelses- og pakkedokumenter, for eksempel returetiketter |
| Articles | Varelinjelister på forsendelses- og pakkenivå |
Merk: Base64-bilder og signaturer gjør filene betydelig større. Be bare om disse når mottakersystemet trenger dem.