HANSA raportointityökalu
Sisällysluettelo
Yhteenveto
1. Johdanto
1.1. Ohjelmiston tarkoitus ja kohderyhmä
1.2. Termit
1.3. Dokumentin esittely
2. Yleiskuvaus
2.1. WWW-palvelu
2.2. Pääkäyttäjä
2.3. Loppukäyttäjä
3. Tiedot ja tietokanta
3.1. HTML
3.2. CompuPron tietokanta
3.2.1. Raporttitiedostot
3.2.2. Muut tietotyypit
3.3. Asiakkaan tietokanta
3.4. Tiedot pääkäyttäjän
ja loppukäyttäjän välillä
3.4.1. Raporttigeneraattori
3.4.2. Määritetiedosto
3.4.3. Käyttöoikeuksien
hallintatiedosto
3.5. Tiedon pysyvyys-, saantiaika- ja kapasiteettivaatimukset
4. Toiminnot
4.1. WWW-serverin tietokannan ylläpitokäyttöliittymä
4.2. WWW-serverin raporttitiedostojen hakukäyttöliittymä
4.3. Loppukäyttäjän käyttöliittymä
5. Ulkoiset liittymät
5.1. WWW-serverin tietokannan ylläpitokäyttöliittymä
5.1.1. Käyttöliittymän
ulkoasu
5.1.2. Liittymät oheislaitteisiin
ja tietoliikenteeseen
5.2. WWW-serverin raporttitiedostojen hakukäyttöliittymä
5.2.1. Käyttöliittymän
ulkoasu
5.2.2. Liittymät oheislaitteisiin
ja tietoliikenteeseen
5.3. Loppukäyttäjän käyttöliittymä
5.3.1. Käyttöliittymän
ulkoasu
5.3.2. Liittymät oheislaitteisiin
ja tietoliikenteeseen
6. Muut ominaisuudet
Yhteenveto
Tarkoituksena on tehdä ohjelmisto, jolla hoidetaan raportteja tuottavien tiedostojen jakelu CompuProlta asiakkaille. Jakelu tapahtuu CompuProlta asiakkaalle WWW-palvelun avulla. Ohjelmiston käyttäjät voidaan jakaa CompuPron WWW-ylläpitoon, asiakkaan pääkäyttäjään ja asiakkaan loppukäyttäjiin. WWW-ylläpito huolehtii palvelun ajan tasalla pitämisestä eli esim. tietokannan ylläpidosta ja käyttäjäoikeuksien hallinnasta. Pääkäyttäjä on asiakkaan puolella toimiva henkilö, joka valitsee CompuPron WWW-palvelusta sopivat raportin tuottamiseen liittyvät tiedostot itselleen. Pääkäyttäjä huolehtii tiedostojen sijoittelusta asiakkaan loppukäyttäjien ulottuville, määritellen niille tarvittaessa rajoituksia käyttäjien tai käyttäjäryhmien suhteen. Loppukäyttäjät ovat pääasiallisia raportin jakelun kohteita, jotka tulostavat raportteja ajettavista tiedostoista eli raporttigeneraattoreista, jotka pääkäyttäjä on asettanut heidän ulottuvilleen NFS-yhteydellä tai vastaavalla tekniikalla.
Järjestelmän ulkoisia liittymiä ovat CompuPron tietokannan WWW-ylläpitokäyttöliittymä, pääkäyttäjän raporttitiedostojen WWW-hakukäyttöliittymä, loppukäyttäjän käyttöliittymä ja liittymät CompuPron ja asiakkaan tietokantoihin.
CompuPron tietokannassa on yhtä raporttioliota kohti mm. WWW-palvelun kautta näytettävä HTML-raporttiesimerkki ja sanallinen kuvaus, hakuprosessissa käytettäviä kriteereitä, ja jaeltavien tiedostojen nimet. CompuProsta jaellaan raportin tuottamista varten raporttigeneraattoreita eli valmiita, ajettaessa raportin tulostavia ohjelmia, sekä raporttipohjia, jolloin raportin rakenne on pääkäyttäjän muokattavissa Crystal Reports-ohjelmalla ja sen jälkeen käännettävissä raporttigeneraattoriksi. Loppukäyttäjälle jaeltavat tiedostot ovat raporttigeneraattoreita, jotka on aseteltu loppukäyttäjän NFS:n tms. ulottuvilla olevaan hakemistoon. Hakemistossa on myös kutakin raporttigeneraattoria kohti pääkäyttäjän tekemä määrittelytiedosto, josta loppukäyttäjän käyttöliittymä osaa lukea mm. käyttöoikeuksia, raporttigeneraattorin tyypin ja lyhyen kuvauksen siitä, minkälaista jälkeä raporttigeneraattori tuottaa. Raporttigeneraattori hakee raporttiin tarvittavat tiedot asiakkaan HANSA-tietokannasta ODBC-rajapinnan läpi.
Loppukäyttäjän käyttöliittymä koostuu choice box-tyyppisestä hakukriteerivalikosta, valikkoikkunasta johon muodostuu kriteerin perusteella hakupuu, seka kuvausikkunasta johon tulostuu valintapalkin kohdalla olevan tiedoston kuvaus. CompuPron tietokannan ylläpitokäyttöliittymällä voi lisätä raporttiolioita tai käyttäjiä sekä muuttaa tai poistaa hakusanan tai muiden kriteerien avulla etsittyjä käyttäjän tai raportttiolion tietoja. Pääkäyttäjän käyttöliittymässä käyttäjä rajaa mieluisiaan raporttiolioita hakusanan ja erilaisten kriteerien avulla, ja voi haun tehtyään tutkia rajatuista HTML-raporttiesimerkkejä ja muita tietoja sekä ladata olioita vastaavat tiedostot.
Mainittavia järjestelmän kehityksen kannalta huomioon otettavia
seikkoja suorituskyky-, tiedon pysyvyys-, saantiaika- ja kapasiteettivaatimuksien
suhteen ei ole, tietoturvan kannalta joitain vähäisiä. Käytön
helppous eli oikean tyyppisen raportin tuottavien tiedostojen löytäminen
käyttäjäystävällisellä tavalla (sekä
loppukäyttäjän että pääkäyttäjän
käyttöliittymässä) on tärkeää.
1. Johdanto
1.1. Ohjelmiston tarkoitus ja kohderyhmä
Ohjelmiston tarkoitus on helpottaa CompuPron HANSA-ohjelmistoa käyttävien
asiakkaiden raportointia. Tavoitteena on saada hallittu tietokanta näistä
tiedostoista, jotta niitä voidaan tehokkaasti uusiokäyttää.
Tarkoituksena on tehdä sekä käyttöliittymä loppukäyttäjälle
raporttien lukuun, että webbisovellus raportin tuottamisessa tarvittavien
tiedostojen jakoon pääkäyttäjälle sekä WWW-ylläpidon
tietokannanhallintaan.
1.3. Dokumentin esittely.
Dokumentti on jaettu yhteenvedon lisäksi kuuteen lukuun. Johdannon
tarkoituksena on esittää lyhyesti ohjelmiston tarkoitus, kohderyhmä
ja tavoitteet. Yleiskuvauksessa kuvataan järjestelmän liittymät
ympäristöön, käyttäjät ja käyttöympäristö
sekä yleiset rajoitteet. Tiedoissa ja tietokannassa kuvataan järjestelmän
käsittelemien tietojen ja tietokantojen tietosisältö ja
kapasiteetti- ja saantiaikavaatimukset. Toiminnoissa kuvataan järjestelmän
kaikki toiminnot - tarkoitus, syötteet, käsittelyn tapahtuminen
ja tulosteet. Ulkoisissa liittymissä tarkennetaan käyttöliittymän
kuvausta ulkoasun suhteen sekä muita liittymiä. Muissa ominaisuuksissa
kuvataan ei-toiminnallisia ominaisuuksia, kuten suorituskykyä ja tietoturvaseikkoja.
2. Yleiskuvaus
Järjestelmä voidaan jakaa toiminnallisesti kahteen osaan:
raporttien tuottamisessa tarvittavien tiedostojen jakelupalvelu webissä
asiakkaan puolella toimivalle pääkäyttäjälle,
ja asiakkaan sisäisessä verkossa tapahtuva jakelu pääkäyttäjältä
loppukäyttäjille. Käyttäjät voidaan taas jakaa
asiakkaan loppukäyttäjiin ja pääkäyttäjään
sekä tiedostoja jakelevan WWW-serverin ylläpitoon.
2.1. WWW-palvelu
CompuPron Microsoft Internet Information Server 3.0:lla toteuttama www-palvelu
tarjoaa pääkäyttäjälle liittymän raporttigeneraattorien
ja raporttipohjien hakuun. Raporttipohjat on tarkoitettu raporttirakenteeltaan
vielä muokattaviksi kun taas raporttigeneraattorit ovat jo lopullisessa,
loppukäyttäjien käynnistettävässä muodossa.
CompuProssa pidetään Microsoft SQL Server 6.5:llä yllä
tietokantaa raporttitiedostoista sekä kuvauksista ja määritteistä,
joiden perusteella pääkäyttäjä löytää
WWW-palvelusta etsimänsä tiedostot. Webbisivuilla olevat HTML-raporttiesimerkit
on generoitu Seagate Crystal Reports 5.0-ohjelmalla. CompuPron käyttöjärjestelmänä
on Microsoft Windows NT 4.0 Server.
2.2. Pääkäyttäjä
Pääkäyttäjä on asiakkaan puolella toimiva koulutettu
henkilö, joka valitsee omien loppukäyttäjiensä kannalta
sopivan tyyppisiä raporttigeneraattoreita ja raporttipohjia CompuPron
www-palvelusta. Haettuaan tarvittavat tiedostot pääkäyttäjä
tarvittaessa muokkaa niitä mieleisekseen sekä kääntää
ne raporttigeneraattoreiksi, määrittelee tiedostojen käyttöoikeudet
sekä muita attribuutteja raporttigeneraattoria vastaavaan määrittelytiedostoon,
ja sijoittaa ne niin UNIX-serverilleen, että loppukäyttäjät
voivat päästä niihin käsiksi. Raporttipohjien muokkaamista
varten pääkäyttäjällä täytyy olla Crystal
Reports 5.0-ohjelma ja Windows-käyttöjärjestelmällä
varustettu tietokone.
2.3. Loppukäyttäjä
Loppukäyttäjä on varsinainen raportinjakelun kohde. Loppukäyttäjän
ei voida olettaa osaavan löytää raporttigeneraattoreita
hakemistorakenteesta, eikä osaavan tulkita niiden tulostaman raportin
ulkoasua raporttigeneraattorin tiedostonimen perusteella. Hän valitsee
ajettavan raporttigeneraattorin erityisellä käyttöliittymällä,
joka löytää tiedoston hakemistorakenteista, ja joka osaa
lajitella raporttigeneraattorit niiden tuottamien raporttien tyypin perusteella
löytämisen helpottamiseksi. Käyttöliittymän tehtäviin
kuuluu myös lukuoikeuksien hallinta siinä mielessä, että
se piilottaa loppukäyttäjän näkyvistä tiedostot,
jotka eivät ole tälle tarkoitettuja. Loppukäyttäjä
käynnistää käyttöliittymän avulla haluamansa
raporttigeneraattorin, jonka tuloksena raportti tulostuu. Loppukäyttäjän
käyttöjärjestelmä on Microsoft Windows 95.
HANSA-ohjelmiston tietokanta, jonka perusteella raporttigeneraattori tekee raportin, sijaitsee asiakkaan unix-palvelimella, ja siihen pääsee kiinni ODBC-rajapinnan avulla. Tällä palvelimella tulevat sijaitsemaan myös raporttigeneraattorit.
Loppukäyttäjän käyttöliittymän kehitykseen tullaan käyttämään Borland Delphiä.
3. Tiedot ja tietokanta
3.1. HTML
CompuPron WWW-palvelun sisältämä HTML-data on v3.0-formaattia.
Tarkoituksena on, että data on ongelmitta selailtavissa sekä
Netscapen että Microsoftin selaimilla versioista 3.0 ylöspäin.
3.2. CompuPron tietokanta
Kunkin tyyppistä raporttia vastaa CompuPron tietokannassa oma raporttiolio. Siihen liittyy joukko määritteitä, joita käytetään sekä oikean tyyppisen raporttigeneraattorin/raporttipohjan etsimisessä, että itse jaeltavien tiedostojen paikantamisessa.
3.2.1. Raporttitiedostot
Yhtä raporttioliota kohti on CompuPron tietokannassa määritelty kolme erilaista raporttitiedostoa. Näiden tiedostojen nimien on oltava yksilöllisiä, mutta ei nimeämiskäytännöltään informatiivisia (esim. numerosarja.pääte). Exe-päätteinen ajettava tiedosto eli raporttigeneraattori tulostaa ajettaessa näytölle (tai tiedoston ajon yhteydessä määriteltävissä olevalle laitteelle) raportin. Tämän tyyppinen tiedosto luovutetaan pääkäyttäjälle silloin, kun hän on tyytyväinen raporttigeneraattorin tuottaman raportin rakenteeseen, eli raportin rakennetta ei siis tarvitse muokata.
Jos pääkäyttäjän mielestä raporttigeneraattorin tuottaman raportin rakenne kaipaa hieman muokkausta, hän ottaa .rpt-päätteisen tiedoston eli Crystal Reports-raporttipohjan. Näin hän voi muokata raportin rakennetta mieleisekseen Crystal Reports-ohjelmalla, ja tämän jälkeen tehdä Crystal Reportsin työkaluilla raporttipohjasta ajettavan ohjelman eli raporttigeneraattorin. Tietysti pääkäyttäjä voi ottaa varmuuden vuoksi sekä ajettavan tiedoston että raporttipohjan, jos hänestä tuntuu, että raportin rakennetta tarvitsee joskus muokata.
HTML-muodossa oleva tiedosto on Crystal Reportsilla CompuPron esimerkkidatasta
HTML-muotoon tulostettu valmis raportti. Tätä tiedostoa ei ole
tarkoitettu jaeltavaksi, vaan käytettäväksi CompuPron www-sivuilla
esimerkkinä pääkäyttäjälle siitä, minkä
näköistä jälkeä ko. raporttioliota vastaava raporttigeneraattori
tuottaa.
3.2.2. Muut tietotyypit
Jokaista raporttiolioa kohti on olemassa nimi sekä lyhyehkö sanallinen kuvaus. Nimi ei ole mikään jaeltavan tiedoston nimi, vaan raporttioliokohtainen tunniste, josta selviää karkeasti, minkä tyyppisiä raportteja raporttioliota vastaava generaattori tuottaa. Sanallinen kuvaus on tarkoitettu HTML-esimerkin ohella raporttiolion generaattorin tulosteen hahmotteluun pääkäyttäjälle.
Muita tietokannan tietoja raporttioliota kohti ovat HANSAn versionumero
ja osa-alue sekä asiakas.
Asiakkaan määrittelyllä voidaan rajata raporttiolion
saatavuus asiakaskohtaiseksi, muuten raporttiolio on yleinen eli kaikkien
asiakkaiden ulottuvissa. Asiakkaan nimi-, salasana- ja tunnusattribuutteja
käytetään
pääkäyttäjän kirjautuessa sisään
WWW-palveluun.
3.3. Asiakkaan tietokanta
Asiakkaan HANSA-tietokanta sijaitsee pääkäyttäjän UNIX-serverillä. Kun raporttigeneraattori käynnistetään, se hakee tarvittavat tiedot kannasta ODBC-rajapinnan läpi. Tietokannan sisältö on toteutettavan järjestelmän kannalta epäolennainen - tietokantahaku on toteutettu valmiiksi raporttigeneraattoreissa.
Pääkäyttäjän UNIX-serverillä sijaitsevat
myös loppukäyttäjille jaeltavat raporttigeneraattorit. Raporttipohjia
ei jaella minnekään, ne on tarkoitettu yksinomaan pääkäyttäjän
muokattavaksi, eli niiden sijainnilla ei ole väliä, kunhan pääkäyttäjä
löytää ne tarvittaessa. Myöskään raporttipohjien
tietorakenteella ei ole järjestelmän kannalta merkitystä
- niiden muokkaus tapahtuu erillisellä ohjelmalla (Crystal Reports)
ja käännös raporttigeneraattoriksi Crystal Reportsin omilla
työkaluilla.
3.4. Tiedot pääkäyttäjän ja loppukäyttäjien välillä
Kun pääkäyttäjän ja CompuPron välillä jaeltavat tiedostot olivat raporttigeneraattoreita ja raporttipohjia, ainoat tiedostot pääkäyttäjän ja loppukäyttäjän välillä ovat raporttigeneraattorit sekä kutakin generaattoria vastaavat määritetiedostot. Näitä ei varsinaisesti jaella, vaan ne ovat loppukäyttäjän ulottuvissa olevassa hakemistossa.
3.4.1. Raporttigeneraattori
Tämä tiedosto on joko suoraan CompuProlta tai pääkäyttäjän CompuProlta saamasta raporttipohjasta generoima. Tiedostonimi on edelleen sama (jos generaattori on pääkäyttäjän kääntämä, nimi on CompuProlta saadun raporttipohjan nimi, rpt-pääte vaihdettuna exe:ksi). Raporttigeneraattorin tietorakenne on epäolennainen, sen sijaan sen tiedostonimen täytyy olla päätteeltään .exe ja nimiosaltaan sama kuin vastaavan määritetiedoston. Generaattoritiedoston omistaa pääkäyttäjä, ja loppukäyttäjien ryhmällä on siihen käynnistysoikeudet.
3.4.2. Määritetiedosto
Tämän tiedoston perusteella loppukäyttäjän käyttöliittymä
HANSONS CFG FILE # # sopiva kommenttimerkki jota käyttöliittymä ei lue # NIMI VaippaVuosiTulos3 # # mahd. monia eri kriteereitä, loppukäyttäjä voi valita minkä suhteen # etsii (ei monella kriteerillä yhtä aikaa, menee liian vaikeaksi # (loppukäyttäjälle :)) # KRITEERI HANSA-Osa-alue Hallinto KRITEERI Jakelu Sisäinen KUVAUS # # sopivan verran merkkejä riville # sopivan verran rivejä # (kuvausikkunaa ajatellen) # loppumerkki . tyhjällä rivillä # Raportti koko vuoden vaippamyynnistä, mukana kilpailijan tulokset . LUKUOIKEUDET # # loppukäyttäjäkohtaisia tunnuksia # 45,58,60-75,144 LOPPUKäyttöliittymä lukee tiedostoa etsien avainsanoja ja toimien niiden perusteella (ohittaa kommentit, hyväksyy tiedoston määritetiedostoksi tietyn alkurivin perusteella, ottaa talteen tietoja tiettyjä avainsanoja seuraavilta riveiltä). Tiedoston omistaa pääkäyttäjä ja loppukäyttäjien ryhmillä on siihen lukuoikeudet (muttei luonnollisestikaan kirjoitusoikeuksia).
3.4.3 Käyttöoikeuksien hallintatiedosto
Tiedosto, josta loppukäyttäjän käyttöliittymä varmistaa sisäänkirjautuvan identiteetin ja saa selville tätä vastaavan tunnisteen, jonka perusteella käyttöliittymä suodattaa tarpeettomia tiedostoja selailtavista.
3.5. Tiedon pysyvyys-, saantiaika- ja kapasiteettivaatimukset
Tiedon pysyvyysvaatimuksien suhteen ei kehitettävällä
ohjelmistolla ole ongelmia, koska raporttia tuotettaessa tarvittavat tiedot
haetaan aina uudelleen HANSA-tietokannasta. Ajettavat raportit ovat kooltaan
pieniä ja paikallinen verkko nopea, joten erityisempiä kapasiteetti-
ja saantiaikavaatimuksia ei myöskään ole.
4. Toiminnot
4.1. WWW-serverin ylläpidon tietokannan hallinnan käyttöliittymä
Toimintoja:
4.2. WWW-serverin raporttivalikko:
Toimintoja:
4.3.Loppukäyttäjän käyttöliittymä:
Toimintoja:
Jos on olemassa kriteereitä, joita ei ole määritelty kaikilla loppukäyttäjän näkemillä raporttigeneraattoreilla, kyseisen kriteerin ollessa valittuna määrittelemättömät raporttigeneraattorit voidaan kasata Määrittelemättömät-hakemistoon.
Asennusvaiheessa voidaan myös määritellä hakemisto,
tai useita hakemistoja pääkäyttäjän levyllä,
mistä raporttigeneraattorien ja näiden määrittelytiedostojen
etsiminen loppukäyttäjälleNFS:n tai muun vastaavan avulla
tapahtuu. Konfigurointi tapahtuisi menusta.
5. Ulkoiset liittymät
5.1. WWW-ylläpidon tietokannanhallinnan käyttöliittymä
5.1.1 Käyttöliittymän ulkoasu
5.1.2. Liittymät oheislaitteisiin ja tietoliikenneyhteyksiin
Järjestelmän ulkoisina liittyminä toimivat Microsoft
IIS:n tietokantayhteyksien avulla toteutetut tietokantahaut ja muutokset
sekä web-teknologian (HTTP-protokolla) mahdollistamat tiedostonsiirrot
molempiin suuntiin, myös palvelimelle päin (FILE UPLOAD). Käyttöliittymä
näkyy ulospäin HTML 3.0 - standardin mukaisina www-sivuina, jolloin
se toimii useimmilla nykyisillä selaimilla (mm Microsoftin ja Netscapen).
5.2. WWW-serverin raporttivalikko
5.2.1 Käyttöliittymän ulkoasu
< Pääkäyttäjän käyttöliittymä >
5.2.2. Liittymät oheislaitteisiin ja tietoliikenneyhteyksiin
Järjestelmän ulkoisina liittyminä toimivat Microsoft
IIS:n tietokantayhteyksien avulla toteutetut tietokantahaut ja web-teknologian
(HTTP-protokolla) mahdollistamat tiedostonsiirrot. Käyttöliittymä
näkyy ulospäin HTML 3.0 - standardin mukaisina www-sivuina, jolloin
se toimii useimmilla nykyisillä selaimilla (mm Microsoftin ja Netscapen).
5.3. Loppukäyttäjän käyttöliittymä
5.3.1 Käyttöliittymän ulkoasu
< delphilla tehty esimerkki (exe-tiedosto) >
5.3.2. Liittymät oheislaitteisiin ja tietoliikenneyhteyksiin
NFS:lla tai vastaavalla tekniikalla toteutettu yhteys pääkäyttäjään
näkyy normaalina hakemistopolkuna. Raporttigeneraattorissa on toteutettu
valmiiksi vaihtoehtoja raportin näytölle monitorissa, esim.tulostus
printterille tai webbiin HTML:nä.
6. Muut ominaisuudet
Käyttäjiä palvelulla tulee olemaan n. 30 Compupron puolelta, max. 100 webbipalvelun käyttäjää, sekä 10-100 loppukäyttäjää/yritys. Toiminnot eivät ole aikakriittisiä, ja siirreltävä tieto on kooltaan pienehköä. Näin ollen suorituskykyyn kohdistuviin vaatimuksiin ei tarvitse kiinnittää erityisen suurta huomiota.
Käytön helppouteen on panostettava varsinkin www-serverin tiedostojakelussa ja loppukäyttäjän käyttöliittymässä, käytön helppoushan on olennaisin liittymän olemassaolon syy.
Turvallisuuden kannalta, Internetin yli kulkevissa pääkäyttäjän
ja www-serverin välisissä raporteissa, kuten ei myöskään
ajettavissa raporteissa, ole erityisen salattavaa tietoa, jos raportin
rakenne ei sitä ole. Tietokantahakujen turvallisuus on Crystal Reportsin
generaattorin ja tietokantapalvelimen harteilla. Unixin tiedostojen käyttöoikeushallinnalla
voidaan rajata kaikista asiakkaan verkossa olevista käyttäjistä
vain loppukäyttäjille oikeudet raporttigeneraattoreiden ja määritetiedostojen
hakemistoon. Näiden välinen käyttöoikeuksien määrittely,
joka on toteutettu raporttigeneraattorikohtaisessa määrittelytiedostossa,
tähtää lähinnä vain loppukäyttäjän
käyttöliittymän turhien raporttigeneraattorien karsimiseen
näytöstä, ei niinkään turvallisuuteen. Jos on
tärkeää saada ehdottomasti tietyt raporttigeneraattorit
pois tiettyjen loppukäyttäjien ulottuvilta, pääkäyttäjä
voi asettaa kyseiset tiedostot paikkaan, jonne vain tietyt käyttäjät
voivat muodostaa yhteyden.