Ohjeita vedenlaatutietojen ja pohjavesien vedenkorkeustietojen tuottajille

Valtion ympäristöhallinnon tiedonsiirtotapa (VYH-tiedonsiirtotapa)

Valtion ympäristöhallinnossa (VYH) on kehitetty pinta- ja pohjavesien vedenlaadun ja pohjavesien vedenkorkeuden tiedon siirtoa varten VYH-tiedonsiirtotapa. Sen perusajatuksena on, että tiedon toimittaja kuvaa siirrettävät tiedot ja niiden muodon (rakenteen) tässä dokumentissa kuvatulla tavalla. Tällöin varsinaisen siirrettävän tiedon (datan) rakenne on melko vapaasti valittavissa. Kuvaus toimitetaan siirrettävän tiedon mukana erillisessä kuvaustiedostossa tai siirtotiedoston alussa.

VYH:ssa on tehty muunto-ohjelma, jonka avulla tietoa voidaan ottaa vastaan eri muodoissa ja muokata sen jälkeen tarvittavaan muotoon. Tämä ohjelma ja VYH-tiedonsiirtomuoto mahdollistavat helpon ja tiedon rakenteesta riippumattoman tiedonsiirron organisaatioiden välillä. Rajoituksena on se, että kullakin rivillä voi olla vain yksi tietue ja yksi tietue ei saa jakaantua useammalle riville.

Kuvaus on XML-muotoinen eli tiedoston osat erotetaan toisistaan XML-kielen omaisilla koodeilla (tageillä). Kaikki koodit kirjoitetaan kulmasulkujen < > sisälle. Koodit toimivat pareina: ensimmäinen koodi kertoo mistä osa alkaa ja jälkimmäinen, kauttaviivalla varustettu koodi, mihin osa loppuu, esimerkiksi <‍HEADER‍>...<‍/HEADER‍>.

Pintavesien vedenlaatutietoja sekä pohjaveden pinnankorkeustietoja voi siirtää myös  XML-muodossa.

Ulkopuolinen käyttäjä voi perustelluista syistä anoa käyttäjätunnuksia joilla pääsee sertfioiudun yhteyden kautta siirtämään vyh- ja dat-siirtotiedostoja sekä XML-tiedostoja suoraan haluttuun tietojärjestelmään.

Erikseen sovittavat asiat

Kuvaustiedoston päätteen tulee olla .vyh, jotta kuvaustiedosto erottuisi siirrettävistä datatiedostoista. Datatiedostojen pääte, voi olla mikä tahansa, paitsi ei .vyh.

Kuvauksen COLUMN-osan NAME on avainsana, jonka perusteella tiedostosta luettu tieto yhdistetään tietojärjestelmässä oikeaan asiaan. Datan lähettäjän ja vastaanottajan on yhdessä sovittava tästä "nimistöstä", jonka perusteella data tunnistetaan.

Mikäli tiedosto on jaettu DATA BLOCK:eihin, samassa DATA BLOCKissa ei saa esiintyä samaa nimeä (NAME) usealle kentälle, koska tämä johtaisi sekaannuksiin. Myös DATA BLOCK:n TARGET:n nimeämiskäytäntö täytyy olla yhteisesti sovittu.

Datan lähettäjän ja vastaanottajan on yhdessä sovittava myös kenttien tietotyypeistä ja muodosta. Nämä ohjeet voivat olla joko kaikkia tietojärjestelmiä koskevia tai tietojärjestelmäkohtaisia.

Koodien perustaminen

Uusia määrityskoodeja voi hakea täyttämällä ja lähettämällä alla olevan koodihakemuksen.

Kuvauksessa käytettävät koodit

Kuvauksen koodit ja niiden järjestys on kuvattu liitetiedoston taulukossa. Koodin pakollisuudella tarkoitetaan sitä, että kyseisen koodin on oltava kuvauksessa, mutta sen arvona voi myös olla tyhjä. Esimerkiksi, jos COLUMN-osan <‍NAME‍> on tyhjä, se tarkoittaa sitä, että kyseinen sarake voidaan hypätä yli. Ne koodit, jotka eivät ole pakollisia voidaan jättää kokonaan pois kuvauksesta.

Esimerkkejä kuvaus- ja datatiedostoista (Vesla)

Esimerkki 1

Vesla:n datan kuvaustiedosto (monta tiedostoa)

Vesla:n datatiedostot:

Esimerkki 2

Vesla:n datan kuvaustiedosto (yksi tiedosto)

Vesla:n datatiedostot:

VYH-tiedonsiirtotapaan liittyvät suositukset

Suositus desimaalierottimeksi on piste (.). Myös pilkkua (,) voidaan käyttää.

Sarakkeiden erotinmerkiksi suositellaan puolipistettä (;). Myös muiden erotinmerkkien käyttäminen on mahdollista, mutta ei suotavaa. Erotinmerkin on oltava sama koko datakokonaisuudessa (DATA BLOCK). Erotinmerkin tulee olla sillä tavoin valittu, ettei se esiinny muualla datassa, kuten esimerkiksi merkkijonotyyppisissä sarakkeissa. Jos erotinmerkki halutaan valita niin, että se esiintyy merkkijonoissa, on merkkijonot reunustettava erikoismerkein (VALUE BEGIN AND END MARKER).

Päivämäärän osien järjestyksen on oltava päivä-kuukausi-vuosi tai vuosi-kuukausi-päivä. Vuosi on ilmoitettava neljällä numerolla. Kellonaika ilmaistaan muodossa tunnit:minuutit. Seuraavat päivämäärämuotoilut kelpaavat:

Päivämäärämuotoilut
Muoto Esimerkki
d.m.yyyy 1.3.1998
dd.mm.yyyy 01.03.1998
d/m/yyyy 5/6/1997
dd/mm/yyyy 05/06/1997
d m yyyy 2 10 1999
dd mm yyyy 02 10 1999
yyyy.m.d 1995.1.13
yyyy.mm.dd 1995.01.13
yyyy/m/d 1993/2/18
yyyy/mm/dd 1993/03/18
yyyy m d 1999 11 8
yyyy mm dd 1999 11 08
yyyymmdd 19910308

 

Lisätietoja

Kehitysinsinööri Jorma Sipilä,
Suomen ympäristökeskus,
Tietokeskus, ICT / Tietojärjestelmäryhmä
Sähköpostiosoite: etunimi.sukunimi@ymparisto.fi

Julkaistu 28.8.2019 klo 13.50, päivitetty 28.8.2019 klo 15.03