KOPPELO
Tietotekniikan cum laude -työprojekti
Minna Hillebrand
Markus Silván
Antti Vanhanen
Marko Ylitalo
Vaatimusmäärittely
14.3.2002
Jyväskylän yliopisto
Tietotekniikan laitos

Contents

1  Johdanto
2  Termistöä
3  Aiheen ehdotus
4  Aiheen hyväksyminen opinnäytteeksi
5  Opinnäytteen kiinnittäminen tekijöille
6  Opinnäytteen aloituksen hyväksyminen
7  Tapahtumien kirjaaminen
8  Työn keskeyttäminen ja poistaminen
9  Työhön liittyvien henkilöiden ylläpito
10  Työn aiheen ylläpito
11  Arvosteleminen
12  Valmiin työn hyväksyminen
13  Haut ja raportit
14  Monikielisyys
15  Yhteenveto

1  Johdanto

Tämä dokumentti on määrittelee KOPPELO-sovellukselta vaaditut ominaisuudet, joita on hahmoteltu käyttötapauksien pohjalta luvuissa 3-14. Luvussa 15 on kuvattu vaatimusmäärittelyt tiivistettynä listana, jota edellisten lukujen käyttötapaukset täydentävät.

2  Termistöä

Taulukoissa 1 ja 2 on esitelty toteutusympäristöön ja projektiin liittyvää termistöä.

TERMI SELITYS
Apache on ilmainen HTTP-palvelinohjelmisto.
CSS eli Cascading Style Sheets on WWW-sivujen ulkoasua kuvaava kieli.
CVS eli Concurrent Versions System on versionhallintaan tarkoitettu ohjelmisto.
Delphi on Inprisen ohjelmistonkehitysympäristö, jossa ohjelmointikielenä käytetään Object Pascal -kieltä.
GNUJSP on ilmainen JSP-moottori.
HTML on WWW-sivujen rakennetta kuvaava kieli.
HTTP on WWW-arkkitehtuurin käyttämä tiedonsiirtoprotokolla.
Java on Sunin kehittämä laitteistoriippumaton olio-ohjelmointikieli.
Java-pavut (engl. Java Beans) ovat Java-ohjelmointikielellä luotuja komponentteja, joita voidaan kutsua JSP-sivuilla.
JDBC eli Java Database Connectivity on Java-teknologian käyttämä tietosilta erilaisiin tietokantoihin.
Jserv on ilmainen Java-servlettimoottori.
JSP eli Java Server Pages on skriptaustyylinen ohjelmointikieli.
Keksi (tai eväste, engl. cookie) on Netscapen luoma, mutta nykyään jo standardoitu menetelmä saada WWW-sivuista vuorovaikutteisempia. Palvelin lähettää pieniä tietopaketteja selaimelle, jonka perusteella käyttäjä asetuksineen tunnistetaan jatkossa.
Poolman on ohjelma, joka kontrolloi tietokantayhteyksiä.
PostgreSQL on ilmainen tietokannanhallintajärjestelmä.
Skripti on ohjelmointikieltä muistuttava ja usein hieman yksinkertaistettu tulkattava kieli.
Skriptaus tarkoittaa WWW-sivujen tapauksessa ohjelmakoodin kirjoittamista HTML-dokumenttien sisään. Palvelinpuolen skriptauksessa koodi ajetaan palvelinkoneessa ja asiakaspään skriptauksessa selaimessa.
Selain on ohjelma, joka käyttäjän koneella tulkkaa HTML-kieliset sivut esitettävään muotoon.
Palvelin on ohjelmisto, joka WWW-sovellusten tapauksessa palvelee asiakkaana toimivien selainten hakupyyntöjä.
Servletti on palvelimella sijaitseva sovelma (engl. applet), joka toteuttaa HTTP-palvelimen pyynnöstä tietyn toiminnon.
SQL eli Structured Query Language on tietokantojen hallintaan kehitetty standardi kieli.
Tomcat on ilmainen servletti- ja JSP-moottori.

Table 1: Toteutusympäristöön liittyvää termistöä.

TERMI SELITYS
HALKO on Heinolan kansalaisopistolle toteutettu opetuksenhallintajärjestelmä.
KOTKA on Jyväskylän yliopiston tietotekniikan laitoksella kehitetty opetus- ja tutkimushallintajärjestelmä.
KORPPI on KOTKA-järjestelmän kurssikirjanpitomoduuli.
KOLIBRI on KOTKA-järjestelmän kalenteriosio.
KURKI on Jyväskylän yliopistossa käytössä oleva Intrabuilderilla toteutettu WWW-pohjainen kurssikirjanpitojärjestelmä.
KUUKKELI on Antti Viinikan Jyväskylän yliopistossa kehittämä järjestelmä ohjausaikojen ajanvaraukseen ja hallintaan.
Käyttötapaus (engl. use case) on käyttäjän tai sovelluksen toimintoa tietyn tehtävän suorittamiseksi kuvaava dokumentti.
Moduuli on Kotka-järjestelmässä tietyn tehtäväjoukon suorittamiseen kehitetty sovellus ja käyttöliittymä.

Table 2: KOTKA-järjestelmään liittyvää termistöä.

Taulukossa 3 esitetään projektin eri dokumenteissa käytettävää opinnäytteisiin liittyvää termistöä.

TERMI SELITYS
Aihe on aihe-ehdotuksesta mahdollisesti tietylle linjalle hyväksytty aihe opinnäytteeksi.
Aihe-ehdotus on opinnäytteen aiheeksi esitetty idea.
Opinnäyte on opiskelijan työn alle ottama opintokokonaisuus eli hyväksytty aihe, jolle on kiinnitetty tekijä. Tarkoittaa esimerkisi graduja, seminaareja ja työharjoitteluja.
Vastaava ohjaaja on opinnäytteen pääasiallinen ohjaaja. Vastaavalta ohjaajalta voi käydä varaamassa aiheen itselleen, ja yleensä vastaava ohjaaja myös ohjaa opinnäytettä sen edetessä.
Ohjaaja Muu opinnäytteen ohjaaja.
Tarkastaja arvostelee opinnäytteen.
Kurssi KOTKA-tietokannan käsite yleiselle kurssinimikkeelle. Jokainen opinnäyte liittyy johonkin kurssiin, jotta opinnäytteeseen liittyisi yksikäsitteinen kurssikoodi.
Kurssi-instanssi KOTKA-tietokannan käsite tiettynä lukukautena tai muuna ajankohtana järjestettävälle kurssille.
Opinnäytteen vaihe Kuvaa opinnäytteen elinkaarta ja ohjausprosessia. Niitä ovat mm. ehdotettu aiheeksi, hyväksytty aiheeksi, tekeillä, hyväksytty ja keskeytetty.
Tapahtuma Opinnäytteeseen liittyvä raportointi- tai ohjaustapahtuma. Jokaiseen tapahtumaan voi edelleen liittyä oma työvaihe.
Työtehtävä Esimerkiksi työprojektin tapauksessa opinnäytteen suorituksesta voidaan erottaa projektisuunnitelman, sovellussuunitelman ja varsinaisen ohjelmoinnin suorittaminen. Nämä työtehtävät voidaan edelleen luokitella esimerkiksi suunnitteluun, ohjelmointiin ja dokumentointiin.
Table 3: KOPPELO-projektiin liittyvää termistöä.

3  Aiheen ehdotus

Opinnäytteiden aihe-ehdotuksia voivat esittää sekä ehdotuksien hyväksymisestä vastaavat henkilöt että sellaiset henkilöt, joilla ei ole hyväksymisoikeutta. Aiheen ehdottajalla tulee kuitenkin olla tunnukset KOTKA-järjestelmään, eli käytännössä aiheen ehdottaja on joko yliopiston opiskelija tai kuuluu henkilökuntaan.

Ehdotusvaiheessa opinnäytteestä syötetään lähinnä kuvaus ja muita yleisiä tietoja kuten esimerkiksi WWW-osoitteet ja muut lähteet. Mikäli aiheen ehdottajalla ei ole aiheen hyväksymisoikeutta, aihe-ehdotuksen antamisesta lähetetään sähköpostiviesti kyseisen opinnäytteen aihe-ehdotusten hyväksymisestä vastaavalle henkilölle.

Aihe-ehdotus on järjestelmässä vain tietyn mittaisen ajanjakson. Ellei ehdotusta hyväksytä aiheeksi kyseisen ajan sisällä, aihe-ehdotus merkitään poistetuksi järjestelmästä. Ennen poistamista aiheen ehdottajalle ja aihe-ehdotusten hyväksymisestä vastaavalle henkilölle lähetetään poistamisesta varoitussähköpostiviesti. Aihe-ehdotusten hyväksyjä voi täten käydä hyväksymässä aiheen.

4  Aiheen hyväksyminen opinnäytteeksi

Aiheen voi hyväksyä opinnäytteeksi vain henkilö(t), jolle tämä oikeus on myönnetty. Hyväksymisoikeudet jaetaan laitoksittain linja- ja opinnäytetyyppikohtaisesti

Ellei aiheeksi hyväksyttyä opinnäytettä kiinnitetä tekijöille tietyn ajan kuluessa, aihe merkitään poistetuksi järjestelmästä. Aiheen poistamisesta lähetetään varoitussähköposti aihetta ehdottaneelle, työhön mahdollisesti kiinnitetyille ohjaajille sekä aiheen hyväksyneelle henkilölle ennen poistamista. Aiheen hyväksyjä tai ohjaaja voi käydä pidentämässä aiheen voimassaoloaikaa.

5  Opinnäytteen kiinnittäminen tekijöille

Oikeus opinnäytteen kiinnittämiseen tekijälle/tekijöille riippuu opinnäytetyyppikohtaisesti. Esimerkiksi harjoitustyön voi kiinnittää opiskelijalle kuka tahansa ohjaaja, mutta gradun kiinnittämiseksi hyväksyjän tarvitsee olla esim. professori, lehtori tai yliassestentti.

Samassa yhteydessä työhön voidaan liittää ohjaajia, tarkastajia ja muita työhön liittyviä henkilöitä. Opinnäytteen aiheen kuvausta tarkennetaan, se liitetään tiettyyn opintojaksoon ja siihen kiinnitetään työtehtäviä.

Työn kiinnittämisen yhteydessä järjestelmä vaihtaa työn vaiheen joko vapaasta aloitetuksi, tekeillä olevaksi tai tehdyksi. Valinta riippuu opinnäytteen tyypistä: esim. gradujen tapauksessa vaiheeksi tulee aloitettu, jonka jälkeen työlle pitää saada vielä esim. laitoksen johdon hyväksyntä. Hyväksynnästä vastaavalle henkilölle lähetetään asiasta sähköpostiviesti.

Työn kiinnittämisen yhteydessä voidaan määrätä, voiko toinen opiskelija(ryhmä) ottaa työn samaan aikaan tehtäväksi erillisenä opinnäytteenä.

Työharjoitteluille, erikoistöille sekä harjoitustyölle ei tarvita erillistä hyväksyntää, joten niiden vaiheeksi tulee suoraan tekeillä oleva. Tämän jälkeen työ ei näy hakutuloksissa mm. opiskelijoille. Työhön kiinnitetyillä henkilöillä on kuitenkin täysi oikeus nähdä työhön liittyviä tietoja koko opinnäytteen elinkaaren ajan.

6  Opinnäytteen aloituksen hyväksyminen

Joidenkin opinnäytteiden (gradut, lisensiaattityöt, väitöskirjat) suorituksen aloittaminen vaatii korkeamman tahon hyväksynnän. Tässä vaiheessa opinnäytteelle on kiinnitetty aihe, tekijät, ohjaajat ja mahdollisesti alustava työsuunnitelma. Hyväksyntä vaihtaa työn tilan aloitetusta tekeillä olevaksi.

7  Tapahtumien kirjaaminen

Opinnäytteeseen liittyviä tapahtumia (kuten ohjaustilanteita ja työn raportointitietoja) saa lisätä kuka tahansa työhön liittyvä henkilö. Erityyppisten tilanteiden osalta rajataan, että esimerkiksi opinnäytteen tekijällä on oikeus lisätä vain työn edistymiseen liittyvää tietoa, ei hyväksymismerkintöjä.

Jokaiseen tapahtumaan liitetään tieto siitä mihin opinnäytteen työtehtäväänn tapahtuma liittyy. Lisäksi järjestelmä tallentaa tiedon kirjaajasta ja ajankohdasta.

Samassa yhteydessä pitää pystyä määräämään esimerkiksi seuraavan tapaamisen ajankohta, joka samalla on nähtävissä Kolibri-sovelluksessa.

Mikäli järjestelmään ei ole kirjattu opinnäytteeseen liittyviä tapahtumia määritellyn ajan kuluttua edellisen tapahtuman kirjaamisesta, järjestelmä lähettää muistutussähköpostiviestin opinnäytteeseen liittyville henkilöille.

KOPPELO-sovellukseen kirjatuista uusista tapahtumista ilmoitetaan opinnäytteeseen liittyville henkilöille opinnäyte-osan etusivulla, kun käyttäjä kirjautuu sisään järjestelmään.

8  Työn keskeyttäminen ja poistaminen

Opinnäytteen ohjaajilla ja mahdollisesti mm. laitoken johtajalla on oikeus keskeyttää opinnäytteen suoritus tai poistaa opiskelijoita työstä. Jos ohjaaja on keskeyttänyt opinnäytteen suorituksen tai poistanut työstä kaikki tekijät, opinnäytteen tila muuttuu tekeillä olevasta keskeytetyksi ja aihe joko hylätään tai vapautetaan muiden käyttöön. Henkilöiden poistamisesta ja työn tilan muuttumisesta lähetetään sähköpostiviesti opinnäytteeseen liittyville henkilöille.

Opinnäytteen ohjaajilla on myös mahdollisuus merkitä opinnäyte poistetuksi järjestelmästä.

9  Työhön liittyvien henkilöiden ylläpito

Työn ohjaajilla, aiheen hyväksyneellä henkilöllä ja mahdollisesti mm. laitoksen johtajalla on oikeus lisätä ja poistaa työhön liittyviä tekijöitä ja ohjaajia.

Kullakin ohjaajalla on oikeus poistaa itsensä opinnäytteestä. Henkilöiden poistamisesta lähetetään sähköpostiviesti muille työhön liittyville henkilöille. Järjestelmä pitää kuitenkin huolta siitä, että opinnäytteellä säilyy kuitenkin vähintään yksi ohjaaja.

10  Työn aiheen ylläpito

Ohjaajat voivat muuttaa työn otsikkoa ja sen kuvausta opinnäytteen suorituksen aikana. Jos työn aihe esimerkiksi muuttuu selvästi työn tekemisen aikana, voi ohjaaja vapauttaa alkuperäisen aiheen uudelleen opinnäytteen aiheeksi. Alkuperäinen aihe säilyy tietokannassa.

11  Arvosteleminen

Tarkastajilla on mahdollisuus arvostella kukin työhön liittyvä tekijä erikseen. Arvostelua varten on käytettävissä erilaisia tyyppejä (esim hyväksytty/hylätty, approbatur-laudatur ja asteikko 1-3). Arvostelua varten järjestelmällä voi tulostaa esimerkiksi gradun arvostelulomakkeen.

Kukin työn tekijä näkee vain henkilökohtaisen arvostelunsa. Useamman tekijän ryhmä näkee myös ryhmäkohtaisen arvostelun.

Arvostelun tiedot näkyvät laitoksen henkilökunnalle.

12  Valmiin työn hyväksyminen

Työn hyväksymisoikeus määräytyy opinnäytetyyppikohtaisesti. Esimerkiksi harjoitustöissä työn hyväksymisoikeus on työn ohjaajilla ja tarkastajilla, mutta gradujen tapauksessa dekaanin tai laitosneuvoston antaman hyväksynnän kirjaamisoikeus voi olla esim. sihteereillä. Hyväksyminen vaihtaa työn tilan tekeillä olevasta tai arvostellusta hyväksytyksi.

13  Haut ja raportit

Järjestelmällä pitää pystyä hakemaan tietoa niin ehdotetuista aiheista, tekeillä olevista töistä kuin valmistuneista ja keskeytetyistä töistäkin. Eri tason käyttäjillä on erilaiset oikeudet hakujen suhteen.

Kunkin laitoksen henkiökuntaan kuuluvilla on oikeus listata oman laitoksen kaikissa eri vaiheissa olevia opinnäytteitä. Lisäksi henkilökuntaan kuuluva voi hakea laitokseltaan esimerkiksi tiettynä vuonna valmistuneet työt opinnäytetyypeittäin tai tietyn opiskelijan tiettynä ajanjaksona tekemät opinnäytteet.

Opiskelijoilla on oikeus hakea kaikkien laitosten aiheeksi hyväksyttyjä töitä ja valmistuneita opinnäytteitä.

Muut käyttäjät voivat hakea vain valmistuneita töitä. Tämä ei vaadi kirjautumista Kotka-järjestelmään.

Kaikki käyttäjät voivat suorittaa hakuja mm. laitoksen, linjan, työn tyypin, avainsanan ja hakusanan perusteella. Hakutulos näytetään listauksena, ja listasta valitsemalla nähdään opinnäytteen tarkempina tietoina kuvaus opinnäytteestä ja muuta yleistä tietoa. Työhön liitettyjen tapahtumien tiedot näkyvät vain kuhunkin opinnäytteeseen liitetyille henkilöille.

14  Monikielisyys

KOPPELO-järjestelmän tulee tukea aiheiden otsikoinnin, kuvausten, ja avainsanojen monikielistämistä. Lisäksi erilaisten vakiolistojen (esimerkiksi opinnäytteen henkilöiden roolit) arvot tallennetaan monikielisinä. Järjestelmän kielinä ovat KOTKA-järjestelmässä määritellyt kielet.

Opinnäytteeseen liittyvät tapahtumat ja arvostelut tallennetaan vain yhdellä opinnäytteeseen liittyvien henkilöiden sopimalla kielellä.

15  Yhteenveto

Alla olevassa listassa on esitetty KOPPELO-järjestelmän vaatimukset mahdollisimman tiiviissä muodossa. Kunkin vaatimuksen perässä on sulkeissa ominaisuuden käyttäjät.