Vaatimusdokumentti. Halaan-ryhmä. Helsinki Ohjelmistotuotantoprojekti HELSINGIN YLIOPISTO Tietojenkäsittelytieteen laitos

Transkriptio

1 Vaatimusdokumentti Halaan-ryhmä Helsinki Ohjelmistotuotantoprojekti HELSINGIN YLIOPISTO Tietojenkäsittelytieteen laitos

2 Kurssi Ohjelmistotuotantoprojekti (6 ov) Projektiryhmä Paula Kemppi Liisa Oikarinen Ville Palkosaari Maria Rinta-Opas Jaakko Sorri Marjaana Välisalo Asiakas Terttu Nevalainen Johtoryhmä Ilari Moilanen Kimmo Simola Kotisivu Versiohistoria Versio Päiväys Tehdyt muutokset Katselmoitava versio Katselmoinnissa päätetyt korjaukset Oikoluvun pohjalta tehdyt korjaukset Asiakaspalautteen pohjalta tehdyt korjaukset

3 Sisältö i 1 Johdanto 1 2 Sanasto Yleissanasto Tekninen sanasto Käyttötapaukset Käytön aloitus ja järjestelmään siirtyminen Järjestelmään rekisteröityminen Järjestelmään kirjautuminen Käyttäjätietojen hallinnointi Käyttäjän rekisteröiminen Käyttäjän tietojen tutkiminen, päivittäminen ja poistaminen Korpuksen päivitys Tietojen lisääminen Tietojen korjaaminen ja poisto Hakukoneen käyttö Kirjeiden tai henkilöiden haku Hakutuloksen graafisen esityksen muokkaaminen Hakutuloksen listaesityksen muokkaaminen Kirjeiden tallentaminen / vienti Kirje- tai henkilölistan tallentaminen Graafisen esityksen tallentaminen Haun parametrien tallentaminen Kirjeen katselu Kirjoittajan tai vastaanottajan tietojen katselu Hakuhistorian katsominen ja käyttö Järjestelmästä poistuminen Uloskirjautuminen Käyttäjävaatimukset Toiminnalliset vaatimukset Sisäänkirjautuminen I

4 ii Sisäänkirjautuminen II Uloskirjautuminen Käyttäjätietojen hallinnointi Tietokannan tietojen lisäys Tietokannan tietojen päivitys Hakuparametrit I Hakutuloksen vienti I Hakutuloksen vienti II Hakutuloksen esittäminen Hakutuloksen muokkaus I Hakuparametrit II Hakutuloksen tarkastelu I Hakutuloksen tarkastelu II Hakutuloksen muokkaus II Käyttäjäryhmät Hakutuloksen vienti III Ei-toiminnalliset vaatimukset Käyttöalusta Käyttöohje Laajennettavuus Järjestelmävaatimukset Toiminnalliset vaatimukset Käyttäjätietojen hallinnointi Hakuehtojen määrittäminen Ei-toiminnalliset vaatimukset Tietoturva I Tietoturva II Nopeus Laajennettavuus Järjestelmäarkkitehtuuri ja -mallit Arkkitehtuuri Käyttöliittymä

5 iii Toiminnalliset osat Tietovuokaavio Tietokanta Järjestelmän elinkaari Käyttöönotto Järjestelmän ylläpito Käytöstä poistaminen Liitteet 1 Hakuparametrit 2 Parametrit

6 1 Johdanto 1 VARIENG-tutkimusyksikön tutkijat ovat koonneet elektronisen tekstiaineiston eli korpuksen vanhoista englanninkielisistä kirjeistä. Kirjeiden lisäksi tutkimusyksiköllä on kerättynä muutakin kirjeisiin liittyvää dataa, kuten tietoja kirjeiden kirjoittajista ja vastaanottajista. Nyt tutkijat kaipaavat hakukonetta, joka mahdollistaisi sosiolingvistiset haut, eli kirjeiden ja niihin liittyvien tietojen hakemisen tietokannasta esimerkiksi kirjoittajan sukupuolen, asuinpaikan ja kirjoitusajankohdan perusteella. Hakukoneen toteuttamiseksi käynnistettiin syyskuussa 2006 Helsingin yliopiston tietojenkäsittelytieteen laitoksella Halaan-projekti, jonka osallistujat (Paula Kemppi, Liisa Oikarinen, Ville Palkosaari, Maria Rinta-Opas, Jaakko Sorri ja Marjaana Välisalo) suorittavat projektiin osallistumalla kurssin Ohjelmistotuotantoprojekti. Ryhmän ohjaajana toimii Ilari Moilanen. Projektin tehtävänä on tuottaa järjestelmä, joka toimii hakukoneena edellä mainitulle aineistolle ja mahdollistaa myös kirjeiden lisäyksen ja muokkauksen sekä haulla rajatun osa-aineiston tallentamisen. Tämä dokumentti määrittelee toteutettavan ohjelmiston toiminnallisuuksineen ja toimii siten asiakkaan ja toteuttajien välisenä sopimuksena. 2 Sanasto 2.1 Yleissanasto Boolean-tyyppinen arvo Arvo, joka voi olla vain joko tosi tai epätosi. Data Yhteydestä riippuen viittaa joko tekstidataan (kirjeiden sisältö) tai metadataan (data, johon haut kohdistuvat). Hakulomake Hakusivu, josta käyttäjä voi valita hakuun vaikuttavat parametrit. Haku kohdistuu joko kirjeisiin tai kirjeiden kirjoittajiin tai vastaanottajiin. Hakutulos Hakuehtoihin täsmäävä lista joko kirjeistä tai niiden kirjoittajista tai vastaanottajista. Viitattaessa hakutuloksen tallennettavaan versioon pyritään puhumaan taulukosta tai CSV-tiedostosta. Hakutuloksesta voidaan tehdä myös graafinen esitys. Instanssi Tietokannassa esiintyvä yksi kokonaisuus, esimerkiksi kirje tai kirjoittaja. Yksi käyttäjä ja sen tiedot käyttäjärekisterissä. Järjestelmä Hakukone, hakujärjestelmä. Koodi-tyyppinen arvo Arvo, jonka arvoalue on rajattu. Korpus Elektroninen tekstiaineisto.

7 Luokitteleva parametri Graafisen esityksen X-akselille sijoittuva parametri. Tämä parametri on oletuksena Aika, mutta se voi olla jokin muukin parametri, kunhan valitun parametrin arvot ovat koodi- tai boolean-tyyppisiä. Metadata Kirjeteksteihin liittyvä tieto, joka kuvaa itse kirjettä ja sen kirjoittajaa tai vastaanottajaa. Data, jota parametrit kuvaavat ja johon haut kohdistuvat Tekninen sanasto CSV Comma-separated values Tekstitiedosto, jossa tietueet (taulukon rivit) ovat omilla riveillään ja arvot on eroteltu erotinmerkillä, esimerkiksi pilkulla tai sarkaimella. ER-malli Entity-relationship Tietokannan suunnittelussa käytettävä yksilö-yhteys -käsitemalli. HTTP Hypertext Transfer Protocol Protokolla, jota selaimet ja WWW-palvelimet käyttävät tiedonsiirtoon. Oracle Eräänlainen relaatiotietokanta. SQL Structured Query Language Kyselykieli, jolla relaatiotietokantaan on mahdollista tehdä erilaisia hakuja, muutoksia ja lisäyksiä. Tietovuokaavio Kaavio, joka kuvaa tiedon kulkua ja kulkusuuntia järjestelmän osien välillä. WWW-selain Valitsimme referenssiselaimiksi Internet Explorer 6:n ja Firefox 1.4:n. 3 Käyttötapaukset Käyttötapaus kuvaa jonkin järjestelmän toiminnon järjestelmän käyttäjän näkökulmasta. Käyttötapaukset on ryhmitelty viiteen eri ryhmään seuraavasti: Käytön aloitus ja järjestelmään siirtyminen, käyttäjätietojen hallinnointi, korpuksen päivitys ja hakukoneen käyttö sekä järjestelmästä poistuminen. Jokaisella käyttötapauksella on toimija. Tässä toimijana on käyttäjä, mikäli käyttötapaus liittyy toimintoon, johon useimmilla käyttäjillä on oikeudet. Toimijana on pääkäyttäjä mikäli käyttötapauksessa kuvattu toiminto edellyttää tavallista laajemmat oikeudet. Alkutila kuvaa välttämättömät edellytykset käyttötapauksen suorittamiselle. Lopputila kuvaa tilan, joka on saavutettu, kun käyttötapaus on suoritettu onnistuneesti. Lisäksi käyttötapauksista on esitetty kuvaus sekä mahdolliset poikkeukset ja rajoitukset. Vaatimusviite viittaa siihen lukuun, jossa käyttötapaukseen liittyvä vaatimus on esitelty.

8 3 3.1 Käytön aloitus ja järjestelmään siirtyminen Järjestelmään rekisteröityminen Toimija: Käyttäjä Alkutila: Käyttäjä ei ole rekisteröitynyt järjestelmään. Lopputila: Käyttäjä on rekisteröitynyt ja saa oikeuden käyttää järjestelmää. Kuvaus: Käyttäjä ottaa yhteyttä pääkäyttäjään, jolla on oikeudet lisätä järjestelmään käyttäjiä. Pääkäyttäjän yhteystiedot löytyvät kirjautumissivulta. Pääkäyttäjä luo käyttäjälle tunnukset järjestelmään ja luovuttaa ne hänelle. Poikkeukset/rajoitukset: - Vaatimusviite: Järjestelmään kirjautuminen Toimija: Käyttäjä Alkutila: Järjestelmän käyttö edellyttää, että käyttäjä on rekisteröity järjestelmän käyttäjäksi eli hänellä on käyttäjätunnus ja salasana. Käyttäjä on siirtynyt järjestelmän sisäänkirjautumissivulle. Lopputila: Käyttäjä on kirjautuneena ja pystyy käyttämään järjestelmää. Käyttäjä on ohjattu hakusivulle. Kuvaus: Käyttäjä syöttää tunnuksensa ja salasanansa sisäänkirjautumissivulla niille varattuihin kenttiin. Jos tunnukset löytyvät käyttäjätietokannasta, käyttäjä pääsee käyttämään järjestelmää. Poikkeukset/rajoitukset: Jos käyttäjä naputtelee tunnuksensa tai salasanansa väärin, tulostetaan virheilmoitus. Jos käyttäjä on unohtanut joko tunnuksensa tai salasanansa, tulee hänen ottaa yhteyttä pääkäyttäjään, jonka yhteystiedot löytyvät kirjautumissivulta. Vaatimusviite: 4.1.1, Käyttäjätietojen hallinnointi Käyttäjän rekisteröiminen Toimija: Pääkäyttäjä Alkutila: Pääkäyttäjä on kirjautuneena järjestelmään ja siirtynyt käyttäjän rekisteröintisivulle.

9 Lopputila: Uuden käyttäjän tiedot on rekisteröity ja hän pääsee käyttämään järjestelmää. Kuvaus: Pääkäyttäjä luo käyttäjäksi haluavalle tunnukset järjestelmään. Tiedot lisätään web-lomakkeen kautta. Käyttäjä liitetään rekisteröitymisen yhteydessä yhteen tietokannassa määritellyistä hierarkkisista käyttäjäryhmistä. Ryhmästä riippuen käyttäjälle annetaan asianmukaiset käyttöoikeudet järjestelmän toimintoihin ja aineistoihin. Tunnukset luovutetaan käyttäjälle henkilökohtaisesti tai esimerkiksi sähköpostilla. Poikkeukset/rajoitukset: Jos käyttäjä on jo rekisteröitynyt järjestelmään tai syötetty käyttäjätunnus on jo olemassa, siitä ilmoitetaan rekisteröintiyrityksen yhteydessä. Vaatimusviite: 4.1.4, Käyttäjän tietojen tutkiminen, päivittäminen ja poistaminen Toimija: Pääkäyttäjä Alkutila: Pääkäyttäjä on kirjautuneena järjestelmään ja siirtynyt sivulle, jolta käyttäjätietojen katselu ja päivittäminen onnistuu. Lopputila: Käyttäjän tietoja on päivitetty, ne on poistettu tai niitä on tarkasteltu. Kuvaus: Järjestelmän käyttäjät esitetään järjestettynä listana. Käyttäjän nimi toimii linkkinä, jota painamalla kyseisen käyttäjän tiedot näytetään lomakkeella. Pääkäyttäjä päivittää käyttäjän tiedot suoraan lomakkeeseen, jonka jälkeen Save changes - nappia painamalla tiedot tallentuvat tietokantaan. Käyttäjän tiedot poistetaan tietokannasta Delete user -nappia painamalla. Poikkeukset/rajoitukset: Jos tallennettavissa tiedoissa on puutteita tai virheitä, annetaan virheilmoitus. Vaatimusviite: 4.1.4, Korpuksen päivitys Tietojen lisääminen Toimija: Pääkäyttäjä Alkutila: Pääkäyttäjä on kirjautuneena järjestelmään ja siirtynyt sivulle, jossa tietoja pystyy lisäämään. Lopputilta: Uuden kirjeen, kirjoittajan tai vastaanottajan tiedot on lisätty tietokantaan. Kuvaus: Tiedot lisätään tietokantaan tiedostosta. Tiedostosta tiedot latautuvat lomakkeeseen, jossa niitä pystyy muokkaamaan. Lomake lähetetään, jolloin tiedot tallentuvat tietokantaan.

10 Poikkeukset/rajoitukset: Jos vaadituissa kentissä on puutteita tai tiedot on syötetty virheellisesti, tulostetaan virheilmoitus. Mikäli yritetään lisätä dataa olemassa olevilla tunnistetiedoilla, käyttäjältä pyydetään varmistus ennen kuin kannassa olevat tiedot korvataan. Vaatimusviite: Tietojen korjaaminen ja poisto Toimija: Pääkäyttäjä Alkutila: Pääkäyttäjä on kirjautuneena järjestelmään ja siirtynyt sivulle, jossa tietoja pystyy poistamaan. Lopputila: Yhden tai useamman kirjeen tai henkilön tiedot on poistettu tietokannasta tai niitä on päivitetty. Kuvaus: Poistettava data voidaan hakea kirjeen tunnisteen, kokoelman, kirjoittajan tai vastaanottajan nimen perusteella. Tämän jälkeen poistettava data voidaan valita tulokseksi saadusta listasta. Valitut kirjeet tai henkilöt poistetaan Delete -nappia painamalla. Tietojen päivitys tapahtuu lomakenäkymässä ja muutokset tallennetaan Save changes -napilla. Kirjeen poiston yhteydessä ehdotetaan myös kirjeen kirjoittajan tai vastaanottajan poistoa, mikäli näihin ei liity muita kirjeitä. Kirjoittajan poisto poistaa myös kirjoittajan kirjoittamat kirjeet, mutta ei henkilön pysyviä tietoja, mikäli samaan henkilöön liittyy myös vastaanotettuja kirjeitä. Poikkeukset/rajoitukset: Jos haettua kirjettä tai henkilöä ei löydy, tulostetaan virheilmoitus. Vaatimusviite: Hakukoneen käyttö Kirjeiden tai henkilöiden haku Toimija: Käyttäjä Alkutila: Käyttäjä on kirjautuneena järjestelmään ja siirtynyt hakusivulle. Lopputila: Haku on suoritettu ja tulokset näkyvät käyttäjälle. Kuvaus: (Käyttäjä valitsee joko perushaun tai tarkennetun haun.) Tämän jälkeen valitaan hakuparametreille halutut arvot. Hakuparametrit on esitetty liitteessä 1. Hakuehdoissa valitaan myös, halutaanko tuloksena kirjeitä, henkilöitä vai kokoelmia, ja määritetään, mihin aineiston osaan eli korpusversioon haku kohdistetaan. Tämän jälkeen painetaan Search -painiketta. Tuloksena näytetään hakuun täsmänneet yksilöt listassa sekä graafinen esitys näiden jakaumasta. Hakuparametrien arvot jäävät hakulomakkeeseen, jolloin hakua on mahdollista palata muokkaamaan.

11 Poikkeukset/rajoitukset: Jos hakutulos on tyhjä, käyttäjälle tulostetaan asianmukainen virheilmoitus. Mikäli käyttäjällä on tallennettuja hakuja, parametrien valitseminen hakuhistorian kautta on mahdollista. Vaatimusviite: 4.1.7, Hakutuloksen graafisen esityksen muokkaaminen Toimija: Käyttäjä Alkutila: Käyttäjä on suorittanut haun, jonka pohjalta on tulostettu graafinen esitys ja lista kirjeistä tai henkilöistä. Lopputila: Hakutuloksen graafista esitystä on muokattu. Kuvaus: Graafinen esitys on pylväsdiagrammi. Oletusarvoisesti luokittelevana parametrina on aika ja yhden luokan koko on viidennes tarkasteltavasta ajanjaksosta. Pylvään kuvaaman ajanjakson pituutta voidaan kuitenkin tulossivulla säätää. Luokitteleva parametri on myös mahdollista vaihtaa. Hakua voidaan rajata valitsemalla yksi tai useampi pylväs, jolloin myös tuloslista päivittyy. Poikkeukset/rajoitukset: Luokitteleviksi parametreiksi tarjotaan vain sellaisia, jotka saavat boolean- tai koodityyppisiä arvoja. Pylvään korkeus määräytyy henkilöhauissa lukumäärän perusteella ja kirjehauissa aina näiden sisältämien sanojen lukumäärän perusteella. Vaatimusviite: Hakutuloksen listaesityksen muokkaaminen Toimija: Käyttäjä Alkutila: Käyttäjä on suorittanut haun, jonka pohjalta on tulostettu graafinen esitys ja lista kirjeistä tai henkilöistä. Lopputila: Hakutuloksen listaa kirjeistä tai henkilöistä on muokattu. Kuvaus: Tuloslistassa näytetään haetuista kirjeistä tai henkilöistä parametrit, jotka asiakas erikseen määrittelee. Otsikkorivillä tarjotaan kuitenkin mahdollisuus parametrien esiintuomiseen, piilottamiseen ja järjestämiseen. Lisäksi käyttäjä voi järjestää listan rivit haluamansa parametrin perusteella klikkaamalla kyseisen sarakkeen otsikkoa. Poikkeukset/rajoitukset: Pitkiä, vapaamuotoisia kuvauksia sisältäviä parametreja ei tarjota listanäkymään vaan näitä pääsee tutkimaan yksityiskohtaisemmasta näkymästä kirjeen tunnistetta tai henkilön nimeä klikkaamalla. Vaatimusviite:

12 Kirjeiden tallentaminen / vienti Toimija: Käyttäjä Alkutila: Käyttäjä on kirjautuneena järjestelmään ja suorittanut tuloksekkaan haun, jolla on haettu kirjeitä. Lopputila: Haettujen kirjeiden muodostama osakorpus on tallennettu käyttäjän omiin tiedostoihin. Kuvaus: Tuloksekkaan haun jälkeen käyttäjä voi tallentaa kirjeet tekstimuodossa Export -nappia painamalla. Kirjeiden järjestys tiedostossa voidaan tässä yhteydessä vielä erikseen määritellä. Poikkeukset/rajoitukset: Jos käyttäjällä ei ole oikeuksia omien hakujen tallentamiseen, annetaan virheilmoitus. Vaatimusviite: 4.1.8, Kirje- tai henkilölistan tallentaminen Toimija: Käyttäjä Alkutila: Käyttäjä on kirjautuneena järjestelmään ja suorittanut tuloksekkaan haun, jolla on haettu kirjeitä tai henkilöitä. Lopputila: Tiedot kirjeistä, lähettäjistä ja vastaanottajista on tallennettu käyttäjän omiin tiedostoihin. Kuvaus: Tuloksekkaan haun jälkeen käyttäjä voi tallentaa kirjeisiin liittyvän metadatan tekstimuotoisena taulukkona Save -painiketta painamalla. (Eri taulukoihin tulevat parametrit määritellään myöhemmin.) Poikkeukset/rajoitukset: Jos käyttäjällä ei ole oikeuksia metadatan tallentamiseen, annetaan virheilmoitus. Vaatimusviite: Graafisen esityksen tallentaminen Toimija: Käyttäjä Alkutila: Käyttäjä on kirjautuneena järjestelmään ja suorittanut tuloksekkaan haun. Lopputila: Käyttäjä on tallentanut hakutuloksen graafisen esityksen omiin tiedostoihinsa. Kuvaus: Käyttäjä tallentaa hakutuloksen graafisen esityksen painamalla kuvan vieressä olevaa Save image -painiketta.

13 Poikkeukset/rajoitukset: Jos käyttäjällä ei ole oikeuksia kuvan tallentamiseen, annetaan virheilmoitus. Vaatimusviite: Haun parametrien tallentaminen Toimija: Käyttäjä Alkutila: Käyttäjä on kirjautuneena järjestelmään ja suorittanut haun. Lopputila: Käyttäjä on tallentanut tekemänsä haun parametrit. Tallentamisen jälkeen ne löytyvät käyttäjän omasta hakuhistoriasta (luku ). Kuvaus: Käyttäjä tallentaa hakuparametrit painamalla Save search -painiketta. Kyselyn voi halutessaan nimetä kuvaavasti. Poikkeukset/rajoitukset: Hakuhistoriassa olevien hakujen maksimimäärä määritellään käyttäjäryhmittäin. Jos käyttäjällä ei ole oikeuksia omien hakujen tallentamiseen, annetaan virheilmoitus. Vaatimusviite: Kirjeen katselu Toimija: Käyttäjä Alkutila: Käyttäjä on kirjautuneena järjestelmään ja on suorittanut tuloksekkaan haun, jolla on haettu kirjeitä. Lopputila: Käyttäjä on siirtynyt katselemaan kirjettä. Kuvaus: Tuloksekkaan haun jälkeen kirjeistä esitetään kirjelista. Kirjeen tunniste toimii linkkinä, jota painamalla kyseisen kirjeen tiedot ja tekstisisältö avautuvat uuteen ikkunaan. Poikkeukset/rajoitukset: - Vaatimusviite: Kirjoittajan tai vastaanottajan tietojen katselu Toimija: Käyttäjä Alkutila: Käyttäjä on kirjautuneena järjestelmään ja on suorittanut tuloksekkaan haun. Lopputila: Käyttäjä on siirtynyt katselemaan kirjoittajan tai vastaanottajan tietoja.

14 Kuvaus: Tuloslistassa kirjoittajan ja vastaanottajan nimet toimivat linkkeinä, joita painamalla on mahdollista nähdä henkilöiden tarkemmat tiedot uudessa ikkunassa. Poikkeukset/rajoitukset: - Vaatimusviite: Hakuhistorian katsominen ja käyttö Toimija: Käyttäjä Alkutila: Käyttäjä on kirjautuneena järjestelmään. Lopputila: Käyttäjä pääsee tarkastelemaan omaa hakuhistoriaansa. Kuvaus: Käyttäjä tarkastelee omia aikaisemmin tekemiään hakuja painamalla User information -painiketta. Jonkin tallennetun kyselyn valitseminen tuo hakuparametrien arvot hakulomakkeelle ja täten haun toistaminen tai muokkaaminen on mahdollista. Poikkeukset/rajoitukset: Jos käyttäjällä ei ole tallennettuja hakuja, hakuhistoriaa ei ole. Vaatimusviite: Järjestelmästä poistuminen Uloskirjautuminen Toimija: Käyttäjä Alkutila: Käyttäjä on kirjautuneena järjestelmään ja haluaa kirjautua ulos. Lopputila: Käyttäjä on kirjautunut ulos järjestelmästä. Kuvaus: Järjestelmästä kirjaudutaan ulos painimalla Logout -painiketta. Uloskirjautumisen jälkeen käyttäjä ohjataan aloitussivulle. Poikkeukset/rajoitukset: Myös selaimen sulkeminen johtaa käyttäjän uloskirjautumiseen. Vaatimusviite: Käyttäjävaatimukset Käyttäjävaatimukset kuvaavat asiakkaan vaatimuksia järjestelmän ominaisuuksiin ja käytettävyyteen liittyen. Käyttäjävaatimukset jaetaan toiminnallisiin ja ei-toiminnallisiin vaatimuksiin. Toiminnalliset vaatimukset kuvaavat järjestelmän tarjoamat palvelut ja järjestelmän toiminnan määritellyissä tilanteissa. Ei-toiminnalliset vaatimukset puolestaan ovat

15 rajoituksia ja reunaehtoja, jotka asetetaan järjestelmän toiminnalle. Vaatimusten priorisoinnissa käytetään seuraavaa notaatiota: A Erittäin tärkeä B Kohtalaisen tärkeä C Vähemmän tärkeä Toiminnalliset vaatimukset Sisäänkirjautuminen I Vaatimus: Järjestelmään tulee kirjautua ennen kuin hakukoneen käyttö on mahdollista. Prioriteetti: A Käyttötapausviite: 3.1.1, 3.1.2, Sisäänkirjautuminen II Vaatimus: Pääkäyttäjän on pystyttävä palauttamaan käyttäjille unohdettuja salasanoja ja tarvittaessa vaihtamaan niitä. Prioriteetti: A Käyttötapausviite: 3.1.2, Uloskirjautuminen Vaatimus: Järjestelmästä on pystyttävä kirjautumaan ulos. Prioriteetti: A Käyttötapausviite: Käyttäjätietojen hallinnointi Vaatimus: Käyttäjien tietoja on pystyttävä hallinnoimaan. Uusia käyttäjiä on pystyttävä lisäämään ja vanhoja poistamaan sekä vanhojen käyttäjien tietoja on pystyttävä muokkaamaan. Prioriteetti: A Käyttötapausviite: 3.2.1, 3.2.2

16 Tietokannan tietojen lisäys Vaatimus: Tietokantaan on pysyttävä lisäämään tietoa siten, että useankin instanssin (kirjeen, henkilön) samanaikainen lisäys on mahdollista. Prioriteetti: A Käyttötapausviite: Tietokannan tietojen päivitys Vaatimus: Kannassa olevien tietojen (kirjeiden, henkilöiden) päivittämisen ja poistamisen tulee tapahtua vaivattomasti, sekä yksi että useampi instanssi kerrallaan. Prioriteetti: A Käyttötapausviite: Hakuparametrit I Vaatimus: Hakemisen tulee olla mahdollista kaikilla mahdollisilla parametriyhdistelmillä. Prioriteetti: A Käyttötapausviite: Hakutuloksen vienti I Vaatimus: Löydetyt kirjeet tulisi lopuksi koota tekstimuotoiseksi paketiksi. Prioriteetti: A Käyttötapausviite: Hakutuloksen vienti II Vaatimus: Tiedot haetuista kirjeistä tai henkilöistä on pystyttävä tallentamaan. Prioriteetti: A Käyttötapausviite: 3.4.5

17 Hakutuloksen esittäminen Vaatimus: Hakutuloksesta tulee luoda graafinen esitys, joka on pystyttävä tallentamaan kuvana. Prioriteetti: A Käyttötapausviite: Hakutuloksen muokkaus I Vaatimus: Hakutuloksen graafista esitystä on pystyttävä muokkaamaan, eli luokittelevalle parametrille on pystyttävä antamaan uusia arvoja. Prioriteetti: B Käyttötapausviite: Hakuparametrit II Vaatimus: Käyttäjän on mahdollista noutaa aikaisemmin tekemiään hakuja hakuhistoriasta. Prioriteetti: B Käyttötapausviite: 3.4.7, Hakutuloksen tarkastelu I Vaatimus: Yksittäisten kirjeiden tietoja on pystyttävä tarkastelemaan. Prioriteetti: B Käyttötapausviite: Hakutuloksen tarkastelu II Vaatimus: Kirjeiden kirjoittajien ja vastaanottajien tietoja on pystyttävä tarkastelemaan. Prioriteetti: B Käyttötapausviite: 3.4.9

18 Hakutuloksen muokkaus II Vaatimus: Hakutuloksen listaa kirjeistä tai henkilöistä on pystyttävä muokkaamaan, eli listan sarakkeita on pystyttävä piilottamaan, tuomaan näkyviin ja järjestämään, ja listaa on voitava järjestää eri sarakkeiden perusteella. Prioriteetti: C Käyttötapausviite: Käyttäjäryhmät Vaatimus: Hakujärjestelmän tulisi tukea käyttäjien ryhmittelyä. Ryhmillä tulisi olla järjestelmään eritasoiset käyttöoikeudet. Prioriteetti: C Käyttötapausviite: 3.2.1, Hakutuloksen vienti III Vaatimus: Eksportoitavien kirjeiden järjestys on pystyttävä valitsemaan tiettyjen parametrien mukaiseksi. Prioriteetti: C Käyttötapausviite: Ei-toiminnalliset vaatimukset Käyttöalusta Vaatimus: Hakukoneen tulisi olla selainpohjainen. Prioriteetti: A Käyttöohje Vaatimus: Hakukoneeseen tulisi liittyä sähköinen käyttöohje. Prioriteetti: B Laajennettavuus Vaatimus: Hakukoneen tulee olla laitteistoriippumaton. Prioriteetti: C

19 5 Järjestelmävaatimukset 14 Järjestelmävaatimukset kuvaavat järjestelmälle asetettavia teknisiä vaatimuksia ja toteutuksen teknisiä rajoitteita. Järjestelmävaatimukset jaetaan samalla tavoin toiminnallisiin ja ei-toiminnallisiin vaatimuksiin kuin käyttäjävaatimuksetkin. Toiminnalliset vaatimukset kuvaavat järjestelmän tarjoamat palvelut ja järjestelmän toiminnan määritellyissä tilanteissa. Ei-toiminnalliset vaatimukset puolestaan ovat rajoituksia ja reunaehtoja, jotka asetetaan järjestelmän toiminnalle. Vaatimusten priorisoinnissa käytetään seuraavaa notaatiota: A Erittäin tärkeä B Kohtalaisen tärkeä C Vähemmän tärkeä 5.1 Toiminnalliset vaatimukset Käyttäjätietojen hallinnointi Vaatimus: Uusia käyttäjiä on pystyttävä lisäämään ja vanhoja poistamaan, sekä vanhojen käyttäjien tietoja on pystyttävä muokkaamaan. Prioriteetti: A Kuvaus: 1. Pääkäyttäjän oikeudet omaavalle käyttäjälle esitetään muiden käyttäjien tiedot kaavakkeessa, josta käyttäjätietoja on mahdollista muokata tai poistaa. 2. Uusien käyttäjien lisääminen tapahtuu lisäämällä kaavakkeeseen uuden käyttäjän tiedot Hakuehtojen määrittäminen Vaatimus: Haun tulee olla mahdollista kaikilla mahdollisilla parametriyhdistelmillä. Prioriteetti: A Kuvaus: 1. Käyttäjälle esitetään hakukaavake, josta on mahdollista valita haluttu parametriyhdistelmä. 5.2 Ei-toiminnalliset vaatimukset Tietoturva I Vaatimus: Käyttäjien tulee kirjautua sisään järjestelmään ennen kuin hakukoneen käyttö on mahdollista

20 15 Prioriteetti: A Kuvaus: 1. Ainoastaan järjestelmään rekisteröidyt käyttäjät, eli käyttäjätunnuksen ja salasanan omistavat henkilöt voivat käyttää järjestelmää Tietoturva II Vaatimus: Hakukoneen käyttöoikeuksia on pystyttävä määrittämään käyttäjäkohtaisesti. Prioriteetti: C Kuvaus: 1. Käyttöoikeuksia määrämällä voidaan kontrolloida käyttäjien oikeuksia haussa käytettäviin aineistoihin sekä myös datan lisäämiseen että käyttäjätilien kontrollointiin. Tarkemmat käyttäjäryhmät ja niiden oikeudet määritellään myöhemmin. 2. Käyttöoikeudet määräytyvät hierarkkisesti siten, että ylempien tasojen käyttäjillä on kaikkien alempien tasojen oikeudet Nopeus Vaatimus: Hakujen tulee tapahtua nopeasti, lyhyellä vasteajalla. Prioriteetti: C Kuvaus: 1. Hakukoneen on oltava informatiivinen siinä suhteessa, että käyttäjälle kerrotaan, jos hakuoperaatiota suoritetaan Laajennettavuus Vaatimus: Hakukoneen on oltava selainpohjainen. Prioriteetti: C Kuvaus: 1. Hakukoneen tulee toimia referenssiselaimiksi valituilla Internet Explorer 6 ja Firefox 1.4 selaimilla sekä näiden tulevilla versioilla. 6 Järjestelmäarkkitehtuuri ja -mallit 6.1 Arkkitehtuuri Järjestelmä perustuu karkealla tasolla asiakas-palvelin -malliin (kuva 1). Asiakas on tässä tapauksessa WWW-selain, joka käyttää HTTP-protokollan kautta palvelimen tarjoamia palveluita, joita ovat mm. tietokantahaut.

21 16 Asiakas (selain) WWW- ja sovelluspalvelin Tietokanta Kuva 1: Asiakas-palvelin -malli Järjestelmän tarkoitus on tehdä hakuja asiakkaan kirjetietokantaan. Haut kohdistuvat kirjoittajiin, vastaanottajiin ja kirjeisiin liittyviin metatietoihin. Tietokantana käytetään Tietotekniikkaosaston tarjoamaa Oracle -tietokantaa, josta asiakas pääsee tekemään hakuja WWW-selaimessa toimivan käyttöliittymän kautta. Järjestelmä koostuu seuraavista osista: Käyttöliittymä Sisäänkirjautuminen Kaikki tietokantaan tallennettava data ei ole julkaisuvapaata, joten järjestelmässä tarvitaan käyttäjän tunnistusta. Kaikilla käyttäjillä ei ole oikeutta koko tietokantaan, tietokannan sisällön muuttamiseen eikä käyttäjätunnusten hallintaan. Käyttäjätunnuksien hallinta Järjestelmällä on pääkäyttäjä, joka pystyy lisäämään uusia käyttäjiä, poistamaan vanhoja ja palauttamaan salasanoja. Tunnuksien hallinta suoritetaan WWW-lomakkeen avulla. Kyselyjen teko Kyselyjä tehdään WWW-lomakkeelta, joka mahdollistaa haut kaikilla hakuparametreilla. Hakuehdot annetaan lomakkeiden valikoiden ja kenttien kautta.

22 Tietokannan päivitys Käyttäjät, joilla on riittävät oikeudet, voivat päivittää tietokantaa lataamalla järjestelmään oikeassa muodossa (määritellään tarkkemmin suunnitteluvaiheessa) olevan tiedoston hakukoneen käyttöliittymän kautta. Korjauksia tietokannan sisältöön voi tehdä erillisen WWW-lomakkeen avulla. Tulosten näyttäminen Tuloksista generoidaan WWW-sivu, joka sisältää perustiedot listassa, linkit tarkempiin tietoihin ja tulostaa havainnollistavan kuvan. Sekä hakutulos, että kuva ovat tallennettavissa Toiminnalliset osat Tietokantaoperaatiot Lomakkeilta saadut kyselyt ja päivitykset tarkistetaan ja niistä muodostetaan SQL-kysely tai tarvittaessa annetaan virheilmoitukset käyttöliittymään. Kyselyjen tulokset ja raportti päivitysten onnistumisesta välitetään käyttöliittymään. Liitos muihin ympäristöihin Hauista saadut tulokset voi tallentaa sellaisessa muodossa, että tuloksia voi tarkastella muilla ohjelmilla. Ennen muuta, hauista on pystyttävä muodostamaan sellaisia osakorpuksia, jotka voidaan antaa syötteeksi kirjeiden sisältöä tutkiville ohjelmille. Myös uuden datan tallentaminen tietokantaan on mahdollista syöttämällä järjestelmään jollakin toisella ohjelmalla tuotettu tiedosto. Kuvan luonti Hakutuloksia havainnolistetaan diagrammin avulla. Tätä varten järjestelmä sisältää komponentin, joka muodostaa sille annetusta ryhmitellystä datasta diagrammin. Diagrammi näytetään hakutuloksen yhteydessä, mutta sen pitää olla myös tallennettavissa 6.2 Tietovuokaavio Oheinen kuva 2 mallintaa järjestelmässä välitettävää informaatiota. Sisäänkirjautumisvaiheessa käyttäjä tunnistetaan, minkä jälkeen hän voi siirtyä valitsemiinsa toimintoihin, mikäli ne ovat kyseiselle tunnukselle sallittuja. 6.3 Tietokanta Kuvassa 3 esitetään asiakkaan tietovaatimukset sekä olemassa oleva data yksilö-yhteys - mallin (ER-malli) avulla. Kaaviossa on esitetty vain yksilöjoukot (suorakulmiot) ja niiden väliset yhteydet eli suhteet (salmiakit). Kaaviossa esiintyvät luvut tulkitaan siten, että esimerkiksi kirjeeseen liittyy vähintään ja korkeintaan yksi kokoelma, jonka osa se on. Kokoelma puolestaan voi sisältää miten monta kirjettä tahansa. Kirjeeseen liittyy myös yksi kirjoittaja, yksi vastaanottaja ja 1-3 versiota sisällöstä. Malliin sisältyy oleellisesti kaksi eri osaa, joista toisen lähtökohtana on järjestelmän vaatimukset ja toisen data, johon haut kohdistuvat. Käyttäjät, ryhmät ja kyselyt ovat vastaus asiakkaan vaatimuksiin, joiden mukaan järjestelmän käyttö edellyttää kirjautumista,

23 18 Kuva 2: Tietovuokaavio käyttöoikeuksia on voitava määritellä hierarkkisille ryhmille ja käyttäjän on mahdollista tallentaa hakuja järjestelmään: Käyttäjä Ryhmä Kysely Yksikäsitteisenä tunnisteena käyttäjätunnus Käyttäjään liittyvät attribuutit (salasana, nimi, ryhmä jne.) Yksikäsitteisenä tunnisteena numero Ryhmään liittyvät attribuutit (nimi, oikeudet jne.) Identifioituu käyttäjätunnuksen kautta (ja on siksi merkitty keksinkertaisella reunaviivalla) Attribuuttina kysely, jonka käyttäjä on halunnut tallentaa mahdollista uudelleen käyttöä varten Asiakkaan haut kohdistuvat kirje- ja henkilödataan. Attribuuteista löytyy tarkempi kuvaus liitteestä 2, jossa on lueteltu kaikki asiakkaan aineistossa esiintyvät parametrit ja tehty

24 19 Kokoelma 0..* osa * vast.ot. Ryhmä 0..* 1..1 oikeus Kirje Henkilö jäsen 0..* 1..3 sisältö * kirj Käyttäjä 1..1 Teksti 0..* tallennus 1..1 Kysely Kuva 3: Yksilö-yhteys -malli ilman attribuutteja alustavaa jaottelua sen suhteen, kuuluuko parametri tietokantaan vai ei. Olemassa olevan tietokannan mallinnuksen perusteet esitellään lyhyesti seuraavassa: Henkilö Yksikäsitteisenä tunnisteena erillinen attribuutti työnimellä correspondentcode Henkilöön liittyvät attribuutit, joiden arvot ovat luonteeltaan pysyviä eivätkä riipu kirjeestä Kirjoittaja / vastaanottaja Kirje Identifioituu henkilön ja kirjeen tunnisteista Henkilöön liittyvät attribuutit, joiden arvo vaihtelee kirjeestä toiseen (esim. sosiaalinen status, joka saattaa muuttua ajan kuluessa) Yksikäsitteisenä tunnisteena erillinen attribuutti työnimellä letter id

25 Teksti Kirjeeseen liittyvät attribuutit (myös attribuutit, jotka kuvaavat suhdetta kirjoittajan ja vastaanottajan välillä) Identifioituu kirjeen tunnisteesta (ja on siksi merkitty keksinkertaisella reunaviivalla) Attribuutteina korpustyyppi sekä itse tekstisisältö (yhdestä kirjeestä voi olla raakatekstiversion lisäksi annotoitu ja/tai syktaktisesti jäsennetty versio) Kokoelma Yksikäsitteisenä tunnisteena alkuperäinen tiedostonimi filename Kokoelmaan liittyvät attribuutit 20 7 Järjestelmän elinkaari 7.1 Käyttöönotto Järjestelmä luovutetaan asiakkaalle käyttövalmiina. Ainoiksi asiakkaalle jääviksi toimenpiteiksi jäävät mahdollisten uusien käyttäjien lisääminen ja oikean www-osoitteen asettaminen selaimeen. 7.2 Järjestelmän ylläpito Järjestelmän tietokanta sisältää alkuvaiheessa vain osan siitä tiedosta, jonka asiakas on suunnitellut sinne sijoittavansa, joten järjestelmään kuuluu helppokäyttöiset työkalut tietokannan päivittämiseen. On myös mahdollista, että jo olemassa oleviin objekteihin lisätään uusia tietoalkioita, mihin varaudutaan mahdollisuuksien mukaan. Myös käyttäjiä poistuu ja tulee lisää järjestelmän käytössäoloaikana. Lopullinen käyttäjämäärä ei ole ennustettavissa. Järjestelmä suunnitellaan sellaiseksi, että edellä mainitut toimenpiteet ovat helposti suoritettavissa ja että muita ylläpitotoimia ei tarvita. Järjestelmä pyritään suunnittelemaan ja dokumentoimaan siten, että toisten toimijoiden on tulevaisuudessa mahdollista kehittää järjestelmää tai liittää se osaksi toista järjestelmää. 7.3 Käytöstä poistaminen Koska järjestelmä ei sinänsä tarvitse erillisiä ylläpitotoimia, se voidaan pitää käytössä niin kauan, kuin käytössä olevat selainversiot tukevat järjestelmää. Järjestelmän poistaminen käytöstä tapahtuu yksinkertaisesti poistamalla siihen kuuluvat tiedostot sovelluspalvelimelta ja tietokannasta. Koska järjestelmä toimii selaimen kautta, sen poistaminen ei vaadi erityisiä toimenpiteitä käyttäjien koneilla suoritettavaksi.

26 Liite 1. Hakuparametrit 1 Tässä liitteessä luetellaan parametrit, joilla asiakas haluaa tehdä hakuja. Asiakas on järjestänyt parametrit kolmeen ryhmään, joista ensimmäiset (A) tulee olla tarjolla hakulomakkeen suppeammassa versiossa eli perushaussa ja toiset (B) ja kolmannet (C) tarkennetussa haussa. C-ryhmän parametrit ovat kuitenkin vähemmän tärkeitä ja niitä voi periaatteessa jättää pois hakulomakkeelta esim. käyttöliittymäteknisistä syistä. Parametrit on ohessa luokiteltu sen mukaan, liittyvätkö ne henkilöön, eli kirjoittajaan tai vastaanottajaan, vai kirjeeseen. Henkilön alla luetellut pienellä kirjoitetut parametrit (esim. Age) kertovat siitä, että ko. tieto on riippuvaista kirjeestä ja/tai se on alkujaan tallennettu kirjetietokantaan. A. Perushaku Sender and recipient: SEX DOM REG SOC MOB Age Rank Letter: Year Relationship Word count Collection B. Tarkennettu haku Sender and recipient: LNAME FNAME TITLE

27 2 CORRESPONDENTCODE YBIRTH YDEATH FLETT LLETT RANKST FRANK PBIRTH DOM CNT MIG EDU SENT NLETT SENT NREC SENT KREC SENT NWORDS SENT LETTQUAL REC NLETT REC NSENT REC KSENT REC NWORDS REC LETTQUAL NEW BOOLEAN PARAM I NEW BOOLEAN PARAM II NEW TEXT PARAM I NEW TEXT PARAM II NEW NUMBER PARAM Status

28 3 Letter: Place Actual relationship Letter authenticity C. Vähemmän tärkeät Sender and recipient: REL SENT LETTCONT REC LETTCONT CAREER MIGHIST DNB EXTRA Education Father Notes Letter: Letter ID Date Address formula Closing formula Content type Letter notes NEW BOOLEAN PARAM I NEW BOOLEAN PARAM II

29 4 NEW TEXT PARAM I NEW TEXT PARAM II NEW NUMBER PARAM

30 Liite 2. Parametrit 1 Tässä liitteessä kuvataan epämuodollisesti järjestelmän kaikki parametrit lähtökohtana asiakkaalta saatu avainlista, jossa on määritelty olemassa olevassa tietokannassa olevat ja sinne suunnitellut kentät. Lisäksi on huomioitu asiakkaalta saatu lista toivotuista hakuparametreista. Ensimmäisessä sarakkeessa on parametrin nimi, toisessa alkuperäinen tyyppi ja kolmannessa lyhyt selitys ja/tai jotain oleelliseksi katsottua tietoa. Taulukossa käytetään seuraavia koodeja: P perushakuun kuuluva parametri T tarkennettuun hakuun kuuluva parametri VT vähemmän tärkeä parametri, jonka voi periaatteessa jättää pois VT? vähemmän tärkeä parametri, jonka suunnittelija olisi jättämässä pois ei-tk parametri, jota ei viedä tietokantaan, koska sen arvo on johdettavissa ref: viittaa toisen yksilön parametriin uusi: uusi parametri haku: parametri, jonka arvo on haettavissa muiden parametrien avulla * alkujaan kirjetietokannassa sijaitseva parametri, joka on arveltu henkilön pysyväksi ominaisuudeksi Kokoelma filename text tiedostonimi collection text nimi (P) years mix vuodet words int sanojen lkm (ei-tk) writers int kirjoittajien lkm (ei-tk) letters int kirjeiden lkm (ei-tk) copyright boolean julkaisuoikeus (ei-tk)

31 Kirje letter id code (VT?) collection text ref: kokoelma/filename sender text ref: kirjehlö/correspondentcode recipient text ref: kirjehlö/correspondentcode year mix aika (P) word count int sanamäärä (P) relationship code kirj-vo -suhde (P) actual relationship text kirj-vo -suhde (T) place text kirjoituspaikka (T) authenticity code kirjeen autenttisuus (T) date text aika (VT) address formula boolean aloituskaava (VT) closing formula boolean lopetuskaava (VT) content type text sisältötyyppi (VT) notes text lisätietoa (VT) letter number mix numero editiossa page number mix sivunumero editiossa source text lähde copyright boolean julkaisuoikeus access int uusi: oikeustaso (ei-tk) complete boolean tiedot valmiit updated date viimeisin päivitys new boolean param I boolean otetaan käyttöön tarpeen mukaan new boolean param II boolean otetaan käyttöön tarpeen mukaan new text param I text otetaan käyttöön tarpeen mukaan new text param II text otetaan käyttöön tarpeen mukaan new number param number otetaan käyttöön tarpeen mukaan Teksti letter text ref: kirje/letter id version int uusi: korpustyyppi (P) text text tekstisisältö (tai sijaintitieto) 2

32 Henkilö correspondentcode text id (T) sex code sukupuoli (P) dom reg code asuinalue (P) dom cnt code asuinkunta (T) soc mob code sos. liikkuvuus (P) lname text etunimi (T) fname text sukunimi (T) title text titteli (T) ybirth mix syntymävuosi (T) ydeath mix kuolinvuosi (T) flett int 1. kirjeen vuosi (T) (ei-tk) llett int viim. kirjeen vuosi (T) (ei-tk) rankst code korkein sos. status (T) (ei-tk?) (ranklvl code sos. luokka - kuulemma turha) frank code isän sos. status (T) father text isän tiedot (VT)* pbirth text syntymäpaikka (T) mig code muuttohistoria (T) migration text muuttohistoria (VT)* (mighist text muutohistoria (VT) - yo. korvaa?) educ code koulutus (T) education text koulutus (VT)* career text ura (VT)* (career text ura (VT) - yo. korvaa?) rel code uskonto (VT) dnb text linkki ODNB Onlineen (VT?) extra text lisätietoa hlöstä (VT) complete boolean tiedot valmiit updated date viimeisin päivitys s/r nlett int kirjeiden lkm (T) (ei-tk) s/r nrec int vo/kirj:n lkm (T) (ei-tk) s/r nwords int kirjeiden sanojen lkm (T) (ei-tk) (s/r krec codes haku: suhde vo/kirj:iin (T) (ei-tk)) (s/r lettqual codes haku: kirjeiden autenttisuus (T) (ei-tk)) s/r lettcont codes kirjeiden sis.tyypit (VT) (s/r col text haku: kokoelmat, joissa kirj/vo kirjeitä (ei-tk)) new boolean param I boolean otetaan käyttöön tarpeen mukaan new boolean param II boolean otetaan käyttöön tarpeen mukaan new text param I text otetaan käyttöön tarpeen mukaan new text param II text otetaan käyttöön tarpeen mukaan new number param number otetaan käyttöön tarpeen mukaan 3

33 Kirjehenkilö (kirjoittaja tai vastaanottaja) correspondentcode text ref: henkilö/correspondentcode (T) letter text ref: letter/letter id age int ikä (P) (ei-tk) rank code sos. status (P) status text sos. status (T) notes text kirjekoht. lisätiedot (VT) 4