Ohjeita tehokäyttäjälle
Tuntuuko, ettei HRI:n perushaku aina riitä? Tutustu HRI:n tehokäyttäjän hakuohjeisiin ja tee entistäkin täsmällisempiä hakuja HRI:n datakatalogiin! Hakusyntaksit toimivat myös muissa CKAN-datakatalogeissa.
HRI:n perushaun vapaasanahaku kohdistuu aineiston latauslinkkejä lukuun ottamatta kaikkiin HRI:n metatietokenttiin (listattu alla). Hakusanasta on kirjoitettava vähintään kolme merkkiä. Yksittäisen hakusanan pituusrajoitus on 30 merkkiä.
Kirjoittamalla hakusanan eteen NOT saa rajattua hakutuloksista pois jonkin sanan tai fraasin (fraasi laitettava lainausmerkkeihin).
Jokerimerkillä * voi korvata haussa yhden tai useamman merkin. Jokerimerkkiä ei tarvitse kirjoittaa katkaistun sanan loppuun.
Hakutulosten vasemmalla puolella marginaalissa on erilaisia suodatinvaihtoehtoja, jotka tarjoavat mahdollisuuden suodattaa hakua tiedostomuodon, maantieteellisen alueen, kategorian sekä ylläpitäjän perusteella tai datakokoelmittain. Hakua voi rajata useammalla suodattimella samaan aikaan.
Hakukentän alla olevasta valikosta voi valita hakutulosten järjestyksen. Oletuksena on tuorein data.
HRI:ssa olevien aineistojen metatiedot ovat avointa dataa. Metatiedot ovat saatavissa avoimen rajapinnan kautta.
Haku suoraan CKAN:in metatietokentistä
HRI:n metatietokanta CKAN:issa on mahdollista kohdistaa haku myös joihinkin muihin CKAN:in kenttiin syntaksilla kentän_nimi:hakusana.
HUOM: Kaksoispisteen jälkeen ei tule välilyöntiä ja useampia sanoja sisältävä hakufraasi on laitettava lainausmerkkeihin, esim. maintainer:”Vantaan kaupungin tietopalveluyksikkö”.
| Metatieto | Kentän nimi | HUOM |
| Ylläpitäjä | maintainer | |
| Otsikko | title | |
| Kuvaus | notes | |
| Lisenssi | license_id | CC 4.0:n id: CC-BY-4.0 |
| Kategoria | groups | nimi kirjoitettava siinä muodossa kuin se näkyy url:ssa (esim. vaesto) |
| Organisaatio | organization | nimi kirjoitettava siinä muodossa kuin se näkyy url:ssa (esim. vantaan-sivistystoimen-toimiala-perusopetus) |
Esimerkkihakuja
| Hakufraasi | Hakutulos |
| Espoo NOT Helsinki | kaikki aineistot, joiden metatiedoissa on sana Espoo mutta ei sanaa Helsinki |
| koulutus AND Helsin* | kaikki aineistot, joiden metatiedoissa on sana koulutus sekä Helsin-alkuinen sana (esim. Helsinki, Helsingin, Helsingissä) |
| NOT license_id:CC-BY-4.0 | kaikki aineistot, joita ei ole lisensoitu CC 4.0:lla |
| NOT organization:* | kaikki aineistot, jotka eivät kuulu mihinkään organisaatioon |
| title:väestöenn* | kaikki aineistot, joiden otsikossa on väestöenn-alkuinen sana |
| maintainer:”Helsingin seudun liikenne HSL” | kaikki aineistot, joiden ylläpitäjä on Helsingin seudun liikenne HSL |
| NOT groups:* | kaikki aineistot, jotka eivät kuulu mihinkään kategoriaan |
Datakokoelmat
Tavalla tai toisella yhteen kuuluvien aineistojen tai aikasarjojen löytymisen helpottamiseksi HRI:ssa avattuja aineistoja on ryhmitelty datakokoelmiin.
Datakokoelmia on muodostettu muun muassa:
- aikasarjoista (esim. väestöennusteet)
- teemasta (esim. Helsingin historialliset kartat)
- samasta julkaisusta peräisin olevista aineistoista (esim. Helsingin tilastolliset vuosikirjat)
- samasta tietokannasta peräisin olevista aineistoista (esim. Aluesarjat)
- saman tutkimusryhmän aineistoista (esim. Kuutoskaupunkien varhaiskasvatus- ja sosiaalipalvelujen vertailut)
Aineisto voi kuulua useampaan datakokoelmaan. Datakokoelmat eivät ole hierarkkisia. Aineistojen hakutoiminnot datakokoelmien sisällä toimivat kuten HRI:n perushakukin.
Organisaatiot
HRI:ssa avatut aineistot on ryhmitelty myös organisaatioittain. Käytännössä organisaatio on aineistoa ylläpitävä toimiala tai tulosalue. Organisaatiot ovat hierarkkisia. Kukin aineisto voi kuulua vain yhteen organisaatioon (ja sen yläorganisaatioihin).
HRI:ssa alimman tason organisaatioita ovat Helsingin, Espoon, Vantaan ja Kauniaisten toimialat tai tulosalueet sekä osa liikelaitoksista. Ylemmän tason organisaatioita ovat kaupungit sekä seudulliset kuntayhtymät HSY ja HSL.
Aineistojen hakutoiminnot organisaatioiden sisällä toimivat kuten HRI:n perushakukin.
HRI:n metatietokentät
Taulukossa on listattu HRI:n kaikki metatietokentät. Jokaisesta aineistosta merkittävät tiedot on merkitty tähdellä (*).
Aineiston metatiedot
| Metatieto | Selitys | Esimerkki | HUOM |
| Nimi * | Aineistoa mahdollisimman tarkasti kuvaava otsikko. Nimen ei kuitenkaan pidä olla kuvaus. | Pääkaupunkiseudun Palvelukartan REST-rajapinta | Nimen loppuun ei tule pistettä. |
| Nimi en / se | Aineiston englannin/ruotsinkielinen otsikko. | Helsinki metropolitan area Service Map REST-API / Servicekarta över Helsingforsområdet | Nimen loppuun ei tule pistettä. |
| URL * | Aineiston 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. |
| Avainsanat (fi/en/se) * | Aineistoa kuvaavat avainsanat. Kun alkaa kirjoittaa avainsanaa, järjestelmä etsii ehdotuksia muissa aineistoissa olevista avainsanoista. | asuminen, esteettömyys, hallinto, … | Useammasta sanasta koostuvissa avainsanoissa välilyönti korvataan väliviivalla (-). |
| Alue * | Alue / alueet, joita aineisto koskee. Kun alkaa kirjoittaa aluetta, järjestelmä etsii ehdotuksia muissa aineistoissa olevista alueista. | Helsinki Espoo Vantaa Kauniainen | |
| Kuvaus (fi/en/se) * | Aineiston vapaa tekstimuotoinen kuvaus. Esim: Mitä aineisto pitää sisällään, miten se on laadittu, mitä käyttäjän tulee tietää, että hän osaa käyttää aineistoa ”oikein”. | Palvelukartta on avoin tiedotuskanava Helsingin, Espoon, Vantaan ja Kauniaisten kaupunkien toimipisteistä ja palveluista… | |
| Linkkejä tietoaineistoa koskeviin lisätietoihin verkossa | Tietoaineistoa kuvaavan sivuston linkki tai linkki esim. tietoaineistoa kuvaavaan PDF-julkaisuun. Linkkejä voi syöttää yhden tai useampia. | http://palvelukartta.hel.fi | Tämä ei ole osoite itse ladattavaan tietoaineistoon, vaan aineiston yleiskuvaukseen. |
| Organisaatio * | Aineistoa ylläpitävä organisaatio, esim. toimiala / tulosalue. | Helsingin kaupunginkanslia | |
| Lähde | Taho(t), jo(t)ka on tuottanut aineiston pohjalla olevan datan. | Helsingin, Espoon, Vantaan ja Kauniaisten kaupungit | |
| Ylläpitäjä * | Aineistoa ylläpitävän tahon nimi toimiala/tulosaluetasolla. | Helsingin kaupunginkanslian tietotekniikka- ja viestintäosaston tietotekniikkayksikkö | |
| Ylläpitäjän sähköposti * | Aineistoa 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 | Aineistoa ylläpitävän tahon verkkosivuston osoite. | https://dev.hel.fi/ | |
| Näkyvyys * | Valinnat: Julkinen (näkyy kaikille) / Yksityinen (näkyy vain aineiston syöttäneelle) | Julkinen | Jos haluaa tallentaa aineiston luonnoksen, voi käyttää Yksityinen-tilaa. |
| Julkaistu * | Päivämäärä, jolloin aineisto on alun perin julkaistu. | 2011-06-09 | Muoto vvvv-kk-pp. |
| Päivitetty | Päivämäärä, jolloin aineisto on viimeksi päivitetty. Ei metatietojen, vaan datan päivityspäivämäärä. | 2017-05-31 | Muoto vvvv-kk-pp. |
| Päivitystiheys (fi/en/se) | Tieto, kuinka usein aineisto päivitetään. Kun alkaa kirjoittaa päivitystiheyttä, järjestelmä etsii ehdotuksia muissa aineistoissa olevista päivitystiheyksistä. | jatkuva | |
| Lisenssi | Lisenssi, jolla tietoaineisto on julkaistu. | CC-BY-4.0 | HRI suosittelee käyttämään lisenssinä kansallista avoimen datan lisenssiä Creative Commons 4.0:aa. |
| Aikasarja alkaa | Päivämäärä / kuukausi / vuosi, jolloin aikasarja alkaa. | 2008 | Tähän merkitään koko aineistokokonaisuuden aikasarjan alku. |
| Aikasarja päättyy | Päivämäärä / kuukausi / vuosi, jolloin aikasarja päättyy. | Päättymisajankohtaa ei merkitä, jos aikasarjaa täydennetään yhä. | |
| Aikasarjan tarkkuus (fi/en/se) | Esim. vuosi / kuukausi / vuorokausi / tunti. | vuosi | |
| Muistutuspäivämäärä | Päivämäärä, jolloin järjestelmä lähettää automaattisen muistutuksen aineiston päivittämisestä HRI:n ylläpidolle. | 2019-01-01 | Muoto vvvv-kk-pp |
| Globaali ID | Tulevaa varten jo tehty kenttä, johon voidaan luoda jokaiselle aineistolle yksilöivä ID (jolloin esim. sama aineisto ei kopioidu montaa kertaa avoindata.fi:hin). | Ei (vielä) käytössä. | |
| Hakusanat | ”Hakumössö”. Jotta hausta tulisi mahdollisimman kattava ja tehokas, olisi tähän kenttään hyvä kirjoittaa mahdollisimman paljon aineistoon liittyviä asiasanoja, synonyymejä ym. | … | Ei näy käyttäjälle. |
Aineiston erilliset metatiedot (välilehdillä)
| Metatieto | Selitys | Esimerkki | HUOM |
| Sovellukset | Linkit aineistosta tehtyihin sovelluksiin, jotka on esitelty sovellusgalleriassa. | ||
| Kategoriat | Kategoria(t), johon aineisto kuuluu. | Asuminen, Rakennettu ympäristö, … | Aineisto voi kuulua useampaan kategoriaan. Kategorioita on yhteensä 12 kpl. |
| Datakokoelmat | Datakokoelmat, johon tietoaineisto kuuluu. Datakokoelmat eivät ole hierarkkisia. | Rajapinnat | Ks. lisätietoja yllä olevista tehokäyttäjän ohjeista. |
Resurssien metatiedot
| Metatieto | Selitys | Esimerkki | HUOM |
| Nimi * | Resurssia mahdollisimman tarkasti kuvaava otsikko. Nimen ei kuitenkaan pidä olla kuvaus. | REST-rajapinta | Nimen loppuun ei tule pistettä. |
| Nimi (en/se) | Resurssin englannin/ruotsinkielinen nimi. | REST API / REST gränssnitt | Nimen loppuun ei tule pistettä. |
| URL | Linkki, jota klikkaamalla käyttäjä voi ladata koko tietoaineiston mieluiten suoraan. Vaihtoehtoisesti URL voi osoittaa palvelimeen, joka tarjoaa ohjelmointirajapinnan. | http://www.hel.fi/palvelukarttaws/rest/ver4_en.html | Jotta linkki toimii, pitää osoitteen olla esim. http:// -alkuinen. |
| Tiedoston koko | Tiedoston koko tavuina (!). | ||
| Formaatti | Tietoaineiston tiedostotyyppi, lyhenne. | JSON | |
| 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ää dataa ”oikein”. | Jos kuvaus on sama kuin koko datan kuvauskin, niin tämä kenttä jätetään tyhjäksi. | |
| Paikkakoordinaatit | Paikkatietoaineistossa käytetty koordinaatisto. | ETRS-GK25 | |
| Julkaistu * | Päivämäärä, jolloin resurssi on alun perin julkaistu. | 2011-06-09 | Muoto vvvv-kk-pp. |
| Päivitetty | Päivämäärä, jolloin resurssi on viimeksi päivitetty. Ei metatietojen, vaan datan päivityspäivämäärä. | 2017-05-31 | Muoto vvvv-kk-pp. |
| Aikasarja alkaa | Päivämäärä / kuukausi / vuosi, jolloin aikasarja alkaa. | 2008 | Tähän merkitään ko. resurssin aikasarjan alku. |
| Aikasarja päättyy | Päivämäärä / kuukausi / vuosi, jolloin aikasarja päättyy. | Päättymisajankohtaa ei merkitä, jos aikasarjaa täydennetään yhä. | |
| Aikasarjan tarkkuus (fi/en/se) | Esim. vuosi / kuukausi / vuorokausi / tunti. | vuosi |
