Muutelugu · Täiendus?

Eesti.ee mittefunktsionaalsed nõuded v1.0

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

Nõuetekogum on mõeldud kasutamiseks eesti.ee portaaliga liituvate teenuste omanikele.

Nõuded on sõnastatud RIA arendusprojektide pikaajalise kogemuse põhjal ja markeerivad valdkondi ning küsimusi, mis vajavad erilist tähelepanu. Praktiliselt iga nõude taga on kellelgi ettetulnud probleem. Kogemusest lähtudes on üritatud sõnastada abstraktne reegel.

Kogumi nõuete täitmine on eesti.ee-ga liitumisel eelduseks.

Tundlikku teavet sisaldavad nõuded tehakse lepingulistele arendajatele kättesaadavaks eraldi.

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 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 Isikustatud teenused peavad seansihoidlana kasutama kas riigiportaali TIMUR komponenti või olema liidestatud GovSSO-ga, juhul, kui teenus liidestub eesti.ee eraisiku vaadega.

2.1.4.1 Juhul, kui liidestuv teenus soovib pakkuda teenust ka ettevõtja rollile/vaates (või ainult ettevõtja rollis/vaates), siis täna on sessiooni jagamiseks võimalik kasutada ainult TIMURi komponenti.

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

2.1.6 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.7 Liidestuva teenuse koodivaramusse ei ole soovituslik lisada pikemaid infoartikleid (va abitekstid).

2.1.7.1 Artiklite kuvamise ja haldusega seotud nõuded on kirjeldatud punktis 2.3.

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

2.2 Nõuded teenuse visuaalile

2.2.1 Teenuse loomiseks vajalikke visuaalseid elemente pakub haldaja.

2.2.2 Kui olemasolevate seas ei leidu vajalikku elementi, siis tuleb uue elemendi loomisel lähtuda eesti.ee stiiliraamatust.

2.2.2.1 Juhul, kui mitut teenust arendatakse paralleelselt ning tekib vajadus uue, kuid samaväärse elemendi järele, siis peavad uued visuaalid olema kõigis arendustes samasugused. Näide: Kui luuakse kahte erinevat teenust ja mõlemas teenuses kasutatakse sama funktsiooni täitvat nuppu, siis peavad uued nupud olema visuaalselt identsed. Erandid kooskõlastatakse riigiportaaliga.

2.2.2.2 eesti.ee stiiliraamat: https://www.figma.com/file/J58K08LMQDeHpdSfM18wU2/Eesti.ee-stiiliraamat-1.0?node-id=3:7900&t=CCFB3LPBNwmtG2Ym-0

2.2.2.3 Riigiportaaliga tuleb kooskõlastada enne arendustegevuste algust:

2.2.2.3.1 Uued visuaalsed elemendid;

2.2.2.3.2 Uute visuaalsete elementide dokumentatsioon;

2.2.2.3.3 Lõplikud visuaalid.

2.2.3 Nõuded mobiilivaatele:

2.2.3.1 Peab olema skaleeruv ehk seadmele kohanduv vastavalt riigiportaali poolt antud murdepunktidele (breakpoints);

2.2.3.2 Hoidma fookuses ühte tegevust/toimingut, näiteks menüü on peidetud e-teenuse vaates;

2.2.3.3 Sisu peab olema selgesti kättesaadav ja loetav, tehes minimaalse vajaliku arvu klikke vajaliku sisuni jõudmiseks;

2.2.3.4 Peab vältima kasutamist segavaid elemente nagu animatsioonid, bännerid, GIFid ja muud sisu tarbimist takistavad visuaalsed komponendid;

2.2.3.5 Tuleb vältida horisontaalset kerimist;

2.2.3.6 Ükski avatav element, nagu datepicker, dropdown menüüd jms, ei tohi väljuda ekraani vaateväljast ja peab mahutuma kuvatava ekraanilaiuse sisse;

2.2.3.7 Võimalusel minimeerida vertikaalset kerimist, kasutades sammu/protsessipõhist vaadet, kus sammud on välja toodud teenuse üleval ning hetkel aktiivsel sammul olev sakk on visuaalselt eristatud;

2.2.3.8 Teenusel kuvatavad vea-, info- ja hoiatusteated peavad kattuma eesti.ee teavitusevärvide ja kujundusega.

2.2.4 Pildimaterjalide ja graafika kasutamine:

2.2.4.1 Pildid peavad kasutama WEBP formaati või erandjuhul olema kohandatud veebis kasutamiseks läbi fototöötlus tarkvara;

2.2.4.2 Illustratsioonide kasutamisel peab eelistama SVG formaati;

2.2.4.3 Taustapildid ja gradiendid peavad olema CSSis base64 formaadis, et vähendada päringute arvu;

2.2.4.4 Piltide ja illustratsioonide/jooniste jmt lisamine teenustesse/rakendustesse jmt toimub pärast materjali kooskõlastamist riigiportaaliga.

2.2.5 Otsuste tegemisel lähtutakse riigiportaalis kokkulepitud kasutajamugavuse printsiipidest, UI/UX parimatest praktikatest ning teenuse kasutatavusest erinevates seadmetes.

2.3 Infoteenus

Üldnõuded

2.3.1 Artikkel (ja ka abitekst) peab olema keeleliselt korrektne, ajakohane, lihtsalt loetav, üheselt mõistetav ja informatiivne.

2.3.2 Kõikide artiklite puhul tuleb järgida ühtset eesti.ee-s kasutusel olevat keelelist stiili:

2.3.2.1 asutuste nimetused kirjutatakse eesti.ee-s väikese tähega;

2.3.2.2 kasutaja poole pöördutakse “Teie” või umbisikulist vormi kasutades;

2.3.2.3 Artiklite koostamisel tuleb arvestada Sõbraliku sõna juhendis toodud soovitustega;

2.3.3 Artiklite struktuur peab vastama ühtsetele eesti.ee artiklite ülesehituse tavadele.

2.3.3.1 Artikli kohustuslikud komponendid on:

  • Sisuartikkel;
  • Kokkuvõte;
  • Teksti autorite loetelu asutuste täpsusega;
  • Kontaktandmed, kuhu lõppkasutaja saab küsimuste korral pöörduda;
  • Märksõnad (ingl. keyword, label);
  • Vajadusel KKK, illustratsioonid, joonised vmt;
  • Informatsiooni uuendamise kuupäev.

2.3.3.2 Artikli soovituslikud komponendid on

  • Seotud seaduste nimekiri;
  • Seotud teenuste nimekiri;
  • Seotud asutuste nimekiri;
  • Seotud artiklite nimekiri;
  • Seotud blankettide nimekiri.

2.3.4 Kui punktis 2.3.3.2 loetletud komponendid artikli jaoks eksisteerivad, siis peavad need olema artiklis viidatud.

2.3.5 Igale artiklile peab määrama vähemalt viis märksõna (keyword), mille järgi on artikkel leitav eesti.ee otsingust.

2.3.6 Artiklite kuvamiseks eesti.ee lehel sisestatakse need eraldiseisvasse Artiklivaramu (ARVA) andmebaasi. ARVAle ülemineku aeg lepitakse kokku jooksvalt.

2.3.7 Artiklite tekstid peavad olema tõlgitud eesti, vene ja inglise keelde.

2.3.8 Infoteenuse asukoht eesti.ee vasakmenüüs lepitakse kokku koostöös riigiportaali ja teenusepakkujaga arvestades eesti.ee terviklikkust.

2.3.9 Artiklite juures olev tagasiside komponent on eesti.ee ülene ning selle eest vastutab haldaja.

2.3.9.1 Uute püsivate küsitluste/tagasiside vormide loomine on keelatud.

2.3.9.2 Ajutised küsitlused peavad olema kooskõlastatud riigiportaaliga.

Teenusepakkuja kohustused

2.3.10 Tekstide ajakohasena hoidmine( toimetamine, tõlgete tellimine ja sisestus) on teenusepakkuja vastutus.

2.4 Isikustatud teenused

Ärilised nõuded

Teenuse visuaal

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

2.4.2 Teenuse visuaalne asukoht eesti.ee lehel on haldaja määrata ning teenuse nimi tuleb eesti.ee-ga kooskõlastada.

2.4.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.4.4 Teenuse juures olev tagasiside komponent on eesti.ee ülene ning selle eest vastutab haldaja.

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

2.4.4.2 Ajutised küsitlused peavad olema kooskõlastatud riigiportaaliga.

2.4.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.4.6 Iga teenuse puhul peab olema loodud teenuse dokumentatsioon, mis käsitleb endas teenuse tutvustust, mille põhjal RIA kasutajatugi saab kasutajaid juhendada.

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

2.4.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.4.8 Teenus peab sisaldama minimaalselt ühte elutukse otspunkti, mis peab olema masinloetav ning mida saab siduda eesti.ee automaatsete veateadete lahendusega.

Otsing

2.4.9 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.4.9.1 Riigiportaali tuleb informeerida, kui teenusele on üles seatud eraldi Elasticsearch, et teha vajalikud täiendavad liidestused;

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

NPM pakk

2.4.10 eesti.ee’ga liidestumisel NPM pakki kasutades on 2 (kaks) võimalust:

2.4.10.1 liidestuv teenus loob NPM paki, mis ei sisalda päist, vasakmenüüd, jalust, vaid sisaldab ainult teenuse sisuosa. Sellisel juhul lisab riigiportaal teenuse ise eesti.ee-sse;

2.4.10.2 NPM core pakkide abil loob liidestuv teenus oma portaali, kus peab kasutama punktis 2.4.14 toodud eesti.ee NPM põhi pakke.

2.4.11 Teenuse liidestamisel eesti.ee-ga punktis 2.4.12.1 toodud viisil, peab NPM pakk sisaldama Angulari komponenti või komponente, mis vastavad järgmistele nõuetele:

2.4.11.1 Angulari komponent peab kasutama minimaalset Angulari versiooni, mis on kasutusel riigiportaalis eesti.ee;

2.4.11.2 Pakk peab sisaldama dokumentatsiooni komponendi/komponentide kasutusele võtmiseks;

2.4.11.3 Pakk peab sisaldama komponendi automaatteste.

2.4.12 Teenuse liidestamisel eesti.ee-ga punktis 2.4.12.2 toodud viisil peab teenus kasutama järgnevaid eesti.ee NPM põhi (ehk core) pakke (sulgudes on NPM paki nimi):

2.4.12.1 vasakmenüü (sidenav);

2.4.12.2 ümbersuunamine (redirect);

2.4.12.3 päis (header);

2.4.12.4 otsing (search);

2.4.12.5 jalus (footer);

2.4.12.6 artikkel (article) (vastavalt vajadusele);

2.4.12.7 artikli tagasiside (article_feedback) (vastavalt vajadusele).

2.4.13 Isikustatud teenus on kohustatud kasutama lisaks NPM põhi (core) pakkidele ka järgnevaid NPM pakke:

2.4.13.1 Timuri core pakk;

2.4.13.2 Timuri UI pakk.

2.4.14 Teenus peab kasutama minimaalset Angulari versiooni, mis on kasutusel eesti.ee-s.

2.4.15 NPM pakkide uute versioonide info edastatakse teenusepakkuja kontaktisikule kokkulepitud kanali kaudu. Kanal lepitakse kokku lepingus.

2.4.15.1 Kanalisse lisatakse teenusepakkuja kontaktisik riigiportaali kontaktisiku poolt;

2.4.15.2 Teenusepakkuja kontaktisik on kohustatud jälgima nimetatud kanalit ning uue väikese muudatusega (minor change) NPM paki versiooni välja tulekul peab teenusepakkuja ise mõistliku aja jooksul kasutusele võtma kõige uuema NPM paki versiooni.

2.4.16 Suure ja kriitilise muudatusega (major ja breaking change) NPM pakkide kasutusele võtmine liidestuva teenuse poolt lepitakse iga kord eraldi kokku kontaktisikute vahel.

2.4.17 Riigiportaali poolt väljaantud NPM pakkide muutmine ja täiendamine ei ole lubatud, neid tuleb kasutada oma teenuse juures olemasoleval (AS-IS) kujul.

2.5 Käideldavus

Üldtingimused

2.5.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.5.2 Teenusega seotud korralisest katkestustest peab teenusepakkuja RIA kasutajatuge (help@ria.ee) teavitama vähemalt 48 tundi enne katkestuse toimumist.

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

2.5.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.5.3.1 Teavituse tekst peab olema korrektne, lõppkasutajale arusaadav ning sobilik eesti.ee-s avaldamiseks;

2.5.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/eesti-ee-mfn