PortalData Export lähettää lähetystietoja nShiftistä järjestelmiisi, kun lähetykseen tai pakettiin liittyy tapahtumia. Voit valita, mitkä tapahtumat lähetetään, milloin ne lähetetään, mitä tiedosto sisältää ja minne se lähetetään.
Milloin tätä käytetään?
Käytä PortalData Exportia, kun ulkoisen järjestelmän on vastaanotettava automaattisesti lähetystapahtumia nShiftistä, kuten varauksia, kuljetusliikkeiden seurantapäivityksiä tai Scan App -sovelluksella tehtyjä skannauksia.
Keskeiset käsitteet
-
Export setting: määritys, joka määrittää, mitkä tapahtumat viedään, milloin ne lähetetään, mitä tiedosto sisältää ja minne se lähetetään.
-
Event origin: tapahtuman lähde, kuten varausjärjestelmä, kuljetusliike tai nShift Scan App.
-
Installation: nShift-asennus, jonka lähetykset viedään.
-
Out-profile: kohde, johon tiedostot välitetään, kuten FTP-palvelin, HTTP-päätepiste, sähköposti tai tekstiviesti.
- Batching: tapahtumien kerääminen ja lähettäminen yhdessä aikataulun mukaisesti sen sijaan, että jokaisesta tapahtumasta lähetettäisiin erillinen tiedosto.
PortalData Exportin pyytäminen
Pyydä PortalData Exportia, jotta nShift voi luoda vientimäärityksen, joka lähettää lähetystapahtumat järjestelmääsi.
Tärkeää:
Vain nShiftin työntekijät voivat luoda ja muokata vientimäärityksiä. Voit pyytää vientimääritystä lähettämällä pyynnön asiakaspalveluun.
Vaiheet
- Päätä, mitkä tapahtumat viedään. Katso Tapahtumien lähteet, Tapahtumatyypit ja Suodattimet.
- Päätä, milloin tiedostot lähetetään. Katso Lähetyksen ajoitus.
- Päätä, mitä tiedosto sisältää. Katso Tiedostoasetukset ja Lisätiedot.
- Päätä, minne tiedostot lähetetään. Katso Kohdetyypit ja Lähetysmenetelmät.
- Lähetä pyyntö asiakaspalveluun ja sisällytä siihen pyynnössä tarvittavien tietojen taulukossa luetellut tiedot.
nShift luo vientimäärityksen ja aktivoi sen, kun vahvistat, että kohde on valmis vastaanottamaan tiedostoja. Mitään ei viedä ennen kuin määritys on aktiivinen.
Määrityksessä tarvittavat tiedot
Lisätietoja nShiftin vakiotiedostomuodon tiedoista ja kentistä on artikkelissa Standard Portal Exportin määrittäminen.
nShiftin asiakaspalvelulle lähetettävässä pyynnössä tarvittavat tiedot:
| Tieto | Mitä tulee ilmoittaa? |
|---|---|
| Käyttäjätunnus | nShift Portal -käyttäjätunnuksesi tai yrityksen UUID-tunnus |
| Asennukset | Kunkin vietävän asennuksen tunnus |
| Tapahtumat | Tapahtumien lähteet ja tapahtumatyypit, jotka käynnistävät tiedoston lähetyksen |
| Kuljetusliikkeet ja palvelut | Valinnainen. Kuljetusliikkeet tai palvelut, jotka sisällytetään vientiin tai jätetään sen ulkopuolelle |
| Ajoitus | Heti jokaisen tapahtuman yhteydessä tai määritettyinä kellonaikoina tai aikavälein sekä aikavyöhykkeesi |
| Tiedostomuoto | Tiedostotyyppi ja esimerkki tiedoston rakenteesta tai XSLT-tiedosto, jos sellainen on käytettävissä, tai pyyntö käsittelemättömästä XML-tiedostosta |
| Tiedostonimi | Nimeämiskäytäntö, jos tiedostoilla on oltava tietyt nimet |
| Kohde | Kohdetyyppi ja sen tiedot. Sisällytä sähköpostin, tekstiviestien ja tiedostotulosteen osalta esimerkki mallista. HTTP:n osalta sisällytä API-dokumentaatio, esimerkki POST-pyynnöstä otsakkeineen ja sisältöineen, päätepiste sekä todennusmenetelmä: API-avain tai token, OAuth asiakastunnuksella ja asiakassalaisuudella tai JSON Web Tokenilla, tai perustodennus |
Tapahtumien lähteet
Tapahtuman lähde määrittää, minkä tyyppinen tapahtuma käynnistää tiedoston lähetyksen. Voit valita useita lähteitä.
| Arvo | Merkitys |
|---|---|
| ShipmentInsert | Yksi vienti, kun lähetys luodaan |
| BookAndPrint | Varausjärjestelmän tapahtumat, mukaan lukien lähetyksen päivitykset lähettämisen jälkeen. Tämä on oletusasetus |
| CarrierData | Kuljetusliikkeiltä vastaanotetut seurantatapahtumat |
| ScanApp | nShift Scan App -sovelluksella tehdyt skannaukset. Vaaditaan toimintakeskuksen perusteella suodattamiseen |
| ClientData | Asiakkaan lähettämät tapahtumat |
Tärkeää:
ShipmentInsert- ja BookAndPrint-vaihtoehtoja ei voi valita samanaikaisesti. ShipmentInsert sisältää jo varaustapahtumat, joten varaus vietäisiin kahdesti.
Tapahtumatyypit
Tapahtumatyypit rajaavat viennin tietynlaisiin tapahtumiin. Tapahtuma viedään, jos se vastaa jotakin valituista tyypeistä. Jos et valitse yhtään tyyppiä, kaikki tyypit viedään.
| Arvo | Merkitys |
|---|---|
| TrackAndTrace | Seurantatilaan liittyvät tapahtumat |
| Measurement | Painoon tai mittoihin liittyvät tapahtumat |
| Price | Hintatapahtumat |
Suodattimet
Suodattimilla rajataan, mitkä tapahtumat viedään.
| Suodatin | Mitä se rajaa? |
|---|---|
| Installations | Pakollinen asiakasyrityksille. Vain valittujen asennusten lähetykset viedään |
| Event max age | Tätä päivien määrää vanhempia tapahtumia ei viedä. Oletusarvo on 365 päivää. Ei koske ShipmentInsert-tapahtumia |
| Actors | Valittujen asennusten lähettäjätilit |
| Carriers | Kuljetusliikkeet, jotka sisällytetään vientiin tai jätetään sen ulkopuolelle |
| Services | Valittujen kuljetusliikkeiden palvelut, jotka sisällytetään vientiin tai jätetään sen ulkopuolelle. Näytetään vientimäärityksessä nimellä Products |
| Action centers | Scan App -sovelluksen toimintakeskukset. Käytettävissä vain ScanApp-tapahtumalähteen kanssa |
| Orphan shipments | Skannaukset, joita ei voitu yhdistää lähetykseen |
| Normalized categories and statuses | Vain tapahtumat, joilla on nämä normalisoidut arvot, esimerkiksi kaikkien kuljetusliikkeiden toimitetut tapahtumat. Luokat ovat System, In transit, Delivered, Information, Carrier exception, Receiver exception ja Sender exception |
| Status kind and status text | Tapahtumat, jotka vastaavat numeerista tapahtumatyypin tunnusta tai täsmällistä tapahtuman nimeä, jossa isot ja pienet kirjaimet erotetaan toisistaan, tapahtumalähteittäin |
| Advanced filtering | Mukautettu JavaScript-suodatin vaatimuksiin, joita muilla suodattimilla ei voida toteuttaa. nShift kirjoittaa suodattimen. Ei käytetä ShipmentInsert-tapahtumiin |
Actors-, Carriers- ja Services-suodattimissa Exclude-valitsin kääntää valinnan päinvastaiseksi, jolloin kaikki muut paitsi valitut kohteet viedään.
Lähetyksen ajoitus
Lähetyksen ajoitus määrittää, milloin tiedostot lähetetään.
| Vaihtoehto | Merkitys |
|---|---|
| Immediately | Yksi tiedosto tapahtumaa kohti, joka lähetetään tapahtuman sattuessa. Tämä on oletusasetus |
| At fixed times | Tapahtumat kerätään ja lähetetään yhdessä tiettyinä kellonaikoina aikavyöhykkeesi mukaan, esimerkiksi klo 06.00 ja 18.30 |
| At fixed intervals | Tapahtumat kerätään ja lähetetään yhdessä määritetyin minuuttivälein |
| Grouped | Tapahtumat kerätään, ryhmitellään esimerkiksi asiakasviitteen perusteella ja lähetetään aikataulun mukaisesti yhtenä tiedostona ryhmää kohti. nShift määrittää ryhmittelyn mukautetulla JavaScriptillä |
Kohdetyypit
| Tyyppi | Huomautukset |
|---|---|
| Vain pelkkä teksti | |
| SMS | Yli 160 merkin viestit lähetetään ylimääräisenä tekstiviestinä |
| FTP | Sekä FTP että SFTP ovat tuettuja. Tiedostot voivat olla vakiomuotoisia, mukautetussa muodossa tai käsittelemättömiä |
| HTTP | POST-pyynnöt yhteen päätepisteeseen. Todennuksessa voidaan käyttää perustodennusta, bearer-tokenia tai mukautettua otsaketta, jossa on avain ja arvo |
Lähetysmenetelmät
| Menetelmä | Merkitys |
|---|---|
| Gateway | Jokainen tiedosto lähetetään välittömästi kaikkiin valittuihin out-profile-kohteisiin. Tämä on oletusasetus |
| JobManager | Tiedostot asetetaan jonoon ja lähetetään töinä out-profile-kohtaisesti |
Huomautus: Sähköposti- ja tekstiviesti-out-profile-kohteet eivät toimi käsittelemättömän XML:n tai JobManagerin kanssa.
Tiedostoasetukset
| Vaihtoehto | Merkitys |
|---|---|
| Standard format | CSV- tai XML-tiedosto nShiftin vakiorakenteessa. Katso Standard Portal Exportin määrittäminen |
| Customized format | Tiedosto, joka luodaan rakenteen määrittävän XSLT-tiedoston avulla |
| Unprocessed XML | nShiftin vienti-XML lähetetään sellaisenaan ilman muunnosta |
| File type | xml, json, csv, edi tai lst. Tiedostotyypin on vastattava muunnoksen tuottamaa muotoa |
| File name | Valinnainen nimeämismalli, joka muodostetaan esimerkiksi määrityksen tunnuksesta, tapahtuman viivakoodista tai päivämäärästä. Mallin on sisällettävä tiedostotunniste. Jos kenttä on tyhjä, luodaan yksilöllinen nimi |
| Compress files | Jokainen tiedosto pakataan ZIP-muotoon. Käytettävissä vain muunnoksen yhteydessä |
| Single export | None vie kaikki vastaavat tapahtumat. Shipment lähettää vain ensimmäisen tiedoston lähetystä kohti. EventLevel lähettää vain ensimmäisen tiedoston pakettia kohti tai lähetystason tapahtumissa lähetystä kohti |
| Units | Pituus, tilavuus ja paino muunnetaan tarvitsemiisi yksiköihin 0–4 desimaalin tarkkuudella. Sisäisesti arvot ovat millimetreinä, grammoina ja kuutiomillimetreinä |
Lisätiedot
Lisätiedot lisäävät vienti-XML:ään ylimääräisiä tietoja ennen sen muuntamista.
| Arvo | Mitä lisätään? |
|---|---|
| Driver | Kuljettajan nimi, sähköpostiosoite ja puhelinnumero tapahtumaan |
| Base64Signature | Allekirjoituskuva upotettuna base64-muodossa. Linkki on aina mukana |
| Base64Image | Tapahtuman kuva, esimerkiksi toimitustodistuskuva, upotettuna base64-muodossa |
| PriceCalculation | Kuljetusliikkeen täydellinen hinnanlaskenta-asiakirja |
| ShipmentDetails | Lähetyksen lisätietokokoelmat |
| ReturnLabelUrl | Julkiset URL-osoitteet ja asiakirjatyypit lähetys- ja pakettiasiakirjoille, kuten palautustarroille |
| Articles | Tuoteriviluettelot lähetys- ja pakettitasolla |
Huomautus: Base64-kuvat ja allekirjoitukset kasvattavat tiedostokokoa huomattavasti. Pyydä niitä vain, jos vastaanottava järjestelmä tarvitsee niitä.