Soveltamisprofiilin tarkoituksena on kuvata yksittäisen tietojärjestelmän (tai sen osan) tietosisältö ja tietoon liittyviä vaatimuksia ja rajoituksia. Tarkoituksena on vähentää tietojärjestelmän kehitys ja ylläpitokustannuksia hyvällä suunnittelulla ja dokumentoinnilla. Tietosisällön dokumentointi tukee tietojärjestelmän ymmärrettävyyttä, tiedon uudelleenkäyttöä, soveltamista ja vähentää uudelleenmäärittelyn tarvetta.
Tietorakenteet kuvataan soveltamisprofiilissa siten, että niiden perusteella voidaan muodostaa fyysinen tietomalli eri tekniikoilla tai syntaksilla. Tietomallit.suomi.fi sovelluksella toteutetun soveltamisprofiilin tietorakenteet ovat määritelty rakenteisesti linkitettynä datana ja siitä voidaan suoraan johtaa XML tai JSON skeema.
Soveltamisprofiili voi kuvata tietosisältöjä eri tarkkuustasoilla
Soveltamisprofiilin tietosisältö kuvataan aina tietojärjestelmän kannalta olennaisella tarkkuudella, joka määrittyy käyttötarpeen mukaan. Sisällöllisesti soveltamisprofiili on sopimus siitä miten yhteisesti sovittua kieltä ja rakenteita käytetään tietyssä käyttötarkoituksessa. Käyttötarkoitus voidaan jakaa karkealla tasolla kolmeen eri ryhmään:
- Tiedonsiirtorajapinnan tietosisältö - Miten tietoa siirretään?
- Sovellusrajapinnan tai tietojärjestelmän tietosisältö - Miten tietoa käsitellään?
- Tietovaraston tietosisältö - Miten tietoa säilytetään?
- Yleinen tietosisällön kuvaus - Mitä tietoja tarvitaan?
Tarkemmin eri käyttötarkoituksia tukevia mallinnustapoja ja hyviä käytäntöjä on listattu tämän ohjeen lopussa.
Yleisiä mallinnusperiaatteita
- Määrittele vain sellaisia tietosisältöjä joille on selkeä käyttötarkoitus
- Kun määrittelet uuden tietosisällön, käytä tietoalueen sanastoa
- Ehdota uusia käsitteitä, jos tietosisältöä kuvaavaa käsitettä ei ole määritelty sanastossa
- Uudelleenkäytä luokkia, attribuutteja ja assosiaatioita julkisen hallinnon tietokomponenttikirjastosta
- Ennen uuden tietosisällön määrittelyä, tutki onko vastaava tietosisältö määritelty aiheeseen liittyvillä tietoalueilla
- Jos luokkaan joudutaan tekemään usein tietoaluekohtaisia lisäyksiä, määrittele luokasta alaluokka tietoalueelle
Nimeämiskäytännöt
Tietosisältöjen nimeäminen tehdään selkokielisesti hyödyntäen tietoalueen vakiintunutta sanastoa. Luokat, attribuutit ja assosiaatiot nimetään kieliversioituna ihmisluettavasti sekä teknisellä nimellä.
Sisältö lokalisoidaan käyttötarpeen mukaan eri kielillä, yleensä suomi, englanti ja ruotsi. Ihmisluettavissa nimissä ei saa olla kyseiseen kieleen kuulumattomia erikoismerkkejä.
Tekninen nimi määritellään aina alphanumeerisesti ja ainoat sallitut merkit ovat pienet ja isot kirjaimet, numerot, sekä alaviiva ja väliviiva. Teknisen nimen lisäksi resurssille voidaan määritellä paikallinen tunnus, jonka avulla tietomäärityksestä voidaan tuottaa XML tai JSON skeema erilaisten teknisten nimeämiskäytäntöjen mukaisesti.
Tietomallin nimeäminen
Tietomallille määritellään ihmisluettava nimi ja etuliite. Etuliite on yksilöllinen lyhyt tunniste josta muodostetaan tietomallin nimiavaruus. Tietomallin nimiavaruus on URI-tunnus, jonka avulla tietomallissa määriteltäviin resursseihin voidaan viitata.
Etuliitteen valinta
Etuliitteen määrittely voi tuntua vaikealta uutta tietomallia tehtäessä. Etuliite muodostetaan yleensä tietoalueella tai projektissa yleisesti käytössä olevasta akronyymistä. Etuliitteen määrittelyssä kuitenkin olennaisinta on se, että se on yksilöivä merkkijono. Esimerkiksi "abc" on yhtä hyvä etuliite kuin "henkilo" tai "personinfo". Lyhyt etuliite kuitenkin helpottaa tunnisteen kirjoittamista lyhennetyssä muodossa, esim: abc:Person. Etuliitettä voi jatkossa vaihtaa tietomallin versioinnin yhteydessä. Etuliitettä vaihtaessa uusi sekä vanha malli voivat jatkaa omaa elämäänsä.
Luokan nimeäminen
Luokka nimetään yleensä yksikkömuodossa.
Luokan tekninen nimi määritellään ns. CamelCase kirjoitusasulla:
- Tekninen nimi alkaa aina isolla alkukirjaimella, esim. Person
- Useamman sanan yhdistelmä esim. SalesContract
- Luokan teknisestä nimestä muodostetaan yksilöivä URI-tunniste, esimerkiksi: http://uri.suomi.fi/datamodel/ns/myexample#Person
Attribuutin nimeäminen
Attribuutit nimetään yleensä yksikkömuodossa. Poikkeustapauksissa attribuutti voidaan nimetä monikossa, jos attribuuttiin tallennetaan useampi tieto, esim. Etunimet.
Nimessä ei kannata toistaa luokan nimeä, esim. "Nimi" ennemmin kuin "Henkilön nimi". Säännöstä saa poiketa jos ei ole selvää mikä "Nimi" on kyseessä esim. jos luokka on denormalisoitu kokoelma Henkilön ja Organisaation tietoja.
Attribuutin tekninen nimi määritellään ns. CamelCase kirjoitusasulla:
- Alkaa pienellä alkukirjaimella, esim: numberOfPages
Assosiaation nimeäminen
Assosiaatiot nimetään yleensä verbimuodossa tai roolin nimellä, esim. purchaced tai customer
Assosiaation tekinen nimi määritellaan CamelCase kirjoitusasulla:
- Alkaa pienellä alkukirjaimella, esim: relatedProduct