Tik-76.115 Tekninen määrittely

HANSA raportointityökalu

Sisällysluettelo

Yhteenveto

  1. Johdanto
  2. Järjestelmän yleiskuvaus
  3. Arkkitehtuurin kuvaus
  4. Moduli (ja prosessi) -kuvaukset
  5. Modulien toteutuksen kuvaus

Yhteenveto

Tämän dokumentin tarkoitus on olla tekninen määrittely projektissamme HANSA raportointityökalu. Dokumentti antaa yleiskuvauksen järjestelmästä ja järjestelmän arkkitehtuurista sekä pyrkii selvittämään suunnittelemamme modulijaon mahdollisimman ymmärrettävästi. Dokumentissa käytettyjen termien suhteen päädyimme ratkaisuun, jossa vieraat termit on selitetty kootusti yhdessä tiedostossa johon dokumentista on pääsy linkin kautta. Koska järjestelmä on helposti jaettavissa kahteen loogiseen osaan: CompuPro ja Asiakas sekä toisaalta käyttöliittymätasolla kolmeen osaan: ylläpitokäyttäjä, pääkäyttäjä ja loppukäyttäjä, suoritimme modulijaon erikseen kaikilla kolmella käyttöliittymätasolla.
Modulien määrittämisen yhteydessä mietimme jo jonkin verran modulien käytännön toteutusta, jonka perusteella modulit ovat verrattaen pieniä ja niitä on lukumäärällisesti varsin runsaasti. Perusteellinen modulijako ajateltiin hyväksi myös modulitestauksen kannalta, pieni ja hyvinmääritelty moduli on helpompi testata ja todeta toimivaksi kuin suuri ja korkealla tasolla määritelty monisisältöinen moduli. Modulien toteutusjärjestys tulee olemaan looginen, seuraten pitkälle modulijakokuvista selviävää järjestystä.

1. Johdanto

Ohjelmiston tarkoitus on helpottaa CompuPron HANSA-ohjelmistoa käyttävien asiakkaiden raporttiolioiden lukemista sekä mahdollistaa raporttipohjien ja -generaattorien jakaminen www:n kautta. Raporttiolioista on tarkoitus saada aikaan hallittu tietokanta CompuPron www-palvelimelle, josta asiakkaan pääkäyttäjä voi hakea esimerkkiraportteja sopivin hakukriteerein ja ohjata niihin liittyvät raporttigeneraattorit loppukäyttäjän ulottuville.

1.1 Termit

1.2 Kuvaus dokumentista

Tämä dokumentti on jaettu alun yhteenvedon lisäksi viiteen lukuun. Johdannossa esitellään ohjelmiston tarkoitus sekä vieraiden termien selitykset. Järjestelmän yleiskuvauksessa esitellään sovellusalueet sekä laitteisto- ja ohjelmistoympäristön kuvaus. Arkkitehtuurin kuvauksessa esitellään ratkaisuperiaatteet, tietokanta-arkkitehtuuri sekä ohjelmistoarkkitehtuuri ja modulit. Modulikuvauksissa annetaan moduleista yleiskuvaus, attribuutit, operaatiot, poikkeus- ja virhetilanteiden käsittely, testattavuus, keskinäinen kommunikointi sekä ohjeita toteutusta varten. Modulien toteutuksen kuvauksessa kerrotaan modulien toiminnan yksityiskohtaiset kuvaukset.

2. Järjestelmän yleiskuvaus

Järjestelmä käsittää kaksi osaa, CompuPron puoli sekä asiakkaan puoli. Näiden osien välinen rajapinta on Internet, jonka välityksellä asiakkaan pääkäyttäjä pääsee käsiksi CompuPron www-palvelimelle. Sovellusalueena toimii CompuPron päässä Microsoft Internet Information Server 3.0 ja tietokantapalvelimena MS SQL Server, molemmat Windows NT 4.0 Server -käyttöjärjestelmässä. Raporttiolioiden tuottamiseen käytetään Crystal Reports -ohjelmistoa. Asiakkaan sovellusalueena on Windows 95 -työasemaverkko, jossa unix-palvelin.

3. Arkkitehtuurin kuvaus

Järjestelmän toteutuksessa CompuPron puolella käytetään Microsoft Internet Information Serverin tarjoamaa active-server-pages -teknologiaa ja siihen liittyviä Jscriptejä. Microsoft SQL Server mahdollistaa raporttiolioiden käsittelemisen tietokannassa. Loppukäyttäjän käyttöliittymän toteutuksessa käytetään Borland Delphi -ohjelmiston tarjoamia työkaluja. HANSA-ohjelmiston tietokanta sijaitsee asiakkaan unix-palvelimella, johon päästään kiinni ODBC-rajapinnan kautta. Pääkäyttäjän valitsemat raporttigeneraattorit sijaitsevat asiakkaan unix-palvelimella, johon loppukäyttäjä pääsee kiinni NFS:n avulla.

Pääkäyttäjän käyttöliittymä jakaantuu viiteen moduliin: tunnistus, haku, lista, malli sekä lataus. Kuvassa 1 on esitetty modulijako sekä transaktiosuunnat modulien välillä.


Kuva 1: Pääkäyttäjän käyttöliittymän modulijako.

Compupron puolelle toteutettava ylläpitokäyttöliittymä pitää sisällään modulit tunnistus, aloitus, haku, lista, malli, lataus, lisää raporttiolio, muokkaa/poista raporttiolio, lisää käyttäjä sekä muokkaa/poista käyttäjä. Kuvassa 2 on esitetty CompuPron ylläpitokäyttöliittymän modulijako.


Kuva 2: CompuPron ylläpitokäyttöliittymän modulijako.

Loppukäyttäjän käyttöliittymä jakaantuu kolmeen moduliin: tunnistus, lista ja lataus. Kuvassa 3 on esitettynä loppukäyttäjän käyttöliittymän modulijako.


Kuva 3: Loppukäyttäjän käyttöliittymän modulijako.

4. Moduli (ja prosessi) -kuvaukset

Pääkäyttäjän käyttöliittymä

  • TUNNISTUS
    Käyttäjän autentikointi käyttäjätunnuksen ja salasanan avulla. Mikäli molemmat syötteet ovat kunnossa, edetään seuraavaan moduliin.
  • HAKU
    Raporttien hakukriteerien syöttäminen, jonka jälkeen päästään etenemään LISTA-moduliin.
  • LISTA
    Lista raporteista, jotka toteuttavat edellisen modulin hakukriteerit. Tästä modulista voidaan edetä suoraan LATAUS-moduliin tai haluttaessa MALLI-moduliin. Myös palaaminen HAKU-moduliin on mahdollinen.
  • MALLI
    Esimerkkiraportin tulostaminen ruudulle. Jos esimerkkiraportin ulkoasu on tyydyttävä, voidaan tästä modulista edetä LATAUS-moduliin. Myös palaaminen takaisin LISTA-moduliin onnistuu.
  • LATAUS
    Valinnan mukaisesti .exe- tai .rpt-tiedoston lataaminen, jonka jälkeen voidaan palata LISTA-moduliin. Palaaminen voidaan tehdä myös ilman lataamista.

    CompuPron ylläpitokäyttöliittymä

  • TUNNISTUS
    Käyttäjän autentikointi käyttäjätunnuksen ja salasanan avulla. Mikäli molemmat syötteet ovat kunnossa, edetään seuraavaan moduliin.
  • ALOITUS
    Halutun toiminnon valitseminen. Eteneminen moduleihin HAKU, LISÄÄ raporttiolio, LISÄÄ käyttäjä sekä MUOKKAA/POISTA käyttäjä mahdollinen.
  • LISÄÄ raporttiolio
    Uuden raporttiolion lisääminen. Paluu ALOITUS-moduliin mahdollinen.
  • LISÄÄ käyttäjä
    Uuden asiakkaan (ts. Asiakkaan pääkäyttäjän) lisääminen. Palaaminen ALOITUS-moduliin.
  • MUOKKAA/POISTA käyttäjä
    Olemassa olevan asiakkaan tietojen muokkaus tai poisto. Paluu ALOITUS-moduliin.
  • HAKU
    Raporttien hakukriteerien syöttäminen, jonka jälkeen päästään etenemään LISTA-moduliin. Myös palaaminen ALOITUS-moduliin mahdollista.
  • LISTA
    Lista raporteista, jotka toteuttavat edellisen modulin hakukriteerit. Tästä modulista voidaan edetä suoraan LATAUS-moduliin tai haluttaessa MALLI-moduliin
  • MUOKKAA/POISTA raporttiolio
    Olemassa olevan raporttipohjan tietojen muokkaaminen tai poistaminen. Paluu LISTA-moduliin mahdollinen.
  • MALLI
    Esimerkkiraportin tulostaminen ruudulle. Jos esimerkkiraportin ulkoasu on tyydyttävä, voidaan tästä modulista edetä LATAUS-moduliin. Myös palaaminen takaisin LISTA-moduliin onnistuu.
  • LATAUS
    Valinnan mukaisesti joko raporttigeneraattorin tai raporttipohjan lataaminen. Palaaminen LISTA-moduliin. Palaaminen voidaan tehdä myös ilman lataamista.

    Loppukäyttäjän käyttöliittymä

  • TUNNISTUS
    Käyttäjän autentikointi käyttäjätunnuksen ja salasanan avulla. Mikäli molemmat syötteet ovat kunnossa, edetään seuraavaan moduliin.
  • LISTA
    Lista raporttiolioiden nimistä, jotka kyseinen käyttäjä on valtuutettu näkemään. Tästä modulista voidaan edetä LATAUS-moduliin.
  • LATAUS
    Raporttigeneraattorin lataaminen, jonka jälkeen palaaminen LISTA-moduliin tapahtuu automaattisesti. Palaaminen voidaan tehdä myös ilman lataamista.

    5. Modulien toteutuksen kuvaus

    Modulien toteutuksen kuvaus tulee tarkentumaan seuraavassa vaiheessa.

    Pääkäyttäjän käyttöliittymä

    TUNNISTUS HAKU LISTA MALLI LATAUS

    CompuPron ylläpitokäyttöliittymä

    TUNNISTUS ALOITUS LISÄÄ raporttiolio LISÄÄ käyttäjä MUOKKAA/POISTA käyttäjä HAKU LISTA MUOKKAA/POISTA raporttiolio MALLI LATAUS

    Loppukäyttäjän käyttöliittymä

    TUNNISTUS LISTA LATAUS