Bruksanvisning för HRI:s CKAN

hri.fi-sivuston alabannerin ylläpito nappula.

Helsinki Region Infoshare -tjänst metadatabas CKAN inloggningslänk finns på alla sidor på webbplatsen hri.fi, på höger sida av alabannern.

Länken “Dataportaali” leder till CKAN-inloggningsformuläret.

OBS: CKANs underhåller endast metadata för data. Om data finns i filformat måste de publiceras innan metadata läggs till eller redigeras på en server. HRI hjälper till med serverrelaterade frågor vid behov.

HRI:s (CKAN) bruksanvisning är bara på finska men metadatafält och instruktioner för uppdatering av metadata finns på svenska i slutet av denna webbsida.

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.
  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:s (CKAN) metadatafält och instruktioner för uppdatering av metadata

Fyll i så många fält som möjligt för att göra det lättare att hitta data och för att hjälpa användaren att förstå vad data handlar om.

Obligatoriska fält är markerade med två asterisker (**). Fält som också bör fyllas i för varje datapost är markerade med en asterisk (*).

HRI-tjänsten hjälper vid behov till att skapa metadata.

HRI:s metadatamodell följer DCAT-AP:s metadatamodell.

Data

Metadata Förklaring Exempel ANMÄRKNING
Titel ** En kortfattad och generisk titel som beskriver data så exakt som möjligt. Servicekarta över Helsinforsområdet Det finns ingen punkt i slutet av namnet.

Namnet måste innehålla det område som uppgifterna avser.

Det är generellt inte lämpligt att ange årtal i namnet, inte heller systemnamn, projektnamn etc.

Titel fi * / en Datans titel på finska / engelska. Pääkaupunkiseudun palvelukartan REST-rajapinta / Helsinki metropolitan area Service Map REST-API Se ovan
URL ** Unikt namn på data, genereras automatiskt från fältet Titel. Systemet kontrollerar också om URL:en redan är i bruk. Om så är fallet ska namnet också anges. paakaupunkiseudun-palvelukartan-rest-rajapinta URL:en måste vara mer än två tecken lång, endast gemener och endast tecknen “a-z0-9″ och “-_”
Det är möjligt att redigera URL:en, men det rekommenderas inte.URL:en får inte redigeras efter att uppgifterna har publicerats.Den maximala URL-längden är 100 tecken.
Beskrivning (fi ** /en * /se) Fritextuell beskrivning av data. Till exempel: vad data innehåller, hur den skapades, vad användaren behöver veta för att kunna använda och tolka data korrekt. Servicekartan är en öppen informationskanal om Helsingfors, Esbo, Vanda och Grankulla städers verksamhetsställen och tjänster… Markdown-format kan användas i beskrivningstexten (se nedan för instruktioner).
En beskrivning på finska är obligatorisk.En beskrivning på engelska krävs också, svenska är valfritt.
Mer information Länk till den webbplats som beskriver data eller länk till en pdf-fil som beskriver data, till exempel. En eller flera länkar kan anges. https://palvelukartta.hel.fi Detta är inte en länk till själva data, utan till en översikt av data eller annan ytterligare information.

Länken ska vara http://- eller https://-alkuinen.

Licens ** Den licens under vilken data publiceras. CC-BY-4.0 HRI rekommenderar att man använder den nationella licensen för öppna data Creative Commons 4.0:aa eller i vissa fall Creative Commons 0:aa.
Kategorier * Kategori(er) som data tillhör.

Det kan finnas en eller flera kategorier.

Boende, Befolking När du lägger till nya data kan kategorier väljas från en lista. Vid redigering av redan öppnade data redigeras kategorierna på en egen flik (se instruktioner nedan).

Data kan tillhöra mer än en kategori. Det finns totalt 12 kategorier. Inga nya kategorier skapas.

Taggar (fi/en/se) * Dataa kuvaavat avainsanat. Kun alkaa kirjoittaa avainsanaa, järjestelmä etsii ehdotuksia jo olemassa olevista avainsanoista. Taggar som beskriver data. När du börjar skriva in en tagg letar systemet efter förslag från befintliga tagg. boende, accessibilitet, administration … Räknebara objekt i plural (t.ex. schools), icke-räknebara objekt i singular (t.ex. education).

Företräde ges till att använda befintliga tagg.

Områden ** Område(n) som berörs av uppgifterna. När du börjar skriva ett viss område kommer systemet att leta efter förslag från befintliga områden.

 

Helsingfors Esbo Vanda Grankulla Data på stadsnivå. Områdena är städerna i huvudstadsregionen, huvudstadsregionen och hela Helsingforsregionen.

Om det finns andra områden i datan, lägg inte till dem här.

Organisation ** Organisation som upprätthåller data, t.ex. sektor / verksamhetsområde. Helsingin kaupunginkanslia Använd endast de organisationer som finns i systemet. Om du inte hittar den organisation du behöver, vänligen kontakta HRI.
Förvaltare * Namn på den enhet som förvaltar uppgifterna på sektornivå eller verksamhetsområdesnivå. Helsingin kaupunginkanslian digitalisaatioyksikkö Måste vara en offentlig förvaltningsorganisation, inte t.ex. ett företag.
Förvaltarens e-post ** E-postadress till den enhet som förvaltar. dev@hel.fi Använd helst en allmän e-postadress snarare än någons personliga adress.
Administratörens webbplats Den registeransvariges webbplatsadress. https://www.hel.fi/ Länken måste börja antingen med http://- eller https://.
Källa Källan/källorna som producerade de underliggande data. Helsingfors, Esbo, Vanda och Grankulla städer Namn på ursprungskällan, inte en länk.
Publicerad ** Datum då data ursprungligen publicerades. 2011-06-09 Format åååå-mm-dd.

Detta fält bör inte redigeras efter att data har publicerats.

Uppdaterad * Datum då data senast uppdaterades. Inte metadata, utan det datum då data uppdaterades. 2023-05-31 Format yyyy-mm-dd.

Ska lämnas tomt endast om data aldrig har uppdaterats.

Uppdateringsfrekvens (fi/en/se) * Information om hur ofta data uppdateras. När du börjar skriva in en uppdateringsfrekvens kommer systemet att leta efter förslag på befintliga uppdateringsfrekvenser. continuous Prioritera att använda befintliga alternativ. Om du inte hittar ett lämpligt alternativ kan du skapa ett nytt.

Om data inte längre ska uppdateras kommer uppdateringsfrekvensen att sättas till “Avslutad”.

Tidsserien börjar Datum/år då tidsserien för data börjar. Format antingen dd.mm.åååå, mm/åååå eller åååå.
Tidsserien slutar Datum/år då tidsserien för data slutar. Slutdatumet anges inte om underhållet av data inte har avslutats.

Format antingen dd.mm.åååå, mm/åååå eller åååå.

Tidsseriens korrekthet (fi/en/se) T.ex. år / månad / dag / timme. Använd helst befintliga alternativ. Om du inte hittar ett lämpligt alternativ kan du skapa ett nytt.
Påminnelsedatum för uppdatering * Datum då systemet skickar en automatisk påminnelse till HRI-administratören att uppdatera data. 2025-01-02 Format åååå-mm-dd.

Om data uppdateras manuellt ska detta fält alltid fyllas i.

Sökord För att göra sökningen så omfattande och effektiv som möjligt är det lämpligt att ange så många ord och synonymer relaterade till data som möjligt i detta fält. Innehållet i detta fält är inte synligt för slutanvändaren (även om det kan vara synligt via gränssnittet).
Globaali ID Ett fält som redan skapats för framtiden, där ett unikt ID kan skapas för varje data (t.ex. kommer samma data inte att kopieras flera gånger till avoindata.fi). Används (ännu) inte.
Synlighet ** Alternativ: Offentlig (synlig för alla) / Privat (synlig endast för inloggade administratörer). Offentlig Om du vill spara ett utkast till beskrivning kan du använda läget Privat.

 

Separata metadata för data (på flikar)

Metadata Förklaring  Exempel ANMÄRKNING
Applikationer Länkar till applikationer som gjorts från data, presenterade i applikationsgalleriet.
Aktivitetsflöde Aktivitetsflödet visar t.ex. vem som har gjort ändringar i metadata, när ändringarna gjordes och vad som ändrades.
Kategorier * Den eller de kategorier som data tillhör. Boende, Byggd miljö… Data kan tillhöra mer än en kategori. Det finns totalt 12 kategorier. Inga nya kategorier kommer att skapas.
Datainsamlingar Datainsamling(ar) som data tillhör. Datasamlingar är inte hierarkiska. Gränssnitt Data kan tillhöra mer än en datainsamling. Mer information finns på HRI:s webbplats.

Om du behöver en ny datainsamling, vänligen kontakta HRI.

 

Resurser

Endast den eller de filer som ska publiceras som öppna data eller en länk till gränssnittsbeskrivningen läggs in som resurser. Dokument som innehåller ytterligare information om data (t.ex. doc eller pdf) placeras som länkar till metadatabeskrivningen av data under avsnittet Ytterligare information.

Filnamn och katalogsökvägar får inte innehålla skands eller andra specialtecken eller mellanslag.

Metadata Förklaring  Exempel ANMÄRKNING
Namn (fi) ** Ett kort och beskrivande namn på resursen. REST-rajapinta Det finns ingen punkt i slutet av namnet.

Namnet kan t.ex. vara årtal, region eller filformat.

Namn (en * / se) Engelsk eller svensk benämning på resursen. REST API / REST gränssnitt Det finns ingen punkt i slutet av namnet.

Minst det engelska namnet måste anges.

URL * Länk som användaren kan klicka på för att ladda ner den fullständiga datan, helst direkt. Alternativt kan URL:en peka till beskrivningen av programmeringsgränssnittet. https://www.hel.fi/palvelukarttaws/rest/ver4_en.html För att länken ska fungera måste adressen vara http:// eller https://.

Tryck inte på Delete-knappen, detta kommer att resultera i en felsituation.

Filstorlek Filstorlek i byte (!). Det får inte vara några mellanslag mellan siffrorna. Bra att fylla i speciellt om filstorleken är stor.
Format ** Filens formt, förkortning. JSON Ange endast ett (det vanligaste) format här. Använd helst befintliga alternativ. Formatet kommer också att visas i sökfilter, så se till att det inte finns några stavfel i formatet. Skriv formatet med versaler.
Beskrivning (fi/en/se) Fritextbeskrivning av resursen. Till exempel: vad data innehåller, hur de sammanställdes, vad användaren behöver veta för att kunna använda och tolka data korrekt. Om beskrivningen är densamma som beskrivningen av hela data lämnas detta fält tomt.
Publicerad * Det datum då data ursprungligen publicerades. 2011-06-09 Format åååå-mm-dd.
Uppdaterad * Datum då data senast uppdaterades. Inte metadata, utan det datum då data uppdaterades. 2017-05-31 Format yyyy-mm-dd.

Ska endast lämnas tomt om data aldrig har uppdaterats.

Koordinatsystem Det koordinatsystem som används i den spatiala datamängden. ETRS-GK25
Tidsserien börjar Datum då tidsserien börjar. Format antingen dd.mm.yyyy, mm/yyyyy eller yyyy.
Tidsserien slutar Datum då tidsserien slutar. Format antingen dd.mm.yyyy, mm/yyyyy eller yyyy.

Ange inte slutdatum om underhållet av data inte har avslutats.

Tidsseriens korrekthet (fi/en/se) T.ex. år / månad / dag / timme. Använd helst befintliga alternativ. Om du inte hittar ett lämpligt alternativ kan du skapa ett nytt.

 

HRI:s (CKAN) markdown design riktlinjer

Bra grundläggande riktlinjer (på finska):
https://github.com/akx/markdown-cheatsheet-fi/blob/master/Markdown-Ohje.md

De flesta av formuleringarna i den riktlinjen används i HRI, med undantag och praxis nedan.

Rubriker

  • den första rubriknivån som användaren anger är ##Rubrik (h2)

Listor

    • det måste finnas en radbrytning före och efter listan (annars viks listan ihop till ett stycke)
      Syntax för underlistor:

– övre nivå

      • – lägre nivå

 

      • – linje

 

      • – framför

 

      • – fyra utrymmen

– den övre nivån fortsätter

1. i numrerade listor
2. punkt eller böjd parentes
3) efter numret
4. och mellanslag före och efter listan

Länkar

  • syntax: [länktext](https://linkki.fi)
  • länken måste vara http eller (helst) https
  • Det får inte finnas något mellanslag mellan hakparentesen och parentesen

Tabeller

  • fungerar inte i HRI (eller så har den korrekta syntaxen inte hittats)

Radbrytningar

  • det måste finnas en blankrad mellan styckena, annars kommer styckena att vikas efter varandra

Bilder

  • syntax: ![alt-text](bild_URL “tooltip”)
  • bilder måste placeras på en extern server, HRI tillhandahåller inte serverutrymme för detta