XML-aineistojen arkistointi

Sijainti: Arkisto > Arkiston tapahtumatyypit

Sovellukseen voidaan arkistoida XML-muotoisia aineistoja, jolloin aineiston sisällöstä tunnistetaan yritys, organisaatioyksikkö sekä hakuavainten arvot. Sovelluksessa on valmiina tapahtumatyyppi Myyntilaskut, jolla voidaan arkistoida Finvoice-muotoisia myyntilaskuaineistoja. Tälle tapahtumatyypille täytyy määritellä oikea lähdehakemisto. Muiden arkistoitavien XML-aineistojen tapahtumatyypin määrittäminen tehdään seuraavasti:

Napsauta -painiketta. Asetustasot-valintaikkuna avautuu. Valitse listasta haluamasi organisaatiotaso ja napsauta Valitse.

Kun muokkaat olemassa olevaa tapahtumatyyppiä, valitse Tapahtumatyyppi-valikosta oikea tapahtumatyyppi. Kun perustat uutta tapahtumatyyppiä, napsauta Uusi-painiketta ja anna tapahtumatyypille nimi Lisää uusi tapahtumatyyppi -ikkunalla ja paina Tallenna.

Käytössä-kohta määrittelee, onko tapahtumatyyppi käytössä vai ei. Jos Käytössä-kohtaa ei ole valittu, tapahtumatyyppi ei näy Arkisto > Haku- eikä Arkistointi-näytöillä.

Tiedostot-välilehti

Määrittele Tiedostot-välilehdelle seuraavat tiedot:

Tyylitiedosto: Tiedosto, jota käytetään XML-tiedoston ulkoasun määrittämiseen. XSL-tiedosto tarvitaan, jotta arkiston aineistoa voidaan selata mielekkäällä tavalla.
Lähdehakemisto: Hakemisto, joka on arkiston asetuksissa määritetyn hakemiston alihakemisto. Jos lähdehakemistomäärityksessä kuitenkin käytetään unc-polkua, annetaan Arkiston tapahtumatyypin lähdehakemistoksi koko hakemistopolku. Kullekin tapahtumatyypille täytyy määritellä oma, yksilöivä lähdehakemistonsa.
Muunnostiedosto: XML-aineiston arkistoitavaan muotoon muuntamisessa käytetty tyylitiedosto. Muunnostiedosto ei ole pakollinen tieto.
Tapahtuman XML-kenttä: ilmoittaa tapahtuman juurielementin eli kertoo sovellukselle, mistä XML-tiedoston elementistä arkistoinnissa käytettävät tiedot alkavat.
Liitteen XML-kenttä kertoo, mistä arkistoitavan XML-tiedoston elementistä sovellus löytää tiedon tapahtuman liitteistä. Jos arkistoitavaan aineistoon ei liity liitteitä, tämä kenttä ei ole pakollinen tieto.

Yrityksen tunnistus -välilehti

Anna seuraavat tiedot Yrityksen tunnistus -välilehdelle:

Tunnistus: Valitse, tehdäänkö tunnistus aineistoittain vai tapahtumittain. Yleensä käytetään Tapahtumittain-valintaa.
XML-kenttä: XML-aineiston kenttä, josta tunnistus tehdään.
XML-attribuutti: Jos tieto ei sijaitse XML-elementissä, vaan attribuutissa, määrittele attribuutti.
Tunnistustapa: Valitse käytetty tunnistustapa. Yrityksen tiedot on määritelty Organisaatiorakenne-sivulla:
- Kirjanpitotunniste: Yrityksen kirjanpitotunniste
- Nimi: Yrityksen nimi
- Y-tunnus: Yrityksen Y-tunnus
- Tunnus: Sovelluksen sisäinen tunnus, joka yksilöi sovellukseen perustetut yritykset. Tämä tieto ei näy käyttöliittymässä ja sitä voi käyttää tunnistukseen vain tietyissä erikoistilanteissa.
- OVT-tunnus: Yrityksen OVT-tunnus
Oletusarvo : Yrityksen oletusarvo arkistoitavalle aineistolle, jos XML-kenttä -riville määriteltyä yritystietoa ei löydy arkistoitavasta aineistosta.

Organisaatioyksikön tunnistus -välilehti

Määrittele tiedot Organisaatioyksikön tunnistus -välilehdelle samoin kuin edellä Yrityksen tunnistus -välilehden ohjeistuksessa on kerrottu. Organisaatioyksikön tunnistus ei ole pakollinen, mutta välilehden XML-kenttä -riville on kuitenkin annettava jokin tieto.

Hakuavaimet

Määrittele hakuavaimet napsauttamalla Hakuavaimet-painiketta. Hakuavaimiin määritellään muut aineiston sisällöstä tai tiedostonimestä tulkittavat kentät kuin yritys ja organisaatioyksikkö. Hakukentät voi vapaasti määritellä aineistotyypin mukaan (esimerkiksi Määrä, Valuutta, Päivä jne.). Tositepäivä on aina pakollinen hakuavain. Määrittele hakuavaimelle seuraavat tiedot:

Hakuavain: Nimi kaikilla ohjelmiston tukemilla kielillä. Hakuavain tulee näkymään arkiston haussa yhtenä hakukriteerinä.
Tyyppi: Tiedon tyyppi sovelluksessa:
- Tositepäivä: Päivämäärän oletusmuoto lähdeaineistoissa on yyyy-MM-dd. Oletuksesta poikkeavat päivämäärämuodot on esiteltävä joko aineistossa päivämääräelementin Format-attribuutin avulla tai sovelluksessa hakuavaimen Määritykset-toiminnossa (josta löytyy lisätietoa alempaa tältä sivulta).
  
  Tositepäivä-hakuavain luodaan automaattisesti, sitä ei voi poistaa eikä sen nimeä, tyyppiä tai pakollisuutta voi muuttaa. Hakuavain näytetään arkistohaussa Yleiset ehdot -välilehdellä päivämäärän selaustyökaluna, ja sen avulla rajaus määritetään päivämäärävälinä.
- Päivä: Päivämäärän muotoilua koskevat säännöt on kuvattu yllä Tositepäivä-kohdassa. Hakuavain näytetään arkistohaussa päivämäärän selaustyökaluna, ja sen avulla rajaus määritetään päivämäärävälinä.
- Aika: Muoto lähdeaineistossa hh:mm:ss. Mikäli sekunnit puuttuvat, aika arkistoituu nollana. Tätä hakuavainta ei ole mahdollista käyttää hakukriteerinä arkistohaussa.
- Rahamäärä, Summa, Vasta-arvo: Desimaaliluku jonka desimaalierotin voi lähdeaineistossa olla pilkku tai piste. Arkistohaussa rajaus määritetään arvovälinä, eli hakuehdoksi syötetään alkuarvo ja loppuarvo (tai vain toinen näistä).
- Liukuluku: Liukuluku jonka desimaalierotin voi lähdeaineistossa olla pilkku tai piste. Arkistohaussa näytetään syöttökenttä.
- Kokonaisluku: Jos lähdeaineistossa on desimaaleja, luku arkistoituu nollana. Arkistohaussa rajaus määritetään arvovälinä, eli hakuehdoksi syötetään alkuarvo ja loppuarvo (tai vain toinen näistä).
- Tositenumero: Kokonaisluku. Jos lähdeaineistossa on desimaaleja, luku arkistoituu nollana. Arkistohaussa näytetään syöttökenttä.
- Laskutyyppi: Matkalaskun tyyppi, kokonaisluku. Lähdeaineistossa ei saa olla desimaaleja, sallitut arvot ovat 0 = Matkalasku, 1 = Ulk.matkalasku, 2 = Kululasku ja kaikki muut arvot = Kaikki-valinta. Arkistohaussa näytetään valintalista.
- Toimittaja: Toimittajan nimi, teksti. Arkistohaussa näytetään ostolaskujen arkistoidut toimittajat ja niiden selaustyökalu. Arkistoinnissa ei luoda uutta toimittajaa, mikäli ostolaskun toimittajien joukosta löytyy samanniminen toimittaja.
- Teksti, Liikekumppani: Teksti. Arkistohaussa näytetään syöttökenttä.
- Valuutta: Teksti. Arkistohaussa valuutat näytetään tapahtumatyyppikohtaisessa selaustyökalussa.
Pakollisuus: Jos hakuavain on aineiston arkistoinnin kannalta pakollinen, määrittele se pakolliseksi. Jos pakollinen tieto puuttuu arkistoitavasta aineistosta, aineisto ei arkistoidu, vaan käyttäjän pitää täydentää ja arkistoida keskeneräiset aineistot Arkisto > Arkistointi-sivulla napsauttamalla Keskeneräiset tapahtumat.
XML-kenttä: XML-kenttä -sarakkeeseen määritellään tieto, mistä XML-elementistä hakuavaimen tieto löytyy. Määrittely on muotoa "Elementti/Alielementti", esimerkiksi "InvoiceDetails/PaymentTermsDetails/InvoiceDueDate". Huomaa, että XML-kenttään kirjoitetun tekstin pitää olla täsmälleen samassa muodossa kuin se on arkistoitavassa XML-aineistossakin.
XML-attribuutti: Jos tieto ei sijaitse XML-elementissä, vaan attribuutissa, määrittele attribuutti. Määrittele myös XML-kenttä, jonka attribuutissa tieto on. Esimerkiksi "InvoiceDetails/InvoiceTotalVatIncludedAmount" on XML-kenttä ja "AmountCurrencyIdentifier" on XML-attribuutti.

Määritykset-painikkeesta avautuvassa ikkunassa määritellään päivämäärien muotoilu, mikäli aineiston päivämäärän muoto poikkeaa oletuksesta. Määritykset-ikkunan Tiedosto-välilehdellä valitaan päättelytavaksi valinta Tiedostosta. Muotoilu-välilehdellä esitellään aineiston päivämäärän muotoilu seuraavien periaatteiden mukaisesti:

Mikäli muotoilu on esitelty käyttöliittymässä, ei aineistossa mahdollisesti määriteltyä Format-attribuutin muotoilua huomioida.
Mikäli aineiston päivämäärässä on kellonaika mukana, täytyy se aina esitellä (vaikka aineistolle arkistoidaan pelkkä päivämäärä).
Mikäli aineiston päivämäärä ei ole annetun muotoilun mukainen, arkistoituu aineisto ilman päivämäärätietoa.
Päivämäärän muotoilu esitetään seuraavilla merkeillä (kirjainkoko merkityksellinen):
- yy, yyyy = vuosi
- M, MM = kuukausi
- MMM = kuukausi, 3 merkkiä pitkä englanninkielinen lyhenne
- MMMM = kuukausi englanninkielisessä kirjoitusasussaan
- d, dd = päivä
- ddd = päivä, 3 merkkiä pitkä englanninkielinen lyhenne
- dddd = päivä englanninkielisessä kirjoitusasussaan
- h, hh = tunnit 12-tunnin kellon mukaan
- H, HH = tunnit 24-tunnin kellon mukaan
- m, mm = minuutit
- s, ss = sekunnit
- f, ff = sekunnin kymmenykset ja sadasosat
- t, tt = kellonajan AM/PM-tarkenne
- zzz = kellonajan erotus UTC-aikaan nähden

Esimerkkejä päivämäärämuotoiluista:

01/09/2016 (päivämäärä aineistossa) -> dd/MM/yyyy (päivämäärämuodon esittely sovelluksessa)
16-01-09 -> yy-dd-MM
2016-09-01T08:05:30 -> yyyy-MM-ddThh:mm:ss
09-01-2016T08:05:30.2410000 -> MM-dd-yyyyThh:mm:ss.fffffff
2016-09-01 8:05:30 AM -> yyyy-MM-dd hh:m:ss tt
2016/09/01 14:35:00+03:00 -> yyyy/MM/dd HH:mm:sszzz
Sep-01-2016 -> MMM-dd-yyyy
Thursday, September 1, 2016 08:05:30 AM -> dddd, MMMM d, yyyy hh:mm:ss tt

Tallenna tapahtumatyypin tiedot Tallenna-painikkeella.

Tarkista, että uusi tapahtumatyyppi on Käyttäjäprofiilit-näytön Tapahtumatyypit-välilehdellä sallittuna sellaisilla profiileilla, joiden käyttäjillä tulee olla oikeus hakea arkistosta tapahtumatyypin aineistoja.