Wiki source code of 2. Kotka-kokoelmienhallintajärjestelmä
Last modified by Anniina Kuusijärvi on 2024/10/21 15:06
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | == Kotkasta == | ||
2 | |||
3 | **Kotka** on [[Suomen Lajitietokeskuksessa>>url:http://laji.fi/||shape="rect"]] rakennettava **näytekokoelmien hallintajärjestelmä** kaikkien eliöryhmille näytteille, kudosnäytteille, fossiileille sekä kasvitieteellisten puutarhojen kokoelmille. Kotkaa on kehitetty "in-house" Luonnontieteellisessä keskusmuseossa Luomuksessa vuodesta 2011 alkaen, ja sen kehitys jatkuu edelleen osana [[Suomen Lajitietokeskuksen>>url:http://laji.fi||shape="rect"]] tietojärjestelmäkehitystä. Kotkan kehitys ja ylläpito on osa Luomusken kansallisia velvoitteita ja sen käyttö on maksutonta suomalaisille luonnontieteellisille kokoelmille. | ||
4 | |||
5 | === Tavoitteet === | ||
6 | |||
7 | Kotkan tavoitteena on: | ||
8 | |||
9 | * Tehdä kokoelmanhallinnasta tehokkaampaa ja virtaviivaisempaa | ||
10 | * Saada kokoelmat ja näyteaineistot saavutettavammiksi ja siten kasvattaa niiden tieteellistä ja muuta käyttöä | ||
11 | * Parantaa kokoelmien ja näytedatan laatua | ||
12 | |||
13 | === Työkaluja === | ||
14 | |||
15 | Kotkassa on selainkäyttöisiä **työkaluja**: | ||
16 | |||
17 | * Datan syöttöön, muokkaukseen ja katseluun koskien | ||
18 | ** kokoelmia - metatietoa luonnontieteellisistä kokoelmista | ||
19 | ** näytteitä - monipuolista dataa museonäytteistä | ||
20 | ** datasettejä - eräänlainen "tagi" jolla voi niputtaa näytteitä yhteen | ||
21 | ** preparaatteja - dataa DNA- ja kudosnäytteistä sekä selkärankaispreparaateista | ||
22 | ** puutarhojen eläviä kokoelmia - puutarhojen kasvikannat ja sijoitukset, hoitotoimet | ||
23 | ** organisaatioita - esim. yhteystietoja lainanhallintaan | ||
24 | ** materiaalitransaktioita - lainat, vaihdot ja lahjoitukset museoiden välillä ja puutarhojen siemenvaihto | ||
25 | ** ABS-tietoja - Nagoyan protokollan ja muiden tietojen saavutettavuutta ja jakoa koskevien säännösten noudattaminen | ||
26 | * Näytetietojen tallennukseen Excel-taulukosta | ||
27 | * Datan validointiin | ||
28 | * näytteiden hakuun, tilastojen ja raporttien luontiin | ||
29 | * puutarhasijoitusten ja preparaattien hakuun | ||
30 | * datan eksportoimiseen Excel-tiedostoon | ||
31 | * Etikettien suunnitteluun ja luomiseen: LabelDesigner | ||
32 | * lainanhallintaan | ||
33 | * datan jakamiseen Suomen Lajitietokeskuksen tietovarastoon, laji.fi | ||
34 | |||
35 | === Periaatteita === | ||
36 | |||
37 | * Kotkassa on primaaridata. Kotkaan tallennettua dataa ei päivitetä muualla. | ||
38 | * Kaikki Kotkan käyttäjät näkevät kaiken datan Kotkassa mutta voivat editoida vain oman organisaationsa dataa. | ||
39 | * Kaikki Kotkaan tallennettu data säilytetään pysyvästi, ja vanhoihin versioihin datasta voidaan palata. | ||
40 | * Kotkan datarakenne on joustava ja painottaa nopeaa kehitystä ja hyödyllisyyttä erilaisissa tilanteissa. | ||
41 | ** Dataformaatti perustuu hyvin löyhästi ABCD -standardiin, mutta käyttää monia omia tietokenttiä. Kentät on mapattavissa DarwinCore -standardiin melko helposti. | ||
42 | ** Datamallia laajennetaan tarpeen vaatiessa. Vain harva kenttä on pakollinen. | ||
43 | ** Datamalli on hierarkinen, ja sallii, että yksi dokumentti sisältää useita havaintoja, määrityksiä, preparaatteja ja tyyppinäytetietoja (esim. herbaarionäyte jossa on useita eri kasveja, joilla kaikille on useita määrityksiä) | ||
44 | ** Suurin osa datasta on denormalisoitua (esi. mikä tahansa lajinimi tai kerääjänimi voidaan tallentaa) | ||
45 | ** voidaan tallentaa sekä näytteitä että muunalisia havaintoja | ||
46 | * Taksonomian hallinta, käyttäjähallinta ja jotkin validoinnit on ulkoistettu muihin Lajitietokeskuksen järjestelmiin ja palveluihihin | ||
47 | * Suomen Lajitietokeskuksen aineistopolitiikan mukaisesti Kotkaan tallennettu data on avointa dataa, muutamia poikkeuksia lukuun ottamatta (esim. sensitiiviset lajit) | ||
48 | * Kaikki resurssit saavat uniikit HHTP URI -tunnisteet | ||
49 | * Kaikkien Suomen luonnontieteellisten museoiden käytettävissä | ||
50 | |||
51 | ==== Kehityksen periaatteita ==== | ||
52 | |||
53 | * Kehitetään ketterin ohjelmistokehityksen menetelmin. Uusia ominaisuuksia julkaistaan tarpeen vaatiesssa | ||
54 | * Järjestelmää testataan ja se on integroitu staging -palevlimelle (kotkatest.luomus.fi) | ||
55 | * Moderni selainpohjainen käyttöliittymä | ||
56 | * joustava ei-relaatiotietokanta, jossa data on enimmäkseen denormalisoitua | ||
57 | * Dataa haetaan, jaetaan ja julkaistaan hakutietokannan kautta (Elastic Search). Se sisältää sekundaarisen kopion datasta, joka on optimoitu hakuja varten | ||
58 | * Olemassaolevien työkalujen hyödyntäminen: Lajitietokeskuksen järjestelmät, ontologiat, Excel-työkalut, avoimen lähdekoodin kirjastot jne. | ||
59 | * Yksinkertaisuus ja joustavuus | ||
60 | * Koodi julkaistaan MIT-lisenssillä avoimena lähdekoodina [[https:~~/~~/bitbucket.org/luomus/kotka/src/master/>>url:https://bitbucket.org/luomus/kotka/src/master/||shape="rect"]] | ||
61 | |||
62 | === Teknologia === | ||
63 | |||
64 | * Backend PHP ja Zend framework | ||
65 | * Frontend Bootstarp, jQuery, ja useita muita avoimen lähdekoodin kirjastoja | ||
66 | * (% style="color:#ff0000" %)Primaaridata tällä hetkellä ontologiatietokannassa, joka perustuu Oraclen relaatiotietokantaan. Siirtyminen tehokkaampaan Oracle JSON dokumenttitoetokantaan on suunnitteilla | ||
67 | * Hakutoiminnot perustuvat ElasticSearchiin | ||
68 | * Data julkaistaan Suomen Lajitietokeskuksen tietovaraston kautta (Vertica) | ||
69 | * Koodi BitBucketissa: [[https:~~/~~/bitbucket.org/luomus/kotka>>url:https://bitbucket.org/luomus/kotka/src/master/||shape="rect"]] | ||
70 | * Perustana pääosin RESTful APIt | ||
71 | |||
72 | === Esimerkkejä datasta === | ||
73 | |||
74 | * Luomuksen kokoelmat: [[http:~~/~~/tun.fi/HR.128>>url:http://tun.fi/HR.128||shape="rect"]] | ||
75 | * Hyönteisnäyte: [[http:~~/~~/id.luomus.fi/GL.3951>>url:http://id.luomus.fi/GL.3951||shape="rect"]] | ||
76 | * Jäkälänäyte: [[http:~~/~~/id.luomus.fi/HA.H9506963>>url:http://id.luomus.fi/HA.H9506963||shape="rect"]] | ||
77 | * Tyyppinäytteet Luomuksen kokoelmissa: [[https:~~/~~/kotka.luomus.fi/types/by-collection?uri=http:~~/~~/tun.fi/HR.128>>url:https://kotka.luomus.fi/types/by-collection?uri=http://tun.fi/HR.128||shape="rect"]] | ||
78 | |||
79 | == Käyttäjät == | ||
80 | |||
81 | Kotkaa käytetään seuraavissa organisaatioissa (09/2021): | ||
82 | |||
83 | * Luonnontieteellinen keskusmuseo Luomus, Helsingin yliopisto | ||
84 | * Eläinmuseo ja kasvimuseo, Oulun yliopisto | ||
85 | * Eläinmuseo ja kasvimuseo sekä kasvitieteellinen puutarha, Turun yliopisto | ||
86 | * Kuopion luonnontieteellienn museo | ||
87 | * Luontomuseo, Jyväskylän tiedemuseo, Jyväskylän yliopisto (+ kasvitieteellinen puutarha) | ||
88 | * Kieppi, Kokkolan luonnontieteellinen museo | ||
89 | * Luonnontieteelliset kokoelmat, Pohjanmaan museo | ||
90 | * Lapin maakuntamuseo | ||
91 | * Luontotalo Arkki, Satakunnan museo, Porin kaupunki | ||
92 | * Forssan luonnonhistoriallinen museo | ||
93 | * HAMBI mikrobikokoelmat, Helsingin yliopisto | ||
94 | * Tampereen luonnontieteellinen museo | ||
95 | * Porvoon museo, luonnontieteelliset kokoelmat | ||
96 | * Iisalmen luontomuseo | ||
97 | |||
98 | ((( | ||
99 | |||
100 | ))) | ||
101 | |||
102 | ((( | ||
103 | **Yhteystiedot** | ||
104 | ))) | ||
105 | |||
106 | Kotkan kehityksestä vastaavat Luomuksen Biodiversiteetti-informatiikan yksikön ICT- ja Lajitietotiimit | ||
107 | |||
108 | * Anniina Kuusijärvi - product owner, **kotka(ät)luomus.fi** | ||
109 | * Käyttäjätunnusasiat - kotka(ät)luomus.fi | ||
110 | |||
111 | == Käyttöohje == | ||
112 | |||
113 | Huomaa että **[[Kotkan käyttöohjeet ovat pääosinosin englanniksi>>doc:digit.Kotka Collection Management System.Manual for Kotka.WebHome]]**, ja osin tässä suomeksi. | ||
114 | |||
115 | |||
116 | |||
117 | {{children/}} | ||
118 | |||
119 | == Yhetystiedot ja viestintä == | ||
120 | |||
121 | Kotkaa kehitetään luonnontieteellisessä keskusmuseossa [[Luomuksessa>>url:http://www.luomus.fi/||shape="rect"]] | ||
122 | |||
123 | Product Owner Anniina Kuusijärvi, kotka(at)luomus.fi | ||
124 | |||
125 | Kotkalla on Yammer ryhmä ja sähköpostilista, joihin voi liittyä saadakseen uusimmat tiedot Kotkan kehityksestä, huoltokatkoista ym. Ota yhteyttä kotka(at)luomus.fi, jos haluat liittyä Yammer-ryhmään tai sähköpostilistalle. | ||
126 | |||
127 | == Osoitteet == | ||
128 | |||
129 | * **Kotka: [[https:~~/~~/kotka.luomus.fi>>url:https://kotka.luomus.fi/||shape="rect"]]** | ||
130 | * **Kotkan testiversio: [[https:~~/~~/kotkatest.luomus.fi>>url:https://kotkatest.luomus.fi/||shape="rect"]]** - Tätä voi käyttää Kotkan käytön harjoitteluun ja siihen voi tallentaa keksittyjä tietoja. Tunnuksen ja salasanan tänne saa Kotkan ylläpidolta. | ||
131 | |||
132 | == Lisätietoa == | ||
133 | |||
134 | * Julkisiin kokoelmien kuvauksiin ja näytetietoihin pääsee tutustumaan Lajitietokeskuksen [[laji.fi-portaalissa>>url:http://laji.fi/||shape="rect"]] | ||
135 | * [[Kotkan esittely Prezissä>>url:http://prezi.com/kpq6_y25fsvt/kotka/||shape="rect"]] | ||
136 | |||
137 |