Tietosisältö

Yleiskuvaus Metaxin tietomallista ja metatiedoista

Tämä kuvaus koskee Metaxin versioita V1 ja V2.

Metax V3 toimii rinnakkain Metax V1/V2 -versioiden kanssa
Uusien API-käyttäjien kannattaa alkaa käyttää V3 -versiota.
Miten V1/v2 ja V3 eroavat toisistaan: https://metax.fairdata.fi/v3/docs/user-guide/migration/

Ohessa suoraviivaistettu yleiskuvaus Metaxin tietomallista ja sen tietojoukoista, joita voidaan muokata Metaxin rajapintojen kautta tai joihin Metaxiin haravoitavista metatiedoista voidaan siirtää tietoja. Tarkemmin yksittäiset tietojoukot on kuvattu alla.

Tietojoukot

Data Catalog - datakatalogi

Datakatalogin alle tulevilla metatiedoilla on jokin yhteinen nimittäjä, esim. organisaatio, järjestelmä tai aineistojen luonne.

Uudelle katalogille tulee määritellä seuraavia tietoja:

Tunniste
Otsikko
Kieli (millä kielillä metatietoa on odotettavissa kyseisessä katalogissa)
Lisenssi (esim. CC0 tai CC4). Huom. yksittäisille aineistoille määritellään lisenssi erikseen.
Julkaisija (organisaatio joka vastaa aineistojen julkaisusta)

Tarvittaessa myös seuraavia tietoja voi määritellä:

Kuvaus (lyhyt tekstimuotoinen kuvaus katalogista)
Yleinen verkkosivu katalogille (käytetään esim. Etsimessä)
Logo (toistaiseksi tätä käytetään lähinnä Etsimessä kuvailusivuilla)

Datakatalogien koko tietomalli on kuvattu: https://tietomallit.suomi.fi/model/mdc/

Datakatalogien tietoja voi tarkastella .json muodossa: https://metax.fairdata.fi/rest/v2/datacatalogs

Catalog Record - katalogin tietue

Yksittäinen tietue datakatalogissa, johon generoidaan pääasiassa teknistä tietoa yksittäisistä aineistoista. Sisältää mm. seuraavia tietoja:

Nykyinen ja aikaisemmat versiot, ja näiden tunnisteet (mukana myös ko. aineisto, ao. esimerkissä aineisto "65209506-00be-498c-bded-cae2169575d4", josta on sekä edellinen, että seuraava versio)

Esimerkki:

"dataset_version_set":[
	{
		"identifier":"e2e9399c-b5ec-4e2b-8111-77bc5a8d6c20",
		"preferred_identifier":"urn:nbn:fi:att:1b1931a0-1881-47e3-a7ea-bc4928c65143",
		"removed":false,
		"date_created":"2022-01-20T10:34:00+02:00"
	},
	{
		"identifier":"65209506-00be-498c-bded-cae2169575d4",
		"preferred_identifier":"urn:nbn:fi:att:039ca9fc-7ee2-4c16-9933-ed57cc759045",
		"removed":false,
		"date_created":"2022-01-20T10:33:39+02:00"
	},
	{
		"identifier":"6f76e9c2-70ef-4198-80e4-19b5fd83103b",
		"preferred_identifier":"urn:nbn:fi:att:e974d201-1eb7-4327-835f-8d4127bf2ada",
		"removed":false,"date_created":"2021-12-31T11:10:10+02:00"
	}
]

Mahdollinen vanhentuminen (kyllä/ei)
Metatietojen alkuperä (organisaatio/käyttäjä)
Onko kyseessä kumulatiivinen aineisto

Tietueen koko tietomalli on kuvattu: https://tietomallit.suomi.fi/model/mrd/

Yleislistaus Metaxin käyttämistä koodistoarvoista: https://metax.fairdata.fi/docs/v2/reference_data.html

Käytä parametria size, kun haluat listata enemmän koodeja kuin oletussivutus näyttää, esim. https://metax.fairdata.fi/es/reference_data/field_of_science/_search?pretty&size=100

Tietueen tietoja voi tarkastella .json muodossa: https://metax.fairdata.fi/rest/v2/datasets

Dataset - aineisto

Sisältyy yhtenä tietojoukkona katalogin yksittäisiin tietueisiin. Sisältää kaiken tutkimusaineistoon sisältöön liittyvän metatiedon. Seuraavat tiedot ovat pakollisia kaikille aineistoille:

Pysyvä tunniste
Otsikko
Julkaisupäivämäärä
Kuvaus
Avainsanat
Tekijä
Julkaisija
Saatavuus

Tietueen koko tietomalli on kuvattu: https://tietomallit.suomi.fi/model/mrd/ResearchDataset/

Tiettyihin kenttiin ilmoitettavien tietojen tulee olla koodistojen mukaisia. Käytetyt koodistot on ilmoitettu alla kenttien kuvauksessa. Metaxin käyttämiä koodistoja voi tarkastella:

Kerättävät tiedot

Pysyvä tunniste (pakollinen)

Kentän nimi: preferred_identifier

Aineiston yksilöllinen, pysyvä tunniste. DOI- tai URN-tunniste.

Koodisto: Aineistojen pysyvien tunnisteiden koodisto

Otsikko (pakollinen)

Kentän nimi: title/fi, title/en

Esimerkki:

"title":{
	    "fi":"Aineiston otsikko",
        "en":"Dataset Title"
}

Aineistoa kuvaava ja yksilöivä otsikko. Otsikko kuvaa aineiston aihepiiriä ymmärrettävästi ja sen tulee olla niin yksilöllinen, että sitä ei todennäköisesti käytetä kuvaamaan muuta aineistoa.

Kuvaus (pakollinen)

Kentän nimi: description/fi, description/en

"description":{
	    "fi":"Kuvaus",
        "en":"Description"
}

Aineiston vapaamuotoinen kuvaus. Kuvauksessa voit kertoa miten aineisto on syntynyt, mihin tarkoitukseen, miten se rakentuu ja miten sitä on käsitelty. Kerro myös sisällöstä, mahdollisista puutteista ja rajauksista.

Julkaisupäivämäärä (pakollinen)

Kentän nimi: issued

Aineiston muodollinen julkaisupäivämäärä.

Avainsanat (pakollinen)

Kentän nimi: keyword

Aineistolle sopivat avainsanat. Avainsanat parantavat aineiston löydettävyyttä, kun niissä on käytetty mahdollisimman tarkkoja termejä.

Asiasanat

Kentän nimi: subject_headings

Asiasanat valitaan kontrolloiduista sanastoista, ontologioista tai luokitteluista, kuten KOKO-ontologian termeistä.

Toimijat

Tutkimukseen tai aineiston tekemiseen osallistuneet henkilöt ja organisaatiot. Voit määrittää Tekijät, Julkaisijan, Kuraattorit, Oikeuksienhaltijat sekä Muut tekijät. Tekijä ja julkaisija ovat pakollisia tietoja. Alla lisätietoa eri toimijoista.

Tekijä (pakollinen)

Kentän nimi: creator

Esimerkki:

"creator":[
	{
		"@type":"Organization",
		"identifier":"http://uri.suomi.fi/codelist/fairdata/organization/code/09206320"
	},
	{
		"name":"Teemu Tekijä",
		"@type":"Person",
		"email":"teemu.tekija@csc.fi",
		"member_of":{
			"@type":"Organization",
			"identifier":"http://uri.suomi.fi/codelist/fairdata/organization/code/09206320"
		},
		"identifier":"http://orcid.fi/orcid_number"
	}
]

Henkilö tai organisaatio, joka on tuottanut aineiston. Tekijä on aineiston alkuperäinen oikeuksienhaltija. Toimijan organisaation määrittelyssä käytetään organisaatiokoodeja. Tekijä on pakollinen toimija ja tekijöitä voi lisätä monta.

Koodisto: Organisaatiokoodisto

Julkaisija (pakollinen)

Kentän nimi: publisher

Esimerkki:

"publisher":{
	"name":"Julle Julkaisija",
	"@type":"Person",
	"email":"julle.julkaisija@csc.fi",
	"member_of":{
		"@type":"Organization",
		"identifier":"http://uri.suomi.fi/codelist/fairdata/organization/code/09206320"
	}
}

"publisher":{
	"@type":"Organization",
	"identifier":"http://uri.suomi.fi/codelist/fairdata/organization/code/09206320"
}

Taho, jolla on oikeus aineiston jakamiseen tai on julkaissut aineiston. Toimijan organisaation määrittelyssä käytetään organisaatiokoodeja. Julkaisija on pakollinen toimija, ja tekijäksi voi lisätä vain yhden (henkilön TAI organisaation).

Koodisto: Organisaatiokoodisto

Kuraattori

Kentän nimi: curator

Esimerkki: Kuten Tekijä (creator).

"curator":[
	{...},
	{...}
]

Aineiston kuraattori, joka on aineiston ensisijainen yhteyshenkilö/organisaatio. Toimijan organisaation määrittelyssä käytetään organisaatiokoodeja. Ei pakollinen. Kuraattoreita voi lisätä useampia.

Koodisto: Organisaatiokoodisto

Oikeuksienhaltija

Kentän nimi: rights_holder

Esimerkki: Kuten Tekijä (creator).

"curator":[
	{...},
	{...}
]

Henkilö tai organisaatio, jolla on aineiston tekijänoikeudet, sen lähioikeudet tai moraalinen oikeus aineistoon tällä hetkellä. Oikeuksienhaltija on useimmiten aineiston tekijä tai tekijän organisaatio. Toimijan organisaation määrittelyssä käytetään organisaatiokoodeja. Ei pakollinen. Oikeuksienhaltijoita voi lisätä useampia.

Koodisto: Organisaatiokoodisto

Muu tekijä

Kentän nimi: contributor

Esimerkki: Kuten Tekijä (creator).

"curator":[
	{...},
	{...}
]

Henkilö tai organisaatio, joka on merkittävästi vaikuttanut aineiston syntyyn. Toimijan organisaation määrittelyssä käytetään organisaatiokoodeja. Ei pakollinen. Muita tekijöitä voi lisätä useampia.

Koodisto: Organisaatiokoodisto

Tieteenala

Kentän nimi: field_of_science

Aineiston tieteenala.

Koodisto: Tieteenalaluokitus

Pääsyoikeus

Kentän nimi: access_rights/access_type

Esimerkki:

"access_rights":{
	"access_type":{
		"in_scheme":"http://uri.suomi.fi/codelist/fairdata/access_type",
		"identifier":"http://uri.suomi.fi/codelist/fairdata/access_type/code/restricted"
	},
	"restriction_grounds":[
		{
			"in_scheme":"http://uri.suomi.fi/codelist/fairdata/restriction_grounds",
			"identifier":"http://uri.suomi.fi/codelist/fairdata/restriction_grounds/code/national_interest"
		}
	]
}

Tällä tiedolla määritellään, miten julkaistun aineiston tiedostot saa käyttöönsä. Tämä kenttä ei vaikuta aineiston kuvailutietojen (metadata) näkyvyyteen. Kuvailu näkyy aina automaattisesti Etsimessä julkaisun jälkeen.

Jos aineiston saatavuus on jonkin muu kuin "Avoin" ("Open"), on valittava myös peruste tiedostojen lataamisen rajoittamiselle. Jos aineiston oikeuksiksi määritellään "Embargo", tulee määrittää myös embargon päättymisajankohta.

Koodisto: Saatavuusluokkien koodisto ja Rajoiteperusteluokat

Lisenssi

Kentän nimi: access_rights/license

Esimerkki: ks. "Pääsyoikeus"

"license": [
	{
		"title": {
			"en": "CreativeCommonsAttribution4.0International(CCBY4.0)",
			"fi": "CreativeCommonsNimeä4.0Kansainvälinen(CCBY4.0)",
			"und": "CreativeCommonsNimeä4.0Kansainvälinen(CCBY4.0)"
		},
		"license": "https: //creativecommons.org/licenses/by/4.0/",
		"identifier": "http: //uri.suomi.fi/codelist/fairdata/license/code/CC-BY-4.0"
	},
	{
		"license": "https: //research.csc.fi/en/home"
	}
]

Lisenssi määrittelee miten aineistoa voi käyttää. Lisenssi voi olla koodiston mukainen lisenssi (title, url, identifier) tai vaihtoehtoisesti lisekssitiedoksi voidaan antaa pelkkä url verkkosivustolle, jossa lisenssi on määritelty.

Koodisto: Lisenssit-koodisto

Aineiston viimeinen muokkauspäivämäärä

Kentän nimi: modified

Viimeisin kerta, jolloin aineistoa tai sen kuvailutietoja on merkittävästi muokattu.

Projekti

Kentän nimi: is_output_of

Esimerkki:

"is_output_of":[
	{
    	"name":{
			"en":"Project ABC",
			"fi":"Projekti ABC"
		},
    	"identifier":"Project identifier here",
	 	"source_organization":[
			{
				"@type":"Organization",
				"identifier":"http://uri.suomi.fi/codelist/fairdata/organization/code/09206320"
			}
		],
    	"funder_type":{
        	"in_scheme":"http://uri.suomi.fi/codelist/fairdata/funder_type",
        	"identifier":"http://uri.suomi.fi/codelist/fairdata/funder_type/code/academy-of-finland"
    	},
    	"has_funding_agency":[
			{
        		"@type":"Organization",
       			"identifier":"http://uri.suomi.fi/codelist/fairdata/organization/code/09206320"
    		}
		],
   		"has_funder_identifier":"Funding identifier here"
	}
]

Projekti, jonka tuotoksena aineisto on luotu. Toimija-organisaatioita on kahdentyyppisiä: organisaatio, joka osallistui projektiin, sekä rahoittajaorganisaatio.

Toimija-organisaatioiden määrittelyssä käytetään organisaatiokoodeja.

Projekti ei ole pakollinen. Projekteja voi lisätä useampia.

Koodisto: Organisaatiokoodisto, rahoittajien koodisto

Aineiston kieli

Kentän nimi: language

Kieli, jota aineisto sisältää.

Koodisto: ISO639-3 koodisto

Maantieteellinen kattavuus

Kentän nimi: spatial

Esimerkki:

"spatial":[
	{
		"as_wkt":[
			"POINT(25.01213 60.17074)"
		],
		"place_uri":{
			"in_scheme":"http://www.yso.fi/onto/yso/places",
			"identifier":"http://www.yso.fi/onto/yso/p167902"
		},
		"full_address":"Kruunuvuorenranta",
		"geographic_name":"Helsinki"
	},
	{
		"alt":"100",
		"as_wkt":[
			"POINT(24.6361 60.15379)"
		],
		"place_uri":{
			"in_scheme":"http://www.yso.fi/onto/yso/places",
			"identifier":"http://www.yso.fi/onto/yso/p109504"
		},
		"full_address":"Kivenlahdentie",
		"geographic_name":"Espoo"
	}
]

Alue, jonka aineisto kattaa (esimerkiksi paikat, joissa on tehty havaintoja).

Koodisto: YSO-paikat

Ajallinen kattavuus

Kentän nimi: temporal/start_date, temporal/end_date

Esimerkki:

"temporal":[
	{
		"end_date":"2021-12-07T00:00:00.000Z",'
		"start_date":"2021-01-01T00:00:00.000Z"
	},
	{
		"start_date":"2021-12-08T00:00:00.000Z"
	}
]

Ajanjakso(-t), jonka aineisto kattaa (esimerkiksi aika jolloin on tehty havaintoja). Muodossa datetime (yyyy-MM-dd'T'HH.mm.ss.SSSXXX). Jompikumpi on annettava: start_date tai end_date.

Viittaukset toiseen tuotokseen

Kentän nimi: relation

Esimerkki:

"relation":[
		{
			"entity":{
				"type":{
					"in_scheme":"http://uri.suomi.fi/codelist/fairdata/resource_type",
					"identifier":"http://uri.suomi.fi/codelist/fairdata/resource_type/code/collection",
					"pref_label":{
						"en":"Collection",
						"fi":"Kokoelma",
						"und":"Kokoelma"
					}
				},
				"title":{
					"en":"testi",
					"und":"testi"
				},
				"identifier":"http://urn.fi/urn:nbn:fi:att:03cc54b6-b1f9-41a6-b6db-ddb417375017",
				"description":{
					"en":"testi",
					"und":"testi"
				}
			},
			"relation_type":{
				"identifier":"http://purl.org/dc/terms/hasPart",
				"pref_label":{
					"en":"Has part",
					"fi":"Osa aineistoa",
					"und":"Osa aineistoa"
				}
			}
		}
	]

Viittaukset muihin aineistoihin, julkaisuihin tai muihin resursseihin, jotka auttavat ymmärtämään ja käyttämään tätä tutkimusaineistoa.

Viitatun aineiston tyyppejä: Metax Resource Types

Viittauksien tyyppejä: Metax Relation Types

Historiatiedot (provenienssi)

Kentän nimi: provenance

Tapahtuma tai toiminta, jonka kohteena aineisto oli. Tiedot aineiston historiatiedoista eli provenienssista. Tällaisia ovat muun muassa aineiston keruuseen, analysointiin tai esittelyyn liittyvät tilaisuudet.

Infrastruktuuri

Kentän nimi: infrastructure

Palvelut tai työkalut, joita aineiston tuottamisessa on hyödynnetty.

Tiedoston lähde - IDA

Tiedostot, jotka ovat IDA-palvelussa. Alla kuvattu tarvittavat kentät.

Tiedostot

Kentän nimi: files

Yhdistää aineiston yhteen tai useampaan tiedostoon IDA:ssa.

Tiedoston lähde - Ulkoinen lähde

Ulkopuolisen palvelun URL-osoitteet, joista tiedostot löytyvät. Alla kuvattu tarvittavat kentät.

Ulkoinen lähde

Kentän nimi: remote_resources

Aineiston konkreettinen säilytyspaikka tai datan formaatti aineistossa. Esimerkiksi tietokanta tai query interface dataan.

Käyttökategoria

Kentän nimi: use_category

Esimerkki:

"remote_resources":[
	{
            "title":"Data in remote location",
            "access_url":{
                "identifier":"https://datasomewhere.fi"
            },
            "download_url":{
                "identifier":"https://downloadsomewhere.fi"
            },
            "use_category":{
                "in_scheme":"http://uri.suomi.fi/codelist/fairdata/use_category",
                "identifier":"http://uri.suomi.fi/codelist/fairdata/use_category/code/outcome"
            }
	}
]

Aineistoon liitetyn aineiston "tyyppi". Määrittelyssä käytetään käyttökategorian koodistoa.

Koodisto: Käyttökategorian koodisto

Metax tietojoukot

Metax overview

Page tree

Tietosisältö

Yleiskuvaus Metaxin tietomallista ja metatiedoista

Tietojoukot

Data Catalog - datakatalogi

Catalog Record - katalogin tietue

Dataset - aineisto

Kerättävät tiedot

Pysyvä tunniste (pakollinen)

Otsikko (pakollinen)

Kuvaus (pakollinen)

Julkaisupäivämäärä (pakollinen)

Avainsanat (pakollinen)

Asiasanat

Toimijat

Tekijä (pakollinen)

Julkaisija (pakollinen)

Kuraattori

Oikeuksienhaltija

Muu tekijä

Tieteenala

Pääsyoikeus

Lisenssi

Aineiston viimeinen muokkauspäivämäärä

Projekti

Aineiston kieli

Maantieteellinen kattavuus

Ajallinen kattavuus

Viittaukset toiseen tuotokseen

Historiatiedot (provenienssi)

Infrastruktuuri

Tiedoston lähde - IDA

Tiedostot

Tiedoston lähde - Ulkoinen lähde

Ulkoinen lähde

Käyttökategoria

Metax tietojoukot