Kuidas andmeteenuseid kirjeldada

Miks andmeteenuseid kirjeldada?

Andmeteenuste kirjeldamise eesmärk on paremini ja inimsõbralikumalt lahti sõnastada X-teel pakutud andmeteenuste olemus ja eesmärk.

Hästi kirjeldatud andmeteenus võib:

tekitada teistel X-tee liikmetel suuremat huvi Teie andmeteenuste vastu;
lihtsustada teistel liikmetel Teie andmeteenuste kasutusele võtmist;
vähendada Teie poole suunatud küsimuste arvu ja seeläbi vähendada Teie halduskoormust;
parendada Teie andmeteenuse kasutusele võtmise kasutajakogemust;

RIA eesmärk X-tee iseteeninduskeskkonna teenuste kataloogiga on anda andmeteenuste pakkujatele võimaluse ühes keskkonnas hallata enda X-tee andmeteenuste dokumentatsiooni ning toetada nende kasutusele võtmist.

Eeltingimused

X-teega liitunud asutuse pakutud andmeteenuseid saab kirjeldada kasutaja kes täidab järgmisi kriteeriumeid:

Kasutaja on X-tee iseteeninduskeskkonda sisse loginud
Kasutajal on andmeteenust pakkuva asutuse esindusõigus või talle on volituse alusel määratud kas esindaja või turvaserveri administraatori roll.

Enda seost asutusega saate kontrollida "Minuga seotud asutused" vaates. Kui Teil on kehtiv esindusõigus või volitus, siis on selles vaates Teie asutus või asutused esile toodud.

Kui avastate, et "Minuga seotud asutused" vaade on tühi või sealt on mõni asutus puudu, siis palun tutvuge volituse lisamise juhendiga.

Andmeteenuste kirjeldamine

X-tee iseteeninduskeskkonna vasakul menüüribal on "Minu teenused" kõrval märgitud punase numbriga kui kasutaja seotud andmeteenusel on kohustuslikud väljad täitmata.

Avades "Minu teenused" vaate, saate koondülevaate Teiega seotud andmeteenustest. Kui andmeteenusel on kohustuslikud väljad täitmata, siis kuvatakse punaselt selgitav tekst selle andmeteenuse teenuse koodi all. Soovitud andmeteenuse kirjeldamist saab alustada vajutades teenuse koodi lingile:

Vajutades teenuse koodi lingile, avaneb selle andmeteenuse detailvaade. Detailvaates saab "Muuda" nupu kaudu alustada andmeteenuse kirjeldamist.

Selle tulemusena avaneb kirjeldamise vaade:

Kirjeldamist saab salvestada ainult juhul, kui kohustuslikud väljad on täidetud:

Teenuse nimetus - andmeteenuse lühike nimetus
Teenuse kirjeldus - andmeteenuse semantiline kirjeldus. Soovitame kirjeldades lähtuda küsimustest, mis võivad andmeteenuse kasutajal tekkida:
- Mida see andmeteenus teeb või võimaldab?
- Kes peaks seda kasutama?
- Mis andmeid võetakse sisendina ja mida väljastatakse vastusena?
Dokumendid (vabatahtlik) - Teenuse kirjeldusele saab lisada ka dokumente, mis võivad andmeteenust näiteks tehnilisemalt kirjeldada või sisaldada andmeteenuse kasutamise tingimusi.
- NB! Dokumendi lisamisega rakenduvad kindlad piirangud:
  - Lubatud faili laiendid: .doc, .pdf, .txt, .docx, .xls, .xlsx, .csv, .log, .rtf, .odt
  - Lubatud maksimum faili suurus: 5MB
  - Faili laadimisel teostatakse failile viirusekontroll, mis võib võtta kuni 5 sekundit aega.

Näited - näidistena võite vaadata järgmiste RIA poolt pakutud andmeteenuste kirjeldusi: