Qvaimen käyttöopas

Tutkimusaineistojen julkaiseminen Qvain-työkalulla: Video Qvaimen käytöstä

SISÄLLYS

• Käytön aloitus
• Etusivu
• Aineiston kuvailu
• Aineiston tallentaminen luonnoksena
• Aineiston julkaiseminen
• Aineiston tietojen muokkaaminen
• Aineiston versiointisäännöt
• Aineistoversion luominen
• Aineiston muokkausoikeuksien jakaminen
• Aineiston poistaminen

---

KÄYTÖN ALOITUS

Tutkimusaineiston metatietotyökalu Qvain löytyy osoitteesta qvain.fairdata.fi. Palveluun pääsee myös osoitteesta etsin.fairdata.fi yläreunan ”Lisää/muokkaa aineistoja”-painikkeen kautta.

Ennen kuin aloitat Qvaimen käytön, luo itsellesi CSC-tunnus (ohjeet löydät täältä).

Voit tämän jälkeen kirjautua sisään palveluun osoitteessa qvain.fairdata.fi käyttämällä Haka-, Virtu- tai henkilökohtaista CSC-tunnustasi.

IDAssa, Qvaimessa ja Etsimessä on käytössä yhteinen kertakirjautuminen (single sign-on, SSO). Tämä tarkoittaa, että kirjaudut kerralla kaikkiin näihin Fairdata-palveluihin, kun kirjaudut kerran sisään IDAn, Qvaimen tai Etsimen kautta. Samoin uloskirjautuminen kirjaa sinut ulos kaikista edellä mainituista palveluista.

Kirjautuaksesi sisään Qvaimeen, klikkaa ”Kirjaudu”-painiketta sisäänkirjautumissivun oikeassa yläkulmassa, valitse CSC Login tai Haka Login ja seuraa annettuja ohjeita.

Huomaa, että henkilökohtaista CSC-asiakastiliä hallinnoidaan MyCSC:n kautta (tilin luominen, CSC-tunnuksen salasanan vaihtaminen).

---

ETUSIVU

Qvaimen etusivulla listataan kaikki palveluun lisäämäsi aineistot. Etusivulta voit joko lisätä uuden aineiston tai voit muokata olemassaolevaa aineistoa.

Uuden aineiston luominen

Voit lisätä uuden aineiston painamalla etusivun ”Lisää uusi aineisto”-painiketta tai klikkaamalla sivun yläreunasta ”Luo aineisto”.

 

 

Aineistolistaus

Aineistolistauksessa näet kunkin aineiston nimen oikealla puolella seuraavat tiedot: aineistolle asetettu otsikko, aineiston tila ja aineiston luomisajankohta. Näiden tietojen oikealta puolelta löydät kullekin aineistolle tarjolla olevat toiminnot.

 

Voit suodattaa aineistolistausta aineiston nimen mukaan käyttämällä aineistolistauksen yläpuolella olevaa hakukenttää.

Aineiston tila on joko ”Julkaistu” tai ”Luonnos”. Aineisto, jonka tila on ”Julkaistu” näkyy julkisesti kaikille Etsimessä. Aineisto, jonka tila on ”Luonnos”, näkyy vain aineiston luoneelle henkilölle, kun hän on kirjautunut Etsimeen.

Jos aineistosta on luotu useampi kuin yksi versio, näkyvät vanhat versiot aineistolistauksessa aineiston uusimman version alla. Näet ne klikkaamalla aineiston nimen alta > -ikonia. Kaikkia ainestoversioita voi muokata.

 

Kun aineistoa menee katselemaan Etsimen haun kautta, Etsin näyttää oletuksena aineiston uusimman version, josta voi siirtyä katselemaan vanhempia aineistoversioita.

Etusivun aineistolistauksen ”Toiminnot”-kohdassa voit

• Muokata julkaistua tai luonnostilassa olevaa aineistoa painamalla ”Muokkaa”-painiketta.
• Katsella, miltä aineisto näyttää tutkimusaineistojen hakupalvelu Etsimessä painamalla ”Katso Etsimessä”-painiketta.
• Luoda uuden aineiston käyttäen mallipohjana olemassa olevaa aineistoasi painamalla ”Käytä mallina”-painiketta ”Lisää”-pudotusvalikon alta. Qvain kopioi tällöin kaikki kuvailutiedot valitsemastasi aineistosta uuden aineiston kenttiin valmiiksi. Huom: Aineistoon liitetyt tiedostot eivät siirry mallipohjan avulla luotuun uuteen aineistoon, eikä aineistojen välille synny automaattisesti linkitystä.

• Luoda uuden version aineistosta painamalla ”Luo uusi versio”-painiketta ”Lisää”-pudotusvalikosta. Huom: Kun luot aineistosta uuden version, aineiston vanhat versiot jäävät näkyviin julkisesti ellet erikseen poista niitä. Versiot ovat aina automaattisesti linkitetty toisiinta hakupalvelu Etsimessä.
• Poistaa aineiston kokonaan painamalla ”Poista”-painiketta. Jos poistat luonnostilassa olevan aineiston, aineisto poistuu pysyvästi. Jos taas poistat jo julkaistun aineiston, se poistetaan Etsimen hakutuloksista eikä sitä enää voi nähdä Qvaimessa. Poistetulle aineistolle jää kuitenkin julkinen kuvailusivu Etsimeen (muistosivu). Tälle sivulle löytää aineiston pysyvän tunnisteen kautta.

---

AINEISTON KUVAILU

Täytä Qvaimen kuvailulomale.

Tarkemmat kenttätiedot löydät erilliseltä sivulta Qvaimen kentät.

---

AINEISTON TALLENTAMINEN LUONNOKSENA

Voit tallentaa syöttölomakkeelle täyttämäsi tiedot luonnoksena klikkaamalla näkymän alareunasta ”Tallenna”. Kun tallennat aineiston luonnoksena, voit esikatsella Fairdata-palveluihin kirjautuneena käyttäjänä Etsimessä, eikä se näy muille.

• • 
    

---

AINEISTON JULKAISEMINEN

Klikkaa kuvailunäkymän yläreunasta ”Julkaise aineisto”, kun haluat julkaista aineistosi. Julkaisun jälkeen aineistosi näkyy Etsimessä (etsin.fairdata.fi) ja voit halutessasi muokata sen kuvailutietoja Qvaimessa. Huomaa, että vain kasvavan aineiston tiedostoja voi lisätä julkaisemisen jälkeen. Muuten aineiston tiedostoja ei voi muokata muuten kuin luomalla aineistosta uuden version.

---

AINEISTON TIETOJEN MUOKKAAMINEN

Voit muokata julkaistun tai luonnoksena tallennetun aineiston tietoja koska tahansa (katso versiointisäännöt alempaa).

Pääset muokkaamaan aineistoa klikkaamalla ”Muokkaa”-painiketta Qvaimen etusivun aineistolistauksessa haluamasi aineiston kohdalla.

Voit julkaista tehdyt muutokset tai tallentaa ne luonnoksena. Luonnoksena tallennetut muutokset aineiston tietoihin näkyvät Etsimessä vain sinulle kirjautuneena käyttäjänä, kun taas julkaistut muutokset näkyvät Etsimessä julkisesti.

---

AINEISTON VERSIOINTISÄÄNNÖT

Kuvailutietojen muokkaaminen on mahdollista koska tahansa. Myös ns. ulkoisen tiedostolähteen linkkejä voi muokata vapaasti. IDA-palvelun kautta liitettyjen tiedoston muokkaaminen sen sijaan liittyy seuraavanlaisia sääntöjä:

• Julkaistun aineiston tiedostoja ei voi poistaa tai muokata. Jos haluat poistaa tai muokata tiedostoja, sinun tulee ensin luoda aineistosta uusi versio (ohjeet alempana).
• Julkaistuun aineistoon ei voi myöskään lisätä tiedostoja, ellei aineistoa ole määritetty Kasvavaksi aineistoksi. Kasvavaan aineistoon voi lisätä vapaasti uusia tiedostoja. Ei-kasvavaan aineistoon voi lisätä tiedostoja ainoastaan luomalla aineistosta uuden version.
  • Aineiston voi muuttaa kasvavaksi vain luomalla siitä ensin uuden version.
• Jos aineiston lähteeksi on valittu IDA, mutta se on julkaistu ilman tiedostoja, siihen voi lisätä tiedostoja KERRAN ilman, että pitää luoda uusi versio ensin. Kun aineisto on kertaalleen julkaistu tiedostojen kanssa, siihen pätee normaalit versiointisäännöt, eli tiedostoja voi muokata vain luomalla uuden version.

Jos siis haluat muokata tiedostoja:

1. Varmista, että oikeat tiedostot ovat jäädytettyinä IDA-palvelussa
   • Jos sinun pitää korjata jo aineistoon liitettyä tiedostoa, tuo haluamasi korjatut/uudet tiedostot IDAan ja jäädytä ne.
   • Huomaa, että jos poistat jo julkaistuun aineistokuvailuun liitetyn tiedoston IDAn jäädyteltä alueelta, ko. aineistokuvailun versio merkitään deprekoituneeksi. Deprekoituneen aineistokuvailuversion datoihin ei enää pääse Etsimen kautta. Voit myös jättää vanhan tiedoston IDAan, ja tuoda korjatun tiedoston eri nimellä (esim. ”versio2”) IDAan. Lisätietoa aineistojen deprekoitumisesta.
2. Luo aineistokuvailusta Qvaimessa uusi versio
   • Vanha aineistokuvailun version jää sellaisenaan edelleen näkyviin sekä Qvaimeen että Etsimeen. Uuden ja vanhan aineistokuvailuversion välille syntyy automaattisesti linkitys, ja Etsin näyttää eri versiot ”versiopuuna”.
3. Tuo haluamasi uudet/korjatut tiedostot tai poista väärät tiedostot uuteen versioon
4. Julkaise uusi aineistoversio
   • Huomaa, että vasta julkaisemisen jälkeen aineistoversio oikeasti syntyy, ja tulee näkyviin Etsimeen
5. Nyt voit joko pitää vanhan version tai voit poistaa sen
   • Huomioi, että poistettuun versioon pääsee Etsimessä edelleen suoralla PID-viittauksella, mutta Qvaimessa ko. versio ei poiston jälkeen enää näy. Jos haluat esimerkiksi kertoa, miksi aineistoversio on poistettu, lisää ko. tieto version kuvailutietoihin ennenkuin poistat sen.

 

---

AINEISTOVERSION LUOMINEN

Voit luoda uuden version jo julkaistusta aineistosta. Uusi versio tarvitaan, jos haluat tehdä muutoksia aineiston tiedostoihin. Uuden version luominen varmistaa alkuperäisen aineiston eheyden säilymisen. Luo uusi versio valitsemalla Qvaimen aineistolistan ”Lisää” -valikosta ”Luo uusi versio”.

Uusi versio ei korvaa automaattisesti vanhaa versiota, vaan molemmat versiot ovat olemassa rinnakkain. Uusi versio on näkyvästi linkitetty vanhaan versioon Etsimessä, ja se saa oman pysyvän tunnisteen (PID). Vanha versio säilyy edelleen saatavilla alkuperäisellä pysyvällä tunnisteellaan.

Huomaa, että vain uusin versio aineistosta on haettavissa Etsimen haulla. Vanhemmat versiot eivät näy hakutuloksissa, mutta ovat edelleen saavutettavissa pysyvän tunnisteensa kautta tai uusimman version versiohistoriasta.

Ajan saatossa aineistosta saattaa syntyä useita aineistoversioita, ja voi olla tarpeen rajoittaa niiden näkyvyyttä Etsimessä. Voit poistaa vanhoja versioita Qvaimen aineistolistan ”Lisää” -valikosta ”Poista”. Tällöin versio poistuu Etsimen versiohierarkiasta, etkä enää pääse kuvailutietoihin Qvaimenkaan kautta. Versioon pääsee kuitenkin edelleen suoralla PID-viittauksella.

---

MUOKKAUSOIKEUKSIEN JAKAMINEN

Kun aineisto luodaan, siihen annetaan muokkausoikeudet aineiston luojan lisäksi kaikille IDA-palvelua käyttävän CSC-projektin jäsenille, jos kyseessä on Fairdata IDA -aineisto.

Aineistoon, jonka data ei ole IDAssa, vaan on käytetty ns. ulkoisia tiedostolinkkejä, annetaan oletuksena muokkausoikeudet vain aineiston alkuperäiselle luojalle.

Aineistolistassa näytetään aineistot:

• jotka olet itse luonut (Omistaja: ”Minä”)
• joihin sinulle on annettu muokkausoikeudet joko IDA-palvelua käyttävän CSC-projektin jäsenyyden kautta tai yksittäisenä käyttäjänä (Omistaja: )

Muokkausoikeudet ovat samalaiset riippumatta siitä oletko aineiston luoja, vai oletko saanut siihen muokkausoikeudet. Voit vapaasti muokata kuvailutietoja, julkaista aineiston/muutokset, luoda uuden version ja editoida muokkausoikeuksia. Voit myös poistaa aineiston. Jos kyseessä on IDA-aineisto, ja olet ko. IDA-palveua käyttävän CSC-projektin jäsen, voit myös muokata tiedostojen kuvailutietoja ja (versiosääntöjen puitteissa) myös lisätä/poistaa tiedostoja. Jos et ole projektin jäsen, voit ainoastaan nähdä tiedostot, muttet voi tehdä muutoksia.

Jos luot aineistosta uuden version, myös muokkausoikeudet periytyvät uuteen versioon.

Aineiston käyttö toisen aineiston mallina ei kopioi muokkausoikeuksia uuteen aineistoon.

Muokkausoikeuksien lisääminen ja poistaminen

Sen lisäksi, että IDA-palveua käyttävän CSC-projektin jäsenet saavat automaattisesti muokkausoikeudet, voit lisätä muokkausoikeuksia myös yksittäisille käyttäjille. Klikkaa ”Muokkaajat” -painiketta aineistolistasta, jolloin aukeaa popup -ikkuna muokkausoikeuksien lisäämiseksi (Kutsu -välilehti) ja listaamiseksi/poistamiseksi (Jäsenet -välilehti).

 

• Lisää käyttäjä (Kutsu -välilehti) kirjoittamalla käyttäjän nimi ”Käyttäjät” -kenttään. Qvain täydentää käyttäjänimeä sitä mukaa, kun löytää kirjoittamaasi nimeä vastaavia käyttäjiä. Valitsema käyttäjä ja klikkaa ”Kutsu”.

• Voit poistaa käyttäjän (Jäsenet -välilehti) klikkaamalla Muokkaaja -alasvetovalikosta ”Poista”
  • Aineiston alkuperäistä luojaa ei voi poistaa. Et voi myöskään poistaa IDA-aineistolta CSC-projektin jäsenyyteen perustuvia muokkausoikeuksia.

---

AINEISTON POISTAMINEN

---