OLLI ROUHIAINEN WEB-POHJAISEN TILAUS- JA LASKUTUSJÄRJESTELMÄN DOKUMENTOINTI. Kandidaatintyö

Transkriptio

1 OLLI ROUHIAINEN WEB-POHJAISEN TILAUS- JA LASKUTUSJÄRJESTELMÄN DOKUMENTOINTI Kandidaatintyö Tarkastaja: DI Mikko Salmenperä 11. heinäkuuta 2011

2 i TIIVISTELMÄ TAMPEREEN TEKNILLINEN YLIOPISTO Automaatiotekniikan koulutusohjelma ROUHIAINEN, OLLI: Web-pohjaisen tilaus- ja laskutusjärjestelmän dokumentointi Kandidaatintutkinnon opinnäytetyö, 20 sivua, 0 liitesivua Heinäkuu 2011 Pääaine: Automaation tietotekniikka Työn tarkastaja: DI Mikko Salmenperä Avainsanat: PHP, web, selain, tilausjärjestelmä, laskutusjärjestelmä, ohjelmointi Tässä työssä tarkastellaan jo toteutettua projektia, jossa asiakkaalle on toimitettu webpohjainen tilaus- ja laskutusjärjestelmä. Työssä parannettiin järjestelmästä olemassa olevaa dokumetaatiota. Päähuomio on kiinnitetty käytettyihin suunnittelumalleihin sekä ohjelmiston liityntöihin muihin järjestelmiin. Järjestelmällä tilaukset kirjataan suoraan sähköiseen muotoon. Järjestelmän avulla voidaan tilaukseen tulostaa suoraan osoitetarrat ja laskut. Lisäksi järjestelmän kautta voidaan hoitaa reskontra, sekä siirtää saatavia perittäväksi. Järjestelmän suunnittelussa on käytetty ns. MVC-mallia. Periaatteena mallissa on erottaa varsinainen sovelluslogiikka mahdollisimman selkeästi sitä ympäröivistä rajapinnoista, erityisesti käyttöliittymästä. Käytetty sovelluskehys AngelineCMS on omalta osaltaan ohjannut järjestelmän kehitystä MVC-mallin mukaiseksi tarjoamiensa palvelujen avulla. Järjestelmän liittymistä muihin järjestelmiin on tarkasteltu, ja käytännöt on todettu vaihteleviksi. Vaikka nykyään rajapintakäytäntöihin löytyy standardoituja menetelmiä, ovat käytössä olevat rajapinnat tapauskohtaisia, ja standardit eivät ole laajassa käytössä varsinkaan vanhemmissa järjestelmissä.

3 ii ALKUSANAT Tämä kandidaatintutkinnon opinnäytetyö on tehty Tampereen teknillisen yliopiston systeemitekniikan laitokselle. Työ on tarkoitettu myös järjestelmän toteuttaneen Satakunnan Verkkotekniikan myöhemmin hyödynnettäväksi. Esitän kiitokseni työn tarkastajalle, tutkija Mikko Salmenperälle sekä kaikille muille dokumentointiprojektissa ja tämän työn valmistumisessa myötävaikuttaneille.

4 iii SISÄLLYS 1. JOHDANTO OHJELMISTON YLEISKUVAUS Käyttäjät OHJELMISTON TOIMINNOT Tilaukset Asiakkaiden hallinta Myyjien hallinta Laskutus Raportointi OHJELMISTON RAKENNE Ohjelmistoympäristö Kolmansien osapuolien ohjelmistot Hakemistorakenne Sivupyyntö KÄYTETYT SUUNNITTELUMALLIT MVC-malli Virhe- ja poikkeusmenettelyt Koodistandardit LIITYNNÄT MUIHIN JÄRJESTELMIIN Itella zipcode Lindorff Prinet echannel Samlink Mikropankki JOHTOPÄÄTÖKSET JA YHTEENVETO LÄHTEET...20

5 iv LYHENTEET JA MERKINNÄT Bootstrap-tiedosto Tiedosto, jonne kaikki sivupyynnöt ohjataan, ja joka käynnistää ohjelman suorituksen. Frontcontroller Toimintalogiikan komponentti, joka käsittelee sivupyynnön ja ohjaa pyynnön halutulle Controllerille. CSS Cascading Style Sheets, on erityisesti WWW-dokumenteille kehitetty kieli esitystavan ja muotoilun määrittelyyn. HTTPS Hypertext Transfer Protocol Secure, on selaimien ja wwwpalvelimien käyttämä tiedonsiirtoprotokolla. MVC Model-View-Controller -suunnittelumalli, jolla käyttöliittymä ja tietosisältö on erotettu toimintalogiikasta. PHP Ohjelmointikieli, jolla järjestelmä on pääosin toteutettu. SFTP SSH File Transfer Protocol, (joskus kutsuttu myös nimellä Secure File Transfer Protocol), on tiedostonkäsittely ja -siirtoprotokolla. XSL Extensible Stylesheet Language, on kieli XML-dokumenttien ulkoasun määrittelemiseksi. XML extensible Markup Language, on rakenteellinen kuvauskieli, jolla tiedon merkitys ja itse tieto jäsennetään selkeäksi rakenteeksi.

6 1 1. JOHDANTO Tämä dokumentti on Tampereen teknilliseen yliopistoon tehtävä tekniikan kandidaatintutkinnon opinnäytetyö. Työssä tarkastellaan jo toteutettua projektia, jossa asiakkaalle on toimitettu web-pohjainen tilaus- ja laskutusjärjestelmä. Työn tarkoituksena on ollut parantaa järjestelmästä olemassa olevaa dokumetaatiota, ja perehtyä käytettyihin suunnittelumalleihin sekä ohjelmiston liityntöihin muihin järjestelmiin. Järjestelmän tilannut asiakas on Satakunnassa toimiva kenkätehdas, jolla on myyjiä ympäri Suomea. Ennen myyjät kirjasivat tilaukset A4 tilauslomakkeelle, jonka he postittivat tehtaalle. Siellä listat tarkistettiin ja korjattiin tarvittaessa. Listan perusteella kirjoitettiin tarralaput paketteihin ja kengät siirtyivät tuotantoon. Lisäksi tilaus kirjattiin erikseen laskutustyökaluun. Tilauksesta tehtiin Itellan portaalin kautta tulostettava osoitetarralappu. Sen jälkeen kengät lähtivät asiakkaalle ja laskut tilaajille. Seuraavassa kuussa kerättiin edellisen kuukauden myynneistä raportit, joiden perusteella laskettiin myyjille provisiot. Saapuneista viitesiirtomaksuista asiakas sai raportit pankista suoraan laskutusohjelmaan. Koko prosessi sisälsi aikaisemmin paljon käsityötä ja samat tiedot kirjattiin moneen kertaan. Lisäksi laskutusjärjestelmä oli monimutkainen ja hidas. Tilalle alettiin suunnitella uutta tilaus- ja laskutusjärjestelmää tarkoituksena saada tilaukset suoraan myyjältä sähköiseen muotoon, vähentää turhaa työtä ja liittää työkalu suoraan yhteistyökumppaneiden rajapintoihin. Järjestelmän käyttöä varten kaikilla myyjillä on kannettavat tietokoneet kiinteällä internetyhteydellä. Tarpeiden pohjalta syntyi järjestelmä, jota käytetään web-selaimella. Ohjelmointikielenä portaalin toteutuksessa on käytetty nykyisin varsin yleisesti käytettyä PHP-kieltä. Järjestelmä on jo tuotantokäytössä ja oikein toimivaksi sekä hyödylliseksi havaittu. Toteutusvaiheessa kuitenkin järjestelmän dokumentaatiota ei kirjoitettu kovin kattavaksi. Tämän työn tavoite on järjestelmän dokumentoinnin parantaminen. Työtä on suoritettu kirjoittamalla lyhyet kuvaukset kaikista järjestelmän toiminnoista, jolloin on muodostunut yleiskuva portaalista ja sen tarjoamista ominaisuuksista. Lisäksi dokumentointia on kirjoitettu käymällä kooditiedostot läpi ja kommentoimalla niihin luokkien vastuut, funktioiden rajapinnat ja muut huomioitavat asiat. Koodia oli kommentoitu jo ohjelmointivaiheessa, mutta kommentit eivät kattaneet koko ohjelmistoa. Näiden kommenttien pohjalta on myöhemmin mahdollista koostaa tarkat ohjelmointirajapintojen kuvaukset. Työssä on pyritty kiinnittämään huomiota erityisesti yleisiin suunnittelumalleihin ja liityntöihin muihin järjestelmiin. Suunnittelumalleilla pystytään yksinkertaistamaan huomattavasti monimutkaisen ohjelmiston rakennetta. Myös liityntöjen käyttämät rajapinnat erottuvat normaalisti selkeästi omina kokonaisuuksinaan piilottaen toteutettujen palveluiden toteutusyksityiskohdat ohjelmoijalta, mikä selkeyttää ohjemiston toimintaperiaatteita.

7 2 2. OHJELMISTON YLEISKUVAUS Myyjillä on kannettavat tietokoneet internetyhteydellä, joilla he kirjautuvat järjestelmään. He aloittavat uuden tilauksen hakemalla asiakkaan tiedot tai luomalla uuden asiakkaan. Tilaus voidaan jättää kesken ja jatkaa myöhemmin esimerkiksi myyjän liikkuessa eri osastojen välillä. Tilaus pysyy "avoimena" niin kauan kunnes myyjä lähettää sen eteenpäin. Kun tilaus on lopulta lähetetty, myyjä ei tämän jälkeen voi enää muokata tilausta. Tuotannossa toimivilla henkilöillä on pääkäyttäjätunnukset portaaliin, jolla he voivat selata kaikkia tilauksia. Pääkäyttäjä hakee listan uusista tilauksista ja tarkistaa ne. Mikäli tilauksessa on virheitä, hän voi vielä muokata tilausta. Jos tiedot tilauksessa ovat kunnossa, pääkäyttäjä merkitsee sen hyväksytyksi. Tämän jälkeen järjestelmä generoi tilauksista PDF-muotoisen sivun, jonka pääkäyttäjä tulostaa ja tilaus menee tuotantoon. Samalla tulostetaan lähetyslista pakettiin ja haetaan Itellan rajapinnan kautta automaattisesti postin pakettikortti, joka tulostetaan tarrapaperille. Järjestelmän laskutusosioon on pääsy ainoastaan tehtaan pääkäyttäjillä. Pääkäyttäjä luo tilauksesta heti laskut ja ne tulostetaan tilauksen mukaan. Laskuja voi tulla yksi tai useampi. Pääkäyttäjä voi myös luoda uusia laskuja ilman tilausta. Listan saapuneista viitemaksuista asiakas hakee käyttäen erillistä Samlink Mikropankki ohjelmistoa, joka tallentaa viitemaksulistat levylle. Tämä viitemaksulista voidaan ladata järjestelmän avulla palvelimelle jatkokäsittelyä ja seurantaa varten. Reskontra näyttää erääntyneet laskut ja laskut, joista on maksettu liikaa tai liian vähän. Laskulle voidaan luoda tarvittaessa hyvityslaskuja, esimerkiksi asiakkaan palauttaessa osan tuotteista. Laskuun voidaan myös tehdä korjauksia, jos esimerkiksi asiakas on maksanut laskun vahingossa kahdesti. Mikäli asiakas ei maksa laskua eräpäivään mennessä, lasku voidaan siirtää perintään. Siirrot perintään tapahtuvat portaalista Lindorff Oy:n tarjoaman rajapinnan kautta. 2.1 Käyttäjät Käyttäjätunnusvaihtoehtona on neljä eri tasoa: myyjän perusoikeudet (taso 1), myyjä tilausten hallintaoikeuksilla (taso 2), myyjä tilausten- ja pakettikorttien hallintaoikeuksilla (taso 3) sekä myyjä tilausten-, pakettikorttien- ja laskutuksenhallintaoikeuksilla (taso 4). Ylemmän tason käyttäjällä on kaikki alemmilla tasoilla käytössä olevat työkalut käytettävissä. Portaali näyttää aina vain toiminnot, joihin kyseisellä käyttäjällä on oikeudet, ja näin esimerkiksi etusivu muokkautuu kullekin käyttäjälle oikeanlaiseksi. Näin käyttäjille näkyvä käyttöliittymä on aina tarkoituksen mukainen, ja käyttäjällä on pääsy kaikkiin oikeustason mukaisiin toimintoihin, muiden toimintojen ollessa piilotetut.

8 3 3. OHJELMISTON TOIMINNOT Tämä luku sisältää lyhyen sanallisen kuvauksen järjestelmän tarjoamista toiminnoista. Toiminnon suorittamiseen vaadittu oikeustaso on alin mahdollinen taso, jolla on kyseiseen toimintoon oikeus. Myös kyseistä tasoa ylemmän oikeustason omaavat käyttäjät voivat kyseisen toiminnon suorittaa. Toimintoja päästään suorittamaan etusivulla olevien suorien linkkien kautta, tai valikon kautta haluttuun toimintoon siirtymällä. Kuvassa 1 näkyy laajimmat mahdolliset oikeudet omaavan käyttäjän etusivu. Kuva 1: Ylimmän tason oikeudet omaavalle käyttäjälle näkyvä etusivu 3.1 Tilaukset Uuden tilauksen syöttäminen Vaadittu oikeustaso: Taso 1 Toiminnon kuvaus: Valitaan valikosta Tilaukset Uusi tilaus. Ensin valitaan asiakas/toimitusosoite. Seuraavaksi valitaan tilaaja, eli henkilö toimituspaikassa, jolle tuotteet toimitetaan sekä laskutusosoite. Tilattavat tuotteet liitetään aina tilaajaan, joita voi olla tilauksessa yksi tai useampia. Seuraavassa vaiheessa lisätään tilattavia tuotteita tilaukseen ja myös toimitusmaksu on muokattavissa. Lopuksi näytetään yhteenveto uudesta tilauksesta, jonka jälkeen talletetaan tilaus odottamaan käsittelyä.

9 Lopputulos: Tilaus on talletettu tietokantaan ja se jää odottamaan tuotantoon hyväksymistä. 4 Tilauksien selaus Vaadittu oikeustaso: Taso 1 / Taso 2. Tason 1 oikeuksilla voi selata vain itse tehtyjä tilauksia. Toiminnon kuvaus: Valitaan valikosta Tilaukset Selaa tilauksia. Hakua voidaan rajata tilauksen vaiheen mukaan tai aikavälin mukaan, tai tilaus voidaan hakea suoraan tilausnumeron mukaan. Vähintään tason 2 käyttäjillä hakukriteerinä on valittavana myös myyjä. Lopputulos: Hakukriteerit täyttävät tilaukset on listattu ruudulle. Tilauksen käsittely Vaadittu oikeustaso: Taso 1 / Taso 2 / Taso 3 Toiminnon kuvaus: Ollaan valittu haluttu tilaus tarkasteltavaksi. Tilauksen tiedot voidaan tulostaa suoraan paperille valitsemalla Tulosta tilaus. Vähintään tason 2 käyttäjä voi valita hyväksyntää odottavalle tilaukselle Hyväksy tilaus. Lisäksi vähintään tason 2 käyttäjällä on jo hyväksyttyä tilausta käsiteltäessä valittavana Lataa osoitetarraarkki, joka avaa PDF-muodossa tarra-arkille sopivaksi muotoillut osoitetiedot. Vähintään tason 3 oikeudet omaava käyttäjä voi lisäksi valita toiminnon Pakettikortit jo hyväksytylle tilaukselle. Toiminto luo Itellan pakettikortti rajapinnan avulla PDFmuotoisen pakettikortin, joka sisältää lähettäjän ja vastaanottajan tiedot, Itellan käyttämät viivakooditunnisteet sekä lähetysseurantatunnuksen. Lopputulos: Tilaus on käsitelty halutulla tavalla. Yhteenvedon listaus Vaadittu oikeustaso: Taso 1 / Taso 2. Tason 1 oikeuksilla voi selata vain itse tehtyjä tilauksia. Toiminnon kuvaus: Valitaan valikosta Tilaukset Tilausten yhteenveto. Haku voidaan rajata aikavälin mukaan. Vähintään tason 2 oikeudet omaavilla käyttäjillä hakukriteerinä on valittavana myös myyjä. Lisäksi tason 2 oikeuksilla on myös etusivulla valittavana suoraan tilauksien yhteenveto, joka listaa yhteenvedon kyseisen kuukauden tilauksista. Lopputulos: Kriteerien mukainen yhteenveto tilauksista tehty. Laskurivien listaus Vaadittu oikeustaso: Taso 1 / Taso 2. Tason 1 oikeuksilla voi selata vain omiin tilauksiin liittyviä laskuja. Toiminnon kuvaus: Valitaan valikosta Laskutus Laskurivit. Haku voidaan rajata aikavälin mukaan. Kukin myyjä pääsee näin itse tutkimaan omista tilauksista tehtyjä laskurivejä. Laskutuksenhallinta- ja pääkäyttäjän oikeuksilla hakukriteerinä on valittavana myös myyjä. Lopputulos: Halutut laskurivit on listattu.

10 5 Keskeneräiset tilaukset Vaadittu oikeustaso: Taso 1 Toiminnon kuvaus: Eusivulta voidaan valita omat keskeneräiset tilaukset. Keskeneräisiä tilauksia voidaan jatkaa, tai poistaa kyseinen tilaus. Valittavan linkin nimessä näkyy, montako tilausta käyttäjällä on kesken. Lopputulos: Keskeneräiset tilaukset listattu. Saapuneet tilaukset Vaadittu oikeustaso: Taso 2. Toiminnon kuvaus: Etusivulta valitaan Saapuneet tilaukset. Valittavan linkin nimessä näkyy, montako kappaletta saapuneita tilauksia on. Lopputulos: Listataan saapuneet tilaukset, jotka odottavat vahvistusta. 3.2 Asiakkaiden hallinta Uuden asiakkaan lisääminen Vaadittu oikeustaso: Taso 1 Toiminnon kuvaus: Valitaan valikosta Asiakkaat Uusi asiakas, jolloin aukeaa lomake uuteen ikkunaan. Lomakkeelle täytetään asiakkaan tiedot ja painetaan Luo asiakas, jolloin asiakkaan tiedot tallentuvat tietokantaan. Lopputulos: Uuden asiakkaan tiedot on tallennettu järjestelmään. Asiakkaan haku Vaadittu oikeustaso: Taso 1 Toiminnon kuvaus: Valitaan valikosta Asiakkaat Hae asiakas. Hakuehdoiksi voidaan kirjoittaa nimi/asiakasnumero, yhteyshenkilön nimi sekä postitoimipaikka. Lopputulos: Hakukriteerit täyttävät asiakkaat on listattu. Asiakkaiden listaus Vaadittu oikeustaso: Taso 1 Toiminnon kuvaus: Valitaan valikosta Asiakkaat Listaa asiakkaat, jolloin listautuvat kaikki järjestelmässä olevat asiakkaat. Lopputulos: Kaikki järjestelmässä olevat asiakkaat on listattu. 3.3 Myyjien hallinta Myyjän lisääminen Vaadittu oikeustaso: Taso 2 Toiminnon kuvaus: Valitaan valikosta Myyjät, jolloin tulostuu lista järjestelmässä olevista myyjistä ja lomake uuden myyjän luomista varten. Täytetään lomakkeelle

11 uuden myyjän tiedot ja painetaan Lisää käyttäjä, jolloin myyjän tiedot tallentuvat järjestelmään. Lopputulos: Uuden myyjän tiedot on tallennettu järjestelmään. 6 Myyjän tietojen muokkaaminen Vaadittu oikeustaso: Taso 2 Toiminnon kuvaus: Valitaan listasta myyjä, jonka tietoja halutaan muokata. Aukeavalla sivulla on mahdollista muokata myyjän tietoja, lukuunottamatta käyttäjätunnusta, joka on pysyvä. Myös myyjän käyttäjätaso voidaan päivittää, jos taso on alempi kuin päivittäjän. Tasoa ei voi myöskään nostaa omaa tasoa korkeammaksi. Lopputulos: Myyjän tiedot päivitetty onnistuneesti. 3.4 Laskutus Uusi lasku Vaadittu oikeustaso: Taso 4 Toiminnon kuvaus: Valitaan etusivulta Uusi lasku. Seuraavaksi valitaan tilaus, johon lasku kohdistuu tai valitaan Uusi lasku ilman tilausta. Jos tehdään lasku ilman tilausta, kirjataan tarvittavat tiedot, joista luodaan lasku. Jos taas lasku liittyy tiettyyn tilaukseen, koostaa järjestelmä laskun tilauksen tiedoista. Lasku liitetään aina johonkin myyjätunnukseen. Jos lasku luodaan tilauksesta, myyjä on automaattisesti tilauksen tekijä. Jos taas luodaan lasku ilman tilausta, on myyjä valittava alasvetovalikosta laskua luodessa. Luodun laskun käsittelyä voidaan lopuksi jatkaa halutulla tavalla. (ks. Laskun käsittely) Lopputulos: Uusi lasku on tallennettu järjestelmään. Erääntyneet laskut Vaadittu oikeustaso: Taso 4 Toiminnon kuvaus: Valitaan etusivulta Erääntyneet laskut, jolloin aukeaa listaus myyntireskontrasta. Listaus sisältää kaikki laskut, joiden eräpäivä on mennyt ja suoritus on ollut eri suuruinen kuin laskun loppusumma tai suoritus puuttuu kokonaan. Haluttu lasku voidaan valita tarkempaan tarkasteluun. (ks. Laskun käsittely) Lopputulos: Listattu erääntyneet laskut. Laskujen selaus Vaadittu oikeustaso: Taso 4 Toiminnon kuvaus: Valitaan etusivulta Selaa laskuja, jolloin kaikki laskut listataan kirjaamisjärjestyksessä. Valitaan haluttu lasku käsiteltäväksi. (ks. Laskun käsittely) Lopputulos: Kaikki laskut on listattu. Laskujen haku Vaadittu oikeustaso: 4

12 Toiminnon kuvaus: Valitaan etusivulta Hae laskuja, jolloin hakulomake aukeaa. Täytetään halutut hakukriteerit, joita ovat laskutettavan nimi, laskun numero ja viitenumero. Kriteerien mukaiset laskut listataan, jonka jälkeen voidaan valita haluttu lasku tarkempaan tarkasteluun. (ks. Laskun käsittely) Lopputulos: Hakukriteerien mukaiset laskut listattu. 7 Laskun käsittely Vaadittu oikeustaso: 4 Toiminnon kuvaus: On avattu haluttu lasku käsiteltäväksi. Käsiteltävä lasku voidaan avata PDF-muodossa, jolloin laskulle tulostuvat laskun tiedot sekä valmis tilisiirtolomake. Voidaan myös valita tilauksen tiedot tarkasteltavaksi tai muokata laskun eräpäivää. Lisäksi laskulle voidaan tehdä hyvityslasku tai se voidaan lähettää perittäväksi valitsemalla Siirrä perintään. Valittavana on myös suorituksen kirjaaminen. (ks. Suorituksien kirjaaminen) Lopputulos: Valittu lasku käsitelty halutulla tavalla. Suorituksien kirjaaminen Vaadittu oikeustaso: Taso 4 Toiminnon kuvaus: Valitaan etusivulta Uusi suoritus. Mikäli käytössä on Samlink Mikropankki ohjelmisto, voi käyttäjä ladata ohjelmalla haetut viitemaksutiedostot reskontraan avautuvalla tiedostontallennus lomakkeella. Suoritus voidaan kirjata suoraan myös käsin täyttämällä maksun tiedot. Käyttäjälle näytetään yhteenveto syötetyistä tiedoista sekä varoitus, mikäli suorituksten jälkeen jollekin laskulle on tehty liikaa suorituksia. Lopuksi käyttäjä hyväksyy yhteenvedon tiedot valitsemalla Tallenna viitemaksut. Myös tarvittavat korjaukset tehdään Suorituksien kirjaaminen -toiminnon avulla, jos asiakas on esimerkiksi vahingossa maksanut laskun kahteen kertaan. Tällöin maksetaan asiakkaan tilille palautettava osa ja kirjataan kyseinen summa järjestelmään miinus-merkkisenä suorituksena. Lopputulos: Suoritus on kirjautunut reskontraan. Suoritusten selaaminen Vaadittu oikeustaso: Taso 4 Toiminnon kuvaus: Valitaan etusivulta Selaa suorituksia, jolloin näytölle tulostuu lista suorituksista suoritusjärjestyksessä. Lasku, johon suoritus on kohdistunut, voidaan valita tarkempaan tarkasteluun. (ks. Laskun käsittely) Lopputulos: Suoritukset on listattu. Perintätapahtumien käsittely Vaadittu oikeustaso: Taso 4 Toiminnon kuvaus: Valitaan etusivulta Perintätapahtumat. Valitaan tarkasteltava aikaväli ja valitaan halutessa myyjä, jonka tapahtumat listataan. Syntyvästä listauksesta voidaan siirtyä tarkastelemaan perintään liittyvää laskua valitsemalla Näytä lasku. (ks.

13 Laskun käsittely) Tarkasteltavan perintätapahtuman tiedot saadaan näkyviin valitsemalla Tiedot. Jos perinnässä olevia laskuja on maksettu suoraan yritykselle tai esimerkiksi reklamaation vuoksi on päätetty antaa asiakkalle hyvitystä, tulee suoritus kirjata normaalisti (ks. Suorituksien kirjaaminen) tai tehdä normaali hyvityslasku. Tämän jälkeen nämä muutokset ilmoitetaan perintään valitsemalla Tee muutosilmoitus. Jos muutosilmoituksen jälkeen perittävä summa on nolla euroa, lopetetaan perintä automaattisesti. Jos suoritus tapahtuu perinnän kautta, tulee se kirjata järjestelmään valitsemalla Kirjaa perinnän kautta saatu suoritus, joka merkitsee perintätapahtuman tietoihin suorituksen saaduksi. Lopputulos: Perintätapahtumat on käsitelty halutulla tavalla Raportointi Tilausten myyjätilastot Vaadittu oikeustaso: Taso 4 Toiminnon kuvaus: Valitaan etusivulta Laskutus Myyjätilastot, jolloin aukeaa yhteenveto kyseiseltä kuukaudelta myyjistä, joilla on tapahtumia tarkasteltavalla ajanjaksolla. Yhteenvedossa näkyvät kunkin myyjän myyntien summat, mahdolliset alennukset ja hyvitykset sekä tapahtumien lukumäärät. Halutessa tilastot voidaan hakea myös muulta ajanjaksolta valitsemalla tarkenna hakuehtoja. Lopputulos: Listattu tilastot myyjien myynneistä. Myyntireskontra Vaadittu oikeustaso: Taso 2 Toiminnon kuvaus: Valitaan etusivulta myyntireskontra, jolloin valittavaksi tulee ajanjakso ja mahdollisesti myyjä, kenen tapahtumat listataan. Listauksesta voidaan valita haluttu lasku käsiteltäväksi. (ks. Laskun käsittely) Lopputulos: Avoinna olevat laskut haluttujen hakukriteerien mukaan on listattu. Suoritusennuste Vaadittu oikeustaso: Taso 4 Toiminnon kuvaus: Valitaan etusivulta Suoritusennuste, jolloin muodostuu ennuste tulevista suorituksista laskujen eräpäivien ja myyntireskontran perusteella. Listauksesta voidaan nähdä eräpäivät ja summat, sekä valita haluttu lasku käsiteltäväksi. (ks. Laskun käsittely) Lopputulos: Oletettavissa olevat suoritukset on listattu. Laskutuksen myyjätilastot Vaadittu oikeustaso: Taso 2 Toiminnon kuvaus: Valitaan etusivulta Tilaukset Myyjätilastot, jolloin aukeaa yhteenveto kyseiseltä kuukaudelta kaikista myyjistä. Yhteenvedossa näkyy kunkin myyjän myyntien summat, mahdolliset alennukset sekä tapahtumien lukumäärät.

14 Halutessa tilastot voidaan hakea myös muulta ajanjaksolta valitsemalla tarkenna hakuehtoja. Lopputulos: Listattu tilastot myyjien myynneistä. 9 Perintäraporttien listaus Vaadittu oikeustaso: Taso 4 Toiminnon kuvaus: Valitaan etusivulta Perintäraportit, jolloin tulee valittavaksi raportin päiväys ja raportin tyyppi. Valittu raportti haetaan Lindorffin palvelimelta ja näytetään käyttäjälle PDF-muodossa. Lopputulos: Haluttu perintäraportti on esitetty käyttäjälle.

15 10 4. OHJELMISTON RAKENNE Ohjelmiston suunnittelussa kantavana ajatuksena on ollut ohjelmiston ytimen tekeminen mahdollisimman yleiskäyttöiseksi. Ohjelmisto voidaankin jakaa hyvin karkeasti kolmeen osaan kuvan 2 mukaisesti. Nämä jaetut luokat, joista käytetään nimitystä kernel, eivät sisällä ollenkaan projektikohtaisia tiedostoja. Ohjelmiston räätälöintiin käytetään moduuleita. Toisin kuin kernel, moduulit ovat täysin projektikohtaisia tiedostoja. Moduulit eivät kuitenkaan saa tehdä yhtään tietokanta- tai rajapintakyselyä suoraan vaan kaikki toiminnot menevät jaettujen luokkien kautta. Lisäksi järjestelmän koonnissa on käytetty useita kolmansien osapuolien ohjelmistoja, sekä valmiita koodikirjastoja, jotka erottuvat ohjelman rakenteesta erilliseksi osa-alueeksi. Kuva 2: Ohjelmiston jakautuminen osiksi 4.1 Ohjelmistoympäristö Järjestelmä on asennettu dedikoidulle Linux Ubuntu palvelimelle, jossa on käytössä Apache 2 palvelinohjelmisto. Järjestelmä on toteutettu pääosin PHP ohjelmointikielellä, joten palvelimelta vaaditaan PHP versio 5.2. Tietokantana käytössä on MySQL:n versio 5. Kehityksessä on käytetty apuna myös Git versionhallintaohjelmistoa. Vastaava ohjelmistoympäristö on todella yleinen kokoonpano verkkopalveluja toteutettaessa. Koska Linux ja Apache perustuvat avoimeen lähdekoodiin on niiden käyttö maksutonta. Lisäksi MySQL tietokanta on saatavissa ilmaiseksi ns. GNU GPL lisenssillä, joka tarkoittaa, että kaikilla on oikeus käyttää, kopioida, muuttaa ja levittää tällaista ohjelmaa ja sen lähdekoodia. Näin ollen koko ympäristö on käytettävissä ilman lisensiointikustannuksia.

16 Kolmansien osapuolien ohjelmistot Ohjelmisto käyttää AngelineCMS sovelluskehyksen tarjoamia palveluita. AngelineCMS on avoimeen lähdekoodiin perustuva sovelluskehys, joka sisältää useita hyödyllisiä ratkaisuja web-sivuston kehitystä varten. AngelineCMS:n palveluilla on toteutettu portaaliin käyttäjien tunnistus, istunnonhallinta, tietokantayhteys ja toiminnot sivun generoimista varten. [1] Laskut tulostetaan PDF-muodossa. Tätä varten käytössä on Apache FOP 1.0. Se on java-pohjainen ohjelmisto, jolla luodaan PDF-tiedostoja XSL:FO kuvauksista (Extensible Stylesheet Language ). [2] Ohjelmisto käyttää Lindorffin tarjoamaa rajapintaa perintätapahtumien käsittelyyn, joka vaatii SFTP yhteyden (SSH File Transfer Protocol ). SFTP-yhteys on toteutettu käyttämällä phpseclib koodikirjastoa. Phpseclib on toteutettu PHP kielellä ja se tarjoaa toteutuksen useisiin salausmenetelmiin kuten SFTP, SSH 1, SSH 2 ym. [3] Multiflex 4.2 on sivustolla käytettävä CSS (Cascading Style Sheets) -teema. Teema mahdollistaa sivuston muotoilun hallinnan vaivattomasti. Teemaa käytetään generoitaessa näytettävä sivu, jolloin esimerkiksi valikoiden lukumäärän vaihdellessa muotoilu säilyy yhtenäisenä ja loogisena. [4] 4.3 Hakemistorakenne Ohjelmiston hakemistorakenteesta käyvät ilmi osat, joista ohjelmisto koostuu, ja niiden sijainti kokoonpanossa: conf/ sisältää AngelineCMS sovelluskehyksen vaatiman XML-kuvauksen (Xtensible Markup Language) sivustosta extensions/kernel/ ohjelmistoa varten kehitetyt jaetut luokat extensions/modules/ tiettyä projektia varten kehitetyt moduulit ja loppukäyttäjälle näkyvät osiot extensions/themes/ kyseisen projektin teeman XSL-kuvaus public/ selaimella avattavissa olevat julkiset tiedostot. Käytännössä sisältää vain ohjelmiston konfiguraatio-tiedoston, ns. bootstrap-tiedoston ja teeman vaatimat javascript-, css- ja kuvatiedostot public/index.php ns. bootstrap-tiedosto, joka käynnistää AngelineCMS sovelluskehyksen ja kutsuu frontcontrolleria public/config.php Sivuston konfiguraatiotiedosto, joka sisältää konfiguraation asetukset sekä joitain jaettuja funktioita. Tiedosto tunnistaa palvelimen hostnimen perusteella käytetäänkö kehitysversion asetuksia, testausversion asetuksia vai tuotantoversion asetuksia angelinecms/trunk/ AngelineCMS sovelluskehyksen käytettävä versio bin/fop/ Apache FOP phpseclib-0.2.1/ PHPSECLIB SFTP yhteyksiä ja SSH salausta varten

17 12 Kernel on toteutettu tavoitteena mahdollisimman hyvä uudelleen käytettävyys. Alla on eritelty kernelin hakemistosta löytyvät tiedostot ja kansiot: dataobject.php DataObject-luokka on abstrakti kantaluokka, jota kaikki yhtä tietokannan taulun riviä kuvaavat objektit laajentavat. Luokka pitää sisällään rajapintafunktioita kyseisen rivin tietosisällön käsittelyä varten. datalist.php DataList-luokka on abstrakti luokka, jota kaikki tietokannan hakutulosta kuvaavat objektit laajentavat. Luokka pitää sisällään rajapintafunktioita tietokantahakujen tuloksien selaamista ja käsittelyä varten. iso3166.php ISO-3166 standardin sisältämät maakoodit pricecalc.php Hintojen ym laskemiseen tarkoitettu jaettu luokka erp/bill/ Laskutuksen hallinnan toteuttavat luokat erp/customer/ Asiakkaan hallinnan toteuttavat luokat erp/order/ Tilausten hallinnan toteuttavat luokat erp/dealer.php Myyjätunnuksien hallinnasta huolehtiva luokka erp/validate.php Käyttäjältä saadun datan validoinnista vastaava luokka itella/zipcode/ Postinumeroiden validoinnista huolehtiva luokka, jonka toiminta perustuu Itellan maksulliseen postinumeroluetteloon lindorf/ Lindorffin SFTP-rajapinnan käytöstä vastaavat luokat prinet/echannel/ Itellan pakettikortti-rajapinnan kanssa toimimisesta huolehtivat luokat samlink/ Samlink Mikropankki ohjelmiston tuottaman viitesiirtotiedoston käsittelystä vastaava luokka xml/fop/ Apache FOP ohjelman käytöstä vastaava luokka, joka luo tarvittaessa PDF-tiedoston XSL:FO kuvauksen pohjalta Toisin kuin kernel, moduulit ovat täysin projektikohtaisia tiedostoja. Moduulit eivät saa tehdä yhtään tietokanta- tai rajapintakyselyä suoraan vaan kaikki toiminnot menevät kernelin luokkien kautta. Esimerkki moduulin hakemistorakenteesta: order/order.php order niminen kontrolleri (pakollinen) order/order.xsl order kontrollerin tyylitiedosto order/order.xml order kontrollerin käännökset (suomi, englanti...) order/conf.xml order moduulin konfiguraatiotiedosto (pakollinen) order/search.php order_search niminen kontrolleri order/search.xsl order_search kontrollerin tyylitiedosto order/order.js order moduulin mahdollinen javascript-tiedosto, jota ei muissa moduuleissa käytetä order/order.css order moduulin CSS tyylitiedosto, jota ei muissa moduuleissa käytetä Kuten esimerkistä näkyy, moduuli voi sisältää useita konrollereita.

18 Sivupyyntö Ohjelmiston alustana toimii AngelineCMS sovelluskehys. Sivupyynnön prosessi etenee seuraavasti: 1. Käyttäjä avaa jonkin sivun, kuvitteellinen esimerkki /order/show/id/12 2. Apache ohjaa pyynnön /public/index.php bootstrap-tiedostoon käyttäen.htaccess tiedostossa määriteltyjä rewrite-sääntöjä 3. Bootstrap liittää mukaan AngelineCMS:n, ohjelmiston konfiguraatiotiedoston ja sen jälkeen kutsuu AngelineCMS:n frontcontrolleria. 4. Frontcontroller jäsentää saapuneen pyynnön /order/show/id/12 1. order on pyydetty moduuli 2. show on pyydetty metodi moduulissa 3. id/12 on metodille annettava parametri id=12 5. Frontcontroller tarkistaa, onko käyttäjällä oikeus pyydettyyn moduuliin 6. Frontcontroller lataa pyydetyn moduulin extensions/modules hakemistosta 7. Frontcontroller kutsuu pyydettyä metodia 8. Ellei moduuli toisin määrää, Frontcontroller generoi XHTML sivun. Sivut generoidaan XML + XSL tiedostojen pohjalta. Teeman XSL-tiedosto löytyy extensions/themes hakemistosta. Tähän liitetään mukaan moduulin hakemistossa oleva XSL-tiedosto sekä moduulin antamat XML-muuttujat.

19 14 5. KÄYTETYT SUUNNITTELUMALLIT Ohjelmistojen suunnittelussa käytetään usein jotain suunnittelumallia. Malleja käyttämällä pyritään selkeyttämään ohjelmiston rakennetta. Suunnittelumalleja käyttämällä monimutkaisista kokonaisuuksista on mahdollista saada loogisiin osiin jakautuvia ja helpommin hallittavia. 5.1 MVC-malli Järjestelmän suunnittelussa on käytetty tärkeimpänä ajatuksena ns. MVC mallia. Periaatteena mallissa on erottaa varsinainen sovelluslogiikka mahdollisimman hyvin sitä ympäröivistä rajapinnoista, erityisesti käyttöliittymästä [5 s.386]. Mallin nimi tulee sanoista model, view ja controller. Model, eli malli tarkoittaa ohjelman sisältämää tietosisältöä. View, eli näkymä tarkoittaa käyttäjälle näkyvää osaa, käyttöliittymää. Controller, eli toimintalogiikka ohjaa järjestelmän toimintaa kuvan 3 mukaisesti. Kuva 3: MVC-malli Model pitää sisällään kaikki esitettävät tiedot, tietokannat ja niiden muuttamiseen tarvittavat toiminnot. Tietokannan on siis tarjottava tietosisältöön liittyviä palveluita toimintalogiikalle. Tämän portaalin tapauksessa tällaista tietoa ovat esimerkiksi asiakastietokannat, tilaushistoriat, laskujen tiedot ja myyjien tiedot. Käyttöliittymä (View) on osakokonaisuus, joka näkyy käyttäjälle selaimessa. Tämä käyttöliittymä muodostuu dynaamisesti tilanteen mukaiseksi toimintalogiikan ohjaamana. Käyttöliittymästä ollaan yhteydessä tietokantaosan tarjoamiin palveluihin toimintalogiikan välityksellä. Se esimerkiksi ohjaa käyttäjän antamat syötteet kontrolliosan käsiteltäväksi, muotoilee tulosteet halutunlaisiksi ja tulostaa tarvittaessa virheilmoituksen. Käyttöliittymä ei siis koskaan pääse suoraan käsiksi tietokantoihin, vaan tieto kulkee aina kontrollikerroksen kautta.

20 Toimintalogiikka eli kontrolleri (Controller) on nimensä mukaisesti ohjausosa, joka vastaa toimintojen suorituksesta ja järjestelmän ohjaamisesta. Kontrollerin ytimenä toimii AngelinCMS:n frontcontroller, joka jäsentää sivupyynnöt ja ohjaa suorituksen aina oikeaan paikkaan kutsuen oikeaa kontrollia ja metodia. Toimintalogiikka myös huolehtii liitynnöistä muihin järjestelmiin ja niiden tarvitsemasta viestiliikenteestä. Kontrolliosa huolehtiikin esimerkiksi käyttöliittymältä tulevista syötteistä, tietokantahakujen suorittamisesta ja kulloinkin halutun sivun kutsumisesta. Käytetty sovelluskehys AngelineCMS pyrkii omalta osaltaan ohjaamaan kehitystä MVC-mallin mukaiseksi tarjoamiensa palvelujen avulla. Se ei suoraan pakota ohjelmoijaa käyttämään orjallisesti MVC-mallia, mutta sen tarjoamat rajapinnat ohjaavat tietokannan ja käyttöliittymän erottamiseen toimintalogiikasta. Graafisia käyttöliittymiä ja verkko-ohjelmointia tukevat sovelluskehykset noudattavat melko yleisesti juuri MVC-mallia [6 s.6] Virhe- ja poikkeusmenettelyt Virheiden käsittelyä varten käytössä on yksinkertainen poikkeushierarkia. Virheen sattuessa annetaan myös sanallinen virheilmoitus, joka mahdollisimman selkeästi kuvaa virheen syyn. Omanlaisensa poikkeukset löytyvät mm. tietokantavirheelle ja käyttäjän autentikointivirheelle. Poikkeukset parantavat järjestelmän virheensietokykyä, koska poikkeukset voidaan käsitellä ja mahdollisista virhetilanteista voidaan toipua. Poikkeuksien kanssa on kuitenkin oltava huolellinen, koska poikkeus, jota ei oteta kiinni ja käsitellä, aiheuttaa ohjelman lopettavan virhetilan [7]. 5.3 Koodistandardit Kaikki PHP-koodit on tehty olio-ohjelmointi periaatteita noudattaen. Proseduaalista koodia on ainoastaan bootstrap ja konfiguraatio-tiedostoissa. Koodin muotoilussa on käytetty ennnalta määritettyjä käytäntöjä ja vakiintuneita muotoiluperiaatteita. Kaikki kooditiedostot on sisennetty 4 merkin tab-sisennyksillä. Luokkien nimet on kirjoitettu aina CamelCase muodossa, isolla alkukirjaimella. Kaikkien metodien nimet ovat vastaavasti camelcase muodossa, pienellä alkukirjaimella. Kaikkien muuttujien nimet on kirjoitettu pienellä alkukirjaimella muutamaa poikkeusta lukuunottamatta. Lisäksi kaikkeen koodiin ja kommentointiin on päätetty kieleksi englanti ja kaikki tiedostot on tallennettu UTF-8 muodossa, jota suositellaan käytettäväksi, kun kyseessä on websivusto [8 s.164]. Luokkien, metodien ja attribuuttien kommentointi on tehty phpdoc/javadoc yhteensopivassa muodossa kooditiedostoihin. Tämän mallin mukainen kommentointi mahdollistaa dokumentin automaattisen koostamisen, josta selviää metodien parametrit, toiminta ja muu ohjelmoijalle oleellinen informaatio. Kommentoinnin syntaksista on esimerkki alapuolella.