HRI:n CKAN:in käyttöohjeet

Helsinki Region Infoshare -palvelun metatietokanta CKAN:in kirjautumislinkki löytyy hri.fi-sivuston kaikilta sivuilta alabannerin oikeasta laidasta.

Helsinki Region Infoshare -palvelun metatietokanta CKAN:in kirjautumislinkki löytyy hri.fi-sivuston kaikilta sivuilta alabannerin oikeasta laidasta. “Dataportaali”-linkki johtaa CKAN:in sisäänkirjautumislomakkeeseen.

HUOM: CKAN:issa ylläpidetään vain datan meta- eli kuvailutiedot. Jos data on tiedostomuodossa, tulee se julkaista ennen metatietojen lisäämistä tai muokkaamista jollain palvelimella. HRI auttaa tarvittaessa palvelimiin liittyvissä kysymyksissä.

Uuden datan lisääminen

Uusi data lisätään CKAN:iin kahdessa vaiheessa. Ensin lisätään datan meta- eli kuvailutiedot ja sen jälkeen dataan liittyvät resurssit (yksi tai useampia), eli joko tiedoston latauslinkki tai linkki rajapinnan kuvaukseen.

Tee kaikki vaiheet kerralla, älä jätä prosessia kesken. Jos sinulla ei ole kaikkia tarvittavia tietoja heti saatavilla, voi ei-pakollisia kenttiä jättää tyhjiksi ja datan tallentaa Luonnos-tilassa.

  1. Mene hri.fi-sivustolla Data-osioon ja kirjaudu sisään CKAN:iin.
  2. Varmista vielä haulla, ettei kyseistä dataa ole jo avattu.
    • Jos jokin toinen kaupunki on jo avannut saman(tapaisen) datan, kirjaa datan metatiedot mahdollisimman samalla tavalla. Näin molemmat datat löytyvät samoilla hakukriteereillä.
  3. Paina Data-sivun yläosassa olevaa “Lisää tietoaineisto” -painiketta.
  4. Täytä lomakkeelle datan metatiedot Metatietokentät-ohjeen mukaisesti. Täytä kentät mahdollisimman kattavasti.
  5. Paina lomakkeen alla olevaa “Seuraavaksi: Lisää dataa” -painiketta.
  6. Täytä lomakkeelle tiedoston tai rajapinnan tiedot Metatietokentät-ohjeen mukaisesti. Täytä kentät mahdollisimman kattavasti.
    • Tiedosto-kohdassa paina Linkki-painiketta ja syötä siitä avautuvaan kenttään linkki tiedostoon tai rajapinnan kuvaukseen. Älä käytä “Lataa”-painiketta.
  7. Jos dataan liittyy useampia tiedostoja, paina lomakkeen alla olevaa “Tallenna ja lisää toinen” -painiketta. Kun olet syöttänyt kaikkien resurssien tiedot, paina “Valmis”-painiketta.
    • Jos data on “Julkinen”-tilassa, se näkyy heti hri.fi-sivustolla. Jos data on “Luonnos”-tilassa, luonnos tallentuu ja on sisäänkirjautuneiden käyttäjien nähtävissä.
  8. Mene vielä kuvaustekstin yläpuolella olevalle “Datakokoelmat”-välilehdelle ja lisää data sopiviin datakokoelmiin.
    • Jos data on rajapinnan kautta saatavissa, lisää se “Rajapinnat”-datakokoelmaan.

Jo avatun datan metatietojen kopioiminen uuden pohjaksi

Jos organisaatiosi on jo avannut samantapaisen datan kuin se, jota olet avaamassa, voit kopioida olemassa olevan datan metatiedot uuden datan metatietojen pohjaksi. Kaikkia kopioituja kenttiä pystyy vapaasti muokkaamaan.

  1. Mene hri.fi-sivustolla Data-osioon ja kirjaudu sisään CKAN:iin.
  2. Etsi datahaulla data, jonka metatiedot haluat kopioida uuden datan metatietojen pohjaksi.
  3. Paina otsikon alla olevaa “Muokkaa”-painiketta.
  4. Paina lomakkeen alla olevaa “Kopioi”-painiketta.
  5. Kirjoita uuden datan suomenkielinen otsikko “Nimi”-kenttään ja kopioi se. Paina kentän alla olevan “URL”-rivin lopussa olevaa “Muokkaa”-painiketta ja liitä otsikko siitä avautuvaan kenttään (aukeaa “Nimi”-osion jälkeen). Kun poistut kentästä, kentän sisältö muokkautuu automaattisesti URL-osoitteeseen sopivaan muotoon.
  6. Jatka lomakkeen muokkaamista ja täydentämistä Uuden datan lisääminen -ohjeen mukaisesti kohdasta 4 eteenpäin.

Jo avatun datan metatietojen päivittäminen

  1. Mene hri.fi-sivustolla Data-osioon ja kirjaudu sisään CKAN:iin.
  2. Etsi datahaulla data, jonka metatietoja haluat päivittää.
  3. Paina otsikon alla olevaa “Muokkaa”-painiketta.
  4. Muokkaa datan metatietoja Metatietokentät-ohjeen mukaisesti. Täytä kentät mahdollisimman kattavasti.
  5. Tarkista, että muissakin kentissä olevat tiedot ovat ajan tasalla ja linkit yhä toimivia.
  6. Paina lopuksi lomakkeen alla olevaa “Päivitä tietoaineisto” -painiketta.

Jo avatun datan resurssien päivittäminen

  1. Mene hri.fi-sivustolla Data-osioon ja kirjaudu sisään CKAN:iin.
  2. Etsi datahaulla data, jonka resurssin haluat päivittää.
  3. Klikkaa “Data ja resurssit” -otsikon alla olevaa päivitettävän resurssin nimeä.
  4. Paina otsikon alla olevaa “Muokkaa”-painiketta.
  5. Muokkaa resurssin metatietoja Metatietokentät-ohjeen mukaisesti. Täytä kentät mahdollisimman kattavasti.
    • Jos päivität URL:ia, älä paina “Poista”-painiketta, vaan kirjoita uusi URL kenttään. ”Poista”-painikkeen painaminen johtaa virhetilanteeseen.
  6. Tarkista, että muissakin kentissä olevat tiedot ovat ajan tasalla ja linkit yhä toimivia.
  7. Paina lopuksi lomakkeen alla olevaa “Päivitä resurssi” -painiketta.

Uuden resurssin lisääminen jo avattuun dataan

  1. Mene hri.fi-sivustolla Data-osioon ja kirjaudu sisään CKAN:iin.
  2. Etsi datahaulla data, johon haluat lisätä resurssin.
  3. Paina otsikon alla olevaa “Muokkaa”-painiketta.
  4. Siirry lomakkeen yläpuolella olevalle “Data ja resurssit” -välilehdelle.
  5. Paina “Lisää uusi resurssi” -painiketta.
    • Täytä lomakkeelle tiedoston tai rajapinnan tiedot Metatietokentät-ohjeen mukaisesti. Täytä kentät mahdollisimman kattavasti.
  6. Tiedosto-kohdassa paina Linkki-painiketta ja syötä siitä avautuvaan kenttään linkki tiedostoon tai rajapinnan kuvaukseen. Älä käytä “Lataa”-painiketta.
  7. Paina “Lisää”-painiketta.
  8. Voit vaihtaa resurssien järjestystä menemällä “Muokkaa” -> “Data ja resurssit” -> “Uudelleenjärjestä resurssit”. Resurssien järjestystä pystyy muokkaamaan hiirellä raahaamalla. Paina lopuksi “Tallenna järjestys” -painiketta.

Datojen tai resurssien poisto

Jos sinulla on tarve poistaa joko yksittäinen resurssi tai koko data HRI:n datakatalogista, ole yhteydessä HRI-tiimiin. Kaikki “Poista”-painikkeet eivät toimi ja osa voi johtaa virhetilanteeseen ja sivuston kaatumiseen, joten HRI-tiimi tekee kaikki poistot.

Ylläpidolta (HRI-tiimi) pyydettäviä asioita

  • datojen tai resurssien poistaminen
  • käyttäjähallinta:
    • uuden käyttäjän lisääminen
    • käyttäjän poistaminen
  • uuden datakokoelman luominen
  • organisaatioiden lisääminen ja muokkaaminen
    • älä lisää tai muokkaa organisaatioiden tietoja itse, se saattaa rikkoa datojen automaattisen kopioitumisen avoindata.fi-palveluun
  • datojen massamuokkaus
    • jos sinulla on tarve muokata useammasta datasta samaa kenttää (esim. organisaation sähköpostiosoitteen vaihtaminen), voi HRI-tiimi tehdä sen massamuokkaustyökalulla

Mahdolliset virhetilanteet

Mahdollisissa virhe- tai ongelmatilanteissa sekä metadataan liittyvissä kysymyksissä saa apua HRI-tiimiltä (hri@hel.fi).

HRI:n (CKAN) metatietokentät ja ohjeet metatietojen päivittämiseen

Täytä mahdollisimman monta kentää, jotta data löytyy paremmin ja käyttäjä ymmärtää paremmin, mistä datassa on kyse.

Pakolliset kentät on merkitty kahdella tähdellä (**). Kentät, jotka olisi hyvä lisäksi täyttää jokaisesta datasta, on merkitty yhdellä tähdellä (*).

HRI-palvelu auttaa tarvittaessa metatietojen laatimisessa.

HRI:n metatietomalli noudattelee DCAT-AP-metatietomallia.

Data

Metatieto Selitys Esimerkki HUOM
Nimi ** Dataa mahdollisimman tarkasti kuvaava tiivis ja yleistajuinen otsikko. Pääkaupunkiseudun Palvelukartan REST-rajapinta Nimen loppuun ei tule pistettä.

Nimessä tulee olla alue, jota data koskee.

Nimeen ei yleensä kannata laittaa vuosilukua, eikä järjestelmän, projektin tms. nimeä.

Nimi en * / se Datan englannin- / ruotsinkielinen otsikko. Helsinki metropolitan area Service Map REST-API / Servicekarta över Helsingforsområdet Ks. yllä
URL ** Datan uniikki nimi, joka generoituu automaattisesti Nimi-kentästä. Järjestelmä myös tarkastaa, onko URL jo käytössä. Jos on, on nimeäkin syytä tarkentaa. paakaupunkiseudun-palvelukartan-rest-rajapinta URL:ssa tulee olla yli kaksi merkkiä, vain pieniä kirjaimia ja vain merkit “a-z0-9″ ja “-_”

URL:n muokkaaminen on mahdollista, muttei suositeltavaa.

URL:ia ei saa muokata datan julkaisemisen jälkeen.

URL:n maksimipituus on sata merkkiä.

Kuvaus (fi ** /en * /se) Datan vapaa tekstimuotoinen kuvaus. Esim: Mitä data pitää sisällään, miten se on laadittu, mitä käyttäjän tulee tietää, että hän osaa käyttää ja tulkita dataa oikein. Palvelukartta on avoin tiedotuskanava Helsingin, Espoon, Vantaan ja Kauniaisten kaupunkien toimipisteistä ja palveluista… Kuvaustekstissä voi käyttää markdown-muotoiluja (ohjeet alempana).

Suomenkielinen kuvaus on pakollinen.

Myös englanninkielinen kuvaus tulee tehdä, ruotsi valinnainen.

Lisätietoja Dataa kuvaavan sivuston linkki tai linkki esim. dataa kuvaavaan pdf-tiedostoon. Linkkejä voi syöttää yhden tai useampia. https://palvelukartta.hel.fi Tämä ei ole linkki itse dataan, vaan datan yleiskuvaukseen tai muuhun lisätietoon.

Linkin tulee olla http://- tai https://-alkuinen.

Lisenssi ** Lisenssi, jolla data on julkaistu. CC-BY-4.0 HRI suosittelee käyttämään lisenssinä kansallista avoimen datan lisenssiä Creative Commons 4.0:aa tai joissain tapauksissa Creative Commons 0:aa.
Kategoriat * Kategoria(t), joihin data kuuluu.

Kategorioita voi olla yksi tai useampia.

Asuminen, Väestö Uutta dataa lisätessä kategoriat voi valita listasta. Jo avattua dataa muokatessa kategoriat muokataan omalla välilehdellään (ks. ohje alempana).

Data voi kuulua useampaan kategoriaan. Kategorioita on yhteensä 12 kpl. Uusia kategorioita ei tehdä.

Avainsanat (fi/en/se) * Dataa kuvaavat avainsanat. Kun alkaa kirjoittaa avainsanaa, järjestelmä etsii ehdotuksia jo olemassa olevista avainsanoista. asuminen, esteettömyys, hallinto, … Laskettavat asiat monikossa (esim. koulut), ei-laskettavat yksikössä (esim. koulutus).

Käytetään ensisijaisesti jo olemassa olevia avainsanoja.

Alueet ** Alue / alueet, joita data koskee. Kun alkaa kirjoittaa aluetta, järjestelmä etsii ehdotuksia jo olemassa olevista alueista. Helsinki Espoo Vantaa Kauniainen Kaupunkitasoinen tieto. Alueina pks-seudun kaupungit, pks ja koko Helsingin seutu.

Jos datassa on muita alueita, älä lisää niitä tähän.

Organisaatio ** Aineistoa ylläpitävä organisaatio, esim. toimiala / tulosalue. Helsingin kaupunginkanslia Käytä vain järjestelmästä löytyviä organisaatioita. Jos tarvitsemaasi organisaatiota ei löydy, ole yhteydessä HRI:hin.
Ylläpitäjä * Dataa ylläpitävän tahon nimi toimiala- tai tulosaluetasolla. Helsingin kaupunginkanslian digitalisaatioyksikkö Yksi ylläpitäjätaho. Oltava julkishallinnon organisaatio, ei esim. yritys.
Ylläpitäjän sähköposti ** Dataa ylläpitävän tahon sähköpostiosoite. dev@hel.fi Mieluummin yleinen sähköpostiosoite kuin jonkun henkilökohtainen osoite.
Ylläpitäjän verkkosivusto Dataa ylläpitävän tahon verkkosivuston osoite. https://www.hel.fi/ Linkin on oltava http://- tai https://-alkuinen.
Lähde Taho(t), jo(t)ka on tuottanut datan pohjalla olevan datan. Helsingin, Espoon, Vantaan ja Kauniaisten kaupungit Alkuperäisen lähteen nimi, ei linkki.
Julkaistu ** Päivämäärä, jolloin data on alun perin julkaistu. 2011-06-09 Muoto vvvv-kk-pp.

Kenttää ei tule muokata datan julkaisemisen jälkeen.

Päivitetty * Päivämäärä, jolloin data on viimeksi päivitetty. Ei metatietojen, vaan datan päivityspäivämäärä 2023-05-31 Muoto vvvv-kk-pp.

Jätetään tyhjäksi vain, jos dataa ei ole koskaan päivitetty.

Päivitystiheys (fi/en/se) * Tieto, kuinka usein data päivitetään. Kun alkaa kirjoittaa päivitystiheyttä, järjestelmä etsii ehdotuksia jo olemassa olevista päivitystiheyksistä. jatkuva Käytä ensisijaisesti jo olemassa olevia vaihtoehtoja. Jos niistä ei löydy sopivaa, voit tehdä uuden.

Jos dataa ei enää päivitetä, laitetaan päivitystiheydeksi “Päättynyt”.

Aikasarja alkaa Päivämäärä / vuosi, jolloin datan aikasarja alkaa. Muoto joko pp.kk.vvvv, kk/vvvv tai vvvv.
Aikasarja päättyy Päivämäärä / vuosi, jolloin datan aikasarja päättyy. Päättymisajankohtaa ei merkitä, jos aineiston ylläpito ei ole päättynyt.

Muoto joko pp.kk.vvvv, kk/vvvv tai vvvv.

Aikasarjan tarkkuus (fi/en/se) Esim. vuosi / kuukausi / vuorokausi / tunti. Käytä ensisijaisesti jo olemassa olevia vaihtoehtoja. Jos niistä ei löydy sopivaa, voit tehdä uuden.
Muistutuspäivämäärä * Päivämäärä, jolloin järjestelmä lähettää automaattisen muistutuksen datan päivittämisestä HRI:n ylläpidolle. 2025-01-02 Muoto vvvv-kk-pp.

Jos dataa päivitetään manuaalisesti, täytä aina tämä kenttä.

Hakusanat ”Hakumössö”. Jotta hausta tulisi mahdollisimman kattava ja tehokas, olisi tähän kenttään hyvä kirjoittaa mahdollisimman paljon dataan liittyviä sanoja ja synonyymejä. Kentän sisältö ei näy loppukäyttäjälle (rajapinnan kautta tosin saattaa näkyä).
Globaali ID Tulevaa varten jo tehty kenttä, johon voidaan luoda jokaiselle datalle yksilöivä ID (jolloin esim. sama data ei kopioidu montaa kertaa avoindata.fi:hin). Ei (vielä) käytössä.
Näkyvyys ** Valinnat: Julkinen (näkyy kaikille) / Yksityinen (näkyy vain kirjautuneille ylläpitäjille) Julkinen Jos haluaa tallentaa kuvauksen luonnoksen, voi käyttää Yksityinen-tilaa.

 

Datan erilliset metatiedot (välilehdillä)

Metatieto Selitys Esimerkki HUOM
Sovellukset Linkit datasta tehtyihin sovelluksiin, jotka on esitelty sovellusgalleriassa.
Aktiivisuusvirta Aktiivisuusvirrasta näkee mm., kuka on tehnyt muutoksia metatietoihin, milloin muutokset on tehty ja mitä on muutettu.
Kategoriat * Kategoria(t), johon data kuuluu. Asuminen, Rakennettu ympäristö, … Data voi kuulua useampaan kategoriaan. Kategorioita on yhteensä 12 kpl. Uusia kategorioita ei tehdä.
Datakokoelmat Datakokoelma(t), johon data kuuluu. Datakokoelmat eivät ole hierarkkisia. Rajapinnat Data voi kuulua useampaan datakokoelmaan. Ks. lisätietoja HRI:n sivuilta.

Jos tarvitset uuden datakokoelman, ole yhteydessä HRI:hin.

 

Resurssi

Resursseiksi laitetaan vain avoimena datana julkaistava(t) tiedosto(t) tai linkki rajapintakuvaukseen. Lisätietoa datasta sisältävät dokumentit (esim. doc tai pdf) laitetaan linkkeinä datan metatietokuvaukseen Lisätietoja-kohtaan.

Tiedostojen nimiin ja hakemistopolkuihin ei saa laittaa skandeja tai muita erikoismerkkejä eikä välilyöntejä.

Metatieto Selitys Esimerkki HUOM
Nimi ** Resurssia kuvaava tiivis otsikko. REST-rajapinta Nimen loppuun ei tule pistettä.

Nimenä voi olla esim. ko. vuosi, alue tai tiedostoformaatti.

Nimi (en * / se) Resurssin englannin- tai ruotsinkielinen nimi. REST API / REST gränssnitt Nimen loppuun ei tule pistettä.

Ainakin englanninkielinen nimi on annettava.

URL * Linkki, jota klikkaamalla käyttäjä voi ladata koko datan mieluiten suoraan. Vaihtoehtoisesti URL voi osoittaa ohjelmointirajapinnan kuvaukseen. https://www.hel.fi/palvelukarttaws/rest/ver4_en.html Jotta linkki toimii, pitää osoitteen olla http:// tai https:// -alkuinen.

Älä paina Poista-nappia, se johtaa virhetilanteeseen.

Tiedoston koko Tiedoston koko tavuina (!). Numeroiden välissä ei saa olla välilyöntejä. Hyvä täyttää erityisesti, jos tiedoston koko on suuri.
Tiedostomuoto ** Tiedoston tiedostotyyppi, lyhenne. JSON Laita tähän vain yksi (yleisin) tiedostoformaatti. Käytä ensisijaisesti jo olemassa olevia vaihtoehtoja. Formaatti näkyy myös hakusuodattimissa, joten varmista, ettei formaatissa ole kirjoitusvirhettä. Kirjoita formaatti kokonaan isoilla kirjaimilla.
Kuvaus (fi/en/se) Resurssin vapaa tekstimuotoinen kuvaus. Esim: Mitä data pitää sisällään, miten se on laadittu, mitä käyttäjän tulee tietää, että hän osaa käyttää ja tulkita dataa oikein. Jos kuvaus on sama kuin koko aineiston kuvauskin, niin tämä kenttä jätetään tyhjäksi.
Julkaistu * Päivämäärä, jolloin data on alun perin julkaistu. 2011-06-09 Muoto vvvv-kk-pp.
Päivitetty * Päivämäärä, jolloin data on viimeksi päivitetty. Ei metatietojen, vaan datan päivityspäivämäärä. 2017-05-31 Muoto vvvv-kk-pp.

Jätetään tyhjäksi vain, jos dataa ei ole koskaan päivitetty.

Koordinaatisto Paikkatietoaineistossa käytetty koordinaatisto. ETRS-GK25
Aikasarja alkaa Päivämäärä, jolloin aikasarja alkaa. Muoto joko pp.kk.vvvv, kk/vvvv tai vvvv.
Aikasarja päättyy Päivämäärä, jolloin aikasarja päättyy. Muoto joko pp.kk.vvvv, kk/vvvv tai vvvv.

Päättymisajankohtaa ei merkitä, jos aineiston ylläpito ei ole päättynyt.

Aikasarjan tarkkuus (fi/en/se) Esim. vuosi / kuukausi / vuorokausi / tunti. Käytä ensisijaisesti jo olemassa olevia vaihtoehtoja. Jos niistä ei löydy sopivaa, voit tehdä uuden.

 

HRI:n (CKAN) markdown-muotoiluohjeet

Hyvät perusohjeet:
https://github.com/akx/markdown-cheatsheet-fi/blob/master/Markdown-Ohje.md

Valtaosa tuon ohjeen muotoiluista toimii HRI:ssa, alla on poikkeuksia ja käytäntöjä.

Otsikot

  • ensimmäinen käyttäjän syöttämä otsikkotaso on ##Otsikko (h2)

Listat

    • ennen ja jälkeen listan tulee olla rivinvaihto (muuten lista taittuu yhdeksi kappaleeksi)
      alilistan syntaksi:

– ylempi taso

      • – alemman tason

 

      • – viivan

 

      • – eteen

 

      • – neljä välilyöntiä

– ylempi taso jatkuu

1. numeroiduissa listoissa
2. piste tai kaarisulku
3) numeron perään
4. ja välilyönnit ennen ja jälkeen listan

Linkit

  • syntaksi: [linkin teksti](https://linkki.fi)
  • linkin tulee olla http- tai (mieluummin) https-alkuinen
  • hakasulun ja sulun välissä ei saa olla välilyöntiä

Taulukot

  • eivät toimi HRI:ssa (tai oikeaa syntaksia ei ole löytynyt)

Rivinvaihdot

  • kappaleiden välissä tulee olla yksi tyhjä rivi, muuten kappaleet taittuvat peräkkäin

Kuvat

  • syntaksi: ![alt-teksti](kuvan_URL ”tooltip”)
  • kuvat täytyy laittaa jollekin ulkoiselle palvelimelle, HRI ei tarjoa tähän palvelintilaa