Muutelugu · Täiendus?

Nõuded eesti.ee-ga liituvatele teenustele (Orbeon xForms) v1.0

· I Teenuste liidestamine eesti.ee-ga · II Ärilised ja tehnilised nõuded · III Muud nõuded

Mõisted

Riigi Infosüsteemi Amet (edaspidi RIA) - Teabevärava eesti.ee haldaja (edaspidi haldaja).

Riigiportaali osakond ehk riigiportaal - eesti.ee portaali eest vastutav RIA osakond.

Teenusepakkuja - teenust pakkuva andmekogu vastutav töötleja või teabevaldaja (sh infoteenuse omanik) või andmekogu volitatud töötleja või nende poolt volitatud esindaja; haldaja (RIA) lepinguline partner.

Lõppkasutaja - eraisikust või ettevõtjast teenuse tarbija kes võib olla eesti kodanik, elanik, välismaalane või Eestis tegutsev juriidiline isik.

Artikkel - eesti.ees avaldatud kirjutis, mis ei ole abitekst.

Teabevaldaja - avaliku teabe seaduse § 5 lõikes 1 nimetatud asutus ja isik, kes on artiklis toodud teabe omanik.

Teenus ehk avalik teenus - avalike ülesannete täitmisel üldistes huvides osutatav teenus, mis on suunatud avalike hüvede pakkumisele, avaliku ülesandega kaasneva kohustuse täitmisele või põhiõiguste, vabaduste ja huvide kaitsele.

Infoteenus - teenusepakkuja koostatud ja eesti.ee lehel avaldatud informatsiooni sisaldavate artiklite kogum

Isikustatud teenus - teenus, mis eeldab isiku tuvastamist (ehk autentimist eesti.ee-s).

Abitekst - teenuse juures olev lõppkasutajale suunatud lühike teenuse sisu ja kasutamist kirjeldav tekst, mis ei ole artikkel.

Käideldavus - arvutatakse protsentuaaselt valmiga: (tegelik teenuse tööaeg/lubatud teenuse tööaeg)*100. Tegeliku teenuse tööaja hulka arvestatakse vaid teabeväravast tingitud katkestused ning ei arvestata sidussüsteemide katkestusi ja teenusepakkuja poolseid katkestusi.

Planeeritud katkestus - planeeritud katkestus on eelnevalt kokkulepitud ajavahemik, mille jooksul teenus ei ole kättesaadav. Planeeritud katkestuste hulka arvestatakse ainult teenuse tööajal toimuvaid planeeritud katkestusi. Planeeritud katkestust kasutatakse hoolduseks, testimiseks ja täienduste tegemiseks.

Planeerimata katkestus - planeerimata katkestus on mitte plaanipärane teenuse või selle funktsionaalsuse maasolek või häire nende töös. Planeerimata katkestuste hulka arvestatakse ainult teenuse tööajal aset leidvad planeerimata katkestused. Planeerimata katkestuseks ei loeta olukorda, kus häiritud on üksikute kasutajate töö, kuid asutuses (sama hoone piires) on teenus kättesaadav.

Funktsionaalsus - tegevus, mida kasutaja saab (äriteenusega seotud) rakenduse/infosüsteemi abil iseseisvalt (st ei eelda RIA inimese tegevust) sooritada.

E-ITS - Eesti infoturbestandard, mis on eestikeelne ja Eesti õigusruumile vastav infoturbe käsitlemise alus. See on kooskõlas rahvusvaheliselt tunnustatud infoturbehalduse standardiga ISO/IEC 27001.

Artiklivaramu - avalike artiklite hoidmise ja haldamise keskkond, mis on ühendatav teiste keskkondadega ja milles olev info on ristkasutatav. Artiklivaramus sisalduva info eest vastutavad teabevaldajad st neil tuleb infot hoida ajakohasena ning seda vajadustest lähtuvalt muuta.

TIMUR - riigiportaali autentimisliides ja seansihoidla. Hoiab enda andmehoidlas infot aktiivsetest seanssidest.

TARA - riigi autentimisteenus.

GovSSO - ühekordse sisselogimise funktsionaalsus TARA teenuses (tehniliselt võib olla SSO funktsionaalsust pakkuv rakendus TARA teenuse ees).

X-tee - andmevahetuse platvorm, mis võimaldab turvaliselt asutuste vahel teavet pärida ja vahetada.

NPM (Node Package Manager) - JavaScripti käituskeskkonna Node.js paketihaldur.

SDG - Single Digital Gateway ehk ühtne digivärav, mille eesmärk on lihtsustada rahvusvaheliselt tegutsevate ettevõtete toimimist ning kodanike mugavat asjaajamist. Selleks luuakse Euroopa Liidu siseturu võrgustik, mis võimaldab ettevõtjatel ja kodanikel saada aja- ja asjakohast teavet ning abi ühest kohast.

Nõuded

I Teenuste liidestamine eesti.ee-ga*

*kehtib seni kuni ei ole hetkel kehtivat eesti.ee määrust muudetud

1.1 Teenusepakkuja poolt volitatud isik täidab ja edastab iga uue teenuse liidestamise avalduse RIA kasutajatoele (help@ria.ee) või elektroonilise veebivormi kaudu. Avalduse vormi kehtestab haldaja.

1.2 Hetkel kehtiva eesti.ee määruse põhjal täidab Teenusepakkuja avalduses järgnevad punktid:

1.3 Teenuse liidestamine eesti.ee-ga või registeerimisest keeldumine toimub maksimaalselt 20 tööpäeva jooksul alates avalduse esitamisest. Selle käigus kontrollib haldaja teenuse nõuetele vastavust, tehnilist sobivust ning kasutatavust.

1.4 Teenusepakkuja kontrollib peale teenuse avaldamist eesti.ee eeltoodangu keskkonnas (stage keskkond), kas teenuse töökindlus ja vajalik funktsionaalsus vastab soovitule. Teenusepakkuja peab arvestama, et teenuse kasutamiseks vajalik funktsionaalsus peab tulema teenuse kaudu, mitte ei ole eesti.ee funktsionaalsusel põhinev.

1.4.1 Kui vastab, avaldatakse teenus toodangu keskkonnas esimesel võimalusel.

1.4.2 Kui ei vasta, siis tuvastatakse, kas tekkinud viga on seotud eesti.ee või teenuse endaga ning lepitakse kokku edasised tegevused vea kõrvaldamiseks.

II Ärilised ja tehnilised nõuded

2.1 Üldnõuded

2.1.1 eesti.ee-ga liidestuvad teenused peavad arvestama lõppkasutaja keelevalikuga. Näiteks kui kasutaja on valinud eesti.ee kuvakeeleks inglise keele, siis ühelt teenuselt teisele liikumine ei tohi seda valikut mõjutada.

2.1.2 Teenused, mis liidetakse eesti.ee-ga, peavad olema turvatestimisel saanud hinnangu toodangukõlbulik.

2.1.3 Teenuse ja eesti.ee liitumislahenduse (kui see on vajalik) turvatestimise tellib RIA pärast seda, kui punktis 2.2 toodud nõuded teenuse visuaalile on täidetud. Turvatestimise kulud katab teenusepakkuja.

2.1.3.1 Liitumislahendust turvatestitakse eesti.ee ja liidestuva teenuse testkeskkondades. Testimise ajal ei ole lubatud eesti.ee ega liidestuva teenuse testkeskkondade muutmine, uuendamine või muul moel manipuleerimine.

2.1.4 Teenus peab kasutama täiskomplektseid testandmeid, mida on võimalik eesti.ee testkeskkonnas (stage) teenuse testimisel välja kuvada.

2.1.5 Kui teenus on liidestatud X-tee’ga, siis peavad ka X-tee testkeskkonnas olema teenuse testimiseks täiskomplektsed testandmed. Kui need andmed on seotud kindlate testisikutega, tuleb testisikute andmed edastada haldajale.

2.1.6 Liidestuva teenuse koodivaramusse ei ole soovituslik lisada pikemaid infoartikleid (va abitekstid).

2.1.7 Teenuse ja selles olevate andmete varundamine ei kuulu haldaja kohustuste hulka.

2.2 Nõuded teenuse visuaalile

2.2.1 Vorm peab olema ilma stiilideta

2.2.2 Visuaalid pannakse HTML elementidele külge eesti.ee poolt

2.2.3 Vorm ei tohi sisaldada HTML elemente, millel pole eesti.ee-s stiile küljes.

2.2.3.1 Toetatud elemendid on:

2.2.3.1.1 Sisestusväljad (ingl input fields);

2.2.3.1.2 Nupud (ingl buttons);

2.2.3.1.3 Lingid (ingl links);

2.2.3.1.4 Abitekstid (ingl tooltip);

2.2.3.1.5 Raadio nupud (ingl radio buttons);

2.2.3.1.6 Märkeruut (ingl checkbox);

2.2.3.1.7 Kalendrisisestusväli (ingl datepicker);

2.2.3.1.8 Viisard (ingl wizard stepper)

2.2.3.1.9 Faili üleslaadimine (ing file upload)

2.2.4 Eesti.ee poolt mitte toetatavad elemendid tuleb läbi rääkida eraldi.

2.2.5 Vormide funktsionaalne kasutatavus (JavaScript kood) sealhulgas ligipääsetavus (WCAG 2.2 AA ja EN 301 549) peab olema tagatud vormi sees teenuse looja poolt.

2.3 Isikustatud teenused

Ärilised nõuded

Teenuse visuaal

2.3.1 Teenuste arendamisel tuleb jälgida nõudeid, mis on kirjeldatud punktis 2.2.

2.3.2 Teenuse visuaalne asukoht eesti.ee lehel on haldaja määrata ning teenuse nimi tuleb haldajaga kooskõlastada.

2.3.3 Lõppkasutajale kuvatavad teenuse tekstid (sh abitekstid, päringu vastused jmt) peavad olema tõlgitud eesti, vene ja inglise keelde.

Otsing ja tagasiside

2.3.4 Teenuse juures olev tagasiside komponent on eesti.ee ülene ning selle eest vastutab haldaja.

2.3.4.1 Uute püsivate küsitluste/tagasiside vormide loomine on keelatud;

2.3.4.2 Ajutised küsitlused peavad olema kooskõlastatud haldajaga.

2.3.5 Haldaja tagab vajaminevad otsingu baaskomponendi arendused. Otsing on eesti.ee ülene ning teenusesiseste otsingute loomine pole lubatud, va põhjendatud juhul, kui teistmoodi ei ole võimalik tagada teenuse kasutatavus. Lubatud on teenusesisesed filtrid.

Kasutajatugi

2.3.6 Iga teenuse puhul peab olema loodud teenuse dokumentatsioon, mis käsitleb endas teenuse tutvustust, mille põhjal RIA kasutajatugi saab kasutajaid juhendada.

2.3.6.1 Teenuses kuvatava ebakorrektse sisu kohta käivad küsimused ja keerulisemad probleemid suunatakse vaikimisi lahendamiseks teenusepakkuja kasutajatoele.

2.3.7 Teenuse juures peab olema teenusepakkuja nimi ja kasutajatoe kontakt (nii telefoninumber kui e-maili aadress), kuhu lõppkasutaja saab teenusega seotud küsimuste ja probleemidega pöörduda.

Tehnilised nõuded

Üldnõuded

2.3.8 Teenus peab sisaldama masinloetavat elutukse otspunkti, mis peab olema eesti.ee-le kättesaadav.

Orbeon xForms

2.3.9 Orbeon XForms vormide arendamisel ja muutmisel peab lähtuma käesolevatest nõuetest ja juhendist “Orbeon XForms arendusjuhend 20.03.2024”

2.3.10 Teenusepakkuja

2.3.10.1 teostab Orbeon XFormsi vormi(de) arenduse;

2.3.10.2 teeb vastava x-tee teenuse riigiportaalile (/GOV/70006317/riigiportaal-citizen) arendus-, test-, stage- ja toodangukeskkonnas kättesaadavaks;

2.3.10.3 testib XForms vormi enne selle toodangusse viimiist riigiportaali poolt;

2.3.10.4 teavitab riigiportaali vormi valmisolekust avaldamiseks toodangu keskkonnas.

Uue vormi lisamisel

2.3.11 Uue teenuse lisamisel peab teenusepakkuja tegema uue avalduse. Teenusepakkuja poolt volitatud isik täidab ja edastab iga uue teenuse liidestamise avalduse RIA kasutajatoele (help@ria.ee) või elektroonilise veebivormi kaudu. Avalduse vormi kehtestab haldaja.

2.3.12 Igakordsel uue vormi lisamisel peab teenuse omanik edastama riigiportaalile lisaks punktis 1.2 nõutud andmetele järgnevad andmed:

2.3.12.1 Uue vormi faili nimi või nimed koos kausta teekonnaga või link koodivaramus olevale muudetud vormi failile

2.3.12.2 Soovituslik kuupäev, millal peab vorm jõudma toodangusse. Täpne kuupäev ja aeg lepitakse kokku riigiportaaliga.

Vormi muutmisel

2.3.13 Igakordsel vormi muutmisel peab teenuse omanik edastama riigiportaalile järgnevad andmed:

2.3.13.1 Kirjeldus, mida vormis muudeti.

2.3.13.2 Ekraanipildid olukorras “enne” ja “pärast”, kus “pärast” piltidel on välja toodud muudetud kohad.

2.3.12.3 Muudetud vormi faili nimi või nimed koos kausta teekonnaga või link koodivaramus olevale muudetud vormi failile.

2.3.12.4 Soovituslik kuupäev, millal peab uuendatud vorm jõudma toodangusse. Täpne kuupäev ja aeg lepitakse kokku riigiportaaliga.

2.3.14 Vormi muutmise sisu vormistatakse lepingu lisana.

2.3.15 Juba olemasolevate failide asukohti ja nimetusi ning sisu ei ole lubatud muuta.

Otsing

2.3.16 Teenuses olevad otsitavad andmed tuleb indekseerida minimaalselt Elasticsearch versioonis 7.x või Opensearch versioonis 2.5. Selleks saab kasutada riigiportaali enda Elasticsearch’i või teenuse juurde listakse eraldi Elasticsearch.

2.3.16.1 Riigiportaali tuleb informeerida, kui teenusele on üles seatud eraldi Elasticsearch, et teha vajalikud täiendavad liidestused;

2.3.16.2 Otsingu tulemused kuvatakse eesti.ee ühtsel otsingutulemuste lehel.

2.4 Käideldavus

Üldtingimused

2.4.1 Käideldavuse osas tuleb lähtuda määruse “Eesti teabevärava eesti.ee haldamise, teabe kättesaadavaks tegemise, arendamise ning kasutamise nõuded ja kord” § 15s sätesatust.

Korralised ja planeerimata teenuse katkestused

2.4.2 Teenusega seotud korralisest katkestustest peab teenusepakkuja RIA kasutajatuge (help@ria.ee) teavitama vähemalt 48 tundi enne katkestuse toimumist.

2.4.2.1 Nädalavahetusel ja/või esmaspäeval toimuvatest katkestustest tuleb teavitada hiljemalt katkestusele eelneval reedel kell 10.00.

2.4.3 Korralise teenuse katkestuse korral eesti.ee lehel avaldatava teavituse teksti koostab ja edastab RIA kasutajatoele (help@ria.ee) teenusepakkuja kolmes keeles (eesti, vene ja inglise keeles).

2.4.3.1 Teavituse tekst peab olema korrektne, lõppkasutajale arusaadav ning sobilik eesti.ee-s avaldamiseks;

2.4.4 Teenusega seotud planeerimata katkestustest peab teenusepakkuja RIA kasutajatuge (help@ria.ee) teavitama niipea kui võimalik, märkides võimaluse korral katkestuse eeldatava lõppaja.

III Muud nõuded

3.1 Teenusepakkuja peab arvestama eesti.ee ekspluatatsiooninõuetega.

3.2 Teenusepakkuja peab arvestama eesti.ee määruses toodud nõudeid: https://www.riigiteataja.ee/akt/104102013008?leiaKehtiv.

3.3 Teenusepakkuja peab arvestama SDG määruses toodud nõudeid: https://eur-lex.europa.eu/legal-content/ET/ALL/?uri=CELEX:62010TB0484(01).

https://github.com/e-gov/orbeon-mfn