Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Kun olet luonut tietomalliisi luokan, voit täydentää ja muokata luokan tietoja. Tiedot on kuvattu tarkemmin alla olevassa taulukossa. Voit esimerkiksi:

  • Täydentää luokan tietokorttia
  • Lisätä luokkaan attribuutteja ja muokata niiden tietoja
  • Lisätä luokkien välille assosiaatioita ja muokata niiden tietoja

Aloita muokkaus napsauttamalla Muokkaa-painiketta. Kun olet tehnyt haluamasi muokkaukset, napsauta Tallenna-painiketta - tai jos halua perua muutokset, napsauta Peruuta-linkkiä. 

Image Added

KenttäSelitePakollinen
(Tarkennetun) Luokan nimiLuokan nimi, jota voit halutessasi muuttaa (ihmiselle ymmärrettävä luokan nimitys)X
KuvausLuokan yksityiskohtaisempi kuvaus, esimerkiksi määritelmä tai käyttötarkoitus
(Tarkennetun) Luokan tunnisteIdentifioi luokan tässä tietomallissa (prefix, koneluettavaksi tarkoitettu luokan yksilöivä nimi eli curie-tunniste, jonka pohjalta mm. URI-osoite muodostetaan)X
TilaLuokan kuvauksen tila (esim. onko vielä luonnosvaiheessa vai jo käytössä eli voimassa oleva). Luokalla on samat tilakoodit kuin tietomallillakin (12. Tietomallin tilat).
Tarkennettu luokasta

Tämä tieto näytetään, jos luokka on tarkennettu jonkin tietokomponenttikirjaston luokasta. Tässä kerrotaan, mikä on se alkuperäinen (tietokomponentti)luokka, josta tämä luokka on tarkennettu.

  • Napsauta tämän kentän alla olevaa Valitse luokka -painiketta, jos haluat muuttaa sen viittaamaan toiseen luokkaan. 

Määritelty soveltamisprofiilissa(Soveltamisprofiilissa) Kertoo, missä soveltamisprofiilissa tämä luokka on määritelty
Tietokomponenttikirjasto(Tietokomponenttikirjastossa) Kertoo, missä tietokomponenttikirjastossa tämä luokka on määritelty
Yläluokka

Yläluokan nimi (ja linkki yläluokkaan), mikäli tälle luokalle on määritelty yläluokka, joka on tätä luokkaa yleisempi merkitykseltään (eli semantiikaltaan laajempi)

  • Napsauta tämän kentän alla olevaa Valitse luokka -painiketta, jos haluat lisätä viittauksen toiseen luokkaan
  • Työkalu avaa uuden ikkunan, jonka listasta voit valita haluamasi luokan. Työkalu lisää tähän kenttään viittauksen valittuun luokkaan. 

Luokan paikallinen tunniste

Luokan paikallinen, toissijainen tunniste, jota voi tarvittaessa käyttää skeemassa. 

  • Esimerkiksi jos luokan virallinen kenttä on nimi, voi sille antaa paikallisesti erikielisen vaihtoehdon (name), jos haluaa tuottaa suomenkielisestä tietomallista erikielisen teknisen toteutuksen
  • Jos tämän kentän sisältö on tyhjä, käytetään varsinaista tunnistetta
  • Paikallisen tunnuksen käsittely on lisätty muun muassa JSON- ja XML-skeemoihin ja JSON-LD context -formaattiin.

Vastaavat luokat

Tähän voi linkittää luokat, jotka on määritelty toisaalla (toisessa nimiavaruudessa) ja joilla on vastaava semanttinen merkityssisältö kuin tällä luokalla.

  • Napsauta tämän kentän alla olevaa Valitse luokka -painiketta, jos haluat lisätä viittauksen toiseen luokkaan
  • Työkalu avaa uuden ikkunan, jonka listasta voit valita haluamasi luokan. Työkalu lisää tähän kenttään viittauksen valittuun luokkaan. 

API polkuOpen API kuvaukseen tuotettava API-polku, jonka perusteella muodostetaan esimerkki GET, POST ja PUT -metodit. Polkuun voidaan lisätä path parametreja esim. "/person/{id}" tai query parametreja esim. "/person?uuid"
Deaktivoitu
  • Kytkin: Jos tämä tieto on ruksattu, se ilmaisee, että tätä luokkaa ei tuoda skeemaan. Luokka on esimerkiksi abstrakti luokka, joka auttaa hahmottamaan tietomallin kokonaisuutta, mutta jolla ei muuten ole sisältöä.
  • Toiminto poistaa deaktivoidun luokan skeemasta eikä sitä käytetä skeemojen generoinnissa tai validoinnissa.
  • Esimerkki: tietomallissa on Henkilö- ja Organisaatio-luokat. Niiden yhteiseksi yläluokaksi voidaan tehdä Toimija-luokka, joka siis linkittää nämä luokat, mutta jolla ei ole muuta sisältöä.

Valitse käsite + mahdollinen käsiteviittaus 
  • Jos luokassa halutaan viitata johonkin Sanastot-työkalussa olevaan käsitteeseen, käsite voidaan linkittää napsauttamalla Valitse käsite -linkkiä ja sen jälkeen valitsemalla haluttu käsite. Sen jälkeen käsitteen tietoja näkyy luokan tiedoissa.  (Katso 5.3 Luo tai vaihda käsiteviittaus)
  • Käsiteviittaus voidaan kohdistaa johonkin toiseen käsitteeseen valitsemalla sen tilalle uusi käsite. 

(Tarkennetun) luokan attribuutit ja assosiaatiot

Lista luokalle määriteltyjä attribuutteja ja assosiaatioita, jos niitä on jo määritelty. 

  • Napsauta Lisää attribuutti tai assosiaatio -linkkiä, niin pääset lisäämään niitä luokkaan.
  • Jos attribuutteja tai assosiaatioita on jo määritelty, voit napsauttaa listan yksittäistä riviä, ja pääset muokkaamaan tuon ominaisuuden tietoja. (Näiden määrittely on kuvattu tarkemmin toisaalla: 7. Lisää attribuutti tai assosiaatio.)
  • Attribuutit ja assosiaatiot sijoittuvat listalle siinä järjestyksessä kuin ne on luotu, uusin alimmaksi. Voit kuitenkin muokkaustilassa muuttaa niiden keskinäistä järjestystä. Ota hiirellä kiinni attribuutti/assosiaatio-kentästä (keskellä näkyy kolme vaakaviivaa) ja siirrä se haluamaasi paikkaan (katso 2.4. Attribuuttien ja assosiaatioiden listauksen muuttaminen).
  • Voit myös vaihtaa attribuutit ja assosiaatiot listautumaan aakkosjärjestyksessä napsauttamalla aakkostuspainiketta:Image Added
    Poista aakkosjärjestys napsauttamalla painiketta uudelleen.

Ominaisuuksien vähimmäismääräIlmaisee, mikä on luokan attribuuttien tai assosiaatioiden vähimmäismäärä (ns. kardinaliteettitieto). Oletusarvo 0.
Ominaisuuksien enimmäismääräIlmaisee, mikä on luokan attribuuttien tai assosiaatioiden enimmäismäärä (ns. kardinaliteettitieto). Oletusarvo ääretön (*)
Lisätiedot 

(ei voi muuttaa) Luotu: Tietomallit-työkalun tuottama aikaleima, milloin luokka on luotu työkaluun

(ei voi muuttaa) Muokattu: Tietomallit-työkalun tuottama aikaleima, milloin luokan tietoja on viimeksi muutettu


Muokkaajan kommentti

Muokkaajan omaan käyttöönsä tekemät muistiinpanot ja huomautukset. Nämä eivät näy luokan varsinaisessa sisältökuvauksessa eivätkä siirry rajapintakuvauksiin.


Loogiset rajoitteet

Nämä tiedot on tarkoitettu esimerkiksi laskentasäännöille. (Tämä toiminnallisuus on tällä hetkellä keskeneräinen.)

  • Kuvaus kertoo ihmisluettavassa muodossa, mikä on loogisen rajoitteen tehtävä. Siinä voidaan esimerkiksi sanoa, että kaksi luokkaa on keskenään vaihtoehtoisia.
  • Loogisen rajoitteen luokat ilmaisee rajoitteen koneluettavassa muodossa (And/Or/Not), kuten että Toimija voi olla joko Henkilö- tai Organisaatio-luokka: Henkilö Or Organisaatio

Image Added


Viittaukset muista komponenteista

(ei voi muuttaa) Tietomallit-työkalun tuottama listaus luokista, tarkennetuista luokista tms., joissa on viitattu tähän luokkaan.

  • Käytännössä luokkaa ei voi poistaa, jos siihen on viittauksia toisaalta.

Tällä sivulla neuvotaan, kuinka lisäät uuden luokan, kun et löydä työkalusta sopivaa, aiemmin tehtyä luokkaa.

Tee näin:

...

  1. Kirjoita hakukenttään (Hae luokkaa) luokan nimi. Voit rajata haun pelkästään nimeen, kuvaukseen tai tunnisteeseen (tai näiden yhdistelmään).
  2. Voit rajata haun alaa, ja kohdistaa haun esim. pelkästään julkishallinnon tietokomponentteihin. 
    Näytä profiileissa määritellyt luokat -kohdassa XXXX?
  3. Jos sopivaa luokkaa ei vielä ole olemassa, voit itse luoda uuden.
    • Klikkaa kohtaa Luo uusi luokka. Kirjoita hakukenttään (a) haluamasi luokan nimi.
      Tietomallit-työkalu tekee uuden luokan, joka saa tämän antamasi nimen. Luokan nimen suositellaan olevan yksikössä oleva substantiivi, joka kirjoitetaan isolla alkukirjaimella (kuten HenkilöRakennus tai Maakunta). 
    • Tämä vaihtoehto on kuvattu tarkemmin sivulla 5.1 Ehdota uusi käsite sanastoon tai vaihda luokan käsiteviittausta)
  4. Jos sopivia luokkia on jo määritelty, sivulle tulee lista luokista, joiden tiedoissa (nimessä/kuvauksessa/tunnisteessa) löytyy antamasi hakusana (kohta e)
  5. Jos luokan nimi näkyy normaalina tekstinä voit valita sen klikkaamalla riviä.
    Mikäli luokka näkyy listassa harmaana, et ole määritellyt sen nimiavaruutta soveltamisprofiiliisi etkä voi siinä tapauksessa valita sitä.
    Kun haluat hyödyntää muiden tietomallien luokkia, linkitä tarvitsemasi tietomallit (eli teknisesti sanoen niiden nimiavaruudet)  mukaan soveltamisprofiiliisi. 
  6. Alasvetolistasta voit valita, näytetäänkö luokkien tiedot listalla suomeksi vai jollain muulla soveltamisprofiiliin määritellyllä kielellä

...

Luo uusi tarkennettu luokka viittaamalla ulkoiseen tunnisteeseen. 

Image Removed

Luokan ytimenä on käsite, joka edustaa luokan tietosisältöä ja jonka ympärille tämä luokka rakentuu. Jos luokka esimerkiksi sisältää henkilöön liittyvää tietoa, sen ytimenä on henkilö-käsite.

    1. Tarkista ensin, onko yhteentoimivuusalustaan jo aiemmin määritelty käsite, jota haluat käyttää. Kirjoita käsite hakukenttään (a). 
    2. Voit rajata, mistä sanastoista käsitettä haetaan.
    3. Jos et löydä tarpeisiisi sopivaa, voit luoda uuden käsite-ehdotuksen sanastoon klikkaamalla ehdota ’xxx’ sanastoon -riviä(xxx tässä siis ehdottamasi käsite). Siinä tapauksessa Tietomallit-editori tuo sivulle näkyviin muutaman uuden kentän:
      • Sanasto: Valitse listasta, mihin sanastoon ehdottamasi käsite pitäisi lisätä
      • Käsitteen nimi: termi, jolla käsitettä tässä soveltamisprofiilissa kutsutaan. Voit pitää nimiehdotuksen ennallaan tai muuttaa tässä kohtaa nimeä/termiä 
      • Määritelmä: Laajempi kuvaus tai selitysteksti, miitä käsitteellä tässä yhteydessä tarkoitetaan
      • Kun olet määritellyt nämä, klikkaa Luo uusi luokka -painiketta.
    4. Jos haluat käyttää uutta käsitettä, mutta et halua lisätä sitä mihinkään sanastoon, klikkaa kohtaa Luo uusi luokka ilman käsiteviitettä. Tällöin Tietomallit-editori luo uuden luokan ja luokan kuvauksessa on maininta "Käsitettä ei ole määritelty". (Voit linkittää sopivan käsitteen myöhemmin klikkaamalla luokan kuvauksessa mukana olevaa Vaihda käsitettä -painiketta, ja pääset hakusivulle, jossa voit etsiä sanastoista sopivia käsitteitä.

 

...

  1. Image RemovedAiemmin määritellyn luokan hyödyntäminen

 

 

Info
tyhjä

Lue myös

Content by Label
showLabelsfalse
max5
spacesVRKYTI
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel = "kb-how-to-article" and type = "page" and space = "VRKYTI"
labelskb-how-to-article

...

hiddentrue

...