Kolibri-niminen tietotekniikan cum laude -työprojekti on jatkoa Kurki-sovelluksen jatkokehittämisestä liikkeelle lähteneeseen opetus- ja tutkimushallintajärjestelmän kehittämiseen. Vuonna 1998 toteutettua Kurki-projektia ovat seuranneet syksyn 2000 Kotka-projekti sekä kevään 2001 Korppi- ja Halko-projektit. Kolibri toteuttaa koko Kotka-järjestelmään liittyen WWW-pohjaisen ajanvaraus- ja päivyriosion.
Olemassaoleva järjestelmä ja sen sisältämä tietokanta on nimeltään Kotka. Korppi-sovellus on Kotka-järjestelmän kurssikirjanpito-osio. Se tulee korvaamaan ensi syksyyn mennessä entisen Kurki-järjestelmän. Halko-projekti toteutti kansalaisopistoille ja muille oppilaitoksille opetushallinto-ohjelman ja teki tiivistä yhteistyötä Korppi-projektin kanssa.
Kolibri toteuttaa ajanvaraus- ja päivyriohjelmiston, jota tullaan käyttämään useammassa Kotka-järjestelmän osiossa. Se ei siis käytännössä tule olemaan oma kokonaan erillinen osionsa, mutta sitä voidaan käyttää myös erillisenä sovelluksena.
Kolibri-sovelluksen avulla Kotka-järjestelmän eri osioissa voidaan esittää henkilökunnan tai opiskelijan varattuja aikoja mm. viikottain sekä voidaan tehdä ajanvarauksia mm. opetukseen liittyen. Päivyriosio tulee olemaan toiminnoiltaan selkeästi laajempi kuin tietotekniikan laitoksella nykyisin käytössä oleva Kuukkeli-niminen kurssien ohjausaikojen varausjärjestelmä.
Syksyn 2001 projektiryhmään kuuluvat Mia Jaakkola, Sanna Juutinen, Matti Lupari ja Mikko Nieminen. Tilaajana toimii Jyväskylän yliopiston tietotekniikan laitos, jota edustavat Pauli Kujala ja Vesa Lappalainen.
Tämä dokumentti määrittelee sovellukseen liittyvät toiminnalliset ja tekniset vaatimukset. Sovellussuunnitelmassa kuvataan sovellukselle asetetut tavoitteet sekä toimintojen ja ominaisuuksien priorisointi. Suunnitelmassa esitetään myös hahmotelmat ajanvaraus- ja päivyriosion sivuista, sivustokartta sekä kuvataan koodin kommentointia ja testausperiaatteita. Projektin toinen suunnitteludokumentti on projektisuunnitelma, jossa kuvataan projektin taustoja ja tavoitteita, projektiorganisaatiota sekä työn jakoa ja suunniteltua aikataulua.
Luku 2 käsittelee sovellukselle asetettuja tavoitteita ja sovelluksen ominaisuuksia. Luku 3 kuvaa sovelluksen palvelinratkaisua, työkaluja ja tekniikoita. Luku 4 käsittelee ko. WWW-sovelluksen sivustokarttaa ja sovelluksen toimintojen jakautumista sivuille. Luku 5 käsittelee ohjelmakoodissa käytettäviä merkintöjä ja luku 6 testauksen periaatteita.
2. Toiminnalliset vaatimukset
Kolibri-sovelluksesta toteutetaan lukujärjestysmuotoinen yksinkertainen ja helppokäyttöinen ajanvaraus- ja päivyriohjelma Jyväskylän yliopiston henkilökunnan ja opiskelijoiden käyttöön. Kalenteriosioon käyttäjä voi merkitä sekä yksityiset että julkiset tapahtumansa. Kalenterinäyttöinä ovat päivä-, viikko-, kuukausi- ja vuosinäkymät.
Kolibri-sovellukseen toteutetaan myös ajanvarauksen vaatimat toiminnot. Sen kautta voi varata aikaa itselleen ohjaajalta tai yhteistä aikaa jollekin hallitsemalleen ryhmälle niin, että näkee kaikkien ryhmän jäsenten kalenterit päällekkäin. Kun ryhmävastaava varaa ajan, näkyy se varattuna aikana jokaisen ryhmän jäsenen päivyrissä. Ryhmän jäsenet näkevät ajanvarauksen lähettäjän ja saavat automaattisesti muistutuksen ajanvarauksesta.
Toiminnallisia vaatimuksia on tullut suunnittelun edetessä huomattavasti lisää verrattuna alkuvaatimuksiin. Tässä luvussa esitetään sovelluksen tärkeimmät toiminnalliset vaatimukset jaoteltuina henkilökohtaiseen kalenteriin, ryhmänäyttöihin ja ajanvaraukseen sekä ohjaajan näyttöihin.
Henkilökohtainen kalenteri sisältää viikko-, päivä-, kuukausi- ja vuosinäytön lukujärjestysmuotoisina. Päivänäytössä päällekkäiset tapahtumat näkyvät vierekkäin eri sarakkeissa. Muissa näytöissä päällekkäiset tapahtumat ovat peräkkäin samassa aikajaksossa. Käyttäjä voi lisätä tapahtumia itselleen ja poistaa niitä.
Vain henkilökohtaisessa kalenterissa on vuosinäyttö, jossa selkeästi erottuvat ne päivät, joissa on tapahtumia sekä sunnuntait ja arkipyhät. Kaikissa näytöissä on selkeästi osoitettava meneillään oleva päivä.
Ryhmänäyttöjen osuudessa voidaan luoda uusi ryhmä ja muokata vanhaa. Uuden ryhmän luonnissa voidaan ihmisiä ja ryhmiä hakea nimellä. Samannimisten ryhmien perustaminen estetään, ettei tule sekaannusta haettaessa ryhmän nimellä.
Kun ryhmän ajat ovat kalenterissa päällekkäin, näkyvät varatut ajat väreillä ja numerolla. Mitä tummempi väri ja suurempi numero ajankohdassa on, sitä huonommin se ryhmälle sopii. Luodulle ryhmälle voidaan varata yhteinen aika, joka näkyy jokaisen ryhmän jäsenen kalenterissa. Ajan varaaja näkee myös kenellä on valittuna aikana joitain muita tapahtumia. Kaikki ryhmän jäsenet voivat liittää tapahtumaan ryhmän jäsenille näkyviä muistilappuja.
Ajanvarauksen kautta voi myös varata itselleen ajan eli laittaa uuden tapahtuman, mutta pääasiassa ajanvaraus on tarkoitettu ryhmäköhtaisten aikojen (kuten ohjausaikojen) varaukseen. Ohjaajalle varatun ohjausajan kohdalla näkyy ajan varaajan nimi, mutta muille aika näkyy vain varattuna aikana. Ohjausaikojen näytön saa näkyville valitsemallaan aikajaksolla.
Ohjaajan näytössä varattavien aikojen merkitseminen tapahtuu niin, että ensin valitaan ajankohdat. Halutessaan ohjaaja voi kirjoittaa varattaviksi annettaville ohjausajoille selityksen tapahtumanlisäyssivulle. Jos ohjaaja haluaa merkitä varattavat ohjausaikansa ruksaamalla ne suoraan viikkokalenterinäyttöön, saa hän käyttöönsä valintaruudut erillisen linkin takaa. Kun tarpeelliset ajat on ruksattu, painaa hän linkkiä, joka vie tehtävän määrittelylomakkeelle.
Koko ajanvaraus- ja päivyriosiossa liikkumista helpottaa Kotka-järjestelmän sivupalkissa oleva navigointilista. Järjestelmässä liikkumista helpottamaan määritetään ajanvaraus- ja päivyriosion sivuille myös loogiset osoitteet.
2.2. Aikataulun salliessa toteutettavat
Vaatimusten määrä on lisääntynyt, mitä pidemmälle projektissa on edetty. Tästä johtuen osa toiminnoista tullaan toteuttamaan vain siinä tapauksessa, että aikaa niihin riittää.
Tällaisia toimintoja ovat esimerkiksi Luo uusi ryhmä -näytön tekeminen pitkäksi ja lyhyeksi versioksi niin, että lyhyessä versiossa osa hakua rajaavista ehdoista on piilotettu (liitteet 13 ja 14). Samaan kategoriaan kuuluvia toimintoja ovat kalenteriin sisällytettävä käyttäjän tehtävälista sekä erilaiset tapahtumien hakutoiminnot.
Kaikkia esitettyjä ideoita ei millään voida näin lyhyen aikataulun puitteissa toteuttaa, joten osa ideoista jätetään suosiolla sovelluksen jatkokehittäjälle. Tällaisia ovat ehdottomasti synkronointi kämmen- ja taskumikroihin ja yliopiston puhelinkeskukseen.
3. Tekniset vaatimukset
Luvussa esitellään projektissa käytettävät työkalut, palvelinohjelmistot ja ohjelmointitekniikat. Kotka- ja Korppi-projektit käyttivät niitä, joten niiden valinta on loogista myös Kolibri-projektin ja -sovelluksen osalta.
Järjestelmään valittiin HTML-palvelimeksi Apache, koska yliopiston WWW-palvelimet käyttävät yleisesti Linux-käyttöjärjestelmää. Apache-palvelimen lisäksi järjestelmään asennetaan TomCat, joka on yhdistetty JSP- ja servlettimoottori. Tietokannan ja TomCatin tietovälittimenä toimii PoolMan-ohjelmisto, joka jakaa tietokantayhteyksiä niitä tarvitseville servleteille. Tietokantajärjestelmänä on PostgreSQL.
Sovellus toteutetaan JSP-tekniikalla (katso kuva 1). Kun WWW-palvelin vastaanottaa pyynnön selaimelta, se päättelee dokumentin tiedostotarkenteen perusteella, onko kyseessä staattinen HTML-sivu vai JSP-sivu. Staattisen sivun tapauksessa palvelin voi palauttaa pyydetyn sivun välittömästi takaisin selaimelle.
JSP-sivun ollessa kyseessä pyyntö välitetään edelleen TomCat-servlettimoottorille. Se tutkii, onko kyseistä sivua vastaava servletti jo olemassa. Jos servlettiä ei ole, pyyntö jatkaa matkaansa JSP-moottorille, joka generoi sivua vastaavan servletin. Se puolestaan on JSP-sivusta muodostettu Java-kielinen luokka, johon on liitetty tarvittavat Java-pavut.
Tämän jälkeen servletti suoritetaan, jolloin muodostuu selaimen pyytämä HTML-sivu ja se lähetetään takaisin selaimelle. Näin asiakassovelluksena toimiva WWW-selain saa pelkkää HTML-koodia sisältävän sivun esitettäväksi.
Java-pavut ovat Java-ohjelmointikielellä toteutettuja luokkia. Papuihin pyritään sijoittamaan mahdollisimman paljon JSP-sivujen Java-koodia, jolloin JSP-sivujen luettavuus paranee.
Kaikki yleiskäyttöiset metodit tulisi upottaa Java-papuihin. Tällöin niitä tarvitsee kutsua vain JSP-koodissa, eikä kirjoittaa aina uudestaan samaa Java-koodia JSP-koodin sekaan.
Kolibri-projekti tulee tarvitsemaan jo Kotka- ja Korppi-projektien käyttämiä Java-papuja. Uusia papuja lisätään tarpeen mukaan.
Koska Kolibri-projektin ajanvaraus- ja päivyrisovellus pohjautuu Kotka-järjestelmän tietokantaan, on valmis pohja jo olemassa. Tiettyjä muutoksia tulee siihen kuitenkin tehdä, jotta kaikki toiminnot olisivat mahdollisia.
Esimerkiksi henkilöryhmien perustamista varten tulee tietokantaa muuttaa. Lisäksi olemassaoleva tietokanta ei tue opettajan varattavien ohjausaikojen merkitsemistä tai WWW-sivun näyttämistä osaltaan piilotettuna henkilökohtaisten parametrien mukaisesti.
4. Sivustokartat sekä toimintojen jakautuminen sivuille
Alustavat toteutettavan sovelluksen sivuhahmotelmat kuvaavat ajanvaraus- ja päivyriosion toimintojen jakautumista sivuille ja sivujen kesken. Hahmotelmiin voi vielä koodausvaiheessa tulla pieniä muutoksia.
Sovelluksen sivustokartta kalenterinäkymän osalta esitetään liitteessä 1, ryhmäajanvarauksen osalta liitteessä 2 ja ohjaajan näytön osalta liitteessä 3. Kuvat sovelluksen sivujen hahmotelmista ovat nähtävissä liitteinä 4-17.
Käyttäjän henkilökohtainen kalenteri sisältää päivä-, viikko-, kuukausi- ja vuosinäytöt. Jokaisesta näytöstä pääsee mihin tahansa oman kalenterin näyttöön. Muista paitsi vuosinäytöstä pääsee lisäämään itselleen tapahtuman. Käyttäjän omaa kalenteriosiota koskevat näytöt ovat viikkonäyttö liitteessä 4, päivänäyttö liitteessä 5, kuukausinäyttö liitteessä 6 sekä vuosinäyttö liitteessä 7. Samana päivänä alkavan ja päättyvän tapahtuman lisäysnäyttö on esitetty liitteessä 8 ja useammalle päivälle sijoittuvan tapahtuman lisäyssivu liitteessä 9.
Ohjaajalta ajan varaamisessa käyttäjä valitsee joko itsensä tai ryhmän ja sen lisäksi ohjaajan, joiden kalenterit näkyvät päällekkäin joko päivä- tai viikkonäyttöinä. Käyttäjä voi varata itselleen tai ryhmälle ohjausajan ohjaajan varattaviksi merkitsemistä ajoista. Ohjaajalta varattavaan aikaan liittyvät näytöt näkyvät varaajan ja ohjaajan ajoista päällekkäin valitulla aikajaotuksella, joista esimerkkinä on jaotus tunnin mukaan liitteessä 10 ja kahdenkymmenen minuutin mukaan liitteessä 11. Muitakin aikajakoja on olemassa. Ohjausajan varausnäyttö on liitteessä 12.
Ryhmäajanvarauksessa valitaan ryhmä, jonka kalenterit nähdään päällekkäin joko viikko- tai päivänäyttöinä. Ryhmälle voi varata yhteisen ajan tai poistaa jo varatun ajan (liitteet 8 ja 9). Valitsemaansa ryhmää voi muokata tai luoda uuden ryhmän. Uuden ryhmän luontinäkymä lyhyenä versiona on liitteenä 13 ja pitkänä versiona on liitteessä 14. Ryhmävastaavilla on oikeus tehdä varauksia koko ryhmän puolesta. Ryhmävastaavien määrityssivu on esitetty liitteessä 15. Ryhmän jäsenten tapahtumien yhdistetty sivu on nähtävissä liitteessä 16. Liitteessä 17 on esitetty nimilista niistä ryhmän jäsenistä, joilla on tapahtumaa määriteltynä ajankohtana.
4.2. Havaitut muutostarpeet
Sivuhahmotelmien pohjalta on jo suunnitteluvaiheessa havaittu muutostarpeita sekä uusien sivujen että sivujen toiminnallisuuden ja ulkoasun osalta.
Sivusto tulee muokkautumaan koko ajan sovelluksen toteutuksen ajan, joten hahmotelmia ei ole päivitetty vastaamaan nykytilannetta. Hahmotelmien ulkoasu ei ole yhtenevä, koska niitä ovat tehneet kaikki projektiryhmän jäsenet itsenäisesti. Lopullisten sivujen ulkoasu hiotaan yhteneväksi viimeistään projektin testausvaiheessa.
Sivuille tarvitaan vähintään seuraavat muutokset toimintojen ja ulkoasun osalta. Jokaisen näytön otsikossa tulee esittää sen henkilön tai ryhmän nimi, jota näyttö koskee.
Liitteessä 10 esitetyssä näytössä oleva Näytä 20 min välit -painike muuttuu alasvetovalikoksi, josta saadaan valittua näytettävä aikajaotus. Liitteissä 12, 13 ja 14 esitetyissä näytöissä olevat tietoja-tekstikentät muutetaan leveämmiksi. Liitteissä 13 ja 14 esitetyissä näytöissä ryhmän nimen viereen tulee painike, jolla tarkastetaan, onko ryhmän nimi jo varattu.
Näytöistä puuttuvat tapahtuman muokkausnäyttö, ohjaajan näyttö varattavien aikojen määrittämisen osalta sekä näyttö, jossa ryhmän jäsenet voivat nähdä kaikki tapahtumaan liittyvät muistilaput sekä lisätä uusia. Tapahtuman muokkausnäyttö eroaa toisto-osaltaan liitteiden 8 ja 9 lisäysnäytöistä. Muokkausnäytössä toistetut tapahtumat esitetään listana toisto-osion paikalla.
5. Ohjelmakoodissa käytettävät merkinnät
Kolibri-projekti päätyi yhtenäisyyden vuoksi käyttämään sovelluksen moduulien listauksissa samanlaista kommentointitapaa kuin Kotka- ja Korppi-projektitkin. Ryhmä tulee käyttämään ja muuttamaan jo Kotka- ja Korppi-projektien toteuttamia Java-papuja. Uusia Java-papuja lisätään sitä mukaa, kun tarve vaatii.
Luvun loppuun on sijoitettu esimerkki Kotka-ryhmän käyttämästä lähdekoodin nimeämis- ja kommentointitavasta, jota siis Kolibri-projektissakin tullaan noudattamaan.
/***************************************************************************
* MODULE DESCRIPTION
****************************************************************************
*
* NAME: XXX
* LANGUAGE: JSP 1.1
* DATE: 8/11/2001
* AUTHOR: Mikko Nieminen, Jyväskylän yliopisto
*
***************************************************************************** COPYRIGHT (C)
KOLIBRI-PROJEKTIRYHMÄ
* Limited rights granted. Please refer to license *
***************************************************************************/
/***************************************************************************
* UPDATES
****************************************************************************
*
* Initial release
*
***************************************************************************/
class MyClass inplements
... extends ... {
protected: // Attributes
boolean MyBoolean; // MyBoolean is used for....
int MyInt; // MyInt is used for...
double MyDouble; //
public: // Access methods
boolean isMyBoolean();
void setMyBoolean(boolean
MyBoolean);
int getMyInt();
void setMyInt(int MyInt);
double getMyDouble();
void setMyDouble(double
MyDouble);
public: // Methods
/*
executeFunc function description
*/
void executeFunc(...) {
...
// Specific line comment
...
}
public: // Events
}
/***************************************************************************
* COPYRIGHT (C) KOLIBRI-PROJEKTIRYHMÄ
* Limited rights granted. Please refer to license
***************************************************************************/
Projektin viimeiselle kolmelle viikolle sisällytetään projektisuunnitelman aikataulussa esitetty testijakso. Tällöin sekä projektilaiset, tilaajan edustajat ja ohjaajat että muutama muu testaukseen lupautunut henkilö testaavat sovelluksen toimivuutta.
Projektilaiset testaavat kehittämäänsä sovellusta Microsoft Internet Explorerin, Netscape Navigatorin, Operan ja Lynxin eri versioilla. Testauksessa käydään läpi eri käyttäjäryhmät ja niiden eri toiminnot.
Kehitysympäristönä toimii pii4-kone, jonne on asennettu kaikki tarvittavat ohjelmat (Apache 1.3.17, Java 2 SDK Standard Edition, Tomcat 3.2.1, PoolMan 1.4.1 ja PostgreSQL 7.0.3). Testausympäristönä käytetään kuitenkin ranchi-konetta, jottei sovelluksen kehitys ja testaus häiritse toisiaan. Testitietokannassa on testidataa oikealta palvelimelta, mutta salasanat ja henkilötunnukset on muutettu.
Horppu Ismo, Mielityinen Markku ja Vire Markku, ”Kotka-projektin projektikansio”, Jyväskylän yliopisto, Tietotekniikan laitos, 2000.
Jaakkola Mia, Juutinen Sanna, Lupari Matti ja Nieminen Mikko, Kolibri-projektin palaverien pöytäkirjat 1-5, Jyväskylän yliopisto, Tietotekniikan laitos 2001.
Koponen Kirsi, Kuittinen Jussi ja Laitinen Santeri, ”Halko-projektin projektikansio”, Jyväskylän yliopisto, Tietotekniikan laitos, 2001.
Lesonen Minna, Pekkanen Hannu, Tawast Tuukka ja Uuksulainen Heikki, ”Korppi-projektin projektikansio”, Jyväskylän yliopisto, Tietotekniikan laitos, 2000.
Santanen Jukka-Pekka, ”Tietotekniikan cum laude -työprojektien ohje”, Jyväskylän yliopisto, Tietotekniikan laitos, 2001.
Santanen Jukka-Pekka, ”Opinnäytteiden kirjoittaminen, lyhyt oppimäärä”, Jyväskylän yliopisto, Tietotekniikan laitos, 2000.
Tawast Tuukka, Uuksulainen Heikki, ”Korppi-projektin jatkokehitys”, Jyväskylän yliopisto, Tietotekniikan laitos, 2001.
Liite 8. Tapahtumien lisäysnäyttö 1
Liite 9. Tapahtumien lisäysnäyttö 2
Liite 15. Oikeuksien lisääminen
Liite 16. Ryhmän yhteinen näyttö
Liite 17. Ryhmän varatut ajat määriteltynä ajankohtana
