Käyttöohje Ipa Helsinki 16.12.2006 Ohjelmistotuotantoprojekti HELSINGIN YLIOPISTO Tietojenkäsittelytieteenlaitos
Kurssi 581260 Ohjelmistotuotantoprojekti (9+1op/6ov) Projektiryhmä Duus Seppo Juhani Hela Ilkka Hukkanen Antti Petteri Karhu Keijo Markus, Projektipäällikkö Usenius Timo Sakari Asiakas Tino Johansson Joni Kukkola Arttu Paarlahti Tanja Stepanova Vastuuhenkilö Taina Juha Ohjaaja Simola Pekka Sähköposti ohtus06-ipa-list@cs.helsinki.fi Kotisivu http://cs.helsinki.fi/group/ipa
Versiohistoria Versio Aika Nimi Muutokset 0.1 16.12.2006 Ipa Ensimmäinen versio
Sisällys 1 Johdanto...1 1.1 Käyttäjät...1 1.2 Ohjelman käyttötarkoitus...1 1.3 Ohjelman yleiskuvaus...1 2 Ohjelman asennus ja käynnistys...2 2.1 Järjestelmän asentaminen... 2 3 Näytöt... 3 3.1 Etusivu... 3 3.2 Pakettien hakeminen...4 3.3 Käyttäjän rekisteröiminen...6 3.4 Sisäänkirjautuminen...7 3.5 Omien tietojen muokkaaminen...8 3.6 Käyttäjien hallinnointi... 8 3.6.1 Kaikkien käyttäjien muokkaaminen...8 3.6.2 Yksittäisen käyttäjän tietojen muuttaminen...8 3.6.3 Käyttäjien lisääminen listasta...9 3.7 Pakettien hallinnointi... 9 3.7.1 Pakettien lisäys...9 3.7.2 Immateriaaliluokat... 10 3.7.3 Pakettien muokkaaminen... 10 3.7.4 Pakettien poistaminen... 10 3.8 Kategorioiden muokkaaminen...10
1 Johdanto 1.1 Käyttäjät Ohjelma on avoin palvelu kaikillle, jotka tarvitsevat oppimateriaalia, johon on yhdistetty paikkatietoa. Yliopiston opiskelijoilla, jotka ovat rekisteröityneet järjestelmän käyttäjiksi, on suuremmat oikeudet kuin muilla opiskelijoilla. Opettajilla on enemmän oikeuksia kuin oppilailla, koska he pystyvät lisäämään ja poistamaan paketteja. Näistä rooleista on lisää tämän dokumentin luvussa kymmenen. Dokumentissa olevat näytöt eivät vastaa täysin tehtyä ohjelmaa 1.2 Ohjelman käyttötarkoitus Interaktiivinen paikkatietojärjestelmä on Helsingin yliopiston Tietojenkäsittelytieteen laitoksen ohjelmistotuotantoprojekti. Projekti liittyy "Halki, Poikki ja Pinoon - interaktiivinen paikkatieto yliopisto-opetuksen tukena" -hankkeeseen, joka on palkittu opetusteknologiakilpailussa vuonna 2004. Hanke tuottaa WWW-käyttöliittymällä varustetun oppimateriaalipankin, johon on tallennettu paikkatietoon yhdistettyä multimedia-aineistoja, kuten tekstiä, kuvaa ja videoleikkeitä. Oppimateriaalipankin tarkoituksena on monipuolistaa ja kehittää itseopiskelua. Ohjelman avulla opettajat voivat vaihtaa keskenään oppimateriaalia ja opiskelijat voivat hakea oppimateriaalipankista materiaalia opiskelua varten. Ohjelma käyttää Suomen kielen laitoksella sijaitsevaa, palvelimella olevaa tietokantaa, jonne oppimateriaali paketit tallennetaan. 1.3 Ohjelman yleiskuvaus Ohjelman etusivulla käyttäjän on mahdolista nähdä järjestelmässä olevia paketteja, joiden immateriaalioikeuksia ei ole rajoitettu. Nämä paketit on siis tarkoitettu kaikkien nähtäväksi. Pääsivulla näkyy muun muassa kartta, johon järjestelmässä olevat paketit sijoittuvat sijaintiensa mukaisesti. Yleisesti järjestelmä koostuu sivuista, joiden avulla käyttäjät voivat lisätä, poistaa tai muokata paketteja tai käyttäjiä. Myös kategorioita, joiden mukaisesti paketit voidaan lajitella, voidaan muokata oman sivunsa kautta. Ylläpitäjille on tarjolla oma 1
sivu, jolla voidaan muokata, lisätä ja poistaa kaikkia käyttäjiä. 2 Ohjelman asennus ja käynnistys Ohjelma on valmiiksi asennettuna Suomen kielen laitoksen palvelimella ja se sijaitsee osoitteessa http://hpp.finnish.helsinki.fi. Menemällä edellä olevaan osoitteeseen, ohjautuu käyttäjä suoraan järjestelmän aloitussivulle. Koska ohjelmalla on oletetusti käyttäjiä laajalla alueella, on palvelin päällä ympäri vuorokauden, eikä järjestelmää sammuteta normaaleissa oloissa. Tässä kappaleessa kerrotaan kuinka järjestelmän saa tarvittaessa asennettua ja käynnistettyä uudelleen. 2.1 Järjestelmän asentaminen 1. Happi järjestelmä on suunniteltu toimivaksi Ubuntu serverillä, versiossa 6.10. Tärkeintä on, että käyttöjärjestelmä on luotettava ja toimii vakaasti perusasetuksilla. Myös käyttöjärjestelmän päivitykset tulee hoitaa tässä vaiheessa. Käskyistä kannattaa muistaa ainakin apt-get update ja apt-get upggrade. 2. Jos serveriin halutaan päästä kiinni verkkoyhteyden kautta, tulee asentaa SSHD. Ubuntussa tämä onnistuu käskyllä apt-get install openssh-server. Asetuksista tulee muuttaa kohta root-login, jota ei sallita. 3. Palomuurin asetukset tulee olla seuraavat: - portin 80 tcp-liikenne ohjataan porttiin 8080 - portiin 22 tuleva liikenne sallitaan, mikäli halutaan ssh:n käyttö mahdolliseksi - muita yhteyksiä ei Happi tarvitse, joten ne voidaan estää - Hapen mukana iptables- skripti, jota voi käyttää - Käytä ROOT-tunnuksia ja kopioi tämä skripti hakemistoon /etc/init.d ja aja siellä komennolla rc-update.d 4. Asenna postgresql tietokanta (nyt versio 8.1.) - Ubuntussa komento apt-get install postgresql-8.1 - Postgresin asetuksia muokattava tiedostosta /etc/postgresql/8.1/main/pg_hba.conf Tässä tiedostossa oltava seuraavat entryt: # Database administrative login by UNIX sockets 2
3 Näytöt local all all trust # TYPE DATABASE USER CIDR-ADDRESS METHOD # IPv4 local connections: host all all 127.0.0.1/32 trust # IPv6 local connections: host all all ::1/128 trust - Vaihda käyttäjäksi postgres, käskyllä : sudo su postgres - Luo uusi käyttäjä käskyllä createuser - Nimi: ipa - superuser: yes - Luo uusi tietokanta ipa, käskyllä: createdb -O ipa ipa - Lataa tietokantaan vanha dumppi käskyllä: psql -U ipa ipa\i dumppi.sql - Tämä kestää hetken! 5. Asenna Java JDK 1.5.X - ohjeet esimerkiksi sivulla http://myy.helia.fi/~karte/sun_java_ja_ubuntu.html - Jotta Tomcat löytää Javan, aseta profiiliin muuttuja JAVA_HOME= /usr/lib/j2sdk1.5-sun - HUOM! Jos käytetään käynnistysskriptiä, niin tuo ei ole välttämätöntä. Sama polku kuitenkin oltava oikein skriptissä. 6. Asenna kääntötyökalu ant käskyllä: apt-get install ant 7. Asenna Tomcat: - lisää käyttäjä tomcat "adduser tomcat" - pura tomcatin paketti ja siirrä /usr/local/tomcat- hakemistoksi - anna tuon kansion omistus käyttäjälle tomcat - kopio tompan käynnistysskripti hakemistoon /etc/init.d/ ja aja update-rc.d tomcat defaults Tässä luvussa kuvataan ohjelman käyttämiseen liittyvät olennaiset näytöt ja niide toiminta. 3.1 Etusivu Järjestelmän etusivu kokonaisuudessaan on kuvassa 1. 3
Kuva 1. Järjestelmän etusivu. Etusivun ylälaidassa on valikko(kuva 1 ja 2.), josta käyttäjä pääsee kirjautumaan sisään järjestelmään. Jos käyttäjä ei ole aiemmin rekisteröitynyt järjestelmän käyttäjäksi, on hänen ensin rekisteröidyttävä, jotta hän saa käyttäjätunnuksen ja salasanan järjestelmän käyttämiseksi. 3.2 Pakettien hakeminen Etusivulla vasemmassa reunassa on valikko(kuva 2.), josta käyttäjä voi rajata paketteja joita hän haluaa katsella. Valikon yläreunassa on linkki, jolla käyttäjä pääsee haun alkuun. Sen alapuolelta käyttäjä voi valita haluamansa kielen, jolla hän haluaa käyttää järjestelmää. Järjestelmän valikot on käännetty suomen lisäksi ruotsiksi ja englanniksi. Paketteja käyttäjä voi rajata paketin julkaisutilan, sijainnin, tieteenalan tai teeman mukaan. Haettujen pakettien yläpuolella on myös vapaatekstihaku, jonka avulla käyttäjä voi hakea paketteja haluamallaan vapaastivalitsemallaan sanalla. 4
Kuva2. Paketin rajaaminen. Hakutulokseen rajautuneet paketit näytetään ikkunan keskellä, kahdessa palstassa. Tooltip kertoo paketista lisää, jos käyttäjä vie hiiren paketin päälle. Halutessaan lisää informaatiota, voi käyttäjä klikata paketin linkkiä, jolloin sen mahdolliset esikatselutiedostot avautuvat sivulla olevan kartan alle(kuva 3.). Esikatselutietojen alta käyttäjä voi ladata paketin koneelleen joko pakkaamattomana, tai zip-muotoon pakattuna. Halutessaan katsella miltä paikkakunnilta järjestelmässä on paketteja, voi käyttäjä viedä hiiren neliön kohdalle, joka kuvaa paikkaa kartalla. 5
Kuva 3. Esikatselutietojen avautuminen etusivulle. 3.3 Käyttäjän rekisteröiminen Kun käyttäjä haluaa rekisteröityä järjestelmään, klikkaa hän rekisteröidy linkkiä jolloin hänelle avautuu rekisteröitymissivu(kuva 4.). Tälle sivulle käyttäjä syöttää käyttäjänimen, jonka tulee olla vähintää viisi merkkiä pitkä, kuten myös salasanan. Käyttäjä syöttää myös etu- ja sukunimensä, sekä sähköpostiosoitteensa. Valikosta hän voi valita kielen, jota järjestelmässä aikoo käyttää. Omia tietojaan voi muuttaa myös myöhemmin. 6
Kuva 4. Rekisteröinti sivu. Painettuaan rekisteröidy nappia, lähettää järjestelmä käyttäjän ilmoittamaan osoitteeseen sähköpostia. Kun käyttäjä klikkaa sähköpostissa olevaa linkkiä, ohjautuu hän järjestelmän etusivulle, jolloin hänet on rekisteröity järjestelmään ja hän voi kirjautua sisään. 3.4 Sisäänkirjautuminen Kun käyttäjä on rekisteröitynyt järjestelmään, voi hän kirjautua sisään syöttämällä käyttäjätunnuksen ja salasanansa etusivun ylälaidassa oleviin kenttiin. Kirjautumisen jälkeen ylälaidan valikon sisältö muuttuu kuvassa 5 olevan kaltaiseksi. Kuva 5. Omien tietojen muokkaaminen. Kirjautunut käyttäjä näkee siis ylävalikossa linkit hakusivulle(hae, etusivu), hakuattribuuttien muokkaussivulle, Pakettien hallinnointi sivulle (Uusi paketti) ja käytt'jien hallinnointisivuille. Oikeasta reunasta käyttäjä voi kirjautua ulos, tai kuten kuvassa viisi, muokata profiiliaan. 7
3.5 Omien tietojen muokkaaminen Kuvassa viisi näkyvällä sivulla käyttäjä voi muokata omia tietojaan. Käyttäjä voi muuttaa nimeään, sähköpostiosoitettaan, käyttäjätasoaan ja käyttämäänsä kieltä. 3.6 Käyttäjien hallinnointi Jos käyttäjällä on riittävät valtuudet, eli hän on pääkäyttäjä, voi hän muokata kaikkien käyttäjien tietoja. Käyttäjien hallinnointia varten avautuva sivu on kuvassa 6. Kuva 6. Käyttäjien hallinnointi. 3.6.1 Kaikkien käyttäjien muokkaaminen Pääkäyttäjälle avautuu lista, jossa on kaikki käyttäjät. Hän voi tarvittaessa muokata käyttäjien tietoja, käyttäjätasoja ja poistaa käyttäjiä. Listasta pääkäyttäjä näkee käyttäjien käyttäjätunnuksen, nimen, sähköpostiosoitteen, roolin(käyttöoikeudet) ja käytössä olevan kielen. Rivin lopussa olevaa edit- linkkiä painamalla käyttäjä saa valitun käyttäjän tiedot sivun oikean reunan editoriin, jolloin hän pääsee muuttamaan niitä. 3.6.2 Yksittäisen käyttäjän tietojen muuttaminen Pääkäyttäjä voi muokata kenen tahansa käyttäjän tietoja valitsemalla käyttäjän listasta, jolloin hänen tietonta avautuvat vieressä olevaan editoriin. Pääkäyttäjä voi muutttaa käyttäjien salasanaa, nimeä, käytettävää kieltä ja käyttäjätasoa. 8
3.6.3 Käyttäjien lisääminen listasta Pääkäyttäjällä on myös mahdollisuus lisätä käyttäjiä listasta, joka on tallennettu csvmuotoon. Tällöin järjestelmään voidaan kerralla lisätä useita käyttäjiä yhdellä kertaa. Listasta lisääminen tapahtuu käyttäjien hallinta sivun yläreunassa olevalla valintaruudulla, johon pääkäyttäjä voi hakea listan jonka haluaa käyttäjätietoihin lisätä. 3.7 Pakettien hallinnointi Järjestelmässä olevia oppimateriaalipaketteja voidaan lisätä, muokata ja poistaa tarpeen mukaan. Klikkaamalla etusivulla olevaa hallinnoi paketteja linkkiä, avautuu käyttäjälle listaus kaikista hänen paketeistaan (Kuva 7). Kuva 7. Käyttäjän pakettien listaus. Listaussivulta käyttäjä voi joko lisätä paketteja, muokata vanhoja pakettejaan tai poistaa paketteja. 3.7.1 Pakettien lisäys Käyttäjä, joka on rekisteröitynyt järjestelmään, voi lisätä omia paketteja menemällä ensin 9
pakettien hallinta sivulle ja klikkaamalla sieltä pakettien lisäämis linkkiä. Paketteja lisättäessä valitsee käyttäjä sen, onko paketti julkaistu, julkaisematon vai roskakorissa. Julkaisematon paketti ei näy muille, mutta on tallennettuna tietokantaan. Roskakorissa oleva paketti on poistumassa järjestelmästä ja julkaistu paketti luonnollisesti näkyy muille. Käyttäjä voi määrittää sen, kenelle kaikille paketti näytetään. Pakettien immateriaalikategoriat on esitelty kohdassa 3.7.2. Pakettia lisätessään käyttäjä voi valita myös paketin kielen, alueen jolle se sijoittuu ja aijan jakson jota se käsittelee. Pakettiin voi myös liittää liitteeksi tekstin lisäksi videokuvaa, ääntä tai kuvia. Järjestelmä tekee kuvista automaattisesti esikatselutiedoston. 3.7.2 Immateriaaliluokat Käyttäjällä on neljä eri mahdollista käyttäjätasoa, jotka rajoittavat hänen oikeuksiaan pakettien näkemisen ja lisäämisen suhteen. Mahdollisia käyttäjätasoja ovat pääkäyttäjä, ylläpitäjä, opettaja ja opiskelija. Ylläpitäjällä on oikeus muokata kaikkien muiden käyttäjien tietoja ja paketteja. Pääkäyttäjä hallinnoi paketteja ja tekee mahdollisia muutoksia hakuattribuuttilistoihin. Opettaja voi lisätä omia pakettejaan ja katsella muiden paketteja. Opiskelija voi ladata järjestelmässä olevia paketteja omalle koneeleen. 3.7.3 Pakettien muokkaaminen Muokatessaan paketteja, käyttäjä voi muuttaa kaikkia samoja asetuksia, joita hän voi muokata lisätessään pakettia. Tehdyt muutokset talletetaan tietokantaan. 3.7.4 Pakettien poistaminen Käyttäjä voi poistaa omia pakettejaan järjestelmästä pakettien listaussivun kautta. Poistettaessa pakettia, poistuvat myös kaikki sen litteet tietokannasta. 3.8 Kategorioiden muokkaaminen 10