Hirviö Vaatimusmäärittely Jani Heikkinen Anssi Kalliolahti Jukka Larja Kim Nylund Liia Sarjakoski Samuli Sorvakko Timo Toivanen 15. maaliskuuta 2005 Tiivistelmä Tässä dokumentissa kuvataan Tietoliikenneohjelmistojen ja multimedian laboratoriolle kehitettävän järjestelmän kaikki vaatimukset yleisellä tasolla sekä kerrotaan järjestelmästä ja sen ympäristöstä yleensä. Vaatimusten dokumentointiin on käytetty vaatimusluetteloita sekä käyttäjätapauksia. 1
Sisältö 1 Dokumentin tarkoitus 3 1.1 Levitys........................................ 3 2 Termit ja määritelmät 3 2.1 Käsitteet...................................... 3 2.2 Lyhenteet...................................... 4 2.3 Tunnisteet...................................... 4 2.4 Statukset...................................... 4 2.5 Prioriteetit..................................... 4 3 Järjestelmän tavoitteet 5 4 Asiakkaan toimialakuvaus 5 5 Järjestelmän kuvaus 5 5.1 Työryhmät ja oikeustasot............................. 6 6 Käyttäjät 6 7 Toiminnalliset vaatimukset 6 8 Ei-toiminnalliset vaatimukset 11 9 Käyttäjätapaukset 12 9.1 Opiskelijan tietojen hakeminen.......................... 13 9.2 Opiskelijan tietojen näyttäminen......................... 14 9.3 Uuden opiskelijan syöttäminen.......................... 15 9.4 Opiskelijakohtaisen muistiinpanon tekeminen.................. 16 9.5 Perusopintojen statuksen päivittäminen..................... 17 9.6 Jatko-opintojen statuksen päivittäminen..................... 17 9.7 Työryhmän vaihtaminen.............................. 18 9.8 Työryhmänäkymän vaihtaminen......................... 18 9.9 Kirjautuminen järjestelmään........................... 19 10 Rajoitukset 19 11 Viitteet 20 2
Versio Päivämäärä Tekijä Versio 1.00 1.11.2004 Sarjakoski Asiakkaalle ja kurssille PP-vaiheen lopussa luovutettava dokumentti 1.01 2.11.2004 Nylund Järjestelmän tavoitteet -kohta korjattu asiakkaan palautteen pohjalta 1.05 12.11.2004 Larja, Nylund Käyttötapaukset tarkennettu 1.10 18.11.2004 Nylund Päivitetty asiakaskokouksen pohjalta 1.15 29.11.2004 Nylund Päivitetty vastaamaan tilannetta I1 jälkeen 1.20 11.1.2005 Nylund Päivitetty toisen iteraatiovaiheen alussa 1.25 6.2.2005 Nylund Päivitetty toisen iteraatiovaiheen lopussa 1.30 14.3.2005 Nylund Päivitetty FD-vaiheen lopussa 1 Dokumentin tarkoitus Dokumentti kuvaa järjestelmän vaatimukset. Dokumenttia päivitetään jatkuvasti projektin edistyessä asiakkaan palautteen pohjalta. 1.1 Levitys Lukijaryhmä Asiakas Asiakasvastaava Ohjelmoijat Testaajat Muu projektiryhmä Tehtävä Asiakas varmistaa, että dokumenttiin on merkitty kaikki oleelliset vaatimukset. Projektin päättyessä asiakas varmistaa, että toteutus täyttää dokumentissa esitetyt vaatimukset. Asiakasvastaava hallitsee vaatimuksia dokumentin avulla. Asiakasvastaava pitää dokumentin ajantasalla. Ohjelmoijat lukevat dokumentin ymmärtääkseen asiakkaan tarpeet. Testaajat varmistavat, että toteutus vastaa dokumentin vaatimuksia. Tiedoksi 2 Termit ja määritelmät Tässä luvussa on esitelty järjestelmään liittyvät käsitteet, lyhenteet, eri vaatimusluokat, vaatimusten tunnisteet, statukset sekä prioriteetit. 2.1 Käsitteet Muistiinpano Muistiinpano on yhteen opiskelijaan ja yhteen työryhmään liitetty määrämuotoinen tietoalkio, jonka tärkein osa on vapaamuotoinen teksti. Muistiinpanoja voi olla vapaavalintainen määrä kutakin opiskelija ja kutakin työryhmää kohti. Professoreihin ja muuhun opetushenkilökuntaan viitataan yleisellä termillä opet- Opettaja taja. Työryhmä Työryhmät ovat järjestelmän tapa määritellä opettajien oikeuksia. Työryhmän opettajat näkevät kaikki työryhmäänsä liitetyt muistiinpanot sekä voivat lisätä ja päivittää muistiinpanoja. Opettajat voivat kuulua useampaan työryhmään. 3
2.2 Lyhenteet TKK TML Teknillinen korkeakoulu Tietoliikenneohjelmistojen ja multimedian laboratorio 2.3 Tunnisteet Jokainen vaatimus, käyttäjätapaus, rajoitus ja ratkaisuidea saa yksilöllisen tunnisteen. Tunnisteiden avulla vaatimusten täyttymistä seurataan projektin myöhemmissä vaiheissa. Tunnisteet on jaettu alempana listattuihin luokkiin, joista kukin saa oman etuliitteensä. Tunnisteet jaetaan kronologisessa järjestyksessä. Jos jokin vaatimus, käyttäjätapaus, rajoitus tai ratkaisuidea muuttuu, sen tunnisteen perään liitetään versiotunniste, esimerkiksi seuraavasti: F1b tai E2a. Tunnisteet ovat: C Rajoitus F Toiminnallinen vaatimus N Ei-toiminnallinen vaatimus S Ratkaisuidea U Käyttäjätapaus 2.4 Statukset Jokaisella vaatimuksella on status, joka kertoo, missä vaiheessa sen toteutus on. Ehdotettu Asiakas tai projektiryhmä on ehdottanut vaatimusta lisättäväksi. Hyväksytty Kummatkin osapuolet ovat hyväksyneet vaatimuksen. Toteutettu Vaatimus on toteutettu ja testattu. On varmistuttu siitä, että toteutus täyttää vaatimuksen. Poistettu Vaatimus on poistettu. Ei toteuteta Vaatimusta ei toteuteta tämän projektin puitteissa. 2.5 Prioriteetit Jokaisella vaatimuksella on prioriteetti. luokat on lueteltu seuraavana: Prioriteetiltaan kriittiset vaatimukset ovat välttämättömiä järjestelmän toiminnan ja käytettävyyden kannalta. Jos projekti täyttää kaikki kriittiset vaatimukset, sitä voidaan pitää onnistuneena. Korkea Prioriteetiltaan korkeat vaatimukset olisi hyvä muttei täysin välttämätöntä toteuttaa. Jos projekti täyttää kaikki korkean tason vaatimukset, sitä voidaan pitää erittäin onnistuneena. Matala Prioriteetiltaan matalat vaatimukset toteutetaan, jos muilta muiden vaatimuksien toteuttamisesta jää. Ne ovat vaatimuksia, joiden toteuttaminen tuottaa käyttäjille lisäarvoa, mutta eivät kuitenkaan kuulu ydintoimintoihin. 4
3 Järjestelmän tavoitteet Järjestelmän on tarkoitus helpottaa TML:n opetushenkilökunnan keskistä viestintää tarjoamalla työkalu opiskelijakohtaisten muistiinpanojen tekemiseen, seuraamiseen ja hallintaan. Erityisesti järjestelmästä on tarkoitus olla hyötyä tietoliikenneohjelmistojen pääaineen professoreille, joiden yhteisten opiskelijatietojen keskitetty hallinta tulisi mahdolliseksi tässä kehitettävällä järjestelmällä. Tietoliikenneohjelmistojen pääainetta hoitaa tällä hetkellä kaksi professoria. Professorit haluavat järjestelmältä pääosin kahta asiaa: mahdollisuutta koordinoida kunkin opiskelijan kanssa sovittavia asioita siten, että saman opiskelijan kohdalla ei sovita asioista ristiriitaisesti, sekä mahdollisuutta seurata diplomitöiden edistymistä. Opiskelijoiden kanssa sovitaan tyypillisimmin erilaisista suorituksien erityisjärjestelyistä. Järjestelmän toissijainen tavoite on helpottaa viestintää opintojaksojen järjestäjien kesken. Laboratorion opintojaksoja on usein järjestämässä useampi henkilö. Myös opintojaksoilla opiskelijat tarvitsevat usein suoritusten erityisjärjestelyjä, joista täytyy viestiä opetushenkilökunnan kesken. Sekä professorien tekemät että opintojaksoilla sovittavat asiat ovat hyvin samankaltaisia, joten niitä on mahdollista tallentaa samaan järjestelmään. Professorit tulevat käyttämään järjestelmää pääosin opinnoissaan pääaineeseen saakka edenneiden opiskelijoiden sekä mahdolliseseti myös jatko-opiskelijoiden ohjaukseen. Opintojaksojen osalta järjestelmää taas tullaan käyttämään tutkinnon alkupään suurilla opintojaksoilla. 4 Asiakkaan toimialakuvaus Tietoliikenneohjelmistojen ja multimedian laboratorio (TML) on Teknillisen korkeakoulun (TKK) Tietotekniikan osaston laboratorio. Laboratorio vastaa alansa tutkimuksesta sekä perus- ja jatko-opetuksesta TKK:ssa. Suurin osa laboratorion opetuksesta on suunnattu tietotekniikan koulutusohjelman perusopiskelijoille sekä jatko-opiskelijoille. Jonkin verran opetusta järjestetään myös muille TKK:n opiskelijoille. TKK:ssa voi suorittaa diplomi-insinöörin, tekniikan lisensiaatin tai tekniikan tohtorin tutkinnon. Diplomi-insinöörin tutkinto koostuu tutkinnon ensimmäisestä osasta, opintosuunnasta, pääaineesta, sivuaineesta sekä diplomityöstä. Diplomityö tehdään tyypillisesti pääaineeseen, mutta pääaineen professorin suostumuksella sen voi tehdä myös sivuaineeseen. TML järjestää tutkinnon ensimmäiseen osaan ja opintosuuntaan kuuluvia opintojaksoja sekä tarjoaa neljä pääainetta ja viisi sivuainetta. Laboratorio vastaa myös omiin pää- tai sivuaineisiin tehtyjen diplomitöiden valvomisesta sekä joskus myös ohjauksesta. TML järjestää opetusta myös jatko-opiskelijoille. Opintojaksojen järjestämisestä TML:ssa vastaavat useimmiten professorit, opettavat tutkijat, tutkijat, tuntiopettajat sekä kurssi- ja tuntiassistentit. Diplomitöiden valvomisen hoitavat professorit. 5 Järjestelmän kuvaus Järjestelmää käyttäen opettajat voivat tehdä yksinkertaisia muistiinpanoja. Muistiinpanot liitetään järjestelmässä oleviin opiskelijoihin. Vanhoja muistiinpanoja voi hakea, ja niiden pohjalta voi tehdä raportteja. Järjestelmä ei sisällä kaikkia opiskelijoita, vaan opettaja lisää opiskelijan järjestelmään asioinnin yhteydessä. Opiskelijan yhteyteen voidaan liittää myös muuta tietoa. 5
5.1 Työryhmät ja oikeustasot Järjestelmässä jokainen muistiinpano liittyy yhteen työryhmään ja mahdollisesti yhteen opiskelijaan. Työryhmät ovat järjestelmän tapa määritellä opettajien oikeuksia. Työryhmän jäsenet näkevät kaikki työryhmäänsä liitetyt muistiinpanot ja voivat lisätä tai muokata muistiinpanoja. Yksi työryhmä sisältää tyypillisesti yhteen opintojaksoon liittyviä muistiinpanoja. Erityisiä työryhmiä ovat lisäksi pääasiassa professorien käyttöön tarkoitetut diplomityötyöryhmä sekä pääainetyöryhmä. Diplomityötyöryhmä sisältää opiskelijoiden diplomitöihin liittyviä muistiinpanoja. Työryhmään voi antaa myös yhtä opiskelijaa koskevan diplomityön ohjaajan oikeuden. Pääainetyöryhmä sisältää pää- ja sivuaineopiskelijoihin liittyviä muistiinpanoja. Myös muut kuin professorit voivat tarvittaessa kuulua näihin työryhmiin. Toisaalta järjestelmässä on kolme käyttöoikeusryhmää. Näistä vain opettajat voivat kuulua työryhmiin. Käyttöoikeusryhmät esitellään seuraavana. Opettaja pystyy lisäämään, lukemaan ja muokkaamaan työryhmiensä muistiinpanoja. Opettajalla on mahdollista olla kolmenlaisia oikeuksia: kurssihenkilökuntaoikeus tietyn kurssin työryhmään, DI-työohjaajuus tietylle opiskelijalle ja professorikäyttäjän oikeus. DI-työohjaajuus tietyllä opiskelijalle antaa oikeuden lisätä, lukea ja muokata opiskelijan diplomityötyöryhmään kuuluvia muistiinpanoja. Professorikäyttäjän oikeus tarkoittaa oikeutta nähdä kaikki tieto kaikista opiskelijoista. Kurssihenkilökuntaoikeus ja DI-työohjaajuus ilmaistaan järjestelmässä työryhmillä ja professorius ON/OFF-tyyppisesti. Yhdelle opettajalle pystytään määrittelemään useampia käyttöikeuksia, jolloin hän voi esimerkiksi opettaa useammalla kurssilla ja samalla ohjata yhtä tai useampaa diplomityötä. Opiskelija näkee kaikki itseään koskevat yleiset tiedot mutta voi muuttaa niitä vain rajoitetusti. Muistiinpanoja opiskelija ei näe. Ylläpitäjä pystyy luomaan, poistamaan ja muuttamaan kaikkia järjestelmän tietoja. Normaaliin tiedon lisäksi ylläpitäjä pääsee käsiksi muutoslokiin. Ylläpitäjä pystyy muuttamaan opettajien käyttöoikeuksia, ja voi luoda ja poistaa opettajia. Tarvittaessa ylläpitäjä voi myös luoda ja poistaa järjestelmän opiskelijoita. Ylläpitäjä myös luo, poistaa ja muokkaa työryhmiä. 6 Käyttäjät Ryhmä Kuvaus Lukumäärä Professorit Järjestelmää käyttävät professorikunnan edustajat 2 Opettajat Opettavat tutkijat ja tuntiopettajat sekä assistentit 10-15 Ohjaajat Henkilöt, jotka ohjaavat diplomityötä 30-50 Assistentit Kurssi- ja tuntiassistentit 15-20 Opiskelijat Opiskelijat jotka suorittavat opintoja TML:llä 500-1000 Ylläpitäjät Järjestelmän ylläpitäjät 1-3 Professoreihin, opettajiin ja assistentteihin viitataan tässä dokumentissa kuitenkin yleisellä termillä opettaja. 7 Toiminnalliset vaatimukset Tässä luvussa esitellään järjestelmän toiminnalliset vaatimukset. Vaatimuksia tullaan päivittämään projektin edetessä. Toiminnallisiin vaatimuksiin liittyvien tunnisteiden, statusten ja prioriteettien selitykset löytyvät luvusta 2. 6
Vaatimus Lähde Kuvaus Selitys Liittyy UC:n F1 Opiskelijakohtaisten Kokous Järjestelmään voi Muistiinpanojen tallen- U4 1.10.2004 tallettaa opiskelitaminen on eräs jär- muistiinpanojen jakohtaisia muisjestelmän ydintoimintaminen tallettiinpanoja. Nämä noista. Muistiinpanot muistiinpanot ovat koskevat yleensä erilaisia asianmukaisten käyttäjien selailtavissa. suoritusten erityisjärjestelyitä tai diplomitöitä. F2 Hakujen tekeminen Kokous Järjestelmästä voi Haut ovat nopea tapa ja U1 1.10.2004 tehdä hakuja opiske- joustava tapa saada tietyn lijan opiskelijanumeron opiskelijan tiedot näkyviin. tai nimen perusteella F3a Opiskelijan Kokous Järjestelmä sisältää Pakollisina tietoina opiskelijasta U2, U3, tietojen tallettaminen 3.12.2004 perustietoja kustakin on järjestelmään U5, U6 opiskelijasta tallennettu nimi, opiske- lijanumero, kieli sekä sähköpostiosoite. Edellisten yleistietojen lisäksi järjestelmään tallennetaan tieto perusopintojen, diplomityön ja jatkoopintojen tilasta, sekä opiskelijan pääaine, sivuaine, osasto ja vuosikurssi. Diplomityön valvoja ja ohjaaja tallennetaan myös järjestelmään. Lisäksi voidaan tallentaa vapaamuotoista tekstiä kohtaan muuta. F4 Tiedostojen Kokous Järjestelmään voi Tyypillisesti tallennettavia - tallennus 1.10.2004 tallettaa opiskelijaan tiedostoja ovat diplomityön liittyviä tiedostoja. sisällysluettelo, luon- Myös tiedostot kuuluvat nos ja opintosuunnitelmat. aina johonkin työryhmään. F5 F6 Diplomitöiden seuraaminen Järjestelmällä voidaan seurata opiskelijan diplomityön edistymistä. Kaikki diplomityöt käyvät läpi tiettyjä tiloja Järjestelmään kuuluu opiskelijakäyttöliittymä, jonka kautta opiskelija voi tal- Opiskelijakäyttöliittymä Kokous 7.10.2004 Kokous 1.10.2004 lentaa järjestelmään tiedostoja. Opiskelija voi myös rajoitetusti muuttaa omia tietojaan, sähköpostiosoitettaan. esimerkiksi Professorit päivittävät opiskelijan diplomityön tilaa tarvittaessa. Opiskelijäkäyttöliittymä helpottaa opettajien työtä, sillä sen kautta opiskelijat itse voivat hoitaa tiedostojen tallentamisen, mikä pienentää opettajien työmäärää. U2 - Matala Ei toteuteta 7
(Jatkoa edelliseltä sivulta) Vaatimus Lähde Kuvaus Selitys Liittyy UC:n F7 Ylläpitotyökalryhmä Projekti- Ylläpitotyökalulla Järjestelmän ylläpito on - hallitaan tunnuksia, eriytetty järjestelmän hyö- (erityisesti opettajien dyntämisestä kokonaan ja tunnuksia) siihen tarvitaan erillinen niiden oikeustasoja ja tunnus. työryhmiä. F8a Raportit Kokous Järjestelmästä saa Järjestelmä tuottaa seuraavat - Korkea 20.1.2005 haettua raportteja. raportit: DI-työtä tekevät opiskelijat Valmistuneet vuonna n Jatkoopiskelijat Lisensiaattityön tehneet Väitöskirjan tehneet F9 Käyttöliittymä Kokous Järjestelmässä on www-pohjainen järjestelmä - 1.10.2004 www-pohjainen on asiakkaan käyttöliittymä, joka vaatimusten mukaisesti toimii HTML- varsin alustariippumaton standardeja noudattavilla ja joustava. selaimilla. F10 Tietojen Projektiryhmä Sekä tietokannassa Tiedot ovat tärkeät - varmuuskopiointi olevat tiedot että henkilökunnalle eikä niitä ulkoiset tiedot pitää välttämättä ole muissa pystyä varmistamaan. rekistereissä. Tietojen varmistaminen on tärkeää huomioida jo suunnitteluvaiheessa. F11 Järjestelmäloki Projektiryhmä Järjestelmän tärkeät Lokitiedot auttavat selvit- - tapahtumat kuten tämään esimerkiksi tieto- sisään- ja uloskirjautumiset murtoa. ja tietojen muuttamiset pitää kirjata lokitiedostoon. F12 Todennusmenetelmäryhmä Projekti- Järjestelmässä täytyy Sisäisen todennus- - olla sisäinen todenmenetelmän täytyy ol- nusmenetelmä käyttäjien la olemassa, sillä muita tunnistamiseen ei välttämättä toteuteta. ja todentamiseen. Kaikilla käyttäjillä ei myöskään välttämättä ole mahdollisuutta käyttää F13 F14 Järjestelmä täytyy toteuttaa siten, että myös muita todennusmenetelmiä voidaan lisätä. Järjestelmä käyttää sisäisen todennusmenetelmän lisäksi muita jo olemassa olevia ulkoisia mentelmiä, kuten esimerkiksi mahdollisia TML:n tai ATK-keskuksen todennuspalveluita. Todennusmenetelmät Projektiryhmä Todennusmenetelmät Projektiryhmä ulkoisia menetelmiä. Jo olemassa olevien menetelmien käyttö pienentää käyttäjien salasanataakkaa. Jo olemassa olevien menetelmien käyttö pienentää käyttäjien salasanataakkaa. - Korkea - Matala Ei toteuteta 8
(Jatkoa edelliseltä sivulta) Vaatimus Lähde Kuvaus Selitys Liittyy UC:n F16 Järjestelmän Kokous Järjestelmässä on Ylläpitäjä luo järjestelmän - Korkea ylläpitäjä 3.12.2004 käyttäjätunnus ylläpitäjälle, rakenteet, ja luo käyt- joka täjätunnuksia vastaavalla pystyy muuttamaan, tavalla kuin muissa tieto- luomaan järjestelmissä. uutta ja poistamaan vanhaa sisältöä ilman rajoituksia. Ylläpitäjä pystyy luomaan, poistamaan ja muokaamaan opettajia, opiskelijoita ja työryhmiä. F17 Opettajan Projektiryhmä Opettaja-tyyppisestä Järjestelmän sujuva käyt- - Korkea tietojen tallettaminenetaan käyttäjästä tallentö vaatii e.m. tietoja. Ti- käyttäjätunnus, etoturvasyistä salasanaa ei nimi, ole- tallenneta selväkielisenä. tustyöryhmä, kieli ja todennusmenetelmä. Paikallista todennusta varten järjestelmään voidaan tallentaa salasanan F18 Tiedot diplomityöstä Kokous 3.12.2004 F19 Statukset Kokous 20.1.2005 F20 F21 F22 F23 F24 F25 Ryhmäkohtaisen muistiinpanon tekeminen Opiskelijakohtaisten muistiinpanojen selaus Ryhmäkohtaisten muistiinpanojen selaus Muistiinpanojen haut Opiskelijan tietojen muokkaus Omien tietojen muokkaus tiiviste. Opiskelijan diplomityön statuksen lisäksi, järjestelmään tallennetaan päivämäärä, jolloin D-työn aihe hyväksyttiin osastoneuvostossa ja päivämäärä jolloin itse D-työ hyväksyttiin. Opiskelijan tietoihin tallennetaan diplomityön status Asiakas Järjestelmään pystytään tallentamaan muistiinpano joka koskee koko ryhmää Asiakas Muistiinpanot selataan opiskelijakohtaisesti Asiakas Tiettyä työryhmää koskevat muistiinpanot pitää pystyä selaamaan Asiakas Muistiinpanoja pitää pystyä hakemaan järjestelmästä Projektiryhmä Projektiryhmä Opettajan pitää pystyä muokkaamaan opiskelijan tietoja Opettajan pitää pystyä muokkaamaan omia tietoja Diplomityön aihe voi vanhentua, ja siksi pvm pitää pystyä tallentamaan järjestelmään. Päivämäärän perusteella löytää myös pöytäkirjan, jossa asiaa käsiteltiin. Statukset ovat: Ei aloitettu, Aiheesta keskusteltu, Aihe hyväksytty, Työ käynnistynyt, Työ melkein valmis, Työ valmis, Opiskelija valmistunut. Kurssiin liittyvät asiat on kätevä tallentaa ilman että ne liittyisivät tiettyyn opiskelijaan Yleensä opettaja haluaa nähdä kaikki tiettyyn opiskelijaan liittyvät muistiinpanot samaan aikaan Opettajat tarvitsevat usein esim. tietoa kaikista kurssin erikoisjärjestelyistä. Ajan myötä tietomäärä kasvaa, ja tehokas hakujärjestelmä auttaa löytämään oleellisen tiedon nopeasti. On tärkeää, että kaikki pystyvät päivittämään tietoja, jotta ne säilyvät ajan tasalla. On tärkeää että käyttäjä pystyy ylläpitämään omia tietoja, jotta ne ovat ajan tasalla. U2 Korkea - Korkea - Korkea - Korkea - Korkea - Korkea - Korkea - Korkea 9
(Jatkoa edelliseltä sivulta) Vaatimus Lähde Kuvaus Selitys Liittyy UC:n F26 Yksinkertainen haku - Korkea F27 Asiakas Järjestelmässä pitää olla nopea, yksinkertainen haku, jolla voi hakea opiskelijan tiedot Kalenterityökalu Asiakas Päivämäärät pitää pystyä syöttämään myös kalenterinäkymästä Opiskelijan haku on usein toistuva tehtävä, ja tämä haku nopeuttaa järjestelmän käytöä. Päivämäärä on joskus helpompi syöttää klikkaamalla päivämäärää kalenterista kuin kirjoittaa se tekstikenttään - Korkea 10
8 Ei-toiminnalliset vaatimukset Tässä luvussa esitellään järjestemän ei-toiminnalliset vaatimukset. Ei-toiminnallisiin vaatimuksiin liittyvien tunnisteiden, statusten ja prioriteettien selitykset löytyvät luvusta 2. Vaatimus Lähde Selitys N1 Järjestelmää voitava Kokous Opiskelijat käyttävät käyttää sekä TML:n 1.10.2004 järjestelmää liki poikkeuksetta verkosta että muualta TML:n ulkopuolelta. Internetistä Opettajat tarvitsevat mahdollisuuden järjestelmän käyttöön myös esimerkiksi etätöitä tehdessään. N2 Työryhmät U7 Järjestelmässä on työryhmiä, joihin kuuluu käyttäjiä. Kukin muistiinpano kuuluu yhteen työryhmään. Työryhmän jäsenet näkevät työryhmään tehdyt muistiinpanot. Työryhmät määrittävät mitä tietoja käyttäjä pääsee näkemään. Käyttäjä voi kuulua useampaan työryhmään. N3 Tunnistus ja valtuutus Tietoturvavastaava N4 Järjestelmän on oltava niin nopea ja helppokäyttöinen, että sitä voi käyttää myös opiskelijan kanssa käytävän keskustelun lomassa. N5 Järjestelmästä pitää kirjoittaa rekisteriseloste. Kokous 7.10.2004 N6 Järjestelmä pitää suunnitella niin, että kieliä voidaan lisätä jälkeenpäin N7 Käyttöliittymä toteutetaan englanniksi Projektiryhmä Kokous 7.10.2004 Käyttäjät pääsevät käsiksi vain niihin tietoihin, joihin heille on annettu lupa Järjestelmän tiedot ovat tarkoitettu vain henkilökunnan käyttöön. Henkilötietolaki vaatii että henkilötiedot käsitellään luottamuksellisesti. Opettajat saattavat haluta nähdä vanhoja opiskelijaan liittyviä muistiinpanoja keskustellessaan hänen kanssaan. Samoin useat tallennettavat muistiinpanot tulevat esiin opiskelijan kanssa keskustellessa. Jotta muistiinpanosta tulisi tarkka, sen tallentaminen pitäisi olla mahdollista tehdä keskutelun lomassa. Projektiryhmä Järjestelmä sisältää henkilötietoja henkilötietolain (523/1999) tarkoittamassa muodossa. Henkilötietolaki (523/1999, 10 ) velvoittaa laatimaan rekisteriselosteen. Saattaa tulla tilanteita, joissa järjestelmää täytyy tai olisi hyvä voida käyttää useammalla kielellä. Englanti on ainoa kieli, jota kaikki järjestelmän käyttäjät ymmärtävät. 11
(Jatkoa edelliseltä sivulta) Vaatimus Lähde Selitys N8 Käyttöliittymä toteutetaan Projekti- Suomenkielisten käyttäjien Matala suomeksi ryhmä saattaa olla miellyttäväm- pää käyttää järjestelmää N9 Diplomityön ohjaajalla pitää olla pääsy tietyn opiskelijan kaikkiin tietoihin N10 Ylläpitokäyttöliittymän täytyy selvästi erota opettajakäyttöliittymästä Asiakas Kokous 3.12.2004 äidinkielellään. DI-työn ohjaaja tarvitsee vastaavat oikeudet kuin professori, mutta vain nimetyn opiskelijan osalta. Ylläpitäjä pystyy toimimaan täysin rajoituksetta, ja siksi käyttöliittymän pitää muistuttaa käyttäjää ylläpitäjän oikeustasosta. Korkea Ei toteuteta Korkea 9 Käyttäjätapaukset Tässä luvussa kuvataa järjestelmän vaatimuksia käyttäjätapausten avulla. Käyttäjätapauksia laatiessa käytettiin apuna HTML-prototyyppiä järjestelmän käyttöliittymästä. 12
9.1 Opiskelijan tietojen hakeminen U1 Nimi Opiskelijan tietojen hakeminen Esiehdot Opettaja A on kirjautunut järjestelmään (Usecase U9 ). Normaali kulku 1. Opettaja A valitsee työkaluvalikosta toiminnon Hae opiskelija. 2. Opettaja A syöttää opiskelijan opiskelijanumeron sekä vapaaehtoisen tarkistuskirjaimen hakutoimintoon. 3. Järjestelmä näyttää opiskelijan tiedot (Usecase U2 ). Poikkeukset 2a. Opettaja A syöttää opiskelijan nimen tai nimen osan hakutoimintoon Jälkiehdot - Liittyy vaatimukseen F2 Liittyy testiin - 1. Järjestelmä näyttää opiskelijan tiedot (Usecase U2 ). 1a. Järjestelmä näyttää listan hakua vastaavista opiskelijoista. 1. Opettaja A valitsee listasta haluamansa opiskelijan. 2. Järjestelmä näyttää opiskelijan tiedot (Usecase U2 ). 2b. Opettaja A käyttää edistynyt haku -toimintoa. 1. Järjestelmä näyttää hakua vastaavan opiskelijan yleiset sekä työryhmän T syöttämät tiedot. 1a. Järjestelmä näyttää listan hakua vastaavista opiskelijoista. 1. Opettaja A valitsee listasta haluamansa opiskelijan. 2. Järjestelmä näyttää opiskelijan tiedot (Usecase U2 ). 3a. Järjestelmästä ei löydy haulla mitään. 1. Järjestelmä näyttää virheilmoituksen. 2. Järjestelmä tarjoaa Lisää uusi opiskelija -toimintoa (Usecase U3 ). 13
9.2 Opiskelijan tietojen näyttäminen Nimi Esiehdot Normaali kulku U2 Opiskelijan tietojen näyttäminen Opettaja A on kirjautunut järjestelmään (Usecase U9 ). Opettajan A aktiivinen työryhmä on T. (Usecase U1 ) 1. Järjestelmä näyttää opiskelijan yleiset tiedot. 2. Järjestelmä näyttää opiskelijan diplomityön statuksen ja onko opiskelija jatko-opiskelija. 3. Järjestelmä näyttää kaikki työryhmän T opiskelijasta syöttämät tiedot. Poikkeukset 3a. Opettajalla A on työryhmänäkymänä näytä kaikki omien työryhmien merkinnät. Jälkiehdot - Liittyy vaatimukseen F3, F5 Liittyy testiin - 1. Järjestelmä näyttää kaikkien opettajan A työryhmien opiskelijasta syöttämät tiedot. 3b. Opettajalla A on valittuna näytä vain aktiiviset muistiinpanot. 1. Järjestelmä näyttää kaikki sellaiset työryhmän T opiskelijasta syöttämät tiedot, jotka eivät ole vielä vanhentuneet. 14
9.3 Uuden opiskelijan syöttäminen U3 Nimi Uuden opiskelijan syöttäminen Esiehdot Opettaja A on kirjautunut järjestelmään (Usecase U9 ) Normaali kulku 1. Opettaja A valitsee työkaluvalikosta toiminnon Lisää uusi opiskelija. 2. Järjestelmä tarjoaa lomakkeen, jolla siihen voi syöttää opiskelijan tiedot. 3. Opettaja A täyttää lomakkeen ja tallentaa sen järjestelmään. Poikkeukset 3a. Opiskelijatiedot ovat jo järjestelmässä. 1. Järjestelmä näyttää virheilmoituksen. 2. Järjestelmä ehdottaa mahdolliseksi toiminnoksi järjestelmässä jo olevan opiskelijan tietojen näyttämistä. 3b. Kaikkia tarvittavia tietoja ei syötetty. 1. Järjestelmä näyttää puutteet selittävän virheilmoituksen ja palauttaa opettajan lomakenäkymään. Jälkiehdot Järjestelmään tallennetaan uusi opiskelija Liittyy vaatimukseen F3 Liittyy testiin - 15
9.4 Opiskelijakohtaisen muistiinpanon tekeminen Nimi Esiehdot Normaali kulku U4 Opiskelijakohtaisen muistiinpanon tekeminen Usecase U1 ja Usecase U9 1. Järjestelmä näyttää opiskelijanäkymässä lomakkeen, jolla voi syöttää määrämuotoisen muistiinpanon. Muistiinpanolomake sisältää seuraavat kentät: - Vapaamuotoinen tekstikenttä - Päiväys, Eräpäivä - Työryhmä, johon muistiinpano liittyy (esim. kurssikoodi tai diplomityö) Lisäksi järjestelmä täyttää automaattisesti kentät: - Muokkauspäivämäärä, eli milloin muistiinpanoa viimeksi muutettiin. - Muokkaaja, eli kuka muutti muistiinpanoa viimeksi. 2. Opettaja A täyttää lomakkeen tarpeellisilta osin ja tallentaa sen järjestelmään. Poikkeukset 2a. Muistiinpanolle halutaan antaa eräpäivä. 1. Opettaja A käyttää helppokäyttöistä päivämääränsyöttötyökalua ja valitsee haluamansa päivän tai syöttää haluamansa päivämäärän tekstikenttään. 2b. Muistiinpanolle halutaan jokin muu kuin sillä hetkellä aktiivinen työryhmä. Jälkiehdot Uusi muistiinpano tallennetaan Liittyy vaatimukseen F1 Liittyy testiin - 1. Opettaja A valitsee työryhmän, johon muistiinpano kuuluu. 16
9.5 Perusopintojen statuksen päivittäminen U5 Nimi Perusopintojen statuksen päivittäminen Esiehdot Usecase U1 ja Usecase U9. Normaali kulku 1. Järjestelmä näyttää opiskelijanäkymässä mahdolliset tilat perusopinnoille. 2. Opettaja A valitsee haluamansa vaihtoehdon. 3. Järjestelmä tallentaa opiskelijan perusopinnoille uuden statuksen. Poikkeukset - Jälkiehdot Opiskelijan perusopintostatus vaihtuu Liittyy vaatimukseen F3 Liittyy testiin - 9.6 Jatko-opintojen statuksen päivittäminen Nimi Esiehdot Normaali kulku U6 Jatko-opintojen statuksen päivittäminen Usecase U2 ja Usecase U9 1. Järjestelmä näyttää opiskelijanäkymässä jatkoopintostatuksen. 2. Opettaja A valitsee haluamansa vaihtoehdon. 3. Järjestelmä tallentaa opiskelijan jatko-opinnoille uuden statuksen. Poikkeukset - Jälkiehdot Opiskelijan jatko-opintostatus muuttuu Liittyy vaatimukseen F3 Liittyy testiin - 17
9.7 Työryhmän vaihtaminen Nimi Esiehdot Normaali kulku U7 Työryhmän vaihtaminen Opettaja A on kirjautunut järjestelmään Usecase U9 1. Järjestelmä näyttää työkaluvalikossa työryhmävaihtoehtoina opettajan A kaikki työryhmät. 2. Opettaja A valitsee haluamansa vaihtoehdon. Poikkeukset - Jälkiehdot Aktiivinen työryhmä muuttuu Liittyy vaatimukseen N2, F1, F4 Liittyy testiin - 3. Järjestelmä vaihtaa opettajan A aktiiviseksi työryhmäksi valitun vaihtoehdon. 9.8 Työryhmänäkymän vaihtaminen Nimi Esiehdot Normaali kulku U8 Työryhmänäkymän vaihtaminen Opettaja A on kirjautunut järjestelmään Usecase U9 1. Järjestelmä näyttää työkaluvalikossa vaihtoehdot näytä kaikki omien työryhmien merkinnät ja näytä vain aktiivisen työryhmän merkinnät. Poikkeukset - Jälkiehdot Työryhmänäkymä vaihtuu Liittyy vaatimukseen N2, F1, F4 Liittyy testiin - 2. Opettaja A valitsee haluamansa vaihtoehdon. 3. Järjestelmä vaihtaa opettajan A työryhmänäkymäksi valitun vaihtoehdon. 18
9.9 Kirjautuminen järjestelmään Nimi Esiehdot Normaali kulku U9 Kirjautuminen järjestelmään A on avannut järjestelmän etusivun www-selaimessa 1. A kirjoittaa käyttäjätunnuksensa kenttään käyttäjätunnus ja salasanansa kenttään salasana. 2. A klikkaa painiketta kirjaudu tai painaa enteriä. 3. A on kirjautunut järjestelmään. Työryhmäksi asetetaan käyttäjän määrittämä oletustyöryhmä. Poikkeukset 3a. A:n antama käyttäjätunnus tai salasana on virheellinen. Järjestelmä näyttää sisäänkirjautumislomakkeen, jossa on mukana virheilmoitus. 3b. Ulkoinen autentikointi epäonnistui. Järjestelmä näyttää sisäänkirjautumislomakkeen, jossa on ongelmaa kuvaava virheilmoitus. Jälkiehdot Käyttäjä on kirjautunut järjestelmään Liittyy vaatimukseen F9, F12, F13, N2, N3 Liittyy testiin - 10 Rajoitukset C1 Aihe HTML-kielen versio Kuvaus Järjestelmän tuottamat www-sivut noudattavat XHTML 1.0 - suositusta Perustelu Asiakkaalla on monta eri selainta ja alustaa käytössä. Vain noudattamalla virallisia suosituksia tarkasti voidaan taata, että järjestelmä toimii kaikissa ympäristöissä. Järjestelmä käyttää 1.1 suosituksen sijaan suositusta 1.0, sillä Microsoft Internet Explorer ei tue suositusta 1.1. Lähde Koko ryhmä Käyttötapaukset Kaikki C2 Aihe PHP-kielen versio Kuvaus Järjestelmä toteutetaan PHP:n versiolla 5. Perustelu PHP 5 tukee olio-ohjelmointia, jota projektiryhmä haluaa käyttää järjestelmän toteutuksessa. Lähde Projektiryhmä Käyttötapaukset Kaikki 19
C3 Aihe Tietokantaohjelmisto Kuvaus Järjestelmä käyttää PostgreSQL-tietokantaa datan tallentamiseen. Perustelu PostgreSQL tukee transaktioita. Lähde Asiakas ja projektiryhmä Käyttötapaukset Kaikki C4 Aihe Tietokantarajapinta Kuvaus Järjestelmä käyttää Pear DB-rajapintaa PHP:ssä tietokantayhteyttä varten. Perustelu Ratkaisu helpottaa koodin siirrettävyyttä. Lähde Projektiryhmä Korkea Käyttötapaukset Kaikki 11 Viitteet Projektisuunnitelma Kuvaa projektiryhmää ja projektin taustat. 20