Lisa 2: TENTec andmete saatmine

Kasutuskontekst

Asutus peab andmestiku, mille levituse all on TENTeci edastatav fail, märgendama TENTec määrusega, et ATV saaks tuvastada, mis andmeid TENTec EU portaali edastada.

ATV kontrollib TENTec andmete edastamiseks, kas antud fail on TENTec andmestiku ja TENTec levitusega seotud.

Primaarne tegija

Organisatsiooni kasutaja/esindaja (TRAM)

Eeltingimused

Kasutaja on autenditud ja esindab organisatsiooni

Õnnestumise garantii

Andmestiku õiguslik alus on TENTEC

Päästik

Kasutaja valib andmestiku lisamise/muutmise

Õnnestumise põhistsenaarium

1. Kasutaja lisab andmestiku kirjelduse/muudab andmestiku kirjeldust ATVs, kas API kaudu või Andmestiku lisamise vormi kaudu

   1. Kasutaja määrab andmestiku kohalduvaks õigusaktiks „TENTEC“ ("dcatap_applicableLegislation":"TENTEC_LEGAL_ACT")

Laiendid

1.b ATV tagastab vea valideerimisvigade tõttu

Lisainformatsioon

API dokumentatsioon: https://abi.ria.ee/teabevarav/atv-mirroring-jobs-api-v2#ATVMirroringJobsAPIV2dokumentatsioon-Andmestikuteenus-dataset, vt ptk “Andmestiku teenus”

Kasutuskontekst

Asutus peab andmestiku ja tema levituse, mille all on TENTeci edastatav fail, märgendama TENTec määrusega, et ATV saaks tuvastada, mis andmeid TENTec EU portaali edastada.

ATV kontrollib TENTec andmete edastamiseks, kas antud fail on TENTec andmestiku ja TENTec levitusega seotud.

Primaarne tegija

Organisatsiooni kasutaja/esindaja (TRAM)

Eeltingimused

1. Kasutaja on autenditud ja esindab organisatsiooni

2. TENTec andmestik on ATVs avalikustatud

Õnnestumise garantii

1. ATV kuvab Admin-liideses rida andmete edastamise kohta vastava staatusega

   1. Admin saab vajadusel saatmise käsitsi käivitada

2. ATV kuvab levitust andmestiku detailvaates ja kasutaja saab faili alla laadida

3. Faili id kuvatakse Andmestiku lisamise vormi sammus "Levitus"

Päästik

Kasutaja valib levituse lisamise/muutmise

Õnnestumise põhistsenaarium

1. Asutus saadab andmestikuga seotud TENTec andmetega json-faili otspunkti /v2/organizations/my-organizations/{id}/datasets/{datasetId}/file-upload kaudu ATVsse.

2. ATV võtab faili vastu ja salvestab ATV S3Bucketisse

   1. edastatud failist levitust ei looda

   2. jääb seos andmestikuga

3. ATV tagastab õnnestumise korral faili id

4. Kasutaja saadab Levituse teenus kaudu levituse kirjelduse (CREATE)/muudab levituse kirjeldust ATVs (UPDATE)

   1. NB! Erisus AINULT TENTec puhul: Levituse teenuse element dcat_accessUrl asendada elemendiga ria_uploadedFileId (uuid, kohustuslik, väärtus saadud punktist 3)

5. ATV algatab levituse kirjelduste (dct_titleEt jne) valideerimise

   1. Kui levitusele JA andmestikule ei ole määratud "TENTec", siis kasutuslugu jätkub punktist 7

      1. Märkus. Kui levituse kohalduvaks õigusaktiks on „TENTEC“ ("dcatap_applicableLegislation":"TENTEC_LEGAL_ACT"), siis ATV kontrollib, kas ka seotud andmestiku (dataset.dct_identifier) kohalduv õigusakt on ka „TENTEC“

   2. Levituse kirjeldus (Distribution objekt) sisaldab ka parameetrit ria_uploadedFileId, mille väärtuseks on vastava faili ID (ria_uploadedFileId on kohustuslik kui "dcatap_applicableLegislation":"TENTEC_LEGAL_ACT")

      1. Märkus: vt punkti 4.a

   3. ATV kontrollib, et fail (ria_uploadedFileId) ei ole seotud ühegi teise levitusega (1 fail saab olla seotud ühe levitusega)

6. ATV algatab faili sisu (TENTEC andmed) valideerimise

   1. "country": "EE";

   2. "parameterName" ja "parameterId" peavad vastama sellele, mis on ATV parameter catalogue tabelis salvestatud (ATV pärib perioodiliselt väärtused EU portaalist);

   3. "transportMode" peab vastama Parameter Catalogue layer väärtusele;

   4. "parameterValue" peab vastama Parameter Catalogue dataType väärtusele ja ENUMERATION tüübi puhul väärtus peab sisalduma enumValues loetelus;

   5. parameterId peab olema "enabled": "true" väärtusega Parameter Catalogue'is.

7. Levitus salvestatakse

   1. ATV genereerib faili allalaadimislingi ja lisab selle accessUrl-iks

8. Kasutaja süsteem pärib job id

9. Kasutaja süsteem kontrollib job id alusel päringu õnnestumist

Laiendid

1a. Mitme faili puhul saadab iga faili eraldi

3a. Faili üleslaadimise ebaõnnestumisel tagastab ATV veateate

5.c.i. Kui fail on seotud teise levitusega, tagastab ATV veateate, et fail on juba seotud teise levitusega.  

5e. Levituse kirjelduse valideerimise ebaõnnestumisel määrab ATV job staatuseks FAILED koos vastava selgitusega JA levitust ei salvestata. Kasutaja saab alustada uuesti punktist 1 või 3

6f. Levituse faili valideerimise ebaõnnestumisel määrab ATV job staatuseks FAILED koos vastava selgitusega JA levitust ei salvestata. Kasutaja saab alustada uuesti punktist 1 või 3

Lisainformatsioon

API dokumentatsioon:

• https://abi.ria.ee/teabevarav/atv-mirroring-jobs-api-v2, vt ptk “Levituse teenus”

• https://andmed.eesti.ee/api/dataset-docs/

Kui levitus on juba olemas ja on vajadus fail vahetada, siis saab seda teha levituse ID alusel otspunkti PUT /v2/organizations/my-organizations/{id}/datasets/{datasetId}/distribution/{distributionId}/file kaudu

Kasutuskontekst

ATV kontrollib TENTec andmete edastamiseks, kas antud fail on TENTec andmestiku ja TENTec levitusega seotud.

Primaarne tegija

Organisatsiooni kasutaja/esindaja

Eeltingimused

1. Kasutaja on autenditud ja esindab organisatsiooni

2. TENTec andmestik on ATVs avalikustatud

Õnnestumise garantii

1. ATV kuvab Admin-liideses rida andmete edastamise kohta vastava staatusega

   1. Admin saab vajadusel saatmise käsitsi käivitada

2. ATV kuvab levitust andmestiku detailvaates ja kasutaja saab faili alla laadida

3. Faili id kuvatakse Andmestiku lisamise vormi sammus "Levitus"

Päästik

Kasutaja valib levituse lisamise/muutmise

Õnnestumise põhistsenaarium

1. Kasutaja lisab levituse kirjelduse/muudab levituse kirjeldust ATVs Andmestiku lisamise vormi kaudu

   1. ATV määrab levituse kohalduvaks õigusaktiks „TENTEC“ automaatselt, kui andmestiku õigusaktiks on valitud "TENTEC"

   2. Kasutaja laeb üles TENTec andmetega json-faili

   3. ATV algatab faili mahu ja formaadi valideerimist

   4. Kasutaja salvestab levituse

2. ATV algatab levituse kirjelduse (dct_titleEt jne) valideerimise 

   1. Kui levitusele JA andmestikule ei ole määratud "TENTec", siis kasutuslugu jätkub punktist 5

      1. Märkus. Kui levituse kohalduvaks õigusaktiks on "TENTEC", siis ATV kontrollib, kas ka seotud andmestiku kohalduv õigusakt on „TENTEC“

3. ATV algatab faili sisu (TENTEC andmed) valideerimise

   1. "country": "EE";

   2. "parameterName" ja "parameterId" peavad vastama sellele, mis on distribution_parameter_catalogue tabelis salvestatud;

   3. "transportMode" peab vastama distribution_parameter_catalogue.layer väärtusele;

   4. "parameterValue" peab vastama distribution_parameter_catalogue.dataType väärtusele ja "ENUMERATION" tüübi puhul väärtus peab sisalduma "enumValues" loetelus;

   5. parameterId peab olema "enabled": "true" väärtusega Parameter Catalogue'is. 

4. Levitus salvestatakse

   1. ATV genereerib faili allalaadimislingi ja lisab selle accessUrl-iks

Laiendid

1.c.i Faili üleslaadimise ebaõnnestumisel tagastab ATV veateate

2b. Levituse kirjelduse valideerimise ebaõnnestumisel annab ATV veateate ja andmeid ei salvestata. Kasutaja jääb vormile ja saab alustada punktist 1

3f. Levituse faili valideerimise ebaõnnestumisel annab ATV veateate ja andmeid ei salvestata. Kasutaja jääb vormile ja saab alustada punktist 1

Lisainformatsioon

-

Kasutuskontekst

Asutused saadavad TENTec andmed ATVsse (lisavad vastava levituse). ATV valideerib andmed vastavalt EU portaalist saadud parameetritele ja valideerimise õnnestumisel edsatatakse andmed TENTec EU portaali.

Primaarne tegija

ATV

Eeltingimused

1. TENTec andmestik on ATVs avalikustatud UC 1: TENTec andmestiku lisamine

2. TENTec andmestikule on lisatud TENTec levitus, mis on seotud TENTec andmeid sisaldava valiidse json-failiga UC 2: TENTec andmestikule TENTec levituse lisamine API kaudu, UC 3: TENTec andmestikule TENTec levituse lisamine UI kaudu

Õnnestumise garantii

TENTec EU portaali kaardil kuvatakse ATVst saadetud andmeid

Päästik

Kasutaja valib levituse lisamise/muutmise

Õnnestumise põhistsenaarium

ATV saadab perioodiliselt (iga aasta 1. detsember, konfigureeritav) andmed TENTec EU portaali.

1. Süsteem leiab kõik andmestikud, mille kohalduvaks õigusaktiks on „TENTEC“;

   1. Süsteem leiab kõik nende andmestike levitused, mille kohalduvaks õigusaktiks on „TENTEC“, mis ei ole varem edastatud TENTec'ile (tentec_ticket.process_end_date = null)

   2. Iga leitud levituse puhul:

      1. edastatakse selle levitusega seotud fail läbi TENTec API klient postData teenust TENTec'i;

      2. TENTec EU portaal võtab edastatud andmed asünkroonselt vastu ja tagastab ATV-le ticket'i numbri, mis on postData API vastus

      3. salvestatakse ticket_id koos edastatud levituse infoga

      4. logitakse saatmise info

      5. uuendatakse saatmise staatus (mida näeb Admin-liideses)

Laiendid

-

Lisainformatsioon

-

Kasutuskontekst

Pärast TENTEC levituse lisamist/muutmist ja kirjelduste salvestamist ATVs, kas API kaudu või Andmestiku lisamise vormi kaudu, vt UC 2: TENTec andmestikule TENTec levituse lisamine API kaudu ja UC 3: TENTec andmestikule TENTec levituse lisamine UI kaudu, kuvatakse rida Admin vaates.

Kui mingil põhjusel automaatne saatmine ebaõnnestub, siis saab Admin käsitsi saatmise käivitada.

Admin saab näha TENTec EU portaali jaoks ATV-sse edastatud levitused eraldi vaates ning järgida TENTec portaali edastatavate levituste staatust.

Admin saab ka käsitsi suunata TENTec levitusi TENTec portaali juhuks, kui automaatsel edastamisel esineb tõrkeid. 

Admin valib ühe levituse ja käivitab saatmise, mille tulemusena algatatakse valitud levituse json-faili saatmine samuti nagu automaatse saatmise korral.

Kui portaalis valideerimine õnnestub, siis Admin ei pea sellest andmete saatjat eraldi teavitama.

Primaarne tegija

Admin (RIA)

Eeltingimused

1. TENTec andmestik on ATVs avalikustatud UC 1: TENTec andmestiku lisamine

2. TENTec andmestikule on lisatud TENTec levitus, mis on seotud TENTec andmeid sisaldava valiidse json-failiga UC 2: TENTec andmestikule TENTec levituse lisamine API kaudu, UC 3: TENTec andmestikule TENTec levituse lisamine UI kaudu

Õnnestumise garantii

TENTec EU portaali kaardil kuvatakse ATVst saadetud andmeid

Päästik

Kasutaja valib levituse lisamise/muutmise

Õnnestumise põhistsenaarium

1. Admin valib menüüst "Tentec distribution"

2. ATV kuvab  Tentec levitused ja nende staatused ("pending" staatus = levitus ei ole varem TENTecile edastatud JA "ticket id" = "puudub")

3. Admin valib "pending" staatusega levituse juures "Edasta Tentecile" tegevuse

4. ATV annab kinnitamiseks valiku

   1. "Katkesta" valikul tegevus katkestatakse ja kasutusjuht lõpeb

   2. "Edasta" valikul UC jätkub

5. ATV käivitab valitud levituse faili saatmise TENTec EU portaali analoogselt automaatse saatmise reeglitele, vt UC 5: TENTec andmete käsitsi saatmine TENTec EU portaali, UC 4: TENTec andmete automaatne saatmine TENTEc EU portaali p 1.a

   1. staatus muutub "processing" 

6. Peale TENTeci vastuse saamist, muutub levituse/ticket'i staatus vastavalt kas "approved" või "rejected" 

   1. Kasutaja saab näha ticket'i andmeid.

Laiendid

6a. Kui staatus on "rejected":

1. Admin võtab ATV väliselt ühendust organisatsiooniga ja teavitab veast

   • Organisatsioon saadab API kaudu ATVsse levitusele uue faili (PUT /v2/organizations/my-organizations/{id}/datasets/{datasetId}/distribution/{distributionId}/file) / vahetab ATVs andmestiku vormi kaudu levituse faili, vt UC.TENTEC.ATV.002

   • Peale faili uuendamist tekib admin paneeli uus rida. Rea staatus on "pending"

   • Admin saab edastada uuendatud andmefaili TENTecile "Edasta TENTecile" nupu vajutamisega.  UC jätkub sammust 5

Lisainformatsioon

-

Kasutuskontekst

Sadama, tee vm sulgemisel peab vastavalt uuenema ka kaart EU portaalis

TENTec EU portaal vastavalt parameetri year väärtusele, kas lisab uued andmed või kirjutab üle sama aasta andmed viimati saadetud andmetega

Primaarne tegija

TENTec EU portaal

Huvipooled

Andmete omanik, Euroopa Komisjon

Eeltingimused

TENTec EU portaalis sama parameetri year väärtus, kui saadetavas sõnumis

Õnnestumise garantii

TENTec EU portaali kaardil kuvatakse andmeid korrektselt

Päästik

UC 5: TENTec andmete käsitsi saatmine TENTec EU portaali, UC 4: TENTec andme automaatne saatmine TENTEc EU portaali

Õnnestumise põhistsenaarium

1. UC 5: TENTec andmete käsitsi saatmine TENTec EU portaali, UC 4: TENTec andmete automaatne saatmine TENTEc EU portaali

   1. Kui varasemalt on sellise aja kohta andmed juba saadetud, siis TENTec EU portaal kirjutab üle sama aasta andmed viimati saadetud andmetega

Laiendid

 1.b Kui varasemalt ei ole sellise aja kohta andmeid saadetud, siis TENTec EU portaal lisab andmed

Lisainformatsioon

https://webgate.ec.europa.eu/tentec-maps/web/public/screen/home