diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8b316a..c97e657 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,13 +3,10 @@ Protokolli omanik on [Riigi Infosüsteemi Amet](https://www.ria.ee) (RIA), kes koordineerib protokolli edasist arendamist. Protokolli arendamine toimub järgnevalt: - [Kõik on oodatud esitama küsimusi, avaldama arvamust ja pakkuma omapoolseid ideid - osaledes diskussioonides, sh luues uusi Issue-sid](https://github.com/e-gov/DHX/issues) - RIA töötab sisendi läbi ja täpsustab ettepanekuid. Laiemad teemad arutatakse läbi MKMi juures paiknevas [dokumendihaldusnõukogus](https://www.mkm.ee/et/tegevused-eesmargid/infouhiskond/dokumendihaldusest-infohalduseni) (DHN). Kui ettepanek ei leia heakskiitu, siis antakse ettepaneku esitajale selle kohta tagasisidet. -- RIA lisab edasisaanud teemad [ettepanekute nimekirja](files/Ettepanekud.md) ja töötab välja vastava lahenduse ettepaneku (sh juurutuskava). +- RIA lisab edasisaanud teemad [ettepanekute nimekirja](docs/Ettepanekud.md) ja töötab välja vastava lahenduse ettepaneku (sh juurutuskava). - DHN kinnitab lahenduse sobivuse ja juurutuskava. - RIA viib muudatuse protokolli ja uuendab ettepanekute nimekirja. Muud tegevused viiakse ellu juurutuskavas olevate vastutajate poolt. ### Taustamaterjale -- [Dokumendihalduse "ökosüsteem"](files/DOK-S.md) -- [Esitlus](files/DHX_esitlus.pptx) _2.11.2016_ -- [Kirjandus](files/Kirjandus.md) -- [Vormingutevahelised seosed](https://e-gov.github.io/DHX/Vormingud.html) -- [Analüüs](files/Hajusa_dokumendivahetuse_andmevahetusprotokolli_DHX_anal%C3%BC%C3%BCs_1.2.pdf) +- [Esitlus](docs/DHX_esitlus.pptx) _2.11.2016_ +- [Analüüs](docs/Hajusa_dokumendivahetuse_andmevahetusprotokolli_DHX_anal%C3%BC%C3%BCs_1.2.pdf) diff --git a/README.md b/README.md index e499ec1..563d107 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,14 @@ ![Riigi Infosüsteemi Ameti](https://avatars3.githubusercontent.com/u/7447915 "Riigi Infosüsteemi Amet") ![](img/EL_struktuuri-_ja_investeerimisfondid_horisontaalne.jpg) -ET | [EN](docs/EN.md) - ## Dokumendivahetusprotokoll DHX -![](docs/DHX.PNG) ![](docs/X-ROAD.PNG) -__DHX on uus, X-tee v6 omadustele rajatud dokumendivahetusprotokoll, mis võimaldab Eesti avaliku sektori dokumendihaldussüsteemidel vahetada dokumente hajus- e detsentraliseeritud põhimõttel.__ +X-tee v6 omadustele rajatud hajus dokumendivahetusprotokoll. -| | | | -|-----|-------------|-----| -| | __[Protokoll](https://e-gov.github.io/DHX)__ | _kinnitatud, ametlik tekst_ | -| | [DHX adapter](https://github.com/e-gov/DHX-adapter) | _DHX-i rakendamist abistavad tarkvarakomponendid; tuleb märtsis 2017_ | -| | [Etalonteostus](https://github.com/e-gov/DHX-etalon) | _demonstreerib protokolli töötavust ja abistab DHX-i rakendajaid testimisel_ | -| | Üleminekukava | _juhised ja nõuanded DHX-i rakendajatele; märts 2017_ | -| | Rakendamise koordineerimine | _tuleb_; teave: Eneli Järve, 663 0278, eneli.jarve@ria.ee | -| | [DHX aadressiraamat](docs/DHX-aadressiraamat.md) | _näitab kes on juba DHX-le üle läinud; märts 2017_ | -| | Testimisteenus | _rakendamise õigsust saab testida [etalonteostuse](https://github.com/e-gov/DHX-etalon) abil_ | -| | [DHX standardtestid](docs/Standardtestid.md) | _soovituslik testide komplekt abiks DHX-i rakendajale_ | -| alt text | Töötoad ja teabepäevad | _tulevad_ | +[Protokolli tekst](https://e-gov.github.io/DHX) -- [Protokolli rakendamine](docs/Rakendamine.md) +[DHX adapter](https://github.com/e-gov/DHX-adapter) -- [E-arved DVK-s üleminekuperioodil](docs/E-arved.md) _töödokument_ +[Etalonteostus](https://github.com/e-gov/DHX-etalon) -- [Protokolli arendamine](CONTRIBUTING.md) +[Protokolli arendamine](CONTRIBUTING.md) diff --git a/docs/Adapter.html b/docs/Adapter.html deleted file mode 100644 index 63b7e65..0000000 --- a/docs/Adapter.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - DHX adapter - - - - - - - - - - - -
-
-
- - - -
-
- -
- - - diff --git a/docs/Arendamine.md b/docs/Arendamine.md deleted file mode 100644 index 3af4a30..0000000 --- a/docs/Arendamine.md +++ /dev/null @@ -1,16 +0,0 @@ -### Protokolli arendamine - -Protokolli omanik on [Riigi Infosüsteemi Amet](https://www.ria.ee) (RIA), kes koordineerib protokolli edasist arendamist. Protokolli arendamine toimub järgnevalt: -- [Kõik on oodatud esitama küsimusi, avaldama arvamust ja pakkuma omapoolseid ideid - osaledes diskussioonides, sh luues uusi Issue-sid](https://github.com/e-gov/DHX/issues) -- RIA töötab sisendi läbi ja täpsustab ettepanekuid. Laiemad teemad arutatakse läbi MKMi juures paiknevas [dokumendihaldusnõukogus](https://www.mkm.ee/et/tegevused-eesmargid/infouhiskond/dokumendihaldusest-infohalduseni) (DHN). Kui ettepanek ei leia heakskiitu, siis antakse ettepaneku esitajale selle kohta tagasisidet. -- RIA lisab edasisaanud teemad [ettepanekute nimekirja](../files/Ettepanekud.md) ja töötab välja vastava lahenduse ettepaneku (sh juurutuskava). -- DHN kinnitab lahenduse sobivuse ja juurutuskava. -- RIA viib muudatuse protokolli ja uuendab ettepanekute nimekirja. Muud tegevused viiakse ellu juurutuskavas olevate vastutajate poolt. - -### Taustamaterjale -- [Dokumendihalduse "ökosüsteem"](files/DOK-S.md) -- [Esitlus](files/DHX_esitlus.pptx) _2.11.2016_ -- [Kirjandus](files/Kirjandus.md) -- [Vormingutevahelised seosed](https://e-gov.github.io/DHX/Vormingud.html) -- [Analüüs](../files/Hajusa_dokumendivahetuse_andmevahetusprotokolli_DHX_anal%C3%BC%C3%BCs_1.2.pdf) - diff --git a/docs/DHX-AR-01.PNG b/docs/DHX-AR-01.PNG deleted file mode 100644 index 90d2b85..0000000 Binary files a/docs/DHX-AR-01.PNG and /dev/null differ diff --git a/docs/DHX-AR-02.PNG b/docs/DHX-AR-02.PNG deleted file mode 100644 index 4a41fa8..0000000 Binary files a/docs/DHX-AR-02.PNG and /dev/null differ diff --git a/docs/DHX-ETALON-TEST.PNG b/docs/DHX-ETALON-TEST.PNG deleted file mode 100644 index 09c1db8..0000000 Binary files a/docs/DHX-ETALON-TEST.PNG and /dev/null differ diff --git a/docs/DHX-ETALON-TEST01.PNG b/docs/DHX-ETALON-TEST01.PNG deleted file mode 100644 index 5835589..0000000 Binary files a/docs/DHX-ETALON-TEST01.PNG and /dev/null differ diff --git a/docs/DHX-MATRYOSHKA.PNG b/docs/DHX-MATRYOSHKA.PNG deleted file mode 100644 index 728bf28..0000000 Binary files a/docs/DHX-MATRYOSHKA.PNG and /dev/null differ diff --git a/docs/DHX-TRANSITION-EN.PNG b/docs/DHX-TRANSITION-EN.PNG deleted file mode 100644 index 489debe..0000000 Binary files a/docs/DHX-TRANSITION-EN.PNG and /dev/null differ diff --git a/docs/DHX-Yleminek-EE-02.PNG b/docs/DHX-Yleminek-EE-02.PNG deleted file mode 100644 index 49acf9d..0000000 Binary files a/docs/DHX-Yleminek-EE-02.PNG and /dev/null differ diff --git a/docs/DHX-Yleminek01.PNG b/docs/DHX-Yleminek01.PNG deleted file mode 100644 index 75b21ad..0000000 Binary files a/docs/DHX-Yleminek01.PNG and /dev/null differ diff --git a/docs/DHX-aadressiraamat.md b/docs/DHX-aadressiraamat.md deleted file mode 100644 index e3f89f4..0000000 --- a/docs/DHX-aadressiraamat.md +++ /dev/null @@ -1,121 +0,0 @@ -![](DHX.PNG) - -# DHX aadressiraamat - -Spetsifikatsioon - -v0.4 08.11.2016 - -Sisukord - -- [1 Ülevaade](#1-Ülevaade) -- [2 Mõisted ja lühendid](#2-mõisted-ja-lühendid) -- [3 Vajadus](#3-vajadus) -- [4 Lahendus](#4-lahendus) -- [5 Ei ole skoobis](#5-ei-ole-skoobis) -- [6 Teostus](#6-teostus) -- [Viited](#viited) -- [Muutelugu](#muutelugu) - -## 1 Ülevaade - -__DHX aadressiraamat__ on tööriist, mille abil hajusale dokumendihaldusele ülemineku erinevad osapooled saavad ülevaate sellest, kes ja kuidas on DHX-i võimekuse loonud ning kes pakuvad DHX vahendusteenust. - -## 2 Mõisted ja lühendid - -Lisaks allolevatele kasutatakse spetsifikatsioonis [dokumendivahetusprotokolli DHX mõisteid ja lühendeid](https://e-gov.github.io/DHX/#3-m%C3%B5isted-ja-l%C3%BChendid). - -| mõiste | seletus | -|--------|---------| -| _ajapildistus_ | mingil ajamomendil koostatud DHX aadressiraamat. Ajapildistus salvestatakse faili masintöödeldavas vormingus (JSON) ja teisendatakse enne RIA veebilehel avaldamist HTML-i. | -| _DHX aadressiraamat_, _DHX AR_ | konkreetse ajamomendiga seotud nimekiri, mis näitab: 1) ajamomendil DHX-i võimekust omanud asutusi; 2) ajamomendil tegutsenud DHX-i vahendajaid ja nende kliente. Asutused ja ettevõtted esitatakse nimekirjas registrikoodide ja nimetuste kaudu, sorteeritult. | -| _viimati muutunud_, ingl _diff_ | loetelu muutustest DHX aadressiraamatu seisus võrreldes mõne varasema kuupäeva seisuga. | - -## 3 Vajadus - -1. Avaliku sektori üleminek hajusale dokumendivahetusele algab plaanide kohaselt 2017. a. Erinevad sihtrühmad (asutused, arendajad, teenusepakkujad, ITAO) hakkavad RIA poole pöörduma küsimustega: - 1. kes on DHX-i vahendajad? - 2. millised asutused on DHX-i vahendajate kliendid? - 3. kes asutustest on DHX-ile juba üle läinud? - 4. millised muutused on toimunud viimasel ajal? -2. Vajame jooksvat ülevaadet ülemineku seisust. -3. Vajalik teave sisaldub mitmes allikas: - 1. X-tee globaalses konfiguratsioonis - 1. DHX nimemustriga (DHX*) alamsüsteemide andmetes - 2. DHX vahendajate grupi liikmete nimekirjas - 2. DHX-i vahendajate poolt X-teel publitseeritavates vahendusnimekirjades. -4. Puudub lihtne viis selle teave kiireks kokkusaamiseks ja inimesele esitamiseks. - -## 4 Lahendus - -4.1 Arhitektuurijoonis - -Joonis 1 - -![](DHX-AR-02.PNG) - -4.2 __Komponendid__ Tööriist koosneb järgmistest komponentidest: - - _DHX aadressiraamatu koostaja_, lühidalt _Koostaja_ - Java rakendus, mis koostab ajahetke aadressiraamatu ja salvestab selle failina kataloogi. - - _Kataloog_ - failikataloog, kuhu kogunevad ajapildistused. - - _Ülespanija_ - skript, mis käib perioodiliselt ajapildistuste kataloogi kontrollimas, võtab kõige uuema faili, teeb selle inimloetavaks (JSON -> HTML teisendus) ja paneb RIA veebilehele üles. - - seejuures koostab nimekirja "viimati muutunud". - - selleks võrdleb viimast faili asjakohase varasema failiga ning toob välja toimunud muutused. - - _RIA veeb_ - DHX aadressiraamat publitseeritakse inimloetaval kujul (HTML) RIA veebi asjakohases sektsioonis. - -4.3 __Töövoog__ Tööriist peab realiseerima protsessi: - - pöördumine - - X-tee globaalse konfiguratsiooni - - ja X-teel publitseeritavate DHX-i vahendusnimekirjade poole, - - sealt teabe kogumine ülalnimetatud neljale küsimusele vastamiseks - - teabe esitaks veebiliidese kaudu inimkasutajale. - -4.4 __Kasutajad__ - - Teenus on suunatud inimkasutajatele: DHX-i planeerijale, arendajale, haldajale, dokumendihalduse koordinaatorile jt. - - Kasutajad võivad olla nii RIA-sisesed kui ka välised. - - Tööriista põhikasutajaks kujunevad eeldatavalt RIA teenusehaldurid ja ülemineku koordinaator, kes kasutavad teavet erinevate sihtrühmade nõustamiseks, probleemide lahendamiseks, üleminekuprotsessi seireks ja statistika andmiseks dokumendihaldust koordineerivale üksusele ITAO-le. - -4.5 __Konfigureerimine__ Komponendis Koostaja peab olema konfigureeritav: - - ajapildistuse intervall - - kataloog, kuhu ajapildistus salvestatakse - - loetelu "viimati muutunud" arvutamise ajaperiood (nt 1 päev, 1 nädal vms). - -## 5 Ei ole skoobis - -5.1 __DHX-i „aadressiraamatut“ ei pakuta masinloetavalt__ - - DHX-i rakendav infosüsteem peab, DHX protokolli kohaselt, dokumendiedastuseks vajaliku aadressiotsingu teostama lokaalselt (https://e-gov.github.io/DHX/#74-lokaalne-aadressiraamat). - - Samas on tööriist projekteeritud nii, et vajadusel saab masintöödeldavat väljundit (JSON) väikese täiendusega kasutada. - -5.2 __RIHA andmete kasutamine__ Tööriist esimeses teostuses ei haara RIHAs registreeritavat teavet. RIHAst pakuks huvi see, kuidas asutused märgivad end dokumendihalduse standardlahenduste kasutajateks ja DHX-i vahendajaid oma DHS-de volitatud töötlejateks. Nimetatud protsess ei ole veel põhjalikult läbi analüüsitud. Samuti puudub RIHA-l praegu võime nimetatud andmeid masinloetaval kujul välja anda. Tööriista täiendamine RIHA andmete hõivamisega on võimalik tulevikus. - -5.3 __laiapõhjalisem DHX dokumendiliikluse, sh DHX vahendamise monitooring ja statistika__ Tööriist on mõeldud kitsa (aga olulise) teabevajaduse rahuldamiseks. Laiema ja sügavama monitooringu ning statistika tegemiseks võivad olla kasulikud X-tee monitooringulahendus vm vahendid. - -5.4 __aadressiraamatu koostamine inimkasutaja "nupuvajutuse" peale__ See võiks olla kasulik, kuid nõuaks keerukamat teostust ja otsustamist, kas juurdepääs aadressiraamatu koostamise nupule peaks olema piiratud. - -## 6 Teostus - -6.1 __Infoturve__ (_Märkus. Käesolev punkt on esialgne ja vajab täpsustamist._) - - Käideldavusnõue on madal. Ei ole hullu, kui teenus päeva maas peaks olema. - - Tervikluse nõue. DHX aadressiraamat on mõneti sarnane usaldusnimekirjaga (_Trusted Service List_), kuid aadressiraamatu andmed on siiski vaid informatiivsed. Andmed võetakse autentsetest allikatest ega läbi inimtöötlust. Kataloog peab olema kaitstud autoriseerimata muutmise eest. - - Konfidentsiaalsuse nõue on madal: RIA veebis publitseeritav DHX aadressiraamat on avalikult, ilma kasutajat autentimata kättesaadav. - - ISKE turbeaste - M (madal). - -6.2 __Olemasolevate komponentide kasutamine__ Tööriista programmeerimiseks vajalikud tarkvarakomponendid on suures osas DHX etalonteostuse käigus juba loodud. Vt [DHX adapter](https://github.com/e-gov/DHX-adapter). - -6.3 __MFN__ Rakenduvad RIA MFN, eriti Java ja logimise osas. - -6.4 __Dokumentatsioon__ Rakenduvad RIA dokumentatsiooniplaani nõuded. - -6.5. __Arendustöö maht ja keerukus__ Hinnanguliselt väike. - -## Viited - -- [Dokumendivahetusprotokoll DHX](https://e-gov.github.io/DHX/) - -## Muutelugu - -| versioon, kuupäev | muudatus | -|-------------------|----------| -| v0.1 28.10.2016 | algversioon, vt https://github.com/e-gov/DHX/issues/41 | -| v0.2 01.11.2016 | detailiseering; lisatud faili kaudu avaldamine | -| v0.3 03.11.2016 | lisatud viimase ajapildistusega võrreldes toimunud muutuste kuvamine; aadressiraamatu koostamine kasutaja nupuvajutuse peale (ei ole skoobis) | -| v0.4 08.11.2016 | lisatud 'diffi' perioodi konfigureeritavus | diff --git a/docs/DHX-adapteri-kasutamine.PNG b/docs/DHX-adapteri-kasutamine.PNG deleted file mode 100644 index 96333b8..0000000 Binary files a/docs/DHX-adapteri-kasutamine.PNG and /dev/null differ diff --git a/docs/DHX.PNG b/docs/DHX.PNG deleted file mode 100644 index 06fb10c..0000000 Binary files a/docs/DHX.PNG and /dev/null differ diff --git a/files/DHX_esitlus.pptx b/docs/DHX_esitlus.pptx similarity index 100% rename from files/DHX_esitlus.pptx rename to docs/DHX_esitlus.pptx diff --git a/docs/DVmark.css b/docs/DVmark.css deleted file mode 100644 index 48035d1..0000000 --- a/docs/DVmark.css +++ /dev/null @@ -1,27 +0,0 @@ - -#markContainer { - width: 100px; height: 100px; - margin: 0px; -} - -/* ---- System symbols ---- */ -.markCircle { - position: relative; - width: 0px; height: 0px; - border-radius: 0px; border: 1px solid Tomato; - // background-color: White; - z-index: 2; -} - -/* ---- Document (message) symbols ---- */ -.docIcon { - font-family: 'Material Icons'; - font-size: 60px; - color: Tomato; -} -.mess { - position: relative; - opacity: 0; /* fade in with timeline */ - z-index: 3; -} - diff --git a/docs/DVmark.js b/docs/DVmark.js deleted file mode 100644 index f110321..0000000 --- a/docs/DVmark.js +++ /dev/null @@ -1,96 +0,0 @@ -$(document).ready(function(){ - - var s = 'm1'; // Menüüvalik - - $('.menu').hover( - function() { - var h = $(this).attr('id'); - if (h != s) { - $('#' + h).addClass('hovered'); - $('#' + s).addClass('suppressed'); - } - }, - function() { - var h = $(this).attr('id'); - $('.menu').removeClass('hovered') - .removeClass('suppressed'); - } - ); - - $('.menu').click( - function() { - var c = $(this).attr('id'); - if (c == s) { - return - } - $('#' + s).removeClass('selected'); - $('#m' + c.substring(1)).addClass('selected'); - $('#t' + s.substring(1)).hide(); - $('#t' + c.substring(1)).show(); - s = c; - } - ); - - $('#t1').show(); - $('#m1').addClass('selected'); - - // Animate the Document Exchange Mark - function animateMark(){ - const messIconWidth = 56; - const messIconHeight = 56; - const sRadius = 40; // circle - - var wTL; // wiggle tL - - /* 1. build and run tL -> prepareWiggle - 2. build and run wTL -> registerHoverBehav */ - - function registerHoverBehav() { - $('#markContainer').hover(function() { - wTL.restart(); - }); - } - - // Prepare wiggle timeline - function prepareWiggle() { - wTL = new TimelineLite({onComplete: registerHoverBehav}); - wTL = new TimelineLite(); - wTL.to('#markM', 0.1, {rotation: '-=20', - transformOrigin: '28px 28px'}); - wTL.to('#markM', 0.1, {rotation: '+=40'}); - wTL.to('#markM', 0.1, {rotation: '-=20'}); - } - - var tL = new TimelineLite({onComplete: prepareWiggle}); - - // Add circle - var sCircle = $('
') - .attr('id', 'markC') - .addClass('markCircle') - .css('display', 'none') - .css('left', 50 - sRadius) - .css('top', 50 - sRadius); - $('#markContainer').append(sCircle); - // Grow circle - tL.to(sCircle, 0.2, {display: 'block', - width: sRadius * 2, - height: sRadius * 2, - borderRadius: sRadius, delay: 0.1}); - - // Form a message DOM element. Initial opacity: 0. - var sym = $('') - .addClass('docIcon'); - $('
') - .attr('id', 'markM') - .addClass('mess') - .css('left', 50 - messIconWidth / 2) - .css('top', -60) - .append(sym) - .appendTo($('#markContainer')); - - tL.to('#markM', 0.1, {opacity: 1}); - } - - animateMark(); - -}); \ No newline at end of file diff --git a/docs/E-ARVELIIKLUS-DHX.PNG b/docs/E-ARVELIIKLUS-DHX.PNG deleted file mode 100644 index 4a3f96f..0000000 Binary files a/docs/E-ARVELIIKLUS-DHX.PNG and /dev/null differ diff --git a/docs/E-ARVELIIKLUS-DVK.PNG b/docs/E-ARVELIIKLUS-DVK.PNG deleted file mode 100644 index 8e52561..0000000 Binary files a/docs/E-ARVELIIKLUS-DVK.PNG and /dev/null differ diff --git a/docs/E-arved.md b/docs/E-arved.md deleted file mode 100644 index f2e49cb..0000000 --- a/docs/E-arved.md +++ /dev/null @@ -1,215 +0,0 @@ -_Selle dokumendi arutelu toimub [issue 43 all](https://github.com/e-gov/DHX/issues/43)._ - -_Märkus. Käesolev dokument on eelkõige suunatud seni DVK kaudu e-arveid vahetanud asutustele ja ettevõtetele. DVK sulgemise tõttu peavad DVK kliendid hakkama e-arveid edastama DHX-i kaudu või valima mõne muu mooduse. Asutused ja ettevõtted, kes DVK-d e-arvevahetuseks ei kasutanud, võivad ka DHX-i kasutada - ja isegi mitmel moel. Nendele asutustele ja ettevõtetele võivad huvi pakkuda [e-arveliikluse skeem koos DHX-i rakendusvõimalustega](https://cdn.rawgit.com/e-gov/DHX/master/docs/E-ARVELIIKLUS-DHX.PNG) ja [e-arveliikluse skeem koos DVK-ga](https://cdn.rawgit.com/e-gov/DHX/master/docs/E-ARVELIIKLUS-DVK.PNG). DHX protokoll aga ei reguleeri spetsiifilist e-arveliiklust._ - -_Lahtiütlus. Käesolev dokument on arenduses olev, veel täienev töödokument, mida ei ole kinnitatud ega ametlikult avaldatud._ - -Arvamused dokumendi kohta palume saata: Riigi Infosüsteemi Amet, Eneli Järve, 663 0278, eneli.jarve@ria.ee - ----- - -# E-arved DVK-s üleminekuperioodil - -v 0.2 | 07.11.2016 - -## Sisukord - -- [1 Ülevaade](#1-Ülevaade) -- [2 E-arvete edastamine DVK kaudu seni (AS IS)](#2-e-arvete-edastamine-dvk-kaudu-seni-as-is) -- [3 E-arvete edastamine DHX protokolli kaudu (TO BE)](#3-e-arvete-edastamine-dhx-protokolli-kaudu-to-be) - - [3.1 Üldpõhimõtted](#31-Üldpõhimõtted) - - [3.2 Kapsli v2.1 kasutamine E-arvete saatmiseks DHX protokollis](#32-kapsli-v21-kasutamine-e-arvete-saatmiseks-dhx-protokollis) -- [4 Üleminek](#4-Üleminek) -- [Viited](#viited) -- [Muutelugu](#muutelugu) - -## 1 Ülevaade - -- Käesolev dokument on suunatud DVK kaudu e-arveid vahetavatele asutustele ja ettevõtetele: e-arvete saatjatele, operaatoritele, saajatele. -- Selgitame, mida tuleb erinevatel osapooltel teha seoses avaliku sektori üleminekuga hajusale dokumendivahetusele. -- Ülemineku peamised osad on: - - dokumendivahetusprotokolli DHX kasutuselevõtmine dokumente vahetavates süsteemides - - dokumendivahetuskeskuse (DVK) sulgemine. -- Ülemineku ettevalmistusi on tehtud 2015. aastast. Praeguseks on välja töötatud ja kinnitatud protokoll DHX (https://e-gov.github.io/DHX/). -- DHX saab universaalseks, turvaliseks elektrooniliste dokumentide vastuvõtmise ja saatmise kanaliks. Prognoosime, et valdav enamus asutusi võtab DHX-i kasutusele, eelkõige dokumendihaldussüsteemides (DHS). (DHX-i võib kasutada ka muudes dokumente vahetavates süsteemides). -- Protokolli rakendamist hõlbustavad tarkvarakomponendid (DHX adapter) valmivad 2016. a lõpuks. Koostatakse ja avaldatakse üleminekukava ja juhised (veebruar 2017. a). -- Üleminek algab praegu veel kindlaks määramata kuupäeval, eeldatavalt 2017. a aprillis ja kestab 2018. a lõpuni. - -## 2 E-arvete edastamine DVK kaudu seni (AS IS) - -Operaatorid saadavad praegu (oktoober 2016) DVK kaudu e-arveid kasutades Kapsli 1.0 versiooni. - -- Operaator saadab E-arve DVK-sse teenusega `sendDocuments.v1`. (Mitte segi ajada DHX teenusega `sendDocument`). -- E-arve saatja määratleb `sendDcouments.v1` päringu sisendis parameetri `` väärtuseks `/ARVED`. - -```xml - - - - - /ARVED - - - -``` - -- DVK Kapsel saadetakse `sendDcouments.v1` päringus manusena. Operaatorid kasutavad e-arvete korral kapsli versiooni 1.0. -- DVK Kapsel sisaldab `` elemendis üldjuhul kolme parameetrit ``, `` ja ``. -- DVK Kapsel sisaldab `` blokis dokumendi liigi elementi `arve` (uues kapsli 2.1 versioonis vastab sellele `arve`). - -## 3 E-arvete edastamine DHX protokolli kaudu (TO BE) - -### 3.1 Üldpõhimõtted - -- DHX-i kasutamisel tuleb e-arvet käsitada dokumendina avaliku sektori dokumendihalduse tähenduses. Vt [DHX, 3 Mõisted ja lühendid](https://e-gov.github.io/DHX/#3-m%C3%B5isted-ja-l%C3%BChendid). -- Dokumendi edastamisel DHX-i protokolli kohaselt tuleb dokument asetada avaliku sektori metaandmete kapslisse. Vt [DHX, 5.6 Kapsli kasutamine](https://e-gov.github.io/DHX/#56-kapsli-kasutamine). Arvestada tuleb, et toetatud on kapsli versioon 2.1 (mitte 1.0). -- DHX protokoll ei kirjuta ette, kuidas e-arvet tehniliselt saata, jättes selle e-arvete saatjate ja saajate omavahelise kokkuleppe teemaks. Koosvõime tagamiseks soovitame siiski - kui ei otsustata kokku leppida teisiti - järgida järgnevat: - - Kui DHX-iga liitunud asutus soovib saata E-arvet, siis peab ta juba dokumendi saatmisel väärtustama Kapsli välja `DecMetadata/DecFolder` väärtuseks `/ARVED`. - - Seejärel vastuvõttev DHX süsteem peab dokumendi vastuvõtmisel suutma vajadusel ise Kapsli `DecMetadata/DecFolder` väärtuse alusel otsustada, kuhu infosüsteemi dokument suunata (kas finantssüsteemi või DHS-i). - - Uue DHX Adapteri variant C „SOAP server“ kasutamine võib hõlbustada seda suunamist, sest sel juhul käivad eraldi infosüsteemid (finantssüsteem ja DHS) DHX Adapteri käest dokumente küsimas `receiveDocuments` teenusega, andes endist viisi ette `` parameetri. - -### 3.2 Kapsli v2.1 kasutamine E-arvete saatmiseks DHX protokollis - -Uue 2.1 ja vana 1.0 Kapsli väljade vastavus ja võrdlus on toodud Kapsli kirjelduses RIHA-s. - -Nüansid üleminekul: -- Kapsli versiooni 1.0 väljale `` vastavat vastet Kapsli uues versioonis 2.1 ei leidu. Seda välja ei saa operaatorid arve edastamisel enam kasutada. -- E-arve operaator peab Kapsli versioonis 2.1 dokumendi saatjaks (`Transport/DecSender/OrganisationCode`) märkima iseenda (mitte ettevõtte, kelle arveid ta vahendab). Vaata DHX protokolli nõue [8.6 „Saatja kindlakstegemine“](https://e-gov.github.io/DHX/#86-saatja-kindlakstegemine): -- DHX `sendDocument` teenusega arvet saates tuleb määrata Kausta väärtus `/ARVED` Kapsli XML elemendis `DecMetadata/DecFolder`. Sest uue DHX `sendDocument` teenuses puudub vastav päringu parameeter, nagu vana DVK korral oli ``. - -Järgnevalt on toodud näide, kuidas kasutada Kapsli 2.1 versiooni e-arvete saatmiseks. -```xml - - - - 10328799 - 90006399 - - - - Lauri TammemäeLauri - Tammemäe - EE38806190294EE - - - 3726630276lauri.tammemae@ria.ee - - - - - sihtasutus Põhja-Eesti Regionaalhaigla - 90006399 - EE - - - - 25892e17-80f6-415f-9c65-7395632f0234 - arve - 213465 - 2016-11-11T19:18:03 - e-arve 163350 - EE - - - AK - - - 25892e17-80f6-415f-9c65-7395632f0001 - 1 - 163350_eInvoice.xml - text/xml - 6232 - ... - - - 25892e17-80f6-415f-9c65-7395632f0002 - 1 - 163350.pdf - application/pdf - 211543 - ... - - - - 12345 - /ARVED - 2016-11-11T19:20:42 - - -``` - -## 4 Üleminek - -Üleminekuperioodil tagab DVK: - - vana, "DVK protokolliga" sissetulnud e-arve edastamise DHX-i võimekuse loonud asutusele, vastavalt DHX protokollile. - - DHX-i võimekuse loonud asutusele edastab DVK e-arve dokumendivahetuse kapslisse v2.1 pakendatult - sest uuema kapslistandardi versiooni kasutamist nõuab DHX protokoll (vt [DHX, 5.6 Kapsli kasutamine](https://e-gov.github.io/DHX/#56-kapsli-kasutamine)). - - DHX protokolliga sissetulnud e-arve edastamise asutusele, kes ei ole veel DHX-le üle läinud. - -Seega sisuliselt toimib DVK tõlgina uue ja vana protokolli vahel. Alljärgnevad neli skeemi selgitavad tõlkimise protsessi. - -__Lähteolukord - oktoober 2016__ E-arve saadetakse DVK-sse ja sealt edasi asutuse DHS-i DVK liidese kaudu (joonisel DVK). DVK-s registreeritud asutused ja operaatorid on DVK kliendid. DVK kaudu saadavad arveid Fitek, Omniva (operaatorid) ja Riigi Kinnisvara AS. Joonis 1: -``` - e-arve e-arve - Operaator ----------------> DVK ----------------> Asutus 1 - (DVK) \ (DVK) - \ e-arve - -----------------> Asutus 2 - (DVK) -``` - -Sama korraldus jääb kehtima ka üleminekuperioodil, nendel juhtudel, kus saatja ja saaja kumbki ei ole veel DHX-le üle läinud: -- E-arve saadetakse vanaviisi, määrates `Type/RecordType` väärtuseks `arve` ja DVK `sendDocuments` teenuse sisendis `/ARVED`. -- Vastuvõtja loeb e-arveid DVK-st vanamoodi, andes `receiveDocuments` teenuse sisendis ette parameetri `/ARVED`. -- Operaatorid ja vastuvõtjad võivad endiselt kasutada vana 1.0 kapsli versiooni (kui nad mõlemad on endiselt DVK kasutajad). - -__Asutus läheb DHX-le üle__ Üleminekuperioodil loovad asutused oma dokumente vahetavates süsteemides DHX-i võimekuse. Joonis 2 kujutab olukorda, kus Asutus 2 on DHX-i võimekuse juba loonud. Üleminekuperioodil tegutseb DVK DHX-i vahendajana ja ühtlasi tõlgina uue ja vana protokolli (DHX-i ja DVK liidese) vahel. See tähendab, et operaatori saadetud e-arve saadab DVK asutusele 2 edasi, nüüd juba DHX protokolli kaudu. Asutusele 1, kes ei ole üle läinud, edastatakse e-arve endisel viisil. Joonis 2: -``` - e-arve e-arve - Operaator ----------------> DVK ----------------> AS1 - (DVK) \ (DVK) - \ e-arve - -----------------> AS2 - (DHX) -``` - -- DHX vastuvõtjale edastatakse ainult sellised e-arved, mis on saadetud kapsli 2.1 versiooniga. -- Kui Operaator püüab DVK-s saata DHX adressaadile vana 1.0 versiooni Kapsli, siis DVK annab `sendDocuments.v1-v3` teenuse väljakutsel koheselt vea `DHX adressaat ei toeta vana Kapsli 1.0 vesiooni`. Operaator ei saa igale suvalisele adressaadile (DHXile üle läinud adresaatidele) enam e-arveid saata, kuni ta ise ei ole üle läinud 2.1 kapsli versioonile. -- DVK edastab talle saabunud E-arve dokumendi DHX vastuvõtja asutusele, väärtustades 2.1 Kapsli sees täiendavalt välja `DecMetadata/DecFolder` väärtuseks `/ARVED`. -- Seejärel DHX süsteem peab dokumendi vastuvõtmisel (`sendDocument` teenusega) ise suutma Kapsli `DecMetadata/DecFolder` väärtuse alusel otsustada, kuhu infosüsteemi dokument suunata (kas finantssüsteemi või DHS-i). Uue DHX Adapteri variant C „SOAP server“ kasutamine võib hõlbustada seda suunamist, sest sel juhul käivad eraldi infosüsteemid (finantssüsteem ja DHS) DHX adapteri käest dokumente küsimas `receiveDocuments` teenusega, andes endist viisi ette `` parameetri. - -__Operaator läheb DHX-le üle__ Joonisel 3 on kujutatud olukorda, kus seni DVK-d kasutanud operaator on loonud DHX-i võimekuse. E-arve saadetakse nüüd vastavalt DHX protokollile: adressaadil Asutus 2 on DHX-i võimekus – operaator saadab talle e-arve otse; adressaadil Asutus 1 ei ole veel DHX-i võimekust – operaator saadab e-arve DVK kaudu. Joonistelt 2 ja 3 on näha, et DVK tõlgib üleminekuperioodil uue ja vana protokolli mõlemas suunas. Joonis 3: -``` - e-arve e-arve - OP ----------------> DVK ----------------> AS1 - \ (DHX) (DVK) - \ e-arve - \------------------------------------> AS2 - (DHX) -``` - -- DHX-ile üle läinud operaator peab juba e-arve saatmisel väärtustama Kapsli välja `DecMetadata/DecFolder` väärtuseks `/ARVED`. -- Saatmisel toetatud kapsli versioon on 2.1. -- `DecFolder` väli salvestatakse maha DVK-sse. DVK vastuvõtja, kes käib dokumente küsimas `receiveDocuments` sisendiga `/ARVED`, saab kätte DHX saatjalt saadetud dokumendi. -- Kui DHX saatja jätab `DecFolder` välja väärtustamata (määrab ainult `arve AS2 - (DHX) -``` - -## Viited - -[Dokumendivahetusprotokoll DHX](https://e-gov.github.io/DHX/) - -Riigi Infosüsteemi Amet. [E-arved ja DVK](https://www.ria.ee/ee/e-arved.html) - -## Muutelugu - -| versioon, kuupäev | muudatus | -|-------------------|----------| -| v0.1 01.11.2016 | algversioon | -| v0.2 07.11.2016 | lisatud tehnilised üksikasjad, eemaldatud DVK-d mittepuudutav osa | diff --git a/docs/EARVED-DVK.html b/docs/EARVED-DVK.html deleted file mode 100644 index 5af3a0f..0000000 --- a/docs/EARVED-DVK.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - E-arveliikluse skeem - - - - - - - - - - - -
-
-
- - - -
-
- -
- - - diff --git a/docs/EARVED.html b/docs/EARVED.html deleted file mode 100644 index ca47a0f..0000000 --- a/docs/EARVED.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - E-arveliikluse skeem - - - - - - - - - - - -
-
-
- - - -
-
- -
- - - diff --git a/docs/EN.md b/docs/EN.md deleted file mode 100644 index 420a7f2..0000000 --- a/docs/EN.md +++ /dev/null @@ -1,30 +0,0 @@ -![Riigi Infosüsteemi Ameti](https://avatars3.githubusercontent.com/u/7447915 "Riigi Infosüsteemi Amet") ![](EU_Regional_Development_Fund_horizontal.png) - -[ET](../README.md) | EN - -## Document exchange protocol DHX -![](DHX.PNG) ![](X-ROAD.PNG) - -__DHX is a new document exchange protocol, that allows Estonian public sector agencies exchange documents by distributed principle. DHX builds on innovative features of X-Road version 6.__ - -| | | | -|-----|-------------|-----| -| | __[Protocol](https://e-gov.github.io/DHX/EN.html)__ | _official text_ | -| | [DHX Adapter](https://github.com/e-gov/DHX-adapter) | _software components helping DHX implementors; March 2017_ | -| | [Reference implementation](https://github.com/e-gov/DHX-etalon) | _proves workability of the protocol and aids DHX implementors in testing_ | -| | Transition plan | _guidance and advice for DHX implementors; March 2017_ | -| | Co-ordination of implementation | _coming; information:_ Eneli Järve, 663 0278, eneli.jarve@ria.ee | -| | [DHX Address Book](../docs/DHX-aadressiraamat.md) | _shows who already has completed the transition; March 2017_ | -| | Testing service | _correctness of implementation can be tested with [Reference implementation](https://github.com/e-gov/DHX-etalon)_ | -| | [DHX Test suite](../docs/Standardtestid.md) | _recommended minimal test set to aid DHX implementors_ | -| alt text | Workshops and briefing events | _coming_ | - -- [Implementation of the protocol](../docs/Rakendamine.md) ET - -- [E-invoices in DEC in transition period](../docs/E-arved.md) ET - -- [Development of the protocol](../docs/Arendamine.md) ET - -- [Overview](../files/Overview.md) - -- [Presentation](../files/DHX_EN%20%282%29.pdf) (with a very brief discussion of X-Road) diff --git a/files/Ettepanek-01.md b/docs/Ettepanek-01.md similarity index 100% rename from files/Ettepanek-01.md rename to docs/Ettepanek-01.md diff --git a/files/Ettepanek-02.md b/docs/Ettepanek-02.md similarity index 100% rename from files/Ettepanek-02.md rename to docs/Ettepanek-02.md diff --git a/files/Ettepanek-03.md b/docs/Ettepanek-03.md similarity index 100% rename from files/Ettepanek-03.md rename to docs/Ettepanek-03.md diff --git a/files/Ettepanek-04.md b/docs/Ettepanek-04.md similarity index 100% rename from files/Ettepanek-04.md rename to docs/Ettepanek-04.md diff --git a/files/Ettepanek-05.md b/docs/Ettepanek-05.md similarity index 100% rename from files/Ettepanek-05.md rename to docs/Ettepanek-05.md diff --git a/files/Ettepanek-06.md b/docs/Ettepanek-06.md similarity index 100% rename from files/Ettepanek-06.md rename to docs/Ettepanek-06.md diff --git a/files/Ettepanek-07.md b/docs/Ettepanek-07.md similarity index 100% rename from files/Ettepanek-07.md rename to docs/Ettepanek-07.md diff --git a/files/Ettepanekud.md b/docs/Ettepanekud.md similarity index 100% rename from files/Ettepanekud.md rename to docs/Ettepanekud.md diff --git a/docs/Gemfile b/docs/Gemfile deleted file mode 100644 index b8ed085..0000000 --- a/docs/Gemfile +++ /dev/null @@ -1,4 +0,0 @@ -source "https://rubygems.org" -ruby RUBY_VERSION - -gem "github-pages", group: :jekyll_plugins diff --git "a/files/Hajusa_dokumendivahetuse_andmevahetusprotokolli_DHX_anal\303\274\303\274s_1.2.pdf" "b/docs/Hajusa_dokumendivahetuse_andmevahetusprotokolli_DHX_anal\303\274\303\274s_1.2.pdf" similarity index 100% rename from "files/Hajusa_dokumendivahetuse_andmevahetusprotokolli_DHX_anal\303\274\303\274s_1.2.pdf" rename to "docs/Hajusa_dokumendivahetuse_andmevahetusprotokolli_DHX_anal\303\274\303\274s_1.2.pdf" diff --git a/docs/LY.md b/docs/LY.md deleted file mode 100644 index 556dac0..0000000 --- a/docs/LY.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -layout: LY -permalink: LY -title: Lähteülesanne ---- - -Riigi Infosüsteemi Amet - -_mudeldokument_ - -Süsteemi N täiendamine DHX-i võimekusega - -# Tööde kirjeldus - -Sisukord - -[1 Eesmärk ja koosseis]() - -[2 Üleantavad tulemid]() - -[3 Kasutatavad komponendid, töövahendid ja ressursid]() - -[4 Sidusarendus]() - -[5 Dokumentatsioon]() - -[6 Testimine]() - -[7 Muud nõuded]() - -[8 Projektikoosolek ja töösuhtlus]() - -[Viited]() - -### 1 Eesmärk ja koosseis -1. Käesolevaga tellitakse tarkvaraarendustööd eesmärgiga luua süsteemis N võimekus vahetada dokumente protokolli DHX [1] kohaselt. -1. Tööd sisaldavad kõiki tarkvaraarendustöid — sh projekteerimist, programmeerimist ja testimist koos vastava dokumenteerimisega, samuti projektijuhtimist — mis on vajalikud, et süsteemis N: - - teostada DHX-i otsevõimekus [1] mõistes, sh - - dokumendi vastuvõtmine `sendDocument` teenuse abil - - dokumendi saatmine `sendDocument` teenusele - - lokaalse aadressiraamatu koostamine - - eemaldada "DVK spetsifikatsiooni" kohane liides DVK-ga. - - Süsteem N vahetab praegu dokumente Dokumendivahetuskeskusega (DVK) [2] nn "DVK spetsifikatsiooni" kohaselt, kasutades komponente "DVK klient" ja "DVK-API". "DVK spetsifikatsiooni" kohane liides tuleb asendada DHX liidesega. Seejuures mittevajalikuks osutuvad komponendid tuleb kas eemaldada või DHX-i vajadustest lähtuvalt ümber teha. -1. DHX-i vahendamise võimekust (vt [1]) süsteemis N ei teostata. -1. "DVK spetsifikatsiooni" liidese asendamine DHX protokolli põhise liidesega ei tohi muuta süsteemi N muid funktsionaalsusi ega halvendada mittefunktsionaalseid omadusi. - -### 2 Üleantavad tulemid - -Täitja annab Tellijale üle süsteemi N vastavalt tööde eesmärgile ja koosseisule täiendatud, testitud ja veavaba koodi koos nõuetekohase dokumentatsiooniga. - -### 3 Kasutatavad komponendid, töövahendid ja ressursid - -| | märkused | Arendajale antakse pääsuõigused? | -|--------------------------|------------------------------|-----| -| __süsteemi N koodirepo__ | BitBucket (Tellija taristus) | jah | -| __süsteemi N avalik koodirepo__ | GitHub (avalik koodirepo) | avalik | -| __DHX adapteri avalik koodirepo__ | DHX-i võimekuse loomisel tuleb kasutada DHX adapteri [3] koosseisus olevaid Java teeke, neid vajadusel kohandades ja täiendades | avalik | -| __automatiseerimisserver__ | Jenkins, Tellija taristus | jah | -| __arenduskeskkond__ | süsteemi N testimiseks Tellija taristus loodav virtuaalmasinate, neisse paigaldatud süsteemi- ja rakendustarkvara, võrguühenduste ja pääsuõiguste kogum | jah | -| __SoapUI__ | testimisvahend | jah | -| __rühmatöökeskkond__ | Confluence Tellija taristus | jah | -| __skype__ | jooksva suhtluse keskkond | jah | -| __JIRA__ | kasutatakse vigade raporteerimiseks, Tellija taristus | jah | -| __e-post__ | projektisuhtluseks | | - -### 4 Sidusarendus -1. Tarkvara ehitamine, paigaldamine ja testimine automatiseeritakse sidusarenduse (ingl _Continuous Integration_) põhimõtete kohaselt. -1. Sidusarenduse töövoog: - - Tellija annab Arendajale pääsuõigused süsteemi N koodireposse, automatiseerimisserverisse ja arenduskeskkonda - - Arendaja loob süsteemi N koodirepost omale töörepo - - Arendaja koostab ehitus-, paigaldus- ja testiskriptid nning häälestab automatiseerimisserveri - - Arendaja kannab arenduse tulemid süsteemi N koodireposse (Git `push` või `pull request`) - - Automatiseerimisserver täidab ehitus-, paigaldus- ja testiskriptid. -1. Süsteemi N koodirepo peegeldamine avalikku koodireposse (GitHub) tehakse Tellija poolt automaatselt. - -### 5 Dokumentatsioon -1. Aluseks võetakse süsteemi N olemasolev dokumentatsioon [6], seda täiendatakse. -2. Dokument "Lahenduse kirjeldus" tuleb ümber nimetada arhitektuuridokumendiks ja täiendada, nii, et oleks: - - spetsifitseeritud süsteemi funktsiooni(d), piir, liidesed, komponentstruktuur, tehnoloogiad jm olulised arhitektuurilised aspektid - - eraldi välja toodud DHX-i võimekuse loomisest tulenevad muudatused - - esitatud arhitektuurijoonis(ed) koos seletuskirjaga (selgitava tekstiga). -3. Dokumentatsioon, mis veel ei ole, tuleb teisendada Markdown-i (GitHub-i stiili). - -### 6 Testimine -1. Arendaja peab testima kõiki DHX-i nõudeid. - - muu hulgas tuleb teha dokumendis "DHX standardtestid" [5] määratletud testid. -1. Koostada tuleb: - - testistrateegia (_test strategy_ ja _test approach_ tähenduses [7]) - - testilood - - testandmed - - testiskriptid, automatiseerimisserveri seadistused (automaattestid) - - testiraport. -1. Testitakse kahe vahendiga: - - SoapUI abil - - DHX etalonteostuse abil, vastavalt dokumendi "DHX standardtestid" [5] jaotises "Etalonteostuse kasutamine DHX-i testimiseks" määratletule. -1. DHX-i nõudeid kontrollivad testid tuleb automatiseerida (teha automaattestid), vastavalt jaotise "Sidusarendus" nõuetele. Automatiseerimisest võib loobuda, kui see on suure keerukuse või töökulu tõttu ebamõistlik. -1. Automaatteste ei tule koostada süsteemi N nendele funktsionaalsustele, mis ei ole seotud DHX-ga. -1. Regressioonitestid tuleb teha. -1. Spetsiaalseid koormusteste ei ole vaja teha. -1. Tööde vastuvõtmise tingimuseks on kõigi testide edukas (veavaba) läbimine. - -### 7 Muud nõuded -1. Süsteemi N täiendamisel peab järgima: - - Tellija mittefunktsionaalseid nõudeid (MFN) - - Tellija dokumentatsiooniplaani. -1. Kõrvalekalded p 1 nimetatud nõuetest on lubatud põhjendatud juhtudel (süsteemi või keskkonna olemuse tõttu nõue ei ole kohalduv või eesmärgipärane) Tellija nõusolekul. - -### 8 Projektikoosolek ja töösuhtlus -1. Projektikoosolek: - - peetakse iga nädal - - Tellija ruumides - - juhatab Tellija projektijuht - - Täitja projektijuht esitab suulise aruande tööde edenemisest - - seejärel arutatakse sisulisi ja korralduslikke küsimusi - - koosolekud protokollitakse. -2. Projektikoosolekute vahel peetakse töösuhtlust Tellija ja Arendaja ühises skype vestluses ja e-kirja teel. -3. Arendajale antakse juurdepääs projekti Confluence-ruumile Tellija taristus. - -### Viited -[1] Dokumendivahetusprotokoll DHX, [https://e-gov.github.io/DHX/](https://e-gov.github.io/DHX/) - -[2] Dokumendivahetuskeskus (DVK), [https://github.com/e-gov/DVK](https://github.com/e-gov/DVK) - -[3] DHX adapter, [https://github.com/e-gov/DHX-adapter](https://github.com/e-gov/DHX-adapter) - -[4] DHX etalonteostus, [https://github.com/e-gov/DHX-etalon](https://github.com/e-gov/DHX-etalon) - -[5] DHX standardtestid, [https://github.com/e-gov/DHX/blob/master/docs/Standardtestid.md](https://github.com/e-gov/DHX/blob/master/docs/Standardtestid.md) - -[6] Süsteem N. Kirjeldus - -[7] ISTQB Glossary, [http://www.istqb.org/downloads/glossary.html](http://www.istqb.org/downloads/glossary.html) - -[8] Tellija mittefunktsionaalsed nõuded - -[9] Tellija dokumentatsiooniplaan diff --git a/docs/MATRYOSHKA.html b/docs/MATRYOSHKA.html deleted file mode 100644 index 1bab8d0..0000000 --- a/docs/MATRYOSHKA.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - Mis mille sees käib - - - - - - - - - - - -
-
-
- - - -
-
- -
- - - diff --git a/docs/Outline.md b/docs/Outline.md deleted file mode 100644 index dd3f8da..0000000 --- a/docs/Outline.md +++ /dev/null @@ -1,98 +0,0 @@ -# Legacy-süsteemide likvideerimisest. DHX (ja RIHA) kogemus ja seis -19.10.2016, Luhtre arhitektuuriseminar - -Priit Parmakson - -MSc, #DontMakeMeThink, #TheSimplestThingThatCouldPossiblyWork, YOLO (algtase) - -Vt ka: - - [protokolli tekst](https://e-gov.github.io/DHX/) - - [DHX adapter](https://e-gov.github.io/DHX/Adapter.html) - -MIS ON DHX? - - a DVK-killer, DVK-tapja - - universaalne muster dokumentide otsevahetamiseks - - -MILLEKS? - - Pythagorase teoreem - - DVK tagasitulek? Pole välistatud, et inkarneerub - nt riigipilve Pub/Sub teenusena - -LAIEM PROBLEEM - - legacy-st vabanemine - - paljud meie e-riigi süsteemid on 10+ aastat vanad - - neid üritatakse teha paremaks - - üksikuid tehnoloogiaid vahetada uuemate vastu - - vahetada arendajaid - - - inimeste mõtlemine on aga jäänud samaks - - töömeetodid on jäänud samaks - - arendajate kapatsiteet ei ole kasvanud - - ja IT ei ole enam sama, mis 10 aastat tagasi - - - avastame, et teeme sama asja uuesti - - - tarkvaraline legacy - - töömeetodite legacy - - mõtlemise legacy - -A, B ja C - - A tippkvaliteet, hoida ajakohane iga hinna eest - - B enam-vähem - - C läbu - -PROTOKOLL - - suunatud koostalitlusvõime saavutamisele - - ei ürita lahendada probleeme, mida on otstarbekas - lahendada mujal (siduskihtides) - - spetsifikatsioon - - "Spec is never up to date? MY spec is up to date" -- Joel Spolsky - - avalik, publitseeritud - - üks omanik - - avatud, formaliseeritud täiendamise protsess - -INNOVATIIVSED ELEMENDID - - RFC 2119 järjekindel kasutamine - - speki haldus Tellija kätes - - vastavusnõuete ilmutatud väljatoomine - - juhitud terminoloogia - - protokollide best practice rakendamine - - avatud standardiloome protsess - - avalik arutelu - - etalonteostus - - X-tee vahendamise kontseptsiooni edasiarendus - -TOOTEPEREKOND - - protokoll (A) - - sh halduse protsess - - etalonteostus (B) - - demonstreerib protokolli teostatavust - - eeskuju protokolli rakendajatele - - toimib testivahendina - - üleminekukava (A) - - testimisteenus (C)? - - tarkvaratükid protokolli rakendajatele - - DHX adapter (B) - - Java teegid (B) - - DVK-DHX konverter (B) - - DVK koosseisus, üleminekuperioodil - - "Kapsel" (B) - -RAKENDAMISE ALTERNATIIVID - - teen ise - - teen ise, kasutades 3 Java teeki - - kasutan DHX adapterit - - SOAP liidesega - - otsepöördusega DHX adapteri andmebaasi - -ÜLEMINEKUKAVA - - selged sõnumid ja tegutsemisjuhised - - sihtrühmadele: - - asutus, DHSi äriomanik - - asutus, IT spetsialist - - arendaja - - DHX vahendusteenuse pakkuja - - Mida ma PEAN teadma? - - Mida ma PEAN tegema? - *Erinevaid üleminekuid on palju. Kuidas vältida, et need asutustel sassi ei lähe? diff --git a/docs/Portfolio.html b/docs/Portfolio.html deleted file mode 100644 index 961ca51..0000000 --- a/docs/Portfolio.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - - One Thing Leads to Another - - - - - - - - - - - - -

Document Exchange Service Portfolio

-

A dynamic portfolio of about 15 services that support and extend the DHX protocol, the core service. Chart shows realized value, outlaying committed effort, and potential for growth (November 2016). All figures are estimates.

- -
- - - diff --git a/docs/RIHA.md b/docs/RIHA.md deleted file mode 100644 index 460db00..0000000 --- a/docs/RIHA.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -permalink: RIHA ---- - -{ - "META":{ - "dokument":"RIHA kirjeldus", - "versioon":"1.0" - }, - "nimi":"Dokumendivahetusprotokoll DHX", - "tüüp":"standard", - "haldaja":"Riigi Infosüsteemi Amet", - "URL":"https://github.com/e-gov/DHX", - "lühikirjeldus": "DHX on uus, X-tee v6 omadustele rajatud dokumendivahetusprotokoll, mis võimaldab Eesti avaliku sektori dokumendihaldussüsteemidel vahetada dokumente hajus- e detsentraliseeritud põhimõttel." -} diff --git a/docs/Rakendamine.md b/docs/Rakendamine.md deleted file mode 100644 index 1fb6396..0000000 --- a/docs/Rakendamine.md +++ /dev/null @@ -1,15 +0,0 @@ -### Protokolli rakendamine - -DHX-i rakendaja peab otsustama, mis viisil ta DHX-i rakendab. Valida on mitme variandi vahel: - -Vt ka ["Matrjoška"](https://e-gov.github.io/DHX/MATRYOSHKA.html) (selgitav joonis tehnoloogiate seose kohta) - -| # | DHX-i rakendusvariant | lühikirjeldus | -|---|---------|---| -| 1 | DHX-i rakendamine otse (ilma vahendajata) | Vt allolevad alamvariandid. | -| 1A | adapteriteekide abil | DHS saab kasutada DHX Java teeke, mis arendatakse välja uue DHX adapteri loomise raames. DHX Java teegid sisaldavad funktsionaalsust dokumendi saatmiseks, vastuvõtmiseks ja aadressiraamatu koostamiseks. Saatmise klassid realiseerivad sisuliselt X-tee SOAP kliendi funktsionaalsuse, koos DHX hajusa saatmisalgoritmiga. Vastuvõtmise klassid realiseerivad DHX SOAP teenuse ja saabunud dokumendi DHS-ile edastamise liidese. Vt [https://github.com/e-gov/DHX-adapter](https://github.com/e-gov/DHX-adapter). | -| 1B | DHX adapteriga (otsepöördusega adapteri andmebaasi) | Paigaldades DHX adapteri ja liidestades selle oma süsteemiga (DHS või muu) otsepöördusega (JDBC) adapteri andmebaasi poole. Vt [https://github.com/e-gov/DHX-adapter](https://github.com/e-gov/DHX-adapter). | -| 1C | DHX adapteriga (SOAP liides) | Paigaldades DHX adapteri ja liidestades selle oma süsteemiga SOAP liidese abil. Vt [https://github.com/e-gov/DHX-adapter](https://github.com/e-gov/DHX-adapter). | -| 1D | teostades DHX protokolli ise | DHS arendaja võib ise DHX protokolli toetavad komponendid programmeerida, valides sobiva platvormi ja programmeerimiskeele. | -| 1E | DHX adapteriga (REST liides) | Paigaldades DHX adapteri ja liidestades selle oma süsteemiga REST liidese abil. Variant oli kaalumisel, __kuid ei ole praegu adapteri poolt toetatud__. Huvi korral võib vabavaralist DHX adapterit ise edasi arendada. | -| 2 | DHX-i rakendamine vahendaja kaudu | Vt [https://e-gov.github.io/DHX/#6-vahendamine](https://e-gov.github.io/DHX/#6-vahendamine). | diff --git a/docs/Rakenduskava.md b/docs/Rakenduskava.md deleted file mode 100644 index 8811e4a..0000000 --- a/docs/Rakenduskava.md +++ /dev/null @@ -1,73 +0,0 @@ -# DHX-i rakenduskava - -Kava eesmärk on määratleda Riigi Infosüsteemi Ameti, avaliku sektori asutuste ja erasektori teenusepakkujate ühised tööd avaliku sektori üleminekul dokumentide elektroonilisele otsevahetamisele DHX protokolli abil. - -## Tähtajad - -Ülemineku algus: 1.03.2017 - -Ülemineku lõpp: 31.12.2018 - -## Riigi Infosüsteemi Amet - -1. avaldab DHX protokolli _avaldatud_ -1. avaldab DHX adapteri tarkvara -1. avaldab etalonteostuse (kood ja töötav rakendus) _avaldatud_ - - pakub etalonteostust DHX-i rakendajatele testimisteenusena _töötab_ -1. loob DVK-s DHX vahendamise võimekuse -1. avab DHX-i aadressinimistu teenuse -1. kuulutab üleminekuperioodi ametlikult välja -1. avaldab juhised DHX-i rakendajatele - - sh rakendamistegevuste soovitusliku nimekirja - - arendustööde tellimise mudel-lepingu -1. levitab teavet ülemineku kohta _levitatud juba päris palju_ -1. annab nõu DHX-i rakendajatele _vältida, et tekiks olukord, kus "RIA ei tõsta toru"_ - - protokolli kohta tekkivates küsimustes - - adaptertarkvara kohta tekkivates küsimustes - - etalonteostuse kaudu pakutava testimisteenuse kohta - - DHX aadressinimistu kohta tekkivates küsimustes -1. peab arvestust ülemineku edenemise kohta, koostab ja avaldab vastavat statistikat -1. teenindab DHX-i rakendajaid: - - registreerib X-teel DHX alamsüsteeme - - lülitab asutuse dokumendiliikluse DVK-s ümber DHX-le -1. haldab DHX-i vahendamist - - registreerib DHX-i vahendaja - - avaldab DHX-i vahendajate nimekirja - - teostab järelevalvet DHX-i vahendajate üle -1. üleminekuperioodi lõpus sulgeb DVK - -## Asutus -1. selgitab välja infosüsteemid, mida üleminek puudutab - - DVK-ga liidestatud DHS-id jm süsteemid - - muud süsteemid, milles DHX-i rakendamine on vajalik ja otstarbekas -1. otsustab, kas ja kuidas DHX-i rakendab - a) ise (otse) - b) DHX-i vahendaja kaudu -1. kavandab üleminekutööd - - selgitab, kas DHX-i rakendamise eeldused on täidetud; vajadusel korraldab vajalikud tööd - - X-tee v6 - - dokumendivahetuse kapsel v2.1 -1. tellib DHX-i võimekuse arendustööd - - võimalusel tellides arendusi ühiselt teiste asutustega - - koostöös arendajaga otsustab, kuidas DHX-i võimekuse tehniliselt loob - - DHX-i adapteri teekide kasutamisega - - DHX-i adapteri paigaldamisega - - ise programmeerides - - testib oma süsteemi DHX-i võimekust - - soovi korral kasutades etalonteostust -1. esitab RIA-le taotluse X-teel DHX alamsüsteemi registreerimiseks -1. esitab RIA-le taotluse DVK dokumendiliikluse ümberlülitamiseks DHX-le -1. DHX-i vahendaja kasutamise korral: - - sõlmib vahendajaga lepingu - - ühendab oma süsteemi vahendaja süsteemiga - -## DHX-i vahendaja -1. loob oma süsteemis DHX-i vahendusvõimekuse -1. registreerib end RIA-s DHX-i vahendajana -1. sõlmib asutusega vahenduslepingu -1. ühendab oma süsteemi asutuse süsteemiga -1. teenindab asutust, käitades vahendusteenust vastavalt DHX protokollile ja X-tee vahendamise nõuetele - -## Arendaja -1. Kui soovib oma toodetes v teenustes DHX-i rakendada, siis kavandab ja teostab vastavad arendused -1. Kui pakub DVK-ga suhtlevat tarkvara või teenuseid, siis kavandab ülemineku DHX-le ja teostab vastavad arendused diff --git a/docs/Standardtestid.md b/docs/Standardtestid.md deleted file mode 100644 index 1f99f9d..0000000 --- a/docs/Standardtestid.md +++ /dev/null @@ -1,106 +0,0 @@ -![](DHX.PNG) - -# DHX standardtestid - -v0.2 14.11.2016 - -## 1 Ülevaade - -Esitatakse standardne testide komplekt DHX-i võimekuse testimiseks. Juhendatakse DHX etalonteostuse kasutamist testimiseks. - -Dokument on suunatud DHX-i võimekuse loomise arendustööde kavandajatele, arendajatele ja testijatele. - -## 2 Mõisted ja lühendid - -Lisaks alljärgnevale kasutatakse käesolevas dokumendis [dokumendivahetusprotokolli DHX mõisteid ja lühendeid](https://e-gov.github.io/DHX/#3-m%C3%B5isted-ja-l%C3%BChendid). - -| mõiste | seletus | -|--------|---------| -| _etalonrakendus_ | etalonteostuse käigus loodud, RIA taristus käitatav rakendus, mis etendab DHX-i võimekusega infosüsteemi ja mida saab kasutada DHX-i võimekuse testimiseks. | -| _etalonteostus_ | kahest eraldi paigaldatud, RIA taristus käitatavast rakendusest (_etalonrakendusest_) koosnev vahend, mida saab kasutada testitava süsteemi testimiseks; vt [DHX-i etalonteostus](https://github.com/e-gov/DHX-etalon). | -| _testitav süsteem_ | X-teega liidestatud infosüsteem - dokumendihaldussüsteem (DHS) või ka muu süsteem - mille DHX-i võimekust testitakse. | -| _DHX standardtest_ | DHX võimekuse testimiseks üldjuhul hädavajalik, praktiliselt teostatav test. | -| _test_ | käesolevas dokumendis kasutatakse testiloo tähenduses. | - -## 3 Etalonteostuse kasutamine DHX-i testimiseks - -DHX-i võimekuse loonud süsteemi testimiseks võib kasutada [DHX-i etalonteostust](https://github.com/e-gov/DHX-etalon). -- Etalonteostus koosneb kolmest eraldi paigaldatud, RIA taristus käitatavast rakendusest, mis etendavad DHX-i võimekusega infosüsteeme. - - Etalon1, [https://dhxdemo.eesti.ee/etalon1/](https://dhxdemo.eesti.ee/etalon1/), etendab DHX-i otsevõimekusega asutust (ministeerium) - - Etalon2, [https://dhxdemo.eesti.ee/etalon2/](https://dhxdemo.eesti.ee/etalon2/), etendab DHX-i vahendajat (eraettevõte), kes vahendab kolme asutust (vallavalitsus, muuseum ja põhikool). - - Etalon 3, [https://dhxdemo.eesti.ee/etalon3/](https://dhxdemo.eesti.ee/etalon3/), etendab DHX-i vahendaja enda infosüsteemi. -- Etalonteostus töötab X-tee arenduskeskkonnas. - -![](TESTIMISTEENUS.PNG) - -## 4 Testiplaan - -[DHX-i vastavusnõudeid](https://e-gov.github.io/DHX/#10-vastavusn%C3%B5uded) on terve rida. Rakendaja peab tagama kõigi nende täitmise. Käesolev testiplaan hõlmab ainult kõige lihtsamini teostatavaid teste. Mõnesid nõudeid võib üldse olla raske testida. Nt süsteemi käitumist juhul, kus adressaat "on maas" (siis peab üritama uuesti saata, aga mitte lõputult). - -__Eeldused__ - - 1. luua testitavas DHS-is (vm infosüsteemis) DHX-i võimekus (teenuse `sendDocument` osutamise ja tarbimise võimekus; lokaalse aadressiraamatu koostamise võimekus; vahendaja korral - teenuse `representationList` osutamise võimekus) - 2. registreerida DHX alamsüsteem X-tee arenduskeskkonnas - -__TEST 1a: Süsteemi ilmumine aadressiraamatusse__ - 1. etalonrakenduse abil kontrollida testitava süsteemi ilmumist etalonrakenduse lokaalsesse aadressiraamatusse - -__TEST 1b: Lokaalse aadressiraamatu koostamise õigsus__ - 1. võrrelda testitava rakenduse lokaalset aadressiraamatut etalonrakenduses koostatud aadressiraamatuga; aadressiraamatud peavad ühtima - - eelduseks on nõude testimise eesmärgil testitavasse süsteemi sisse ehitatud logimine vm moodus lokaalset aadressiraamatut inimesele kuvada - - Kontrollitav nõue: [7.4 Lokaalne aadressiraamat](https://e-gov.github.io/DHX/#74-lokaalne-aadressiraamat) - - Märkus. Etalonrakenduse asemel võib kasutada [DHX aadressiraamatu](DHX-aadressiraamat.md) teenust - -__TEST 2a: Dokumendi saatmine (õige dokument, DHX otsevõimekusega asutusele)__ - 1. testitavast süsteemist saata nõuetekohaselt kapseldatud dokument etalonrakendusse 1 (testasutusele Ministeerium) - 2. etalonrakenduse logist kontrollida dokumendi kohalejõudmist - - Kontrollitav nõue: [5.6 Kapsli kasutamine](https://e-gov.github.io/DHX/#56-kapsli-kasutamine) - -__TEST 2b: Dokumendi saatmine (õige dokument, vahendajat kasutavale asutusele)__ - 1. testitavast süsteemist saata dokument etalonrakendusse 2 (testasutusele Vallavalitsus, Muuseum või Põhikool) - 2. etalonrakenduse logist kontrollida dokumendi kohalejõudmist - -__TEST 2c: Dokumendi korduv saatmine__ - 1. testitav süsteem saadab seeria dokumente etalonrakendusele - 2. etalonrakenduse kasutajaliidese kaudu kontrollitakse, et saadetise id-d on erinevad - - Kontrollitav nõue: [5.7 Unikaalne identifikaator.](https://e-gov.github.io/DHX/#57-unikaalne-identifikaator) - -__TEST 2d: Saatmine suvalisele DHX-i võimekusega asutusele__ - 1. etalonrakenduse kasutajaliideses kuvatavast DHX aadressinimistust võetakse juhuslikult asutus - 2. kontrollitakse, kas testitav süsteem suudab asutusele dokumenti saata - - Kontrollitav nõue: [7.1 Addressaadi DHX-i võimekuse väljaselgitamine](https://e-gov.github.io/DHX/#71-dhx-v%C3%B5imekus) - -__TEST 2e: Saatmine asutusele, kellel on mitu DHX-i võimekusega infosüsteemi__ - 1. testitavast süsteemist saata dokument etalonrakendusse 3 (X-tee lühinimi `DHX.raamatupidamine`) - 2. kontrollida, et dokument jõudis kohale (mitte ei läinud sama adressaadi teise süsteemi (etalonrakendusse 2, X-tee lühinimi `DHX`) - -__TEST 3a: Vastuvõtmine (õige dokument)__ - 1. etalonteostuse kasutajaliidese abil saata testitavale süsteemile õigesti moodustatud ja adresseeritud dokument - 2. kontrollida etalonteostuse kasutajaliidese kaudu, et testitav süsteem vastab nõuetekohase 'OK teatega - 3. testitavast süsteemist kontrollida, et dokument on kohale jõudnud - -__TEST 3b: Vastuvõtmine (valesti adresseeritud dokument)__ - 1. etalonteostuse kasutajaliidese abil saata testitavale süsteemile valesti adresseeritud dokument - 2. kontrollida etalonteostuse kasutajaliidese kaudu, et testitav süsteem vastab nõuetekohase veateatega - 3. testitavast süsteemist kontrollida, et vigane transaktsioon logitakse asjakohaselt - - Kontrollitav nõue: [8.1 Aadressi kontroll](https://e-gov.github.io/DHX/#81-aadressi-kontroll) - -__TEST 3c: Vastuvõtmine (valesti kapseldatud dokument)__ - 1. etalonteostuse kasutajaliidese abil saata testitavale süsteemile valesti kapseldatud dokument - 2. kontrollida etalonteostuse kasutajaliidese kaudu, et testitav süsteem vastab nõuetekohase veateatega - 3. testitavast süsteemist kontrollida, et vigane transaktsioon logitakse asjakohaselt - - Kontrollitav nõue: [8.3 Kapsli kontroll](https://e-gov.github.io/DHX/#83-kapsli-kontroll) - -Märkus. Ülalolev testiplaan hõlmab ka DVK-ga suhtlemist, sest DVK tegutseb üleminekuperioodil DHX-le veel üle minemata asutuste vahendajana. - -## Viited - -- [Dokumendivahetusprotokoll DHX](https://e-gov.github.io/DHX/) - -## Muutelugu - -| versioon, kuupäev | muudatus | -|-------------------|----------| -| v0.3 13.12.2016 | lisatud Etalonrakendus 3 ja TEST 2e | -| v0.2 14.11.2016 | lisatud joonis ja testiplaan | -| v0.1 09.11.2016 | algversioon | diff --git a/docs/TESTIMISTEENUS.PNG b/docs/TESTIMISTEENUS.PNG deleted file mode 100644 index 49f389c..0000000 Binary files a/docs/TESTIMISTEENUS.PNG and /dev/null differ diff --git a/docs/Testilugu.md b/docs/Testilugu.md deleted file mode 100644 index 6222025..0000000 --- a/docs/Testilugu.md +++ /dev/null @@ -1,23 +0,0 @@ -# Tutvus DHX-ga - - - -__Öelge palun, kas teie kasutate DHX-i?__ Jah, oleme hajusale dokumendivahetusele üle läinud. Rakendame DHX-i ministeeriumi dokumendihaldussüsteemis. - -__Kuidas saab teile dokumente saata?__ Lihtne küsimus. Meie DHS-i nimi X-teel on, nii nagu DHX standard ette näeb, `DHX`. Sellele tuleb ette panna ministeeriumi registrikood `40000001`. X-tee täisnimi seega on `EE-DEV/GOV/40000001/DHX`. - - - -__Hõbekuuli OÜ? Öelge, palun, millega teie firma tegeleb?__ Heameelega. Oleme eesti kapitalil põhinev firma. Põhiliselt pakume IT süsteemide majutusteenust. Muuhulgas tegeleme ka DHX-i vahendamisega. - -__Palun, kas avaksite lähemalt, mida DHX-i vahendamine tähendab?__ Aga palun. Vahendamist pakume asutustele ja ettevõtetele, kes soovivad X-teel DHX-i dokumendivahetuses osaleda, kuid ei oma selleks vajalikku infrastruktuuri või ei taha infra ülalpidamisega tegelda. Peamiselt väiksemad asutused. Näiteks vallavalitsus A, muuseum B ja põhikool C, kui nimetada mõnd meie klienti. Tavaliselt on ka kliendi DHS meie juures majutatud, aga ei pea tingimata olema. - -__Ja kas olete äriga rahul?__ Kindlasti. Kliendid on rahul ja kasvuvõimalused on head. Olen isegi Hõbekuuli raamatupidamise ühendanud DHX-iga. Kui ministeerium tahab saata meile arve, siis ta teeb seda DHX-ga. Arve läheb kohe meie raamatupidamissüsteemi. Eat your own dogfood, nagu IT-mehed ütlevad. - -__Kuidas teie süsteemidega suhelda saab?__ DHX-is on see lihtne. Adresseerimiseks on vaja teada ainult asutuse või ettevõtte registrikoodi. Näiteks vallavalitsusel A on registrikood `70000001`, muuseumil B - `70000002`, põhikoolil C - `700000003`. Teie süsteem leiab X-tee globaalsest konfiguratsioonist, et Hõbekuul on `70000001`, `70000002` ja `70000003` vahendaja. Järelikult võtate Hõbekuuli registrikoodi ja saadate X-teel `EE-DEV/COM/30000001/DHX`. Dokumendi kapslis märgite kellele ma pean dokumendi edastama (`70000001`, `70000002` ja `70000003`). Kui soovite Hõbekuuli raamatupidamisse saata, siis panete `EE-DEV/COM/30000001/DHX.raamatupidamine`. - -__Selge. Aga kuidas kontrollida, et saadetud dokumendid tõesti kohale jõudsid?__ Väga lihtne. Annan teile juurdepääsu meie vahendussüsteemi ja raamatupidamise kasutusliidestele. Võtke veebisirvijas lahti `https://dhx.demo.eesti.ee/etalon2` ja teises aknas `https://dhx.demo.eesti.ee/etalon3`. Seal saate vaadata, kellelt mis dokumendid on saabunud. Saate ka ise dokumente saata. Ministeeriumi DHS-il on samasugune kasutajaliides - `https://dhx.demo.eesti.ee/etalon3`. - -__Kui ma tahan ka DHX-ga liituda, kuidas ma saan oma süsteemi testida?__ Liituge X-tee arenduskeskkonnaga, arendage oma süsteemis välja X-tee võimekus, valige oma süsteemile DHX alamsüsteemi nimi (DHX või DHX*). Pange oma süsteem ministeeriumile, aga samuti vallavalitsusele A, muuseumile B ja põhikoolile C dokumente saatma. Saatke dokumente ka Hõbekuuli OÜ raamatupidamisele. Nii testitegi. - -![](TESTIMISTEENUS.PNG) diff --git a/docs/Tooted.html b/docs/Tooted.html deleted file mode 100644 index c7667ea..0000000 --- a/docs/Tooted.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - Tooted - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- -

Avaliku sektori üleminek hajusale dokumendivahetusele

- -

Ülemineku peamised osad on: a) dokumendivahetusprotokolli DHX kasutuselevõtmine dokumente vahetavates süsteemides; 2) dokumendivahetuskeskuse (DVK) sulgemine.

- -

Ülemineku ettevalmistusi on tehtud 2015. aastast. Praeguseks on välja töötatud ja kinnitatud protokoll DHX (https://e-gov.github.io/DHX/). Protokolli rakendamist hõlbustavad tarkvarakomponendid (DHX adapter jm) valmivad 2016. a lõpuks. Koostatakse ja avaldatakse üleminekukava ja juhised (veebruar 2017. a).

- -

Üleminek algab praegu veel kindlaks määramata kuupäeval, eeldatavalt 2017. a aprillis ja kestab 2018. a lõpuni.

- -

Ülemineku teostamiseks luuakse järgmised tooted ja teenused (*-ga asjad ei ole kindlad):

- -
-

sihtrühm

-
- -
-

üleminekukava

-

-
-
-

juhised ja nõuanded erinevatele sihtrühmadele

-
-
-

DHS-i haldaja, IT juht, DHX-i vahendaja, DHS-i arendaja

-
- -
-

protokoll

-

-
-
-

dokumendivahetusprotokoll DHX

-
-
-

IT juht, DHX-i vahendaja, DHS-i arendaja

-
- -
-

tarkvaratükid

-

-
-
-

tarkvarateegid abiks protokolli rakendajatele

-
-
-

DHS-i arendaja

-
- -
-

DHX adapter

-

-
-
-

DHX-i kasutuselevõttu hõlbustav tarkvarakomponent

-
-
-

IT juht, DHS-i arendaja

-
- -
-

testimisteenus

-

-
-
-

*teenus, mille abil DHX rakendaja saab kontrollida, et on protokolli õigesti rakendanud

-
-
-

DHX-i vahendaja, DHS-i arendaja

-
- -
-

DVK-DHX tõlkija

-

-
-
-

DVK-DHX protokollide tõlkimise funktsionaalsusega täiendatud DVK, toimib üleminekuperioodil

-
-
-

RIA

-
- -
-

etalonteostus

-

-
-
-

rakendus, milles on teostatud DHX protokoll (protokolli teostatavuse kontrolliks). Toimib ühtlasi näidisena ja testimisvahendina

-
-
-

DHS-i arendaja

-
- -
-

ChangeMaster

-

-
-
-

*inimene, kes aitab kõrvaldada üleminekul võimalikke takistusi ja anda rakendajatele nõu; ülemineku "koordinaator"

-
-
-

DHS-i haldaja, IT juht, DHX-i vahendaja, DHS-i arendaja

-
- -
-

sertifitseerimine

-

-
-
-

*teenus, milles sertifitseerija kontrollib DHX-i rakendamise õigsust ja väljastab vastava sertifikaadi

-
-
-

IT juht, DHX-i vahendaja, DHS-i arendaja

-
- -
-

järelevalve

-

-
-
-

RIA järelevalve DHX vahendajate tegevuse üle

-
-
-

DHS-i haldaja, IT juht, DHX-i vahendaja

-
- -
-

DHX aadressiraamat

-

-
-
-

*teenusena käitatav tööriist, mis näitab DHX-i võimekusega organisatsioonide nimekirja, sh DHX-i vahendajaid

-
-
-

RIA (järelevalvajana), DHS-i haldaja, IT juht, DHX-i vahendaja

-
- -
-

testide komplekt

-

-
-
-

*testide komplekt, millega DHX-i rakendaja saab kontrollida, et on protokolli õigesti rakendanud

-
-
-

DHS-i arendaja

-
- -
-
- -
- - - diff --git a/docs/Vormingud.html b/docs/Vormingud.html deleted file mode 100644 index b8a0908..0000000 --- a/docs/Vormingud.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - Vormingutevahelised seosed - - - - - - - - - - - -
-
-
- - - -
-
- -
- - - diff --git a/docs/Vormingutevahelised-seosed.png b/docs/Vormingutevahelised-seosed.png deleted file mode 100644 index 6a0714c..0000000 Binary files a/docs/Vormingutevahelised-seosed.png and /dev/null differ diff --git a/docs/X-ROAD.PNG b/docs/X-ROAD.PNG deleted file mode 100644 index ddd4e2b..0000000 Binary files a/docs/X-ROAD.PNG and /dev/null differ diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 6c14c50..0000000 --- a/docs/_config.yml +++ /dev/null @@ -1,10 +0,0 @@ -# Üldised määratlused -title: DHX -baseurl: "https://e-gov.github.io/DHX" - -# Build settings -gems: - - jekyll-feed -exclude: - - Gemfile - - Gemfile.lock diff --git a/docs/_layouts/LY.html b/docs/_layouts/LY.html deleted file mode 100644 index 16e22dc..0000000 --- a/docs/_layouts/LY.html +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - {{ content }} - - diff --git a/docs/auto-fix.svg b/docs/auto-fix.svg deleted file mode 100644 index 4d0a5b1..0000000 --- a/docs/auto-fix.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/book-open-variant.svg b/docs/book-open-variant.svg deleted file mode 100644 index 682c114..0000000 --- a/docs/book-open-variant.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/checkbox-marked-circle-outline.svg b/docs/checkbox-marked-circle-outline.svg deleted file mode 100644 index c3c19f2..0000000 --- a/docs/checkbox-marked-circle-outline.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/css/base.css b/docs/css/base.css deleted file mode 100644 index 0637d22..0000000 --- a/docs/css/base.css +++ /dev/null @@ -1,362 +0,0 @@ -/******************************************************************************/ -/* Body */ -/******************************************************************************/ - body { - /* Layout */ - max-width: 50em; /* limit line length to 50em for readability */ - margin: 0 auto; /* center text within page */ - padding: 1.6em 1.5em 2em calc(26px + 3em); /* leave space for status flag */ - /* Typography */ - line-height: 1.1; - font-family: 'Times New Roman', serif; - font-size: 14pt; - /* Colors */ - color: black; - } - -/** Headings ******************************************************************/ - h1, h2, dt { - font: 100% sans-serif; /* Reset all font styling to clear out UA styles */ - font-family: inherit; /* Inherit the font family. */ - line-height: 1.2; /* Keep wrapped headings compact */ - hyphens: manual; /* Hyphenated headings look weird */ - } - h1, h2, h3 { - color: #034575; - background: transparent; - } - h1 { font-size: 170%; margin-top: 2em; } - h2 { font-size: 140%; margin-top: 1em; } - dt { font-weight: bold; } - -/** Section divider ***********************************************************/ - :not(.head) > hr { - font-size: 1.5em; - text-align: center; - margin: 1em auto; - height: auto; - border: transparent solid 0; - background: transparent; - } - :not(.head) > hr::before { - content: "\00a4\2003\2003\00a4\2003\2003\00a4"; - } - -/******************************************************************************/ -/* Paragraphs and Lists */ -/******************************************************************************/ - p { - margin: 1em 0; - } - dd > p:first-child, - li > p:first-child { - margin-top: 0; - } - ul, ol { - margin-left: 0; - padding-left: 2em; - } - li { - margin: 0.25em 0 0.5em; - padding: 0; - } - dl dd { - margin: 0 0 .5em 2em; - } - .head dd + dd { /* compact for header */ - margin-top: -.5em; - } - /* Style for algorithms */ - ol.algorithm ol:not(.algorithm) { - border-left: 0.5em solid #DEF; - } - /* Style for switch/case
s */ - dl.switch > dd > ol.only { - margin-left: 0; - } - dl.switch > dd > ol.algorithm { - margin-left: -2em; - } - dl.switch { - padding-left: 2em; - } - dl.switch > dt { - text-indent: -1.5em; - margin-top: 1em; - } - dl.switch > dt + dt { - margin-top: 0; - } - dl.switch > dt::before { - content: '\21AA'; - padding: 0 0.5em 0 0; - display: inline-block; - width: 1em; - text-align: right; - line-height: 0.5em; - } - -/** Terminology Markup ********************************************************/ - dfn { /* Defining instance */ - font-weight: bolder; - } - a > i { /* Instance of term */ - font-style: normal; - } - dt dfn code, code.idl { - font-size: inherit; - } - dfn var { - font-style: normal; - } - -/** Change Marking ************************************************************/ - del { color: red; text-decoration: line-through; } - ins { color: #080; text-decoration: underline; } - -/** Miscellaneous improvements to inline formatting ***************************/ - sup { - vertical-align: super; - font-size: 80% - } - -/******************************************************************************/ -/* Code */ - - pre, code, samp { - font-family: 'Courier New', monospace; - font-size: 1em; - color: DeepPink; - overflow-y: hidden; - overflow-x: hidden; - page-break-inside: avoid; - hyphens: none; - text-transform: none; - } - pre code, - code code { - font-size: 100%; - } - pre { - margin-top: 1em; - margin-bottom: 1em; - } - -/** Inline Code fragments *****************************************************/ -/* code { color: #D93B00; } */ - -/******************************************************************************/ -/* Links */ -/******************************************************************************/ - -/** General Hyperlinks ********************************************************/ - - /* We hyperlink a lot, so make it less intrusive */ - a[href] { - color: #034575; - text-decoration: none; - border-bottom: 1px solid #707070; - /* Need a bit of extending for it to look okay */ - padding: 0 1px 0; - margin: 0 -1px 0; - } - a:visited { - border-bottom-color: #BBB; - } - - /* Use distinguishing colors when user is interacting with the link */ - a[href]:focus, - a[href]:hover { - background: #f8f8f8; - background: rgba(75%, 75%, 75%, .25); - border-bottom-width: 3px; - margin-bottom: -2px; - } - a[href]:active { - color: #C00; - border-color: #C00; - } - - /* Backout above styling for W3C logo */ - .head p:not(.copyright) > a, - .head > a:first-child { - border: none; - text-decoration: none; - background: transparent; - } - - -/******************************************************************************/ -/* Tables */ -/******************************************************************************/ - - th, td { - text-align: left; - text-align: start; - } - -/** Property/Descriptor Definition Tables *************************************/ - - table.def { - /* inherits .def box styling, see above */ - width: 100%; - border-spacing: 0; - } - - table.def td, - table.def th { - padding: 0.5em; - vertical-align: baseline; - border-bottom: 1px solid #bbd7e9; - } - - table.def > tbody > tr:last-child th, - table.def > tbody > tr:last-child td { - border-bottom: 0; - } - - table.def th { - font-style: italic; - font-weight: normal; - padding-left: 1em; - width: 3em; - } - - /* For when values are extra-complex and need formatting for readability */ - table td.pre { - white-space: pre-wrap; - } - - /* A footnote at the bottom of a def table */ - table.def td.footnote { - padding-top: 0.6em; - } - table.def td.footnote::before { - content: " "; - display: block; - height: 0.6em; - width: 4em; - border-top: thin solid; - } - -/** Data tables (and properly marked-up index tables) *************************/ - /* - highlights structural relationships in a table - when correct markup is used (e.g. thead/tbody, th vs. td, scope attribute) - - Use class="complex data" for particularly complicated tables -- - (This will draw more lines: busier, but clearer.) - - Use class="long" on table cells with paragraph-like contents - (This will adjust text alignment accordingly.) - Alternately use class="longlastcol" on tables, to have the last column assume "long". - */ - - table { - word-wrap: normal; - overflow-wrap: normal; - hyphens: manual; - } - - table.data, - table.index { - margin: 1em auto; - border-collapse: collapse; - border: hidden; - width: 100%; - } - table.data caption, - table.index caption { - max-width: 50em; - margin: 0 auto 1em; - } - - table.data td, table.data th, - table.index td, table.index th { - padding: 0.5em 1em; - border-width: 1px; - border-color: silver; - border-top-style: solid; - } - - table.data thead td:empty { - padding: 0; - border: 0; - } - - table.data thead, - table.index thead, - table.data tbody, - table.index tbody { - border-bottom: 2px solid; - } - - table.data colgroup, - table.index colgroup { - border-left: 2px solid; - } - - table.data tbody th:first-child, - table.index tbody th:first-child { - border-right: 2px solid; - border-top: 1px solid silver; - padding-right: 1em; - } - - table.data th[colspan], - table.data td[colspan] { - text-align: center; - } - - table.complex.data th, - table.complex.data td { - border: 1px solid silver; - text-align: center; - } - - table.data.longlastcol td:last-child, - table.data td.long { - vertical-align: baseline; - text-align: left; - } - - table.data img { - vertical-align: middle; - } - - -/* -Alternate table alignment rules - - table.data, - table.index { - text-align: center; - } - - table.data thead th[scope="row"], - table.index thead th[scope="row"] { - text-align: right; - } - - table.data tbody th:first-child, - table.index tbody th:first-child { - text-align: right; - } - -Possible extra rowspan handling - - table.data tbody th[rowspan]:not([rowspan='1']), - table.index tbody th[rowspan]:not([rowspan='1']), - table.data tbody td[rowspan]:not([rowspan='1']), - table.index tbody td[rowspan]:not([rowspan='1']) { - border-left: 1px solid silver; - } - - table.data tbody th[rowspan]:first-child, - table.index tbody th[rowspan]:first-child, - table.data tbody td[rowspan]:first-child, - table.index tbody td[rowspan]:first-child{ - border-left: 0; - border-right: 1px solid silver; - } -*/ diff --git a/docs/format-align-justify.svg b/docs/format-align-justify.svg deleted file mode 100644 index f73fa4b..0000000 --- a/docs/format-align-justify.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/ghost.svg b/docs/ghost.svg deleted file mode 100644 index 0ef9533..0000000 --- a/docs/ghost.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/kava.css b/docs/kava.css deleted file mode 100644 index 2da33f5..0000000 --- a/docs/kava.css +++ /dev/null @@ -1,32 +0,0 @@ -body { font-family: 'Open Sans', sans-serif; - font-size: 16px; line-height: 28px; - padding-top: 30px; - padding-bottom: 50px; } - -h1 { margin: 2rem 0 2rem; - font-family: 'Open Sans'; font-weight: 300; - font-size: 32px; } - -.mainMenu { margin: 2rem 0; } -.mainMenu li { display: inline; - text-align: center; margin-left: 4rem;} -.mainMenu li a { - display: inline-block; - width: 12rem; - padding: .5rem 0; - margin: 0; - text-decoration: none; - color: #333; font-size: 20px; -} -.mainMenu li .hovered { - border-bottom: 3px solid Gray; -} -.mainMenu .selected { - border-bottom: 3px solid black; -} -.mainMenu .suppressed { - border-bottom: none !important; -} - -#t1, #t2, #t3, #t4 { margin: 3rem; color: #525c65; - display: none; } diff --git a/docs/kava.html b/docs/kava.html deleted file mode 100644 index d42320b..0000000 --- a/docs/kava.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - - Kava - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
-
-
-
-
-

Hajusa dokumendivahetuse üleminekukava

-
-
- -
-
- - -
- -
-

-

Siin lehel anname erinevatele sihtrühmadele juhiseid ja teavet hajusale dokumendivahetusele üleminekuks.

- -
    -
  • Välja töötatud on uus andmevahetusprotokoll DHX, mis võimaldab X-teega liitunud asutustel vahetada dokumente omavahel kiiremini ja lihtsamini.
    • - -
  • Praegu toimub asutustevaheline dokumendivahetus põhiosas keskse andmevahetuskeskkonna DVK kaudu, kuid aeg on toonud esile selle piirangud ja kitsaskohad. Andmevahetusprotokoll DHX eeldab X-tee olemasolu ning toetub X-tee versioonis 6 lisandunud uutele võimalustele.
    • - -
  • Asutuste dokumendihaldussüsteemid liidestatakse omavahel X-tee abil ning need hakkavad tulevikus rääkima ühte keelt, milleks ongi dokumentide saatmiseks ja vastuvõtmiseks kasutatav suhtlusprotokoll DHX.
    • - -
  • Lisandub uudne X-tee teenuste vahendamise kontseptsioon, kus asutuselt ei nõuta enam kohustuslikku kohalolekut X-teel, vaid vahendamise saab delegeerida kas erafirmale või teisele riigiasutusele. Vahendamine hoiab kokku arendus- ja käituskulusid ning arendab majutusteenuse osutamise praktikat. Ühtlasi muutub vahendusteenus X-teel senisest täpsemini korraldatumaks ja legaalseks.
    • - -
  • Üleminek DHX protokollile algab aastal 2017.
    • -
- -
- -
- -
    -
  • Kirjeldame lühidalt, mis saab olema teisiti
    • -
  • Selgitame üleminekuks vajalikke tegevusi
    • -
  • Ajakava
    • -
  • Kulud ja võimalik rahastus
    • -
-
- -
- -
    -
  • DHX tutvustus koos arhitektuurijoonistega
    • -
  • Protokolli rakendusjuhised
    • -
  • Spekid, joonised jm dokumentatsioon
    • -
  • DHX adaptertarkvara
    • -
  • Nõuanne inimese poolt
    • -
-
- -
- -
    -
  • Kes on vahendaja? Kellele on vaja vahendajat? Kes sobib vahendajaks?
    • -
  • Vahendajaks saamine: nõuded, registreerimine
    • -
  • Registreeritud vahendajate nimekiri
    • -
-
-
-
- -
- - - - diff --git a/docs/noun_69699_cc.png b/docs/noun_69699_cc.png deleted file mode 100644 index 2e1eab7..0000000 Binary files a/docs/noun_69699_cc.png and /dev/null differ diff --git a/docs/noun_69716_cc.png b/docs/noun_69716_cc.png deleted file mode 100644 index baa4532..0000000 Binary files a/docs/noun_69716_cc.png and /dev/null differ diff --git a/docs/power-plug.svg b/docs/power-plug.svg deleted file mode 100644 index 8830570..0000000 --- a/docs/power-plug.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/repeat.svg b/docs/repeat.svg deleted file mode 100644 index 5c221f9..0000000 --- a/docs/repeat.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/files/representationList.md b/docs/representationList.md similarity index 100% rename from files/representationList.md rename to docs/representationList.md diff --git a/docs/ruler.svg b/docs/ruler.svg deleted file mode 100644 index b47e7a1..0000000 --- a/docs/ruler.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/files/sendDocument.md b/docs/sendDocument.md similarity index 100% rename from files/sendDocument.md rename to docs/sendDocument.md diff --git a/docs/test-tube.svg b/docs/test-tube.svg deleted file mode 100644 index e145841..0000000 --- a/docs/test-tube.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/weather-windy.svg b/docs/weather-windy.svg deleted file mode 100644 index b2fb1d3..0000000 --- a/docs/weather-windy.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/widgets.svg b/docs/widgets.svg deleted file mode 100644 index d06e135..0000000 --- a/docs/widgets.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/files/AjakohasusePlaan.md b/files/AjakohasusePlaan.md deleted file mode 100644 index d6b1caa..0000000 --- a/files/AjakohasusePlaan.md +++ /dev/null @@ -1,17 +0,0 @@ -_Hajusale dokumendivahetusele üleminek_ - -### Ajakohasuse plaan - -| nr | artefakt, sh asukoht | ajakohasena hoidmine (JAH/EI/jooksvalt täienev) - kes hoiab? | -|----|----------|---------|----------------------| -| 1 | Hajusale dokumendivahetusele ülemineku kava (lühidalt „Üleminekukava“) - asukoht GitHubis? | JAH - RIA | -| 2 | [DHX protokoll (tekst)](https://e-gov.github.io/DHX) | JAH - RIA | -| 3 | UK (universaalkomponent) - eraldi repo? | JAH - RIA | -| 4 | [DVK](https://github.com/e-gov/DVK) (üleminekuperioodi täiendustega) | JAH - RIA | -| 5 | [Skype vestlus „DHX töögrupp“](https://join.skype.com/fEffO9ipFUw7) (huvilistele, kutsetega) | jooksvalt täienev | -| 6 | [protokolli arendamisega seonduv (GitHub)](https://github.com/e-gov/DHX) | jooksvalt täienev | -| 7 | [DHX protokolli tekst EN](https://github.com/e-gov/DHX/blob/master/files/Protocol.md) | EI | -| 8 | [esitlus](https://github.com/e-gov/DHX) | EI | -| 9 | [analüüsi raport](https://github.com/e-gov/DHX/blob/master/files/Hajusa_dokumendivahetuse_andmevahetusprotokolli_DHX_anal%C3%BC%C3%BCs_1.2.pdf) | EI | -| 10 | [Etalonteostus](https://github.com/e-gov/DHX-etalon) – kood + dokumentatsioon + [töötav rakendus](https://dhxdemo.eesti.ee/) | EI | -| 11 | [DHX ruum Confluence-is](https://confluence.ria.ee/display/DHX/DHX+Home) | jooksvalt täienev | diff --git a/files/Arutelu.md b/files/Arutelu.md deleted file mode 100644 index 9edbf40..0000000 --- a/files/Arutelu.md +++ /dev/null @@ -1,47 +0,0 @@ -![](../img/EL_struktuuri-_ja_investeerimisfondid_horisontaalne.jpg) - -### Dokumendivahetusprotokoll DHX - -#### Avalik arutelu - -Lugupeetud dokumendihaldussüsteemi haldaja, arendaja, poliitikakoordinaator, kasutaja! - -Oleme välja töötanud uue lahenduse dokumentide elektrooniliseks vahetamiseks Eesti avaliku sektori asutuste vahel. - -Uus lahendus põhineb dokumendihaldussüsteemide (DHS-de) otsesuhtlusel X-tee abil ja kannab nimetust dokumendivahetusprotokoll DHX. - -Protokolli väljatöötamise eesmärk on teha dokumendivahetus kiiremaks, lihtsamaks ja veelgi turvalisemaks. - -Oleme hoolikalt kaalunud omadusi, mida protokollis teostada ja lähtunud protokollide parimast praktikast. - -Samuti oleme [analüüsinud DHSde kasutajate soove ja vajadusi](https://github.com/e-gov/DHX/raw/master/files/Hajusa_dokumendivahetuse_andmevahetusprotokolli_DHX_anal%C3%BC%C3%BCs_1.2.pdf) elektroonilise dokumendivahetuse korraldamisel. - -[Protokolli kavand](files/Protokoll.md) on läbinud mitmed sisemised läbivaatused ja täiendusringid. - -Protokolli terviklikkuse ja teostatavuse veelkordseks kontrollimiseks (verifitseerimiseks) oleme teinud protokolli [etalonteostuse](https://github.com/e-gov/DHX-etalon). - -Protokolli koostamisel oleme üritanud järginud [avatud standardimise](https://github.com/e-gov/DHX/issues/37) (_open standard_) protsessi. Avastandardit iseloomustab väljatöötamise protsessi läbipaistvus, kaasamine, tasakaalustatus ja laiahaardeline konsensus. Avatud standardimise protsessi kohustuslik osa on kavandite avalik arutelu (_public review_). - -Avalikus arutelus osalejatele oleme kokku pannud väikese [abistava juhendi](#juhend). - -Ootame teie arvamusi, ettepanekuid ja hinnanguid kuni 8. augustini 2016. - -Teie arvamus on oluline, et saaksime protokolli "lukku lüüa" ja 2017. a alustada rakendustegevustega. - -##### Juhend - -Palume teil tutvuda: -- [protokolli kavandiga](files/Protokoll.md) -- hajusa dokumendivahetuse andmevahetusprotokolli DHX [analüüsi raportiga](https://github.com/e-gov/DHX/blob/master/files/Hajusa_dokumendivahetuse_andmevahetusprotokolli_DHX_anal%C3%BC%C3%BCs_1.2.pdf) - - analüüsitud on protokolli vastavust dokumendivahetuse ärinõuetele, käsitletud on DVK ja dokumendivahetuse probleeme; raportis tehakse ettepanekuid protokolli täiendamiseks. -- [protokolli etalonteostusega](https://github.com/e-gov/DHX-etalon). - -Arvamused palume saata: -- Arvamused palume saata RIA koostööpartnerile DHX analüüsi väljatöötamisel: Evelin Kuusik, BPW Consulting OÜ, evelin.kuusik@bpw-consulting.com - - arvamused avaldatakse koondatult protokolli GitHubi lehel - - kui te ei soovi oma nime väljapaistmist, siis märkige seda saatmisel -- või sisestada otse protokolli [probleemide rubriiki](https://github.com/e-gov/DHX/issues) - - olete oodatud kommenteerima olemasolevaid issue-sid või algatama uusi. - - - diff --git a/files/DHX_EN (2).pdf b/files/DHX_EN (2).pdf deleted file mode 100644 index 3dc3a22..0000000 Binary files a/files/DHX_EN (2).pdf and /dev/null differ diff --git a/files/DOK-S.md b/files/DOK-S.md deleted file mode 100644 index 7f7921d..0000000 --- a/files/DOK-S.md +++ /dev/null @@ -1,31 +0,0 @@ -##Dokumendihalduse ökosüsteem - -_Euroopa koosvõimeraamistiku (European Interoperability Framework. Draft intermediate version, 2016) mudeli alusel_ - -###Õiguslik koosvõime -- [Asjaajamise ühtsed alused](https://www.riigiteataja.ee/akt/119062012007) -- [Teenuste korraldamise ja teabehalduse alused](https://eelnoud.valitsus.ee/main/mount/docList/e0e969c6-4e9f-4d95-952f-69a447623a2b) _eelnõu menetluses_ -- strateegia ["Dokumendihalduselt infohaldusele"](https://www.mkm.ee/et/tegevused-eesmargid/infouhiskond/dokumendihaldusest-infohalduseni) - -###Organisatsiooniline koosvõime -- dokumendihalduse koordinaator [MKM ITAO](https://www.mkm.ee/et/tegevused-eesmargid/infouhiskond/dokumendihaldusest-infohalduseni) -- [Dokumendihaldusnõukogu](https://www.mkm.ee/et/tegevused-eesmargid/infouhiskond/dokumendihaldusest-infohalduseni) -- DHS arendajad (u 4-5) -- [DHS haldajad](https://riha.eesti.ee) (u 450) -- DHS teenusepakkujad - -###Informatsiooniline koosvõime -- [Dokumendihalduse metaandmed (v3.0)](https://riha.eesti.ee/riha/main/xml/dokumendihalduse_metaandmed/1) -- [Elektrooniline dokumendivahetuse metaandmete loend (v2.1)](https://riha.eesti.ee/riha/main/xml/elektroonilise_andmevahetuse_metaandmete_loend/1) -- [DHX protokoll (v1.0.5)](https://e-gov.github.io/DHX) - -###Tehniline koosvõime -- DHS tarkvarad (u 4-5) -- [DHS-id](https://riha.eesti.ee) (u 50) -- [DVK](https://github.com/e-gov/DVK) -- [ADIT](https://github.com/e-gov/ADIT) -- muud dokumente töötlevad süsteemid -- [UK](https://github.com/e-gov/DHX) _kavandamisel_ - - - diff --git a/files/Kirjandus.md b/files/Kirjandus.md deleted file mode 100644 index 7be4020..0000000 --- a/files/Kirjandus.md +++ /dev/null @@ -1,31 +0,0 @@ -## Kirjandus -- Thaler D (2016) [Out With the Old and In With the New: Planning for Protocol Transitions](https://datatracker.ietf.org/doc/draft-iab-protocol-transitions/?include_text=1) -- Internet Mail 2000, D. J. Bernstein's project "to design a new Internet mail infrastructure around the following concept: Mail storage is the sender's responsibility." -- [Hacker News](https://news.ycombinator.com/item?id=10406040); Aaron Schwartz on D. J. Bernstein: [http://www.aaronsw.com/weblog/djb](http://www.aaronsw.com/weblog/djb). -- Two general’s problem https://en.wikipedia.org/wiki/Two_Generals%27_Problem -- Understanding trade-offs is distributed messaging http://bravenewgeek.com/what-you-want-is-what-you-dont-understanding-trade-offs-in-distributed-messaging/ -- A Transport Protocol for Content-Centric Networks https://eggert.org/papers/2010-icnp-con-trans.pdf -- RFC 1045 VMTP: Versatile Message Transaction Protocol https://tools.ietf.org/html/rfc1045 -- RFC 1263 TCP extensions considered harmful https://tools.ietf.org/html/rfc1263 -- RFC 7452 Architectural Considerations in Smart Object Networking http://www.rfc-editor.org/rfc/rfc7452.txt -- Saltzer et al (1981) End-to-end Arguments in Systems Design http://web.mit.edu/Saltzer/www/publications/endtoend/endtoend.pdf -- Vikipeedia: End-to-end principle https://en.wikipedia.org/wikiEnd-to-end_principle -- Delivery semantics http://bravenewgeek.com/you-cannot-have-exactly-once-delivery/ -- At most once: https://de.wikipedia.org/wiki/Remote_Procedure_Call#Fehlersemantik -- Timeout/Retry/ExponentialBackOff https://news.ycombinator.com/item?id=9845820 -- Simple Service Discovery Protocol/1.0 Operating without an Arbiter https://tools.ietf.org/html/draft-cai-ssdp-v1-03 -- Zawinski’s Law https://en.wikipedia.org/wiki/Jamie_Zawinski -- de Graauw (2008) Nobody needs reliable messaging http://www.infoq.com/articles/no-reliable-messaging -- his blog: http://www.marcdegraauw.com/ -- Microsoft (2001) Note: Reliable messaging http://www.w3.org/2001/03/WSWS-popa/paper40 -- Guaranteed delivery/Reliable messaging: https://en.wikipedia.org/wiki/Reliable_messaging -- Daigneau (2011) Design Solutions for SOAP/WSDL and RESTful Web Services. Veebisait: http://www.servicedesignpatterns.com/ -- Idempotent Retry pattern http://www.servicedesignpatterns.com/WebServiceInfrastructures/IdempotentRetry -- Adam Ierymenko. [Firewalls, deperimeterization, and the nature of digital media](https://www.zerotier.com/misc/BorderNone2014-AdamIerymenko-DENY_ALL.pdf); http://adamierymenko.com/author/adam-ierymenko/; https://www.zerotier.com/blog/; -- [Ask HN: Why don't more apps use peer to peer networking?](https://news.ycombinator.com/item?id=8175453) - - - - - - - diff --git a/files/Overview.md b/files/Overview.md deleted file mode 100644 index 1e8c537..0000000 --- a/files/Overview.md +++ /dev/null @@ -1,46 +0,0 @@ -# Document exchange protocol DHX - -Developed by Estonian Information System Authority in 2015-2016 - -### Purpose -* standardised and simple method to exchange documents - -### Target group -* all Estonian public sector organisations (mandatory) -* companies who have a lot of business with public sector (optional) - -### Motivation -* faster and simpler document ecxhange -* lower operating costs -* no Single Point of Failure - -### Architecture -* from centralised to distributed model - -![](img//AsIs.PNG) - -![](img//ToBe.PNG) - -![](img//Transition.PNG) - -### Builds on unique capabilities of X-Road - -![](img//ProtocolStack.PNG) - -X-Road, the Estonian national public sector data exchange layer, solves: -* addressability -* service discovery -* identity -* security -* legal - -### Elements of DHX -* DHX web service -* naming rule -* message format: Estonian Document Metadata Standard ("the Capsule") -* processing rules - -### Schedule -* 2015 - Draft version of the protocol -* 2016 - Reference implementation, verification, development of universal adapter component, migration planning -* 2017-2018 - Migration to DHX diff --git a/files/Pakendamine.md b/files/Pakendamine.md deleted file mode 100644 index d242380..0000000 --- a/files/Pakendamine.md +++ /dev/null @@ -1,162 +0,0 @@ -##Pakendamine - -_ülevaade sellest, mis mille sees käib_ - -#### Sisukord - -[HTTP sõnum (HTTP message)](#http-s%C3%B5num-http-message) | [interneti sõnumivorming (Internet Message Format)](#interneti-s%C3%B5numivorming-internet-message-format) -| [laiendatud, mitmeosaline sõnumivorming (MIME)](#laiendatud-mitmeosaline-s%C3%B5numivorming-mime) | [SOAP sõnum (SOAP messsage)](#soap-s%C3%B5num-soap-messsage) | [X-tee sõnum (X-Road message)](#x-tee-s%C3%B5num-x-road-message) | [Kapslis dokument](#kapslis-dokument) | [Elektroonilise andmevahetuse metaandmete loend](#elektroonilise-andmevahetuse-metaandmete-loend) | [e-arve](#e-arve) - -#### HTTP sõnum (_HTTP message_) -- võib olla: - - __päring(sõnum)__, _request (message)_ - - __vastus(sõnum)__, _response (message)_ -- edastuse osapooled: - - __klient__ (HTTP), _client_ - - __server__ (HTTP), _server_ -- [RFC 2616 HTTP/1.1](https://tools.ietf.org/html/rfc2616) jaotis 4.1 -- olemas laiendamisraamistik, ebaselge, kuidas läbi löönud [RFC 2774 An HTTP Extension Framework](https://www.ietf.org/rfc/rfc2774.txt) - -- HTTP tugineb e-posti e nn interneti sõnumivormingule (_Internet Message Format_) - -#### interneti sõnumivorming (_Internet Message Format_) -- [RFC 2822 Internet Message Format](https://tools.ietf.org/html/rfc2822) (2001) - - vanemates standardites nimetatud ka RFC 822 sõnumivorminguks - - __ümbrik__ (_envelope_) ja __sisu__ (_contents_) - - “messages are viewed as having an envelope and contents. The envelope contains whatever information is needed to accomplish transmission and delivery.” - - __päis__ (_header_) - koosneb __päiseväljadest__ (_header fields_) ja __keha__ (_body_) - - “A message consists of header fields (collectively called "the header of the message") followed, optionally, by a body.” - - ümbriku ja päise erinevuse kohta vt [siit](http://stackoverflow.com/questions/1750194/why-does-email-need-an-envelope-and-what-does-the-envelope-mean) -- kasutatakse e-posti transpordiprotokollis [RFC 2821 Simple Mail Transfer Protocol (SMTP)](https://tools.ietf.org/html/rfc2821#section-2.3) aga ka mujal - -#### laiendatud, mitmeosaline sõnumivorming (MIME) -- [RFC 2045 Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies](https://www.ietf.org/rfc/rfc2045.txt) ja seonduvad - - vt [ametlikku internetistandardite nimistut](https://www.rfc-editor.org/standards) -- määratleb mehhanismid mittetekstilise ja mitmeosalise (_multi-part_) teabe edastamiseks RFC 822 sõnumites -- nn MIME päiseväljad: - - MIME päisevälju kasutatakse nii RFC 822 sõnumi päises kui ka mitmeosalise konstruktsiooni kehas (_body part_) - - `MIME-Version` päiseväli - kinnitab, et sõnum on koostatud kooskõlas RFC 2045 standardiga. - - `Content-Type` päiseväli - kirjeldab kehas sisalduvat teavet - - selle välja väärtust nimetatakse meedia tüübiks (_media type_) - - "private values (starting with "X-") may be defined bilaterally between two cooperating agents without - outside registration or standardization. Such values cannot be registered or standardized." - - meediatüüpide registreerimine RFC 2048 - - `Content-Transfer-Encoding` päiseväli - - `Content-ID` ja `Content-Description` päiseväljad -- __entity__ = __MIME-päiseväljad__ (_MIME-defined header fields_) + __sisu__ (_contents_) -- __body part__ - mitmeosalises olemis (_entity_) olev olem -- rekursiivne struktuur -- laiendamisvõimalus: päiseväljad, nõudeks, et peab algama `Content` -- vt [näide](https://msdn.microsoft.com/en-us/library/ms526560(v=exchg.10).aspx) -- mitmest ressursist koosnevad dokumendid (_multi-resource documents_) - - [RFC 2387 The MIME Multipart/Related Content-type](https://tools.ietf.org/html/rfc2387) - - juurressurss (_root resource_), alamressursid (_subsidiary resources_) -- viitamine teistele osadele, eriti juurosast (_root body part_): [RFC 2557 MIME Encapsulation of Aggregate Documents, such as HTML (MHTML)](http://www.ietf.org/rfc/rfc2557.txt) - - `Content-Location` päiseväli - -#### SOAP sõnum (_SOAP messsage_) -- SOAP sõnum on XML dokument, mis koosneb: - - __SOAP ümbrik__ (_SOAP envelope_) (nõutav) - - __SOAP päis__ (_SOAP header_) (valikuline) - - __SOAP keha__ (_SOAP body_) (nõutav) -- SOAP ümbrik - "the top element of the XML document representing the message" -- SOAP päis - "a generic mechanism for adding features to a SOAP message in a decentralized manner without prior agreement between the communicating parties." - - sisaldab __päiseelemente__ (_header entries_) -- SOAP keha - "a container for mandatory information intended for the ultimate recipient of the message" - - võib sisaldada erinevaid __kehaelemente__ (_body entries_) - - kehas võib sisalduda __SOAP veablokk__ (_SOAP fault_) - - "Typical uses of the Body element include marshalling RPC calls and error reporting." -- Laiendamise kohta vt protokolli jaotis 4.2 SOAp Header: - - "SOAP provides a flexible mechanism for extending a message in a decentralized and modular way without prior knowledge between the communicating parties." - - `mustUnderstand` atribuut -- Veablokk - - "used to carry error and/or status information within a SOAP message" - - __faultcode__ "to provide an algorithmic mechanism for identifying the fault" - - __faultstring__ "to provide a human readable explanation of the fault" - - __detail__ "for carrying application specific error information related to the Body element" - - "The absence of the detail element in the Fault element indicates that the fault is not related to processing of the Body element. This can be used to distinguish whether the Body element was processed or not in case of a fault situation." - - "The default SOAP faultcode values are defined in an extensible manner that allows for new SOAP faultcode values to be defined". Vt standardi jaotis 4.4.1 SOAP Fault Codes. - -- Simple Object Access Protocol (SOAP) 1.1, - - http://www.w3.org/TR/2000/NOTE-SOAP-20000508/ - - https://www.w3.org/TR/soap/ - - http://www.tutorialspoint.com/soap/soap_quick_guide.htm - - [SOAP Version 1.2 Usage Scenarios](https://www.w3.org/TR/xmlp-scenarios/) -- protokollina sisaldab kolme asja: - - ümbrik - kui raamistik sõnumite sisu ja töötlemise määratlemiseks - - kodeerimisreeglid - - protseduuride kaugväljakutsete (RPC) kokkulepe (_convention_) -- kasutatav kombineeritult teiste protokollidega, eelkõige HTTP-ga - - standardne alus- e ülekandeprotokoll on HTTP - -- SOAP sõnumil võivad olla __manused__ (_attachments_) - - manused edastatakse MIME mitmeosalise sõnumi (_multipart_) mehhanismi abil - - _SOAP sõnumipakk_ (_SOAP message package_) koosneb SOAP sõnumist ja võimalikest manustest; manused ei pea olema XML vormingus - - SOAP sõnumipakk koostatakse `Multipart/Related` meediatüübi abil - - [SOAP Messages with Attachments](https://www.w3.org/TR/SOAP-attachments) - - vt ka [https://www.w3.org/TR/xmlp-scenarios/#S19](https://www.w3.org/TR/xmlp-scenarios/#S19) - -#### X-tee sõnum (_X-Road message_) -- määratletud kahe protokolliga: - - [X-tee sõnumiprotokoll](http://x-road.eu/docs/x-road_message_protocol_v4.0.pdf) (X-Road Message Protocol) - - [X-tee sõnumitranspordi protokoll](http://x-road.eu/docs/x-road_message_transport_protocol.pdf) (X-Road Message Transport Protocol) -- SOAP 1.1 protokolli profiil -- edastuse osapooled: - - __X-tee teenuse klient__, _service client_ - - __X-tee teenuse osutaja__, _service provider_ -- kaht liiki: - - __päring(sõnum)__, _request (message)_ - - __vastus(sõnum)__, _response (message)_ - - kuna X-tee on SOAP profiil ja SOAP transpordikihiks on HTTP, siis on üksüheselt seotud HTTP päringu ja vastusega -- struktuur: - - __päis__ (_header_) - - X-Road message headers = additional SOAP headers used by the X-Road - - nt `id`, X-tee sõnumi unikaalne identifikaator. - - "id - string - M(andatory) - Unique identifier for this message. The recommended form of message ID is UUID. --X-Road Message Protocol v4.0" - - __keha__ (_body_) - - "MUST use Document/Literal-Wrapped SOAP encoding convention" - - __manus__ (_attachment_) - - MIME multipart standardil - -#### Kapslis dokument -- "DVK dokument" -- "DVK konteiner" e "kapsel" -- DVK ja DHS vahel ühe teenusekasutusega (päring-vastus interaktsiooniga) edastatav dokument -- XML vormingus -- dokument võib koosneda mitmest failist -- DVK spetsifikatsioonis nimetatakse dokumendi faile kohati samuti dokumentideks -- edastatakse X-tee SOAP ümbrikus (_X-Road SOAP envelope_) - - sisaldab gzip-ga kokkupakitud, seejärel base64 kodeeritud "DVK dokumenti" -- asetseb "DVK konteineris" -- kirjeldatud [DVK spetsifikatsioonis](https://github.com/e-gov/DVK/tree/master/doc) - - jaotis "Üldskeem [..]" lk 7-20 -- seotud (lõdvalt) "Elektroonilise andmevahetuse metaandmete loendiga" -- kasutusel on kaks versiooni: - - versioon 2 - - XML skeem: [http://www.riik.ee/schemas/dhl/dhl.2010.r1.xsd](http://www.riik.ee/schemas/dhl/dhl.2010.r1.xsd) - - öeldakse, et formaadis - - sisaldab: - - üks või rohkem faili, zip-tud ja Base64 kodeeritud - - lisaks failide metaandmed - - versioon 1 (seotud Elektroonilise andmevahetuse metaandmete loendiga v1 - - XML skeem [http://www.riik.ee/schemas/dhl/dhl.xsd](http://www.riik.ee/schemas/dhl/dhl.xsd) - - DigiDoc 1.3 vormingus - - [teave DigiDoc vormingute kohta](http://www.id.ee/?id=36161) - -#### Elektroonilise andmevahetuse metaandmete loend - - nn semantiline standard, ei anna konkreetse masinloetava esituse süntaksit - - vt DVK konteiner e "kapsel" - - kaks versiooni: - - 2.1 - - [ametlik publikatsioon RIHAs](https://riha.eesti.ee/riha/main/xml/elektroonilise_andmevahetuse_metaandmete_loend/1) - - 1.0 - [ametlik publikatsioon RIHAs](https://riha.eesti.ee/riha/main/xml/elektroonilise_andmevahetuse_metaandmete_loend) - - mõned pole veel 2.1-le üle läinud (nt Riigi Teataja) - - DVK transleerib vanast uude - -#### E-arve - - ametlik standard EVS 923:2014 (vt link RaM [e-arvete lehel](http://www.fin.ee/e-arved)) - - kirjeldus on ka Eesti Pangaliidu veebilehel [E-arve](http://www.pangaliit.ee/et/arveldused/e-arve) - - XML-vormingus dokument - - - diff --git a/files/Protocol.md b/files/Protocol.md deleted file mode 100644 index fb65e22..0000000 --- a/files/Protocol.md +++ /dev/null @@ -1,256 +0,0 @@ - -### Document exchange protocol DHX - -Estonian Information System Authority - -Draft v 0.5 - -_Note. Newer draft(s) exist in Estonian. These have not been translated yet._ - -#### Table of Contents - -- [Overview](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#overview) -- [Definitions and abbreviations](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#definitions-and-abbreviations) -- [Main characteristics](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#main-characteristics) -- [Motivation](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#motivation) -- [Aim (”TO BE” situation)](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#aim-to-be-situation) -- [Parties](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#parties) -- [DMS service](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#dms-service) -- [Name rule](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#name-rule) -- [Messages](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#messages) -- [Message format](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#message-format) -- [Assessing the DHX capability of the addressee](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#assessing-the-dhx-capability-of-the-addressee) -- [Processing logic](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#processing-logic) -- [Enforcement](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#enforcement) -- [Extension options](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#extension-options) -- [Transition](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#transition) -- [Functioning of DEC during the transition period](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#functioning-of-dec-during-the-transition-period) -- [References](https://github.com/e-gov/DHX/blob/gh-pages/Protocol.md#references) - -#### Overview -The protocol provides a technical solution, which allows the document management systems (DMS) of the Estonian public sector, but also the information systems of the private and third sector that communicate with the public sector, to exchange documents, based on the distributed or decentralised principle. - -DHX is a new document exchange protocol which uses the X-Road infrastructure. - -Unlike the old document exchange centre (DEC), DHX does not require visiting “the post office” any longer for mail collection, but brings documents to the doorstep. - -DHX is intended for the secure organisation of the public sector’s document exchange. - -The compilation of the protocol is based on the best practice in protocol specification [RIA-PP]. - -The text has a normative meaning. The other content of the GitHub repository has an informative purpose. - -The protocol has been developed by the Estonian Information System Authority. Please send proposals and comments to priit.parmakson@ria.ee or create Issue in this repository. - -#### Definitions and abbreviations - -_Institution_    An organisation entered into the national register of state and local government institutions (RKOARR). - -_Document_    A document processed in an institution within the meaning of document management in the Estonian public sector. - -_DMS_    Document management system, an information system for electronic document management within an institution, incl. for servicing document management. - -_DMS service_    A relationship, whereby one organisation (company or another institution) provides an institution with the DMS technical environment. There may be several “virtual” DMSs in one technical environment. For example, the Ministry of Economic Affairs and Communications provides a DMS service to institutions under the administration of the ministry; the Information System of Estonian Schools (EKIS) provides the DMS service to several kindergartens. - -_DEC_    Document Exchange Centre [DEC]. - -_RIA_    Estonian Information System Authority. - -_Registry code_    A registry code granted to an institution in RKOARR. E.g. `70002093` `Kadrioru kindergarten`. - -_Service identifier_    X-Road service identifier under the requirements of X-Road version 6 [X-Road]. Uniquely identifies the X-Road service both on the Estonian X-Road and in the international federation of X-Road instances. Consists of an X-road member identifier, a service code denomination and an optional version number. For example: `EE/GOV/70003158/DMS/sendDocument`. - -#### Main characteristics - -1. DHX enables decentralised organisation of electronic document exchange without a central mail processing node. - -2. The protocol does not require individual (bilateral) agreements, configurations, building of interfaces, etc. between institutions that exchange documents. An institution following the protocol may send a document to another institution without previous communication between the two institutions. - -#### Motivation - -1. Currently, DMSs exchange documents via DEC, by using the tentatively named “DEC protocol”. - -2. The “DEC protocol” is determined by the list of electronic data exchange meta data [Capsule], the specification of DEC interfaces [DEC specification ] and [DEC maintenance procedure], and, in a broader context, “Common Principles of Administrative and Records Management Procedures” [AÜK]. - -3. To a smaller degree, document exchange interfaces have also been established between other information systems that process documents. These interfaces have not been standardised. - -4. The extending document circulation and the tightening network of information systems that exchange documents (modern document exchange is not limited to the so-called pure DMSs – documents are also exchanged by information systems, where document management in the traditional meaning is simply one type of data processing) call for an alternative to the document circulation occurring via a central mailbox server. - -#### Aim (”TO BE” situation) -1. DMSs exchange documents by using document exchange services, which follow the distributed document exchange protocol DHX. -2. Each DMS offers and uses a DHX document exchange service equivalent to the one used by other institutions. -3. All DMSs offer an equivalent service – the system is symmetrical. -4. All document exchange between institutions takes place in the aforementioned manner. DEC has been removed from the use. Intermediaries or central nodes are not used. - -#### Parties -1. The parties on an organisational level are the following: -1) institutions that have adopted DHX document exchange; -2) DMS service providers that have adopted DHX; -3) other organisations (companies, NPOs) that have joined X-Road and wish to send documents to institutions via DHX. -2. The parties on a system level are the following: -1) DMSs; -2) other systems interfaced with X-Road that wish to use DHX for sending documents to DMS. -Interaction -Figure 1 is a conceptual diagram of the interaction. The dashed lines represent the flow of documents. - -``` -+-----------+ +-----------+ -| |<---------------------| | -|Institution| |Institution| -| 1 |--------------------->| 2 | -+-----------+ +-----------+ -+-----------+ sendDocument +-----------+ -| |--O)------------------| | -| DMS 1 | | DMS 2 | -| |-----------------(O---| | -+-----------+ sendDocument +-----------+ -``` - -1. At an abstract institutional level, institutions exchange documents by directly sending them to and receiving them from each other -2. On the system level, document exchange is carried out via communication between DMSs on X-Road. -3. Larger institutions usually have their own DMS. Yet, many institutions, especially smaller ones, use DMS as a service. In such a case, a technical DMS environment may accommodate DMSs of several institutions. The DHX protocol works in both cases, but also in rare instances, where an institution has several DMSs. - -#### DMS service - -1. An institution develops their own DMS and opens an X-Road service on X-Road for all other public sector institutions – namely a DHX service, whereby other institutions send documents to that particular institution. - - Note. If an institution uses DMS as a service, then the service is developed by the DMS service provider. An institution authorizes the service provider to run the DHX service on behalf of the institution. This is conducted pursuant to the X-Road certificate management procedure. - -2. For an institution, the DHX service is the official channel for receiving documents on X-Road. - -3. For sending documents to another institution, DMS utilises the DHX service offered by the other institution. - -4. The service must be up and running at least 8 hours a day. DMS with smaller capability must establish a buffer component with higher availability; message queue solutions are well-suited for this purpose. Several of the latter can be found on the market. - -5. In addition to other DMSs, all institutions that have joined X-Road can send documents to the DHX service. In justified cases, an institution may restrict access to the DHX service for X-Road members that are not institutions. - -6. DHX is a standardised document exchange scheme, which allows a simple communication between a large number of parties. However, institutions may, in view of business requirements, create other, special interfaces which use X-Road for exchanging documents and other data between DMSs and other information systems. - -#### Name rule - -1. The name of a DHX service must comply with the form defined in this section. Fixing the name form ensures service discovery and, thereby, the addressability of the institution. - -2. The code name of the DHX service within the meaning of X-Road is `sendDocument`. - -3. The full name of the service pursuant to the X-Road v6 name rules is `EE/GOV/< registry code >/DHS/sendDocument` - - where `DHS` (DMS in English) is the name fixed with this protocol ensuring service discovery and `` is the registry code of the institution. - - Note. `EE/GOV` is a type name for an Estonian public sector institution in X-Road v6. - - No version number is added to the technical code name of the service. - - Example: `EE/GOV/70003158/DMS/sendDocument` - -#### Messages - -1. Two types of messages move within the interaction: an X-Road query message (query) sent to the service `sendDocument` and a response message (response) sent as a response. - -2. The document is forwarded with the query. - -3. A confirmation of receiving the document is sent as a response to the X-Road query. - -#### Message format - -1. The document is forwarded in “a capsule”, containing metadata which must comply with the officially confirmed list of digital data exchange metadata [Capsule]. - -2. The registry code of the addressee-institution is also forwarded in the capsule of the document. - -3. The transmitting DMS provides the document with an identifier (a number), which is unique at least within the DMS. - -#### Assessing the DHX capability of the addressee - -1. The transmitting system may use one or more of the following methods. - -2. Assessing the DHX capability of the addressee with a transmitting attempt. - - The transmitting system attempts to send a document; if it is expressed in the response that the service does not exist, then the addressee has no DHX capability and the document will be sent via DEC. - - The method does not require the maintenance of status information regarding the capability of addressees in the transmitting system. - -3. Identification of the addressee’s DHX capability before a transmitting attempt. - - The security server of the sender periodically downloads information about the configuration of X-Road [PR-GCONF], including information about the subsystems (e.g. DMS) identified by the members of X-Road, and security servers. The sender’s security server determines, based on the aforementioned configuration data, whether the addressee has identified the DMS subsystem. If the results are negative, then DHX capability is absent. If the results are positive, then the transmitting system queries the addressee’s X-Road meta service `allowedMethods` [PR-META] for the list of services offered by the addressee. If the list contains `sendDocument`, then the addressee has DHX capability and the document will be sent. If the list does not contain the service, then the addressee has no DHX capability and the document will be sent via DEC. - -4. Identification of the DHX capability before sending, with buffering. - - Equivalent to the previous method, but the results of queries are buffered (not repeated over time, the results of the first query are relied upon instead). The method requires the maintenance of status information regarding the capability of addressees in the transmitting system. - -#### Processing logic - -1. The document is deemed to be forwarded if the addressee’s DMS or the buffer component with higher availability in front of it has sent a confirmation to the sender and the sender has received it. - -2. If it is not possible to connect with the addressee or if there is no confirmation of receipt, the system will try to send it again after a while (similarly to the DVC protocol). In order to reduce the amount of empty queries, it is recommendable to use the well-known exponential back-off algorithm [EXP]. - -3. Upon receipt of a document, DMS has to verify whether the document has been sent twice and avoid repeated processing (characteristic of business logic) of the same document, e.g. entering an invoice into an accounting system twice. A unique identifier of the document allows identifying duplicates. - -4. A technical DMS system, which is servicing several institutions has to ensure the delivery of a document which has arrived via the DHX service to the “virtual” DMS of the correct addressee. - -5. Instead of a confirmation, a corresponding message is sent to the sender regarding incorrectly addressed documents. - -#### Enforcement - -1. The effect resulting from the use of the protocol is the greatest if all institutions adopt the protocol. Upon developing the protocol, the assumption is that the vast majority of institutions will start using DHX. - -2. Even though there are institutions that do not use DHX, it does not disrupt the use of DHX. - -3. The protocol does not require the simultaneous switching of all institutions to the DHX protocol (see section “Transition”) - -4. Imposing an obligation to use the protocol does not fall within the scope of this protocol. - -#### Extension options - -1. The essential elements of the DHX protocol are as follows: 1) a name rule, which allows simple service discovery; 2) a standardised message format (metadata submitted with the document, the so-called capsule); 3) processing logic, which enables guaranteed delivery in practice; 4) the use of X-Road. - -2. The use of the DHX protocol in the Estonian private sector as well as in international document exchange is the object of further standardisation. - -#### Transition - -1. Transition to the DHX protocol takes place in a predetermined period of time. The transition period will start for all institutions simultaneously. RIA will announce of the beginning of the period. - -2. In the transition period, institutions will develop in their DMSs the capability to send and receive documents under the DHX protocol. In technical terms, “DHX capability” refers to the provision of X-Road service under the DHX protocol and the capability to connect to an equivalent service of other institutions. - -3. The capability under the DHX protocol to send and receive documents will be simultaneously developed and adopted in DMS. However, development in various DMSs will be completed at different times. - -4. In the transition period, as soon as the DMS of an institution has developed the DHX-capacity (when the development is finished), the institution must start, at the earliest opportunity, using the DHX service for sending documents. - -5. If it turns out that the addressee has not created a DHX service for receiving documents (i.e. the service cannot be found on X-Road), then the document is sent via DEC by using the DEC service `sendDocument` and marking the document of the addressee in the capsule of meta data. - -6. Once the first document is successfully sent under the DHX protocol to another institution, only DHX (not DEC) has to be used henceforth for sending documents to that institution. - -7. An institution which has launched the DHX service must keep using it. - -#### Functioning of DEC during the transition period - -1. DEC will be kept in operation throughout the whole transition period. DEC will be implemented with necessary functionality, so it would be operational during the transition period. - -2. DEC provides the service `sendDocument`, which the institution that has created the DHX capability can use to forward the document to an institution that has not yet established the DHX capability. The forwarding is performed by DEC. - -3. In case a document which has been addressed to an institution that has established the DHX capability is received by DEC, DEC will attempt to immediately forward it. - -4. DEC will be switched off when all institutions have been proven to established the DHX protocol capability (when the institution has received and sent at least one document). This will be established by sending corresponding DHX check queries from the DMS of RIA. - -#### References - -[AÜK] Government Regulation “Common Principles of Administrative and Records Management Procedures”, https://www.riigiteataja.ee/akt/130122011062?leiaKehtiv. - -[DEC] Document Exchange Centre [DEC]. Information System Authority. https://www.ria.ee/dokumendivahetus. - -[DEC maintenance procedure] Document Exchange Centre Maintenance Procedure. Information System Authority. https://www.ria.ee/public/dvk_kord.pdf. - -[DEC specification] Document Exchange Centre (DEC). Interface specification 1.6.0. https://svn.eesti.ee/projektid/dvk/doc/dvk_spetsifikatsioon_1.6.0.odt. - -[DH metadata] Records Management Metadata. List 3.0. The Ministry of Economic Affairs and Communication https://www.mkm.ee/sites/default/files/dokumendihalduse_metaandmed.pdf. - -[EXP] Exponential backoff. https://en.wikipedia.org/wiki/Exponential_backoff. - -[Capsule] List of digital data exchange metadata 2.1. Information System Authority. https://riha.eesti.ee/riha/main/xml/elektroonilise_andmevahetuse_metaandmete_loend/1. - -[PR-GCONF] X-Road Protocol for Downloading Configuration - -[PR-META] X-Road Service Metadata Protocol. - -[RIA-PP] Protocol Specification Best Practice. Information System Authority. 2015 - -[X-Road] Data Exchange Layer X-Road, https://www.ria.ee/x-tee/. - diff --git a/files/Protokoll.md b/files/Protokoll.md deleted file mode 100644 index bab265e..0000000 --- a/files/Protokoll.md +++ /dev/null @@ -1,3 +0,0 @@ -DHX protokoll on avaldatud siin: https://e-gov.github.io/DHX/ - - diff --git a/files/Workflow.md b/files/Workflow.md deleted file mode 100644 index d204c04..0000000 --- a/files/Workflow.md +++ /dev/null @@ -1,7 +0,0 @@ -### Protokolli haldamise korraldus - -#### Avaldamise töövoog -- Kinnitatud versioonide avaldamiseks kasutatakse W3C [ReSpec](https://github.com/w3c/respec) kujunduslahendust -- Avaldatakse GitHubis, kasutades [GitHub Pages](https://help.github.com/categories/github-pages-basics/) funktsionaalsust. Asjaomased teabelehed: - - [User, Organization, and Project Pages](https://help.github.com/articles/user-organization-and-project-pages/) - - [Configuring a publishing source for GitHub Pages](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/) diff --git a/img/01-auto-fix.png b/img/01-auto-fix.png deleted file mode 100644 index 8bf2d1f..0000000 Binary files a/img/01-auto-fix.png and /dev/null differ diff --git a/img/01-book-open-variant.png b/img/01-book-open-variant.png deleted file mode 100644 index 1631741..0000000 Binary files a/img/01-book-open-variant.png and /dev/null differ diff --git a/img/01-bug.png b/img/01-bug.png deleted file mode 100644 index 902d573..0000000 Binary files a/img/01-bug.png and /dev/null differ diff --git a/img/01-format-align-justify.png b/img/01-format-align-justify.png deleted file mode 100644 index 6409ccc..0000000 Binary files a/img/01-format-align-justify.png and /dev/null differ diff --git a/img/01-power-plug.png b/img/01-power-plug.png deleted file mode 100644 index 5a9a47e..0000000 Binary files a/img/01-power-plug.png and /dev/null differ diff --git a/img/01-presentation.png b/img/01-presentation.png deleted file mode 100644 index a6dc9d8..0000000 Binary files a/img/01-presentation.png and /dev/null differ diff --git a/img/01-ruler.png b/img/01-ruler.png deleted file mode 100644 index 8b4e4a3..0000000 Binary files a/img/01-ruler.png and /dev/null differ diff --git a/img/01-test-tube.png b/img/01-test-tube.png deleted file mode 100644 index 1f1218b..0000000 Binary files a/img/01-test-tube.png and /dev/null differ diff --git a/img/01-weather-windy.png b/img/01-weather-windy.png deleted file mode 100644 index 1b1a8d4..0000000 Binary files a/img/01-weather-windy.png and /dev/null differ diff --git a/img/DHX-adapteri-kasutamine.PNG b/img/DHX-adapteri-kasutamine.PNG deleted file mode 100644 index 96333b8..0000000 Binary files a/img/DHX-adapteri-kasutamine.PNG and /dev/null differ diff --git a/img/ProtocolStack.PNG b/img/ProtocolStack.PNG deleted file mode 100644 index 899a8f8..0000000 Binary files a/img/ProtocolStack.PNG and /dev/null differ