Kuovi-projekti. Sovellussuunnitelma

Transkriptio

1 Kuovi-projekti Sovellussuunnitelma Antti Hedlund Juho Kortelainen Jaana Ojala Juhana Pikki Versio 0.1 Julkinen Jyväskylän yliopisto Tietotekniikan laitos Jyväskylä

2 Hyväksyjä Päivämäärä Allekirjoitus Nimenselvennys Projektipäällikkö Tilaaja Ohjaaja

3 Tietoa dokumentista Tekijät: Antti Hedlund (AH) Juho Kortelainen (JK) Jaana Ojala (JO) Juhana Pikki (JP) Dokumentin nimi: Kuovi-projekti, Sovellussuunnitelma Sivumäärä: 32 Tiedosto: sovellussuunnitelma01.tex Tiivistelmä: Tämä dokumentti on Kuovi-projektin sovellussuunnitelma. Dokumentissa kuvataan projektin sovellusta, sen tekotapaa, käytettyjä työkaluja ja miten se liittyy varsinaiseen Korppi-järjestelmään. Avainsanat: HTTP, HTTPS, Korppi-opintotietojärjestelmä, matkapuhelimet, rajoitetut laiteresurssit, räätälöinti, tekstiviesti, WAP, WWW-sovellus, ääniselain. i

4 Versiohistoria Versio Päivämäärä Muutokset Tekijät Dokumentin yleiset tiedot, johdanto, termit, sovelluksen tavoitteet, toiminnot ja ominaisuudet, toteutustekniikat ja -työkalut, prototyyppisivut, koodin nimeämis- ja kommentointikäytännöt, testausperiaatteet sekä yhteenveto. JP ii

5 Tietoa projektista Kuovi-projekti suunnittelee ja toteuttaa Jyväskylän Yliopistolle Korppi-järjestelmän tärkeimmistä toiminnoista matkapuhelimiin soveltuvat versiot. Tekijät: Antti Hedlund (AH) Juho Kortelainen (JK) Jaana Ojala (JO) Juhana Pikki (JP) Tilaaja: Vesa Lappalainen Mauno Väisänen Ohjaajat: Vesa Korhonen Jukka-Pekka Santanen Maunu Tuomainen Yhteystiedot: Sähköpostilistat: Sähköpostiarkistot: kuovi05_opetus/ind.html, kuovi05/ind.html Työhuone: Ag C222.2, puh iii

6 iv

7 Sisältö 1 Johdanto 1 2 Termit Käyttäjäryhmät Dokumentin aihealueen termejä Dokumentissa esiintyviä teknisiä termejä Sovelluksen tavoitteet, toiminnot ja ominaisuudet Matkapuhelinten selaimet ja Korppi Toteutettavia tietoja ja toimintoja Toteutustekniikat ja -työkalut Sovelluksen suhde Korppi-järjestelmään JSP-tekniikka Java-pavut Prototyyppisivut Login-sivu (N1) Pääsivu (N2) Kalenteri (N3) Tapahtuman lisääminen Tapahtuman tyyppi (N7) Tapahtuman tiedot (N15 ja N16) Tapahtuman esikatselu (N17) Opiskelusi (N4) Kurssin tiedot (N9) Ryhmät (N5) Ryhmän tiedot (N10) Viestin lähettäminen ryhmälle (N11) Ryhmäkalenteri (N12) Tenttisi (N6) Tenttihaku (N14 ja N15) Tenttihaku, vaihe 2 (N18) Tentin tiedot (N13) Ohjelmakoodin kommentointi ja nimeämiskäytännöt 28 v

8 7 Testausperiaatteita 30 8 Yhteenveto 31 9 Lähteet 32 vi

9 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti 1 Johdanto Korppi on Jyväskylän yliopiston opiskelijoille ja henkilökunnalle kehitetty opintotietojärjestelmä. Nykyisenlaisena se on ollut toiminnassa muutamia vuosia. WWWselaimia sisältävien matkapuhelimien yleistyessä Korpin tarjoamia palveluita on haluttu käyttää myös matkapuhelimien kautta. Tämän hetkiset sivut sisältävät aivan liikaa tietoa ja toimintoja matkapuhelimen ruudulla esitettäväksi. Lisäksi isojen datamäärien liikuttaminen tulee siirtomäärän mukaan laskutettavilla puhelinliittymillä kalliiksi. Kuovi-projekti on Jyväskylän yliopiston tietotekniikan laitoksen opiskelijoiden sovellusprojekti. Tilaajana toimii Jyväskylän yliopisto. Projekti suunnittelee ja toteuttaa Korppi-opintotietojärjestelmän keskeisimmät toiminnot paremmin matkapuhelimissa toimivina. Tämä dokumentti on Kuovi-projektin sovellussuunnitelma. Sen tarkoituksena on kuvata, miten vaatimusmäärittelyn sisältämät vaatimukset toteutetaan. Luvussa kaksi käydään läpi aihealueeseen liittyviä termejä. Luvussa kolme kerrotaan sovelluksesta, sen tavoitteista, toiminnoista ja ominaisuuksista. Luku neljä keskittyy projektin käyttämiin toteutustekniikoihin ja -työkaluihin. Viidennessä luvussa tarkastellaan projektin tuottamia prototyyppisivuja, niiden ulkoasua ja toimintoja. Kuudennessa luvussa kerrotaan ohjelmakoodin nimeämis- ja kommentointikäytännöt, seitsemäs luku käsittelee sovelluksen testausta. 1(32)

10 2 Termit Luvussa esitellään dokumentissa esiintyvät käyttäjäryhmät, dokumentin aihealueen termit ja tekniset termit. 2.1 Käyttäjäryhmät Käyttäjäryhmiä ovat seuraavat käyttäjätunnuksellaan ja salasanallaan Korppi-järjestelmään kirjautuvat henkilöt: vierailija opiskelija opettaja sihteeri on alimman käyttäjätason käyttäjä. Tämä status tulee oletuksena rekisteröinnin jälkeen. Vierailija saa ilmoittautua kursseille ja tentteihin. saa samat oikeudet kuin vierailija. Opiskelijatasolle nostetaan siinä vaiheessa kun käyttäjä on tunnistettu Atk-keskuksen tunnuksen omistajaksi. Eli kun käyttäjä kirjautuu Atk-keskuksen käyttäjätunnuksella ja salasanalla - käyttäjätunnuksen tulee tällöin olla Korpissa sama kuin Atk-keskuksen palvelimilla) opiskelijaoikeuksien lisäksi opettaja voi lisätä kursseja, muokata omien kurssien tietoja, määritellä kurssikuvauksia, jne. ylin yleisesti jaettava oikeustaso; omaa kaikkiin laitoksen kursseihin opettajaoikeuden; sihteeri voi nostaa sihteeriksi toisen oman laitoksen käyttäjän (myös Korppi-ylläpito voi nostaa sihteeriksi, mutta vain hyvien perusteluiden kera ja henkilökohtaisen tapaamisen yhteydessä - henkilöllisyys on varmistettava) 2.2 Dokumentin aihealueen termejä Seuraavat termit kuvaavat dokumentin aihealuetta ja taustaa: Korppi on Jyväskylän Yliopiston opiskelijoille tarkoitettu opintotietojärjestelmä. 2(32)

11 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti Kotka tekstiviesti on Korppi-järjestelmän tietokanta ja henkilötietojen hallintaosio. Tekstiviestit ovat lyhyitä, alunperin 160 merkkiä pitkiä viestejä, joita lähetetään matkapuhelinverkossa tyypillisesti matkapuhelimesta toiseen. 2.3 Dokumentissa esiintyviä teknisiä termejä Dokumenttiin ja projektiin liittyviä teknisiä termejä ovat seuraavat: Apache CSS CVS Eclipse HTTP HTTPS Java Java-pavut JSP on avoimen lähdekoodin WWW-palvelinohjelmisto, joka palauttaa asiakkaan HTTP-protokollalla pyytämän HTML-sivun. (engl. Cascading Style Sheets) on tekniikka, joka mahdollistaa tyylien ja ulkoasun määrittelyn WWW-sivuja luotaessa. CSS-tiedosto sisältää listan ohjeita selaimelle, jotta selain osaa näyttää sivut oikein. (engl. Concurrent Version System) on versionhallintaan tarkoitettu ohjelmisto. on kehitystyökalu, joka tukee lukuisia eri ohjelmointikieliä. (engl. HyperText Transfer Protocol) on WWW-tekniikassa käytettävä tiedonsiirtoprotokolla, jolla selain pyytää haluttuja sivuja WWWpalvelimelta. (engl. Hypertext Transfer Protocol over Secure Socket Layer) on HTTPprotokollan salattu versio. on Sun Microsystems, Inc.:n kehittämä laitteistoriippumaton oliopohjainen ohjelmointikieli. (engl. JavaBeans) on uudelleenkäytetävien komponenttien luontiin tarkoitettu standardi. (engl. Java Server Pages) on skriptaustyylinen ohjelmointikieli, jossa HTML-koodin sekaan on mahdollista lisätä Java-kielellä kirjoitettua koodia. 3(32)

12 L A TEX 2ε PostgreSQL servletti Tomcat WAP WWW XHTML ääniselain on projektin dokumenteissa käytettävä ladontaohjelmisto. on avoimeen lähdekoodiin perustuva relaatiotietokantapalvelin. eli sovelma on pieni ohjelma, joka on tehty Javalla laajentamaan palvelimen toiminnallisuutta. Servletit ajetaan palvelimella. Tomcat on Apache Software Foundationin javalla toteutettu WWWsovelluspalvelin, joka lisää Apacheen mm. JSP-tuen. (engl. Wireless Application Protocol) on avoin standardi, joka välittää internetin kaikkialle ajasta ja paikasta riippumatta. (engl. World Wide Web) on Internetissä toimiva hypertekstijärjestelmä. Hypertekstiä selataan selaimella, joka hakee web-sivuiksi kutsuttuja dokumentteja web-palvelimilta ja esittää niitä käyttäjälle (engl. Extensible HyperText Markup Language) on HTMLn pohjalta kehitetty sivunkuvauskieli, joka perustuu XML-standardiin. on selain, joka perustuu äänisyötteiden ja -vasteiden antamiseen. Esimerkiksi näkövammaiset eivät voi hyödyntää näköaistin käyttöön perustuvaa selainta. 4(32)

13 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti 3 Sovelluksen tavoitteet, toiminnot ja ominaisuudet Luvussa käydään ensin läpi projektin taustaa ja syitä sen tekemiseen. Sen jälkeen keskitytään projektin sovelluksen tavoitteisiin ja siihen tehtäviin toiminoihin ja ominaisuuksiin. 3.1 Matkapuhelinten selaimet ja Korppi Matkapuhelinten käyttö on lisääntynyt räjähdysmäisesti viime vuosien aikana. Yhä useammasta puhelimesta löytyy nykyään myös WWW-selain. Selailun yleistymisen myötä myös Jyväskylän yliopiston tietotekniikan laitoksella kehitetyn Korppi-opintotietojärjestelmän palveluiden käyttö muulloinkin kuin oman tietokoneen ääressä yleistyy. Nykyiset Korpin WWW-sivut sisältävät kuitenkin liikaa informaatiota matkapuhelimen pienellä näytöllä selattavaksi. Lisäksi siirtomäärän mukaan laskutettavissa liittymissä selaaminen on kallista. Myös näkövammaisten käyttämillä ääniselaimilla nykyisten sivujen käyttö on lähes mahdotonta. Tämä on luonut tarpeen kehittää Korpin valituille toiminnoille rinnakkainen, varta vasten matkapuhelimella käytettävä käyttöliittymä. Kuovi-projekti on syntynyt tämän tarpeen pohjalta. 3.2 Toteutettavia tietoja ja toimintoja Kuovi-projektissa suunnitellaan ja toteutetaan yksinkertaistetut versiot Korppi-järjestelmän eniten käytetyistä WWW-sivuista, jotta käyttö matkapuhelimella olisi mahdollisimman helppoa ja vaivatonta. Myös ääniselainta käyttävät henkilöt huomioidaan. Toteutettavat toiminnot valitaan siten, että ne vastaavat Jyväskylän yliopiston sekä Avoimen yliopiston opettajien ja opiskelijoiden tarpeita. Jokainen käyttäjä kirjautuu järjestelmään omilla henkilökohtaisilla tunnuksillaan ja kirjautujan käyttäjäryhmästä riippuen hänelle tarjotaan joko opiskelijan tai opettajan toimintoja. Lisäksi kirjautumisvaiheessa tarkastetaan käyttäjän laite, jolloin matkapuhelinta käyttävät voidaan ohjata automaattisesti niille räätälöidyille sivuille. Kurssitietoja käyttäjä voi selata myös kirjautumatta. Opiskelijoille annetaan mahdollisuus tarkastaa kalenterista viikkonäkymänsä, ilmoittautua kursseille ja tenttei- 5(32)

14 hin sekä tarkistaa opintosuorituksiaan. Opettajalle tärkeitä toimintoja ovat tapahtumien lisäykset ja poistot, salivarausten tekeminen sekä kalenteripalvelut. Kuovi-projektissa kehitetään useita Korppi-järjestelmän osioita. Niitä kutsutaan yleisesti myös sovelluksiksi, mutta Kuovi-projektissa ja tässä dokumentissa termillä sovellus viitataan Kuovi-projektissa toteutettaviin toiminnallisuuksiin. 6(32)

15 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti 4 Toteutustekniikat ja -työkalut Luvussa kuvataan Kuovi-projektin toteuttamiseen käytettäviä työkaluja ja ohjelmointiympäristöjä. Ryhmän tietokoneista kolmessa on käyttöjärjestelmänä Windows XP ja yhdessä Fedora Core 4. Ohjelmointikäyttöliittymä on Eclipse 3.1. Testimatkapuhelimena projektilla on käytössä Nokian matkapuhelin. 4.1 Sovelluksen suhde Korppi-järjestelmään Projektin toteuttama sovellus lisää Korppi-järjestelmään uuden käyttöliittymän, jota on helpompi käyttää mobiililaitteilla sekä teksti- ja ääniselaimilla. Varsinaista uutta toiminnallisuutta olemassa olevaan järjestelmään se ei tuo. Kuva 4.1 kuvaa sovelluksen suhdetta Korppi-järjestelmään. 4.2 JSP-tekniikka JSP-sivut eroavat normaaleista XHTML-sivuista siten, että niihin on mahdollista kirjoittaa Java-koodia normaalin XHTML-koodin sekaan. Normaalisti kun WWWpalvelin vastaanottaa staattisen sivun latauspyynnön, niin palvelin lähettää kysyisen sivun takaisin suoraan. JSPn tapauksessa asia on hieman monimutkaisempi, WWW-palvelin ohjaa pyynnön servlet-moottorille (engl. servlet engine). Tämä puolestaan tarkistaa onko kyseinen servlet oikea versio, jos ei niin se käännetään uudestaan lähettämällä pyyntö JSP-moottorille. Sivupyyntö ohjataan edelleen servletille, joka sitten muodostaa sivusta HTML-version ja lähettää sen takaisin selaimelle. Kuva 4.2 valaisee tilannetta [3]. 4.3 Java-pavut Java-pavut on uudelleenkäytettävien komponenttien luontiin tarkoitettu standardi. Pavut ovat normaaleja Java-luokkia, mutta niiden pitää toteuttaa joitakin erityisvaatimuksia. Kommunikointi papujen välillä tapahtuu tapahtumien avulla, pavut voivat rekisteröidä joitain muiden komponenttien tarjoamia tapahtumia ja saavat sitten tiedon, kun näitä tapahtuu [1]. 7(32)

16 Kuva 4.1: Sovelluksen suhde Korppi-järjestelmään. Kaikki toiminnallisuus yritetään projektissa saada sisällytettyä Java-papuihin, jolloin JSP-sivut vain kutsuvat papujen metodeita. Näin saadaan eroteltua näkymä ja toiminnallisuus toisistaan. 8(32)

17 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti Matkapuhelin HTML-selain Internet WWW-palvelin (apache) Staattiset HTML-sivut Servlettimoottori (tomcat Käännetyt servletit JSP-moottori Kotka-tietokanta JSPdokumentit Kuva 4.2: JSP-tekniikan yleiskuva. 9(32)

18 5 Prototyyppisivut Projektin alkuvaiheessa toteutettiin prototyyppisivuja Korpin varsinaisten sivujen pohjalta. Näiden tarkoituksena oli päästä tutkimaan WWW-sivujen käytettävyyttä matkapuhelimella heti alusta lähtien. Käytettävyyttä on pyritty parantamaan karsimalla kaikki ylimääräinen sivuilta pois, kuten navigointipalkit ja logot. Sivujen koko on myös pyritty minimoimaan, jotta ne latautuisivat nopeammin hitaalla yhteydellä. Varsinaista toiminnallisuutta prototyyppisivuihin ei tehty. Kaikilta sivuilta karsitut ominaisuudet Kaikki kuvat ja logot poistetaan. CSS-tiedostoa pienennetty. Navigointipalkit poistettu sivun yläreunasta ja vasemmasta reunasta. Alareunan navigointi muutetaan matkapuhelimelle paremmin sopivaksi ja poistetaan vähemmän käytettyjä linkkejä. Muruspolkua on lyhennetty, siitä näytetään vain ensimmäinen linkki, viimeinen sivu ja sitä edeltävä linkki. Tarvittaessa myös sanoja lyhennetään. Toteutetuista prototyyppisivuista on näkymäkartta kuvassa 5.1. Siinä on puumaisesti kuvattu kaikki sivut ja minkä alle mikäkin sivu kuuluu. Näkymät on nimetty N1, N2,..., N19 ja toiminnot T1, T2,..., T19. Kaikkia linkkejä kuvassa ei ole. Taulukkoon 5.1 on kuvailtu sivulta löytyvät toiminnot. Toiminto T1 T2 T3 T4 T5 T6 T7 Toiminnon kuvaus Käyttäjä kirjautuu sisään käyttäen omaa käyttäjätunnustaan ja salasanaa. Käyttäjä valitsee kalenteri-linkin. Käyttäjä valitsee opiskelusi-linkin. Käyttäjä valitsee ryhmät-linkin. Käyttäjä valitsee tenttisi-linkin. Käyttäjä haluaa lisätä uuden tapahtuman, tämä tulee käyttäjän valitessa joko lisää uusi tapahtuma -linkin tai taulukkokalenterissa + -linkin. Käyttäjä haluaa päivänäkymän valitsemalla kalenterista jonkun päivän. 10(32)

19 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti T8 T9 T10 T11 T12 T13 T14 T15 T16 T17 T18 T19 Käyttäjä pääsee kurssin tietoihin valitsemalla kurssin nimen linkin. Käyttäjä pääsee ryhmän tietoihin valitsemalla ryhmän nimen listasta. Käyttäjä pääsee lähettämään viestin ryhmän jäsenille valitsemalla ryhmän nimen edessä -merkissä olevan linkin. Ryhmän kalenteriin pääsee valitsemalla K -linkin, joka on ryhmän nimen edessä. Tentin tietoihin pääsee valitsemalla tietyn tentin tenttilistasta. Tenttiin ilmoittautuminen löytyy sivun alareunassa olevasta linkkilistasta. Kun käyttäjä saa tehtyä uuden tapahtuman ensimmäisen vaiheen, painaa hän Seuraava >> -painiketta. Seuraavaksi näytetään tapahtuman luonnin toinen vaihe, tästä sivusta on sekä suppea, että laaja versio. Kumpaa käytettään riippuu siitä, kumpaa käyttäjä on aikaisemmin käyttänyt. Tämä asetus siis tallennetaan käyttäjäkohtaisesti. Käyttäjä voi tapahtuman luonnin toisessa vaiheessa vaihdella suppean ja laajan näkymän välillä. Tapahtuman luonnin toisesta vaiheesta siirrytään kolmanteen painamalla Seuraava >> -painiketta. Kolmannessa vaiheessa tapahtuma luodaan Luo tapahtuma -painikkeella. Käyttäjä voi tenttihaun ensimmäisessä vaiheessa vaihdella suppean ja laajan näkymän välillä. Tenttiin ilmoittautumisen ensimmäisessä vaiheessa syötetään halutun kurssin hakuehto (nimi tai koodi) sekä haluttu aikaväli. Seuraavaan vaiheeseen siirrytään Hae tentit -painikkeella. Ilmoittautumisen toisessa vaiheessa valitaan listasta haluttu tentti. Hakuehtoja voidaan muuttaa uusi haku -linkin takaa, joka palaa vaiheeseen yksi. Tentin tiedot -sivulta tenttiin voi ilmoittautua Ilmoittaudu -painikkeella. Taulukko 5.1: Prototyyppisivujen toiminnot. 5.1 Login-sivu (N1) Kuvassa 5.2 on login-sivun prototyyppi. Se kysyy käyttäjältä salasanan ja käyttäjätunnuksen, joiden avulla kirjaudutaan Korppi-järjestelmään. Mikäli käyttäjä syöt- 11(32)

20 Kuva 5.1: Näkymäkartta prototyyppisivuista. 12(32)

21 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti tää tiedot väärin näytetään sivusta hieman enemmän tietoa sisältävä versio, jossa on muun muassa yhteystiedot, mistä voi kysyä apua. Kuva 5.2: Login-sivu. 5.2 Pääsivu (N2) Korppiin kirjautumisen jälkeen käyttäjälle aukeaa näkymä 5.3, joka sisältää linkin yleisimmin käytettyihin ominaisuuksiin. Välittömästi sisäänkirjautumisen jälkeen käyttäjälle tulee sivun informatiivisempi versio, joka on kuvassa vasemmanpuoleinen näkymä. Tämän jälkeen sivulle palattaessa siitä näytetään oikeanpuoleinen versio, josta puuttuvat käyttäjän henkilötiedot ja status. 5.3 Kalenteri (N3) Viikkokalenterinäkymästä on esillä ollut kaksi vaihtoehtoa, lista- ja taulukkomuotoinen kalenteri. Kuvassa 5.4 on esitetty nämä molemmat. Listamuotoinen kalenteri kertoo tarkemmin, minkä niminen tapahtuma mihinkäkin aikaan päivästä on. Siitä ei kuitenkaan yhdellä silmäyksellä näy, mihin aikaan on vapaata. Lisäksi uuden tapahtuman luominen on kuormittavaa, koska käyttäjän tarvitsee itse muistaa vapaa aika, kun hän siirtyy tapahtuman luontiin. Listamuotoinen kalenteri ei myöskään sovi ryhmäkalenteriksi. Taulukkomuotoinen kalenteri muistuttaa Korpin nykyistä kalenteria, mutta tietoa on paljon vähemmän. Siitä on helppo hahmottaa vapaat ajankohdat ja lisätä tapahtumia vapaisiin paikkoihin. Tapahtumien kuvaukset eivät taulukkoon mahdu, joten 13(32)

22 Kuva 5.3: Pääsivut. ne käyttäjä joutuu katsomaan ajankohdan takaa. Taulukkomuotoinen kalenteri voi toimia myös ryhmäkalenterina, jolloin ajankohdan kohdalla oleva numero kuvaa sitä, kuinka monella on merkitty tapahtuma tuohon aikaan. Lisäksi jotkin matkapuhelimet hajottavat taulukot kokonaan, jolloin kalenteri muuttuu käyttökelvottomaksi. 5.4 Tapahtuman lisääminen Tapahtuman lisääminen tapahtuu vähintään kolmessa vaiheessa. Tämä on kaikkein yksinkertaisin tapaus, monesti esimerkiksi salin haku tuo lisää vaiheita Tapahtuman tyyppi (N7) Tapahtumaa luotaessa ensimmäiseksi valitaan tapahtuman tyyppi (kuva 5.5). Näitä mahdollisuuksia on varsinaisessa Korpissa enemmänkin, mutta vielä ei ole päätetty kuinka monta niistä toteutetaan mobiiliversioon, mutta ainakin henkilökohtainenja ryhmän tapahtuma tullaan tekemään. 14(32)

23 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti Kuva 5.4: Viikkokalenterit; lista- ja taulukkomuotoinen kalenteri. 15(32)

24 Kuva 5.5: Tapahtuman lisääminen, näkymä 1: tapahtuman tyypin valinta Tapahtuman tiedot (N15 ja N16) Tapahtuman luomisen toinessa vaiheessa syötetään tapahtuman varsinaiset tiedot (kuva 5.6). Tästä näkymästä on kaksi versiota, pitkä ja lyhyt. Lyhyessä versiossa on vain kaikkein tärkeimmät ja yleisimmin käytetyt tiedot, koska matkapuhelimella tietojen syöttäminen on aina hidasta. Pitemmässä versiossa on kaikki samat kysymykset kuin Korpin varsinaisessa tapahtumassakin, mutta sivun pituus kasvaa heti huomatavasti, kuten myös syötettävän tiedon määrä. Lopullisesta versiosta poistetaan Uusi tapahtuma: Maatuska Isomursu teksti sivun ylälaidasta Tapahtuman esikatselu (N17) Tapahtuman luomisen kolmas vaihe on esikatselu (kuva 5.7), se näyttää syötetyt tiedot ja varmistaa näin käyttäjältä, että ne ovat oikein. Tämä vaihee voidaan ohittaa henkilökohtaisten asetusten avulla. 5.5 Opiskelusi (N4) Opiskelusi-osassa (kuva 5.8) on listattu opiskelijan aktiiviset kurssit. Jokainen kurssi on linkki, joka vie kurssin tietoihin. Kurssit ovat listan elementtejä, mutta listalta poistetaan CSSn avulla sisennys ja listan alkioiden erotinmerkki. 16(32)

25 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti Kuva 5.6: Tapahtuman lisääminen, näkymä 2: tapahtuman tiedot, laaja ja suppea versio. 17(32)

26 Kuva 5.7: Tapahtuman lisääminen, näkymä 3: tapahtuman esikatselu. Kuva 5.8: Opiskelusi. 18(32)

27 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti Kuva 5.9: Kurssin tiedot Kurssin tiedot (N9) Kurssin tiedoissa (kuva 5.9) näkyy kurssin nimi, koodi, opintoviikkomäärä, päivämäärä, kurssin ryhmät ja kurssin kuvaus. Tämän perässä voi mahdollisesti listata kurssin lomaketiedot (kuten demopisteet). Kurssin ryhmien seuraavan tapaamisen aika ja paikka näytetään myös. 5.6 Ryhmät (N5) Ryhmät-näkymässä (kuva 5.10) on listattu ryhmät, joihin käyttäjä kuuluu. Jos näitä ryhmiä on liikaa (henkilökohtainen asetettava arvo), niin näytetään vain muutama ensimmäinen ja loput piilotetaan. Jos piilotusta tapahtuu, lisätään sivulle hakutoiminto, jolla voi tarkentaa, mitä ryhmiä haluaa näkyviin, sekä linkki, jonka takaa löytyy kaikki ryhmät pitkänä listana. 19(32)

28 Kuva 5.10: Ryhmät. Ryhmien nimien edessä on kaksi linkkiä, # # -merkin (kuvassa 5.10 on käytössä vanha K -merkki) takaa pääsee ryhmäkalenteriin -merkissä olevasta linkistä pääsee lähettämään ryhmälle viestin. Ryhmän nimestä pääsee katsomaan ryhmän tarkempia tietoja Ryhmän tiedot (N10) Ryhmän tiedot -sivulla (kuva 5.11) on listattuna ryhmästä seuraavat tiedot: nimi, kotisivut, lisätiedot ja tila. Lisäksi ryhmän jäsenet on lueteltu, mutta niistäkin näytetään vain ensimmäiset, jos niitä on liikaa. Sivulta pääsee ryhmäkalenteriin ( # -merkki) ja lähettämään ryhmälle viestin - merkki) Viestin lähettäminen ryhmälle (N11) Viestin lähettäminen ryhmälle -näkymän (kuva 5.12) avulla voidaan lähettää viesti joko ryhmän sähköpostilistalle, jos sellainen on tehty, tai kaikille ryhmän jäsenille erikseen, jos listaa ei ole. Vastaanottajia ei saa yksittäin valittua, vaan viesti lähtee kaikille ryhmän jäsenille. Viestistä voi lähettää kopion haluamiinsa osoitteisiin (Cc- 20(32)

29 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti Kuva 5.11: Ryhmän tiedot. 21(32)

30 Kuva 5.12: Viestin lähettäminen ryhmälle. kenttä) ja lähettäjän osoitteen voi valita, jos niitä on tietokannassa monta. Muita annettavia tietoja on otsikko ja viesti Ryhmäkalenteri (N12) Ryhmäkalenteri (kuva 5.13) muistuttaa vahvasti taulukkokalenteria ks Ainoa ero on taulukon sisältämän numeron merkitys, ryhmäkalenterissa se osoittaa kuinka monella ryhmän jäsenellä on jotain menoa tuohon aikaan. Numerossa olevasta linkistä pääsee katsomaan, mitä menoja kenelläkin on merkittynä. + -merkistä pääsee lisäämään tapahtumia ryhmälle. Sivun alareunassa on linkki tapahtuman lisäämiseen. Lisäksi sivulle lisätään hakutoiminto, jolla voi siirtyä haluamaansa päivämäärään. 22(32)

31 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti Kuva 5.13: Ryhmäkalenteri. 5.7 Tenttisi (N6) Tenttisi-näkymässä (kuva 5.14) on listattu opiskelijan tulevat tentit aikajärjestyksessä. Tenteistä näytetään kurssin koodi ja nimi sekä tentin aika ja paikka. Sivun alareunassa on linkki tenttihakuun. 5.8 Tenttihaku (N14 ja N15) Tenttihaun (kuva 5.15) avulla opiskelija voi hakea tenttejä. Tenttihausta on kaksi versiota: suppea ja laaja. Supeassa tenttihaussa haetaan niitä vain kurssin nimen tai koodin sekä aikavälin avulla. Laajassa versiossa voidaan tämän lisäksi määritellä haluttu yliopisto (Jyväskylän- vai avoimen yliopiston kurssit) ja haluttu laitos/oppiaine. Laitos/oppiainelistassa on vain muutama vaihtoehto, jotka valitaan opiskelijan mukaan, esimerkiksi näytetään listassa vain ne, joista opiskelija on suorittanut kursseja. Alla on linkki, jolla listataan kaikki oppilaitokset. 23(32)

32 5.9 Tenttihaku, vaihe 2 (N18) Kuva 5.14: Tenttisi. Tenttihaun toisessa vaiheessa (kuva 5.16) listataan haun tulokset. Sivun yläreunassa on linkki uuteen hakuun. Muuten sivulla on mahdolliset tentit listattu päivämäärän, paikan ja järjestävän laitoksen mukaan järjestykseen. Tentin linkistä pääsee katsomaan tentin tietoja, josta myös siihen ilmoittautuminen tapahtuu Tentin tiedot (N13) Tentin tiedot -näkymässä (kuva 5.17) näkyy tentistä seuraavat tiedot: järjestävä organisaatio, aika, ilmoittautumisajan alku ja päättyminen, ilmoittautuneiden lukumäärä, sali, tentaattorit ja lisätiedot. Lisäksi alareunassa on painike, jolla voidaan tenttiin ilmoittautua, jos opiskelija ei sitä ole vielä tehnyt. Jos opiskelija on jo ilmoittautunut tenttiin, on alareunassa painike, jolla ilmoittautumisen voi poistaa. 24(32)

33 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti Kuva 5.15: Tenttihaku: suppea ja laaja versio. 25(32)

34 Kuva 5.16: Tenttihaun tulokset. 26(32)

35 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti Kuva 5.17: Tentin tiedot. 27(32)

36 6 Ohjelmakoodin kommentointi ja nimeämiskäytännöt Ohjelmakoodin kommentoinnissa ja muuttujien nimeämisessä käytetään Korppijärjestelmän kehittäjien laatimaa nimeämisohjetta. Seuraavassa on esimerkki ohjelmakoodin kommentoinnista, luokkien, metodien ja poikkeusten nimeämisestä [2]. /******************************************************** * PAGE DESCRIPTION ********************************************************* * * ID: $Id$ * LANGUAGE: jsp * PURPOSE: Demostrates commenting.. * AUTHOR: Tiina Pöyhönen, Jyväskylän yliopisto * AUTHOR: Juhana Pikki, Jyväskylän yliopisto * ********************************************************* * COPYRIGHT (C) KUOVI-PROJEKTIRYHMÄ * Limited rights granted. Please refer to license. ********************************************************/ /******************************************************** * UPDATES ********************************************************* * * Initial release * Added something.. (Tiina Pöyhönen) * Added CVS id, added TestClass and made * some small modifications. (Juhana Pikki) * ********************************************************/ /** * <p>title: Test class</p> * <p>description: Example of commenting classes.</p> 28(32)

37 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti Juhana Pikki */ public class TestClass { /** * Function does this and that... * param1 is parameter which is given to function param2 is second parameter given to function SomeException which is some kind of an exception Return value */ public String thisandthat(int param1, param2) if (param1!= param2) { } throws SomeException { throw new SomeException("Some kind of exception.."); else { } //do this and that.. } } return value; /******************************************************** * COPYRIGHT (C) KUOVI-PROJEKTIRYHMÄ * Limited rights granted. Please refer to license. ********************************************************/ 29(32)

38 7 Testausperiaatteita Sovelluksen testausta pyritään suorittamaan jatkuvasti kehitysvaiheessa. Jokainen sivu testataan ensin huolellisesti erillään ja vasta tämän jälkeen se voidaan liittää muihin sivuihin. Yhdistämisvaiheessa suoritetaan integraatiotestaus, jossa pyritään löytämään sivujen yhteistoimintaan liittyvät ongelmat. Sivuja testataan kaikilla ryhmän käytössä olevilla selaimilla ja alustoilla. Ryhmällä on käytössä Linux- ja Windows-käyttöjärjestelmät sekä Nokian Series 60 -puhelin. Selaimina Linuxissa on Opera 8.5, Mozilla Firefox ja Lynx 2.8.5rel.1, Windowsissa Mozilla Firefox 1.0.6, Internet Explorer 6.0 ja Mozilla Lisäksi käytössä on Nokian matkapuhelimen vakioselain, jolla sivut pitää testata erityisen huolellisesti. 30(32)

39 Julkinen Sovellussuunnitelma 0.1 Kuovi-projekti 8 Yhteenveto Kuovi-projekti suunnittelee ja toteuttaa Korppi-opintotietojärjestelmän keskeisimmät toiminnot paremmin matkapuhelimissa toimivina. Tässä dokumentissa kuvataan projektin tavoitteita ja kehitysvälineitä ja esitellään projektin prototyyppisivut. Lisäksi käydään läpi ohjelmakoodin nimeämis- ja kommentointikäytännöt sekä sovelluksen testausperiaatteita. 31(32)

40 9 Lähteet [1] Kosonen, Sami, Java- ja Enterprise Java -pavut, Jyväskylän yliopisto, viitattu [2] Kottarainen-projekti, Sovellussuunnitelma, Jyväskylän yliopisto, [3] Korppi-projeki, Sovellussuunnitelma, Jyväskylän yliopisto, (32)