Projektiryhmä Tete Työajanseurantajärjestelmä
T-76.115 Tietojenkäsittelyopin ohjelmatyö 2(17) Muutoshistoria Version Date Author Description 0.10 1.12.2003 Miikka Lötjönen First incomplete draft 0.20 6.2.2004 Miikka Lötjönen Käännös suomeksi 0.21 8.2.2004 Miikka Lötjönen Tekstiosuus kirjoitettu 0.22 9.2.2004 Miikka Lötjönen Screenshotit paikallaan 1.00 9.2.2004 Niilo Fredrikson Tarkistettu ja hyväksytty palautukseen 1.10 8.3.2004 Miikka Lötjönen Lisätty I3-vaiheen uudet ominaisuudet 1.11 9.3.2004 Marc Josefsson Oikoluku 1.12 14.3.2004 Miikka Lötjönen I3-viimeistely 2.0 15.3.2004 Niilo Fredrikson Tarkistettu ja hyväksytty palautukseen
T-76.115 Tietojenkäsittelyopin ohjelmatyö 3(17) Sisällysluettelo Muutoshistoria... 2 Sisällysluettelo... 3 1 Johdanto... 5 2 Dokumentin laajuus... 5 3 Yleistä... 5 3.1 Järjestelmän tarkoitus... 5 3.2 Käytetty terminologia... 5 3.3 Käyttöliittymä... 6 3.4 Käyttäjien roolit... 6 4 Yleiset toiminnallisuudet... 7 4.1 Sisään- ja uloskirjautuminen... 7 5 Työntekijän käyttämät toiminnot... 7 5.1 Sisään- ja ulosleimaus... 7 5.2 Automaattikirjaus... 8 5.3 Tuntien syöttö... 8 5.4 Tuntien syöttö suosikkikategorioiden avulla... 9 5.5 Tuntien poistaminen... 9 5.6 Syötettyjen tuntien muuttaminen... 9 5.7 Omien tuntien haku... 10 6 Johtajan käyttämät toiminnot... 10 6.1 Raporttitoiminnot... 10 6.1.1 Tuntiraporttien tekeminen... 10 6.1.2 Tuntien hyväksyminen... 11 6.1.3 Tuntien merkitseminen laskutetuiksi... 11
T-76.115 Tietojenkäsittelyopin ohjelmatyö 4(17) 6.1.4 Raporttimallit... 11 7 Ylläpitäjän käyttämät toiminnot... 12 7.1 Työntekijöiden hallinta... 12 7.1.1 Työntekijöiden lisäys... 12 7.1.2 Työntekijöiden tietojen muokkaaminen... 13 7.1.3 Työntekijöiden poisto... 13 7.1.4 Työntekijöiden suosikkityölajit...13 7.2 Työlajien hallinta... 14 7.2.1 Työlajien lisäys... 14 7.2.2 Työlajien muokkaaminen...15 7.2.3 Työlajien poisto... 15 7.3 Järjestelmäylläpito... 15 7.3.1 Lisenssinhallinta... 15 7.3.2 Järjestelmän asetukset... 15
T-76.115 Tietojenkäsittelyopin ohjelmatyö 5(17) 1 Johdanto Tämä käyttöohje kuvaa Work-time Attendance System (WTAS) -työnajanseurantajärjestelmän toiminnan käyttäjän näkökulmasta kertoen, kuinka yleisimmät toiminnot suoritetaan. 2 Dokumentin laajuus kuvaa järjestelmään kirjoittamishetkeen mennessä implementoidun toiminnallisuuden, pääosin havainnollistavien esimerkkien avulla. Tekninen dokumentaatio on erikseen dokumentissa technical specification. 3 Yleistä 3.1 Järjestelmän tarkoitus WTAS-Järjestelmää käytetään työajan ja projektien seurantaan. Sillä voidaan kirjata tunteja tehdyiksi ja liittää nämä tunnit käytetyiksi tiettyihin työtehtäviin. Tämän jälkeen voidaan luoda erilaisia raportteja tehdyistä tunneista tiettynä ajanjaksona ja tehdä merkintöjä niihin, esimerkiksi tunteja voi merkitä laskutetuksi. Tunteja voidaan syöttää myös usealle päivälle yhdellä kirjauksella, jolloin esim. työmatkat saadaan kirjattua. 3.2 Käytetty terminologia Termi Käyttäjä Valikko Hanke Työlaji Selitys Käyttäjiä ovat kaikki ohjelmistoa hyödyntävät ihmiset. WWW-sivun yläpalkissa olevat navigointipainikkeet. Hanke, jonka alla töitä tehdään. Yläkategoria, joka voi olla esimerkiksi yrityksen meneillään oleva projekti tai yrityksen asiakas. 1. Kategoria, johon työn voi sisällyttää. Esimerkiksi suunnittelu, toteutus, markkinointi jne. 2. Työlajia käytetään myös yhteisnimenä hankkeesta, työlajista ja työtyypistä. Työlajien jaottelu käyttö on vapaasti määriteltävissä, WTAS -ohjelmisto ei rajoita sitä. Työtyyppi Kertoo, minkä tyyppisestä työstä työlajin sisällä on kyse. Työlaji voi olla esimerkiksi suunnittelu, ja sen sisällä on monta työtyyppiä, jotka kertovat erilaisista suunnittelutehtävistä.
T-76.115 Tietojenkäsittelyopin ohjelmatyö 6(17) Rooli Raportti Raportointi Leimaus Määrittää käytössä olevat toiminnot ja käyttöoikeudet järjestelmään. Kuvattu tarkemmin kohdassa 3.4 Listaus tehdyistä tunneista. Tehtyjen tuntien syöttäminen järjestelmään. Perinteisen kellokorttiajattelun mukainen sisään- tai uloskirjaus. Tunteja voidaan kirjata vain sisään- ja ulosleimauksen väliselle ajalle. 3.3 Käyttöliittymä Yllä on tyypillinen ohjelman aloitusruutu, tuntinäkymä. Käyttöliittymä jakaantuu kolmeen selkeään alueeeseen: 1. Tummemman sininen yläosa on jokaisessa ohjelman näkymässä lähes vakio. Se sisältää navigointiin tarvittavat linkit, joista myöhemmin käytetään nimeä valikko. Huomaa, että valikon sisältö ei välttämättä ole juuri kuvan mukainen, sillä se luodaan ajonaikaisesti käyttäjäryhmien mukaan. 2. Vasemman reunan vaalean sininen alue muuttuu ruutukohtaisesti, se sisältää tilanteen mukaan eri tyyppisiä toimintopainikkeita. 3. Ruudun loppuosa muodostaa työalueen. 3.4 Käyttäjien roolit Järjestelmää käyttää monta erilaista käyttäjäryhmää, joilla on erilaisia rooleja ja oikeuksia. Jokaisella käyttäjällä pitää olla vähintään yksi rooli, usein useampia. Esimerkiksi projektipäälliköllä voi olla
T-76.115 Tietojenkäsittelyopin ohjelmatyö 7(17) johtajarooli, käyttäjien ylläpitäjärooli ja työntekijärooli. Jokaiselle rooliyhdistelmälle näytetään sovelluksessa asiaankuuluvat näkymät ja sallitaan tietyt toiminnallisuudet. Työntekijä pystyy raportoimaan tekemiään tunteja ja tekemään raportteja tekemistään tunneista. Johtaja pystyy tekemään raportteja, hyväksymään tunteja ja merkitsemään niitä laskutetuiksi. Käyttäjien ylläpitäjä pystyy luomaan uusia käyttäjiä sekä muokkaamaan ja poistamaan vanhoja. Projektien työlajien ylläpitäjä pystyy luomaan uusia hankkeita, työlajeja ja työtyyppejä. Järjestelmän ylläpitäjä pystyy tekemään yksityiskohtaisia järjestelmä toimintaan vaikuttavia asetuksia ja muutoksia. 4 Yleiset toiminnallisuudet Seuraavassa mainitaan, mitkä toiminnallisuudet ovat kaikille rooleille yhteisiä. 4.1 Sisään- ja uloskirjautuminen Ennen kun järjestelmää voidaan käyttää, täytyy uudelle käyttäjälle hankkia käyttäjätunnus ja salasana. Tämä pyydetään järjestelmän ylläpitäjältä. Kun tunnus on saatu, voidaan kirjautua sisään itse järjestelmään. Tämä tapahtuu kirjoittamalla aloitussivulla käyttäjätunnus ja salasana niille varattuihin kohtiin ja painamalla sisäänkirjautumisnappia. 5 Työntekijän käyttämät toiminnot 5.1 Sisään- ja ulosleimaus Järjestelmään kerätään perinteisen kellokorttiajattelun mukaisesti kirjauksia töihinsaapumisajoista ja töistälähtöajoista. Tarkoituksena on, että heti töihin tulon yhteydessä kirjaudutaan ja leimataan sisään järjestelmään ja töistä lähtiessä leimataan ulos. Tunteja voi kirjata vain näiden leimauksien välisille ajoille.
T-76.115 Tietojenkäsittelyopin ohjelmatyö 8(17) Kun Leimaa sisään nappia on painettu, se muuttuu Leimaa ulos painikkeeksi. Ulosleimauksen yhteydessä näytetään leimauksen kesto. 5.2 Automaattikirjaus Työaikoja voidaan merkitä automaattimerkinnöillä joustavasti useille päiville, esimerkiksi työmatkan ajaksi. Automaattiset leimaukset toimivat ulospäin samalla tavoin kuin käsinleimauksetkin. Raportoidessa tunteja näytetään, mitkä leimaukset on luotu automaattisesti. Automaattileimaus tehdään vasemmalla olevan toimintopalkin kohdasta Kirjaa tunteja usealle päivälle. 5.3 Tuntien syöttö Tunteja kirjataan valikon Tehdyt tunnit -kohdasta. Ensin valitaan vasemman palkin kalenterista päivä, jolle halutaan tunteja kirjata. Päivät, joille on jo kirjattu tunteja, näkyvät siinä lihavoituna. Tunteja voi tietyille ajanjaksoille kirjata vain, jos kyseisenä aikana on ollut leimautuneena sisään. Järjestelmä näyttää, mille ajanjaksoille on mahdollista kirjata tunteja. Tarvittaessa voidaan lisätä kohdassa 5.2mainittu automaattinen sisään- ja ulosleimaus, jotta tunteja voidaan kirjata myös muille ajanjaksoille. 1. Määrittele alasvetovalikosta hanke, johon työtä on tehty. 2. Määritelle työlaji, joka kertoo minkälaista työtä on tehty. 3. Määrittele työtyyppi.
T-76.115 Tietojenkäsittelyopin ohjelmatyö 9(17) 4. Määrittele työn alku- ja loppuaika, kellonajat annetaan eroteltuina kaksoispisteellä. 5. Kirjoita havainnollinen kuvaus, mitä kirjattavien tuntien aikana on tehty. 5.4 Tuntien syöttö suosikkikategorioiden avulla Suosikkinäkymä helpottaa tuntien syöttöä tarjoamalla käyttäjälle mahdollisuuden määritellä usein käytettyjä kategoriayhdistelmiä, joita voi sitten syöttää yhdellä painalluksella tuntien syötön erillisessä suosikkinäkymässä. Suosikkeja ei voi muokata muuten kuin poistamalla kategorian ja määrittelemällä uuden. Käyttäjä voi määritellä suosikkikategorian valikon kohdassa Suosikit, määrittelemällä halutun hankkeen, työlajin ja työtyypin. Tällöin tätä kategoriaa voi käyttää suoraan Tehdyt tunnit -näkymässä siirtymällä suosikkinäkymään vasemmalla olevan toimintopalkin painikkeella Vaihda suosikkinäkymään. Näkymä toimii kuten tavallinenkin, mutta kolmen kategorian sijaan valitaan vain yksi suosikkikategoria. 5.5 Tuntien poistaminen 1. Valitse ensin vasemman palkin kalenterista päivä, jolta tunteja poistetaan 2. Valitse poistettavat kirjaukset rastittamalla vasemmalta halutut tapahtumat. 3. Paina listauksen alla olevaa Poista valitut painiketta. 4. Hyväksy poisto painamalla OK esiin tulevasta dialogista. 5.6 Syötettyjen tuntien muuttaminen Jo syötettyjä tunteja voi muuttaa painamalla tehdyt tunnit kohdassa painamalla muokkaa linkkiä ja vaihtamalla tiedot haluamakseen.
T-76.115 Tietojenkäsittelyopin ohjelmatyö 10(17) 5.7 Omien tuntien haku Työntekijä voi luoda yksinkertaisia raportteja omista tunneistaan ylävalikon Raportit kohdasta. Raportti luodaan valitsemalla raporttiin haluttava aikaväli ja siihen sisällytettävät hankkeet, työlajit ja työtyypit. Sitten valitaan vielä, halutaanko listata kaikki kirjaustapahtumat erikseen, vai halutaanko pelkkä yhteenveto, jossa kerrotaan jaksolla tehtyjen tuntien määrä. 6 Johtajan käyttämät toiminnot 6.1 Raporttitoiminnot 6.1.1 Tuntiraporttien tekeminen Johtaja voi luoda monipuolisempia raportteja kuin normaali työntekijä. 1. Valitse ylävalikosta Raportit.
T-76.115 Tietojenkäsittelyopin ohjelmatyö 11(17) 2. Valitse haluttu aikaväli. 3. Valitse raporttiin mukaan otettavat hankkeet, työlajit ja työtyypit. 4. Valitse tehdäänkö raportti kaikista työntekijöistä vai yksittäisestä henkilöstä. 5. Valitse raportin tyypiksi joku seuraavista Listaus näyttää valitun mukaisen raportin sisältäen kaikki kirjaustapahtumat erikseen. Yhteenveto näyttää pelkän yhteenvedon, jossa kerrotaan jaksolla tehtyjen tuntien määrä. Hyväksy tunteja näyttää listaus-tyypin mukaisen näkymän ja lisäksi valintalaatikon, jolla johtaja voi hyväksyä tehtyjä tunteja. Merkitse tunteja laskutetuksi näyttää listaus-tyypin mukaisen näkymän ja lisäksi valintalaatikon, jolla johtaja voi merkitä tunteja laskutetuksi. Huom.! Tunnit pitää hyväksyä ennen kuin ne merkitään laskutetuiksi. Jos käyttäjä yrittää tehdä merkintää ennen hyväksyntää, hänelle tarjotaan mahdollisuus hyväksyä tunnit samalla. Tulostettava tuottaa uuteen ikkunaan tulostusta varten muotoillun version raportista ja tarjoaa mahdollisuuden sivun tulostamiseen. CSV tuottaa raportista standardinmukaisen CSV -muotoisen tiedoston, jota voidaan käyttää monissa muissa ohjelmissa, kuten Excel. Luotaessa tämän tyyppinen raportti tiedosto tarjotaan selaimella ladattavaksi ja selain toimii niin kuin sen on määritelty toimivan CSV -tyyppisten tiedostojen yhteydessä. Tavallisesti se antaa mahdollisuuden joko avata tai tallentaa tiedoston. 6.1.2 Tuntien hyväksyminen Tunteja hyväksytään tekemällä kohdan 4.3.1 mukaisesti Hyväksy tunteja tyyppinen raportti ja merkitsemällä tästä raportista halutut tunnit hyväksytyiksi. 6.1.3 Tuntien merkitseminen laskutetuiksi Tunteja merkitään laskutetuiksi hyväksymällä ensin tunnit ja sitten tekemällä kohdan 4.3.1 mukaisesti Merkitse tunteja laskutetuksi tyyppinen raportti ja merkitsemällä tästä raportista halutut tunnit laskutetuiksi. Jos tunteja ei ole hyväksytty, ja niitä yritetään merkitä laskutetuiksi, järjestelmä tarjoaa näitä tunteja hyväksyttäväksi. Vasta hyväksymisen jälkeen tunnit voidaan merkitä laskutetuiksi. 6.1.4 Raporttimallit Raporttinäkymän toimintopalkista on mahdollista valita erilaisia ennalta määriteltyjä raporttityyppejä, jotka hakevat tietokannasta juuri tietyt kriteerit täyttävät kirjaukset ja näyttävät tulokset tietyllä tavalla. Tällä hetkellä implementoituna on perinteisen tuntiraportin lisäksi:
T-76.115 Tietojenkäsittelyopin ohjelmatyö 12(17) 1. Työntekijäraportti, jossa näytetään kaikki työntekijät, joilla on merkittyjä tunteja valittuna aikavälillä. Muoto valittavissa välillä listaus, tulostettava tai csv. 2. Kategoriaraportti, joka hakee tietokannasta kaikki määritellyt työlajit. Muoto valittavissa välillä listaus, tulostettava tai csv. Lisää raporttimalleja voi määritellä XML-tiedostoina, jotka sijaitsevat konfiguraatiotiedostossa määritellyssä hakemistossa (oletus /etc/wtas). 7 Ylläpitäjän käyttämät toiminnot 7.1 Työntekijöiden hallinta 7.1.1 Työntekijöiden lisäys 1. Valitse valikosta Työntekijät.
T-76.115 Tietojenkäsittelyopin ohjelmatyö 13(17) 2. Valitse esiin tulevassa ruudussa vasemmasta palkista Luo uusi työntekijä. 3. Kirjoita uuden työntekijän tiedot niille varattuihin kenttiin. 4. Valitse työntekijälle annettavat roolit. 5. Hyväksy painamalla lisää työntekijä. 7.1.2 Työntekijöiden tietojen muokkaaminen 1. Valitse valikosta Työntekijät. 2. Paina muutettavan henkilön nimeä. 3. Muuta halutut tiedot. Varoitus! Jos otat käytössä rastin pois, käyttäjä poistetaan etkä enää pääse käsiksi hänen tietoihinsa. Lisäksi jos poistat itseltäsi käyttäjien ylläpitäjä oikeudet, et enää pääse muokkaamaan käyttäjätietoja. 4. Hyväksy muutokset painamalla tallenna. 7.1.3 Työntekijöiden poisto 1. Valitse valikosta Työntekijät. 2. Merkitse poistettavat työntekijät painamalla niiden kohdalle rasti 3. Paina listauksen alla olevaa Poista valitut nappia. 4. Vahvista poisto. 7.1.4 Työntekijöiden suosikkityölajit Tavallisesti työntekijät määrittelevät itsellensä suosikkityölajit, kuten käyttöohjeen kohdassa 5.4 kerrotaan. Ylläpitäjä voi kuitenkin myös lisätä Työntekijät -näkymän painikkeesta Muokkaa suosikkeja tietyn käyttäjän kohdalla ja valitsemalla halutun työlajiyhdistelmän.
T-76.115 Tietojenkäsittelyopin ohjelmatyö 14(17) 7.2 Työlajien hallinta 7.2.1 Työlajien lisäys 1. Valitse valikosta Työlajit. 2. Valitse esiin tulevassa ruudussa vasemmasta palkista Luo uusi työlaji. 3. Kirjoita uuden työlajin nimi sille varattuun kenttään. 4. Valitse taso, jolle uusi työlaji sijoitetaan. 5. Valitse vasemmasta valintalaatikosta uuden työlajin alle sijoitettavat työlajit tai työn tyypit. 6. Valitse >>, jolloin ne merkitään valituiksi alakategorioiksi. Jos teit virheen, valitse << ja työlajit palautetaan listaukseen. 7. Tarkista, että käytössä valintalaatikko on valittuna.
T-76.115 Tietojenkäsittelyopin ohjelmatyö 15(17) 8. Vahvista lisäys painamalla Lisää työlaji. 7.2.2 Työlajien muokkaaminen 1. Valitse valikosta Työlajit. 2. Valitse muokattava hanke, työlaji tai työtyyppi painamalla sen nimeä. 3. Työlajin muokkaus toimii oleellisilta osin samoin kuin lisääminenkin. Voit: Muokata työlajin nimeä kirjoittamalla uuden nimen sille varattuun kenttään. Nostaa tai laskea työlajin tasoa valitsemalla Taso valikosta jonkin muun tason. Lisätä tai poistaa alakategorioita siirtämällä niitä >> ja << painikkeilla oikealle tai vasemmalle. Voit poistaa työlajin käytöstä, jolloin se säilyy tietokannassa, mutta sitä ei voi käyttää. 4. Hyväksy muutokset painamalla tallenna. 7.2.3 Työlajien poisto 1. Valitse valikosta Työlajit. 2. Merkitse poistettavat työlajit painamalla niiden kohdalle rasti 3. Paina listauksen alla olevaa Poista valitut nappia. 4. Vahvista poisto. 7.3 Järjestelmäylläpito 7.3.1 Lisenssinhallinta Lisenssi määrää järjestelmän suurimman mahdollisen käyttäjämäärän. Määrän tullessa täyteen järjestelmä ei enää hyväksy uusia käyttäjätunnuksia. Lisenssinhallinta perustuu avainkoodeihin. Tamtronin asiakaspalvelusta saa tarvittaessa tilattua koodin, jolla lisenssin suurinta mahdollista käyttäjämäärää voidaan nostaa. Käyttäjämäärä vaihdetaan yksinkertaisesti kopioimalla tämä koodi sille varattuun kenttään Ylläpitovalikossa ja painamalla Päivitä-nappia. 7.3.2 Järjestelmän asetukset Hakemistossa conf on tiedosto wtas.properties, jossa määritellään järjestelmän yleisiä käyttöasetuksia. Tällä hetkellä asetuksilla voidaan vaikuttaa seuraaviin seikkoihin:
T-76.115 Tietojenkäsittelyopin ohjelmatyö 16(17) 1. Raporttimallien hakemisto 2. Check in toiminto päällä/pois. (valinta true tai false) 3. Kielivalinta (FI/EN) 8 Client-ohjelma WTAS-ohjelmiston mukana toimitetaan itsenäinen graafinen asiakasohjelma, jolla voidaan leimata sisään järjestelmään ja ulos sieltä. Tällä hetkellä kokonainen asennuspaketti ja käyttöohjeet on vain Windowsille, mutta koska kyseessä on Java-ohjelma, Unix/Linux versio toimii pääosin samalla tavalla. 8.1 Java Runtime Environmentin (JRE) asennus WTAS-Client tarvitsee toimiakseen Sunin Java ympäristön. Tämän saa ilmaiseksi heidän kotisivuiltaan. 1) Mene osoitteeseen http://java.sun.com/j2se/1.4.2/download.html. 2) Valitse kohdan Download J2SE (kirjoittamishetkellä v 1.4.2_3) alta JRE-sarakkeesta Download. 3) Hyväksy lisenssiehdot valitsemalla accept ja painamalla continue. 4) Valitse Windows Platform kohdasta Windows installation, Multi language 5) Suorita ladattu ohjelma ja Windows Installer ohjelma käynnistyy 6) Hyväksy lisenssi valitsemalla I accept the terms in the licence agreement ja valitsemalla next. 7) Valitse Typical asennus. 8) Tiedostojen kopiointi käynnistyy ja ohjelma tekee tarvittavat asetukset. 9) Valitse Finish. 8.2 Asiakasohjelman asennus ja toiminta (Windows) Suorita toimitettu Client.exe. Valitse asennushakemisto ja paina install, Tällöin syntyy Client alihakemisto, joka sisältää seuraavat komentoriviltä suoritettavat tiedostot:
T-76.115 Tietojenkäsittelyopin ohjelmatyö 17(17) Tiedosto Kuvaus Käyttö client.jar Toiminnallisuuden sisältävä javaohjelma. Sisältää sekä graafiset että tekstipohjaiset ominaisuudet. java jar client.jar <palvelin:portti> <käyttäjätunnus> <salasana> tai java cp client.jar wtas.util.clientutil <palvelin:portti> <käyttäjätunnus> <salasana> [in out] run.bat Käynnistää graafisen asiakasohjelman run <palvelin:portti> <käyttäjätunnus> <salasana> runtest.bat Muuten kuin run.bat, mutta käynnistää sovelluksen suoraan testipalvelimelta (wtas.tky.hut.fi:8080) run <käyttäjätunnus> <salasana> ci.bat Tekee tekstipohjaisen sisäänleimauksen ci <käyttäjätunnus> <salasana> co.bat Tekee tekstipohjaisen ulosleimauksen co <käyttäjätunnus> <salasana> status.bat Tarkastaa käyttäjän leimaustilanteen status <käyttäjätunnus> <salasana> Esimerkiksi testikäyttäjä Pekka, jonka salasana on akkep, käynnistää graafisen ohjelman komennolla runtest pekka akkep. Päivän päätteeksi hän leimaa itsensä ulos kirjoittamalla co pekka akkep.