X-tee liides
Amphora võimaldab kasutada X-tee teenuseid ning nende tulemusi kanda dokumendi vormile. Antud näites on kirjeldatud Maksu- ja Tolliameti võlapäringu teenuse seadistamine Amphorasse. Sarnaselt sellele teenusele saab kasutada muid X-tee kaudu pakutavaid teenuseid. Lüüs on põhimõtteliselt andmekogu kuhu saab ligi X-tee vahendusel. Lüüside all saab seadistada andmete pärimise ka teistest X-tee teenustest, mis väljastab lihtandmeid, ehk siis suudab kanda ühe kirje erinevad andmed dokumendi vormile. Nimekirjade haldust see liides hetkel ei toeta, ehk siis ei saa lisada kollektsioonina saabuvaid andmed dokumendi vormile.
Alustuseks on vaja teada kasutatava andmekogu parameetreid:
- xRoadInstance – kas toodang , test või arendus ( EE / ee-test / ee-dev)
- MemberCode – Teennusepakkuja registrikoodi
- MemberClass (Organisatsiooni tüüp) – GOV / COM / NGO / NNE
- Infosüsteem (subsystemCode) – teenusepakkuja teenuse alamsüsteem turvaserveris
- Infosüsteemi nimeruum – enamikel juhtudel täitmata, kuid osade teenuste vastuse töötlemiseks võib olla vajalik seadistada ka nimeruum, mille saab teensuepakkuja teenuse kirjeldusest.
Paremal veidi all on vaja määrata päringut tegeva asutuse andmed. Siin on siis vaja sisestada Amphora turvaserveri ja alamsüsteemi andmed. Need andmed leiab sellest dokumendist või saab Amphora kasutajatoe käest. Isikukood jätta täitmata, siis läheb X-tee päring selle kasutaja isikukoodiga, kes Amphoras seda teenust käivitab. Selle osa andmed on alati samad kõikide X-tee teenuste kasutamiseks.
Kui teenusepakkuja teenuse ja päringut tegeva asutuse üldised andmed on paigas siis teenuse sisend- ja väljundparameetrid saab seadista lehe all osas oleva „Päringud/teenused“ osa juures. Hetkel ei ole WSDLi alla laadimine võimalik ning samuti ei saa automaatselt veel teenuse nimekirja ning parameetreid tuvastada. Selle osa uuendame järgmistes versioonides, kui on huvi X-tee teenuseid kasutama hakata.
Järgmisena on vaja seadistada teenus(ed), mida siis on vaja kasutada.
Valida „Lisa uus päring“, seejärel avaneb uus aken, kuhu sisestada teenuse andmed. Täpsem kirjeldus järgmises peatükis.
Andmekogu teenuste seadistus
Järgnevalt on näidatud võlapäringu teenuse „vpt“ seadistamine. See osa on toodangus ja testis sama. Saab aktiveerida nõude, et ilma kasutajanime ja parooliga autenditud kasutaja ei saaks teenust käivitada. Seda on võimalik siis iga teenuse tasandil eraldi aktiveerida/deaktiveerida.
Esimene lehekülg – teenuse detailandmed
Olulised andmed esimesel lehel on:
- Teenuse nimetus – „vpt“ täpne nimetus, mis tuleb teenusepakkuja käest
- ServiceVersion – „v1“ (teenuse versioon, v1 enamikel juhtudel)
- Input root element – „keha“ (kui vastuse töötlemine ilma ei toimi, siis juurelemendi nimetuse määramine on abiks)
- Nimetus –„Võlapäring“ (vabatekstina, see kuvataks ka vormil lingi nimetusena, kui on vaja teenust käivitada)
Teine lehekülg – parameetrid
Määrab teenuse sisendid ja väljundid ehk parameetrid. Teenuse sisendise on kood ja millal ning lisaks on samad parameetrid ka väljundis. Kuupäeva juures kasutame siin käivitamise kuupäeva (DATE)ning kindlat formaati, mida teenus nõuab.
Kolmas lehekülg – õigused
Määrab kasutaja või grupi tasandil, kes teenust näeb ja saab käivitada. Kui piirata pole vaja, siis jätta täitmata.
Neljas lehekülg - testimine
Teenuse seadete testimiseks saab teha ka käivitamise. Enne käivitamist tuleks teenuse ja andmekogu (lüüsi) andmed salvestada.
Kõigepealt täidan sisendid ja seejärel käivitan
Viies lehekülg - seostamine vormidega
Kui testimine oli edukas, siis võib jätkata teenuse seadistamise vajaliku vormi(de) külge. Siin on seadistatud teenus dokumendi vormi „Jaanise test laadimine vol3“ ning elemendi „Asutus“ juurde. Asutuse lahter on tekstikast, kuhu on mõeldud sisestada asutuse registrikood. Päringu tulemus pannakse lahtritesse „“Kontrollimise aeg“ ja „Maksuvõla kontrollimise tulemus“. Lisa nupuga fikseeritakse vormi sidumine teenusega. Käivita salvestamisel jätta täitmata.
Sellega on teenus seadistatud ning salvestada lüüsi detailvaates kindlasti muudatused.
Seejärel proovida luua uus dokument vormiga Dokumendi vorm.
Käivitada x-tee teenus lingist „Võlapäring“. Ilmub uus aken, kus on info millise lüüsi päring käivitati.
Päringu lõpetamisel teate akna sisu muutub.
Kui valida „Kanna andmed vormile“, siis pannakse saadud vastused dokumendi vormil nendesse lahtritesse, mis oli eelnevalt seadistatud.
Kui dokument on eelnevalt salvestatud, siis läheb päringu käivitamise info ka dokumendi ajaloo paneelile. Lisaks läheb info alati ka süsteemi logisse. See võimaldab kontrollida, kes on päringut käivitanud.
Lisainfo
Antud näide on EMTA X-tee teenuste jaoks. listMethods on tehniline teenus ning selle võib seadistada teenuse ligipääsu testimiseks. Selles näites on oluline teenus „vpt/v1“.
Testkeskkonna seadistuse näidis
MemberClass väärtused
Vajalik lüüsi (andmekogu) seadistamisel. * GOV - Riigiasutus (valitsusasutus) * COM - Eraettevõte (äriühing) * NGO - Vabaühendus (MTÜ, SA) * NEE – Eraisik
Viimati muudetud: 30. september 2025, 16:41:00