Qvaimen käyttöopas

SISÄLLYS


Qvaimen kenttäkohtaiset ohjeet


Etusivu

Qvaimeen pääsee Etsimen ”Lisää aineisto” painikkeen kautta tai suoraan https://qvain.fairdata.fi.

Kirjaudu ensin sisään voidaksesi käyttää Qvainta.

  • Etusivulla on painike “Login now!”
  • Jos olet jo kirjautunut Qvaimeen, mutta kirjautumisesti on vanhentunut, saat virheilmoituksen “error: no token received” ==> klikkaa oikean yläkulman linkkiä ”login”.

Qvaimen käyttöliittymä on toistaiseksi toteutettu ainoastaan englannin kielellä.

Kirjauduttuasi päädyt sivulle, joka listaa kaikki omat aineistosi.

  • Klikkaamalla aineiston riviä, pääset suoraan muokkaamaan aineistoa
  • Klikkaamalla aineiston edessä olevaa numero-painiketta, näet muut toiminnot.

Kirjautuminen

Kirjaudu sisään käyttääksesi Qvainta. Kirjautuaksesi sinun pitää olla rekisteröitynyt CSC käyttäjäksi. Rekisteröitymisen jälkeen voit kirjautua joko HAKA-käyttäjätunnuksellasi tai CSC-tunnuksellasi.

Jos et ole vielä rekisteröitynyt CSC käyttäjäksi, mutta sinulla on HAKA-käyttäjätunnus, voit rekisteröityä CSC käyttäjäksi CSC:n asiakasportaalissa (SUI) käyttämällä HAKA-tunnustasi. Jos sinulla ei ole oman organisaatiosi tarjoamaa HAKA-tunnusta, voit hakea CSC -tunnusta tämän linkin kautta.


LUO UUSI  KUVAILU

Aloita kuvailu valitsemalla aineistolista-visun oikeasta yläkulmasta ”new dataset”.

Valitse, missä tiedostosi sijaitsevat

Ennenkuin pääset syöttämään kuvailutietoja, kerro Qvaimelle, missä kuvailuusi liittyvät tiedostot sijaitsevat. Ne voivat olla joko Fairdata IDAssa tai jossain ulkoisessa lähteessä.

Tee valita alasvetovalikosta “Where are my files“. Huom! Et voi vaihtaa valitaa myöhemmin, sillä se vaikuttaa siihen, miten tietojen kerääminen ja tallennus tapahtuu Qvaimen taustalla,

  • Jos haluat muuttaa valintaa, aloita uuden kuvailun tekeminen valitsemalla ”Reset dataset editor”.

Tallenna kuvailu

  • Valitse ”Save”, niin työsi tallentuu Qvaimeen. Sitä ei vielä julkaista. Voit palata myöhemmin muokkaamaan sitä. Tallennetut työt näet ”my datasets”-sivulla.
  • Kun haluat julkaista kuvailun, katso ohjeet kohdasta JULKAISE KUVAILU.
  • TALLENNA (”Save”) aineistosi aina ennen julkaisua. Julkaisu julkaisee aina viimeisimmän TALLENNETUN aineiston.

Peruuta

  • Valitsemalla ”Reset dataset editor” tyhjennät koko kuvailulomakkeen, myös kaikki muut välilehdet, syöttämistäsi tiedoista tai tekemistäsi muutoksista niihin viime tallennuksen jälkeen.

Välilehdet

Metatiedon syöttäminen on jaettu välilehdille. Voit liikkua niiden välillä vapaasti.

Välilehdet ovat:

  • Content Description: tutkimusaineiston sisältö
    • Otsikko, kuvaus ja tärkeimmät ”perustiedot”
    • Keywords: Vapaat asiasanat
    • Subject heading: Asiasana-kenttä, jossa käytössä KOKO -ontologia, http://www.yso.fi/onto/koko
  • Actors: Tutkimusaineiston tekijät ja muut, jotka ovat auttaneet sen syntymisessä.
  • Rights and Licence: Täällä määrittelet, onko tutkimusaineisto avoimesti saatavilla tai, jos ei, miksi ja miten pääsyä siihen on rajataan. Määrittelet myös uudelleenkäytön ehdot valitsemalla sopivan lisenssin
    • Huom! Kenttään ”Available: Select date”  tallennetulla päivämäärällä on merkitystä vain, jos valitset Access Type -valikosta ”embargo”. Tällöin aineistosi on näkyvillä heti julkaisun jälkeen, mutta sen sisältämät tiedostot ovat ladattavissa vasta asetettuna päivämääränä (ja sen jälkeen).
    • Muista valita aineistollesi lisenssitieto!
  • Temporal and Spatial Coverage
    • Käytössä ns. WKT -muoto (https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry)
    • Esim.
      • yksittäinen piste:
        • POINT(longitude latitude)
      • alue
        • POLYGON((longitude1 latitude1, longitude1 latitude2, longitude2 latitude2, longitude2 latitude1, longitude1 latitude1))
        • HUOM! Kaksoissulkeet
        • Voit lisätä niin monta pistettä kuin haluat, mutta ole tarkkana, että yhdistät ne oikein. Viimeiseksi uudestaan aloituspiste.
  • Relations and History: Viittaukset muihin aineistoihin, julkaisuihin tai muihin resursseihin, jotka auttavat ymmärtämään ja käyttämään tätä tutkimusaineistoa. Täällä voi syöttää myös tietoja aineiston historiasta eli provenienssista.
  • Files: Määrittele tiedostot, jotka muodostavat tutkimusaineiston.

Pakolliset metatiedot

Muutamat metatiedot on pakko antaa, ennen kuin kuvailua voi julkaista. Ennen julkaisemista voit tallentaa työn kuinka keskeneräisenä hyvänsä.

Pakolliset kohdat on merkitty punaisella tähdellä.

  • Nimi (Title), tutkimusaineiston nimi eli nimeke. Jos sillä ei ole nimeä, se täytyy nimetä nyt.
  • Kuvaus (Description), aineiston vapaamuotoinen kuvaus.
  • Tekijät (Creator) eli ne henkilöt ja/tai organisaatiot, jotka ansaitsevat tulla mainituiksi aineiston pääasiallisina tekijöinä. Jos tekijä on henkilö, myös organisaation nimi (ja kieli, jolla organisaation nimi annetaan) on annettava.
  • Oikeudet (Access Type), jos jotain muuta kuin Avoin (Open), myös syy, miksi rajoitettu (Restrcition Grounds) on pakollinen.

Tunnisteita ja metatietoja lisätään automaattisesti

Tutkimusaineisto saa pysyvän tunnisteen, kun julkaiset sen.

Jos tarvitset tunnisteen pikaisesti esim. julkaisuun tai raportointiin, tee näin:

  • Luo alustava kuvailu (jossa täytyy olla yllä mainitut pakolliset metatiedot), ja julkaise se.
  • Julkaistu alustava kuvailu saa tunnisteen.
  • Täydennä kuvailua, kun se on mahdollista.

Kuvailuun lisätään automaattisesti joitakin metatietoja; mm. aineiston käsittelyhistoria Qvaimessa.

Metatietojen tarkastus

Qvain tarkastaa syöttämiäsi tietoja ilmeisten virheiden ja pakollisten tietojen puutteiden varalta.

 

Referenssidatat

Useammassa Qvaimen kentässä käytetään ns. valmiita referenssidatalähteitä, joista valitaan haluttu.

Subject heading: Asiasana, Qvain käyttää KOKO -ontologiaa, http://www.yso.fi/onto/koko


TIEDOSTOT

Et voi ladata tiedostoja Qvaimen kautta. Qvaimessa tiedostoihin vain viitataan.

Mene Files-välilehdelle. Se muuttuu sen mukaan, oletko valinnut tiedostojen sijaitsevat IDAssa vai haluatko linkittää niitä ulkoisista lähteistä (ks. tämän ohjeen kohta ”Valitse, missä tiedostosi sijaitsevat”).

Jos tiedostosi sijaitsevat IDAssa:

  • Näet välilehdellä IDA-projektit, joihin sinulla on pääsy (valikko ”Change Project”).
  • Valitse projekti, minkä jälkeen näet ko. projektiin kuuluvat tiedostot ja hakemistot. Huom! Vain jäädytetyt tiedostot/hakemistot näkyvät.
  • Hakemiston sisälle pääset siirtymään klikkaamalla hakemiston nimeä (mutta voit myös valita koko hakemiston kuvailuusi).
  • Tiedosto / hakemisto valitaan osaksi kuvailua ruksimalla sen edessä oleva valintaruutu. Ruksaamisen jälkeen tiedosto / hakemisto siirtyy automaattisesti sivun alaosan ”Selected items”
    • Voit muokata valitun tiedoston / hakemiston tietoja klikkaamalla valitun tiedoston oikealla puolella olevaa kynän kuvaa
    • Poistaaksesi valitun tiedoston / hakemiston kuvailustasi, klikkaa roskakorin kuvaa. Huom! Tiedosto / hakemisto poistuu vain tästä kuvailusta, ei IDAsta.
    • Huom! Qvain asettaa tiedostolle / hakemistolle oletuksena tiettyjä oletustietoja; pääset katsomaan / muokkaamaan näitä klikkaamalla kyvän kuvaa.

Jos haluat linkittää tiedostoja ulkoisista lähteistä:

  • Anna ulkoisen tiedoston nimi ja url ja klikkaa ”Add”.

HALLINNOI KUVAILUJA

Valitse ”my datasets” ylimmästä navigointipalkista. Näet listan tekemistäsi kuvailuista. Avaa haluamasi kuvailu klikkaamalla. Toiminnot ovat seuraavat:

  • Open: Kuvailusi aukeaa muokattavaksi.
  • Kun haluat julkaista kuvailusi, siirry ensin muokkaustilaan ja klikkaa sen jälkeen siellä näkyvää Publish -painiketta. Kuvailu siirtyy tällöin tutkimusaineistojen hakupalvelu Etsimeen (etsin.fairdata.fi), ja se tulee kaikkien näkyville. Pääsy tiedostoihin riippuu siitä, miten olet määritellyt sen Qvaimessa.
  • View -painike näkyy julkaistuille kuvailuille. Klikkaamalla sitä näet, miltä kuvailu näyttää Etsimessä.
  • Delete: Poista kuvailu Qvaimesta.

JULKAISE KUVAILU

Voit julkaista kuvailun muokkausnäkymästä klikkaamalla ”Publish” -painiketta.

TALLENNA (”Save”) aineistosi aina ennen julkaisua. Julkaisu julkaisee aina viimeisimmän TALLENNETUN aineiston.

Muokkausnäkymään pääset my datasets -näkymästä klikkaamalla haluamasi kuvailu ”Open” -painiketta.


MUOKKAA JULKAISTUA KUVAILUA

Voit muokata julkaistua kuvailua. Huomaa kuitenkin seuraavat rajoitukset:

  • Voit muokata tietoja vapaasti. Kun valitset ”Publish”, entiset tiedot korvataan uusilla.
  • TÄRKEÄÄ! Jos lisäät, poistat tai muokkaat tiedostoja, luot kuvailustasi uuden version. Uusi versio saa uuden pysyvän tunnisteen.