AirDog Hovedprosjekt ved Høgskolen i Oslo 2009

Transkript

1

2

3 Kravspesifikasjn

4 AirDg Hvedprsjekt ved Høgsklen i Osl 2009 Kravspesifikasjn 2

5 AirDg Hvedprsjekt ved Høgsklen i Osl 2009 Kravspesifikasjn 1 Frrd Hensikten med kravspesifikasjnen er å gi ppdragsgiver g utviklere en enighet g frståelse av funksjnaliteten til systemet sm skal lages. Videre har kravspesifikasjnen definert prsjektets rammer g krav til brukervennlighet, kvalitetssikring g sikring av data. Utviklingsprsessen fregår etter smidig utviklingsmetdikk. Å jbbe smidig vil si å levere prduktet frtløpende i delleveranser slik at deler av funksjnaliteten blir implementert g kan tas i bruk av kunden. Kravspesifikasjnen er basert på de funksjnelle g praktiske krav sm er km underveis i prsjektets iterasjner. Kravene ble gitt sm user stryer fra ppdragsgiver. Mer m utviklingsprsessen med bruk av user stryer er mtalt i prsessrapprten. Listen av user stryer fungerer sm en ønskebrønn med ulik funksjnalitet sm systemet kunne hatt. Listen med user stryer er i utgangspunktet lengre enn hva kunden frventer å få, så det er pp til kunden å priritere hva sm skal implementeres. Kravspesifikasjnen har under prsjektperiden fungert sm et styringsdkument sm har endret seg frtløpende. Da vi har ppdatert kravspesifikasjnen når vi har fått nye ppgaver har aldri kravspesifikasjnen vært fullstendig fra prsjektets start, men bevisst bekreftet endringer underveis. 1.1 Leserveiledning Sm nevnt er det blitt jbbet etter en smidig utviklingsmetdikk der kravene er listet pp sm user stryer gitt fra ppdragsgiver. Disse stryene er blitt verført til kravspesifikasjnen slik at den står sm styringsdkumentet til prsjektet. 3

6 AirDg Hvedprsjekt ved Høgsklen i Osl 2009 Kravspesifikasjn 2 Innhld 1 Frrd Leserveiledning Innhld Innledning... 6 Gruppen... 6 Oppdragsgiver g kunde... 6 Bakgrunn fr ppgaven... 7 Mål fr ppgaven Funksjnelle krav fr systemet En bruker skal kunne En administratr skal kunne En superbruker skal kunne Dat-filene sin struktur Eier Fugl Hdsykdm Hund Kull Oppdrett Persn Premie Utstilling Veteriner Aasykdm Rammekrav i systemet Kunden Sikring av tap, ødeleggelse, tyveri g misbruk av data Kmpatibilitet Krav til design g brukervennlighet Krav til kde g vedlikehld Fremtidig utvidelse av systemet Andre krav

7 AirDg Hvedprsjekt ved Høgsklen i Osl 2009 Kravspesifikasjn 7.1 Lave driftskstnader g bruk av åpen kildekde Adbe Flex Pivtal Tracker Ggle Cde

8 AirDg Hvedprsjekt ved Høgsklen i Osl 2009 Kravspesifikasjn 3 Innledning Denne innledningen innehlder bakgrunnsinfrmasjn fr prsjektet g finnes i både prsess- g prduktdkumentasjn. Her presenterer vi først gruppen, ppdragsgiver g kunde. Videre går vi mer i detalj m bakgrunnen fr, g målet med, ppgaven. Gruppen Gruppen bestd av Hans Magnus Inderberg, Egil Paulsen, Tre Lervik g Pelle Christffer Bjerkestrand. Medlemmene kjente hverandre fra før g har jbbet sammen ved flere anledninger. Frventningene til hverandre var basert på egne erfaringer gjrt ver de t fregående årene g er derfr realistiske. Vi valgte å danne denne gruppen da vi hadde gd kmmunikasjn, et gdt samarbeid g likt ambisjnsnivå. Oppdragsgiver g kunde I denne ppgaven er det et skille mellm kunde g ppdragsgiver. Kundene er Nrsk Pinterklub g Nrsk Bretn Klubb, mens Bekk fungerte sm vår ppdragsgiver g vil vedlikehlde systemet etter levering. Bekk Bekk Cnsulting AS er et nrsk knsulentselskap sm leverer rådgivnings-, teknlgi- g frvaltningstjenester til stre ffentlige g private virksmheter. Selskapet har i dag 210 ansatte g er en del av ErgGrup - et kraftsenter i Nrden innen teknlgi. Bekk stilte med t veiledere til prsjektet: Erlend Opdahl g Ole Christian Langfjæran. Ole er utvikler g er Bekk sin ekspert på Adbe Flex-teknlgi. Ole hadde sm sin bachelrppgave å utfrme det eksisterende systemet sm nå er utdatert. Erlend er selv fuglehundeier g har kntakter i miljøet. På denne måten har de sm ppdragsgiver gd innsikt i kundens situasjn. Nrsk Pinterklub (NPK) Pinteren i Nrge representerer en liten, men sunn hunderase. Det registreres rundt 300 valper i året. Rasen har få alvrlige arvelige defekter, ne sm skyldes at NPK har gd kntrll ver rasen, g avler på sunne g friske bruksdyr. Det er svært få pintereiere sm ikke driver med jakt g hundesprt, g dette har ført til at de jaktlige egenskapene alltid Figur 1. AirDg-lg har hatt høyeste priritet fr ppdretterne her i landet. Figur 2. NPK-lg Klubben har i dag ca. 950 medlemmer. Veileder Erlend Opdahl er medlem i Nrsk Pinterklub. Nrsk Bretn Klubb (NBK) Bretn er en liten hunderase, så vel i størrelse sm i antall, i Nrge. Bretn er den minste av de stående fuglehundrasene. Det skal være en kvikk, livlig g våken hund med energiske, kraftige bevegelser uten å virke tung. Klubben har i dag ca. 900 medlemmer. Veileder Ole Christian Langfjæran sitt system benyttes av denne klubben. 6

9 AirDg Hvedprsjekt ved Høgsklen i Osl 2009 Kravspesifikasjn Bakgrunn fr ppgaven Veileder Ole Christian Langfjæran hadde fra før laget en løsning fr å vise infrmasjn m hunder, raser g jaktresultater fra Nrsk Kennel Klubb. Løsningen blir benyttet av Nrsk Bretn Klubb. Dagens løsning er ikke gd nk g det ønskes bedre statistikkmuligheter. Fr eksempel ønskes bedre muligheter fr å redigere på data sm fte er feil, g å legge inn egne data. Videre ønskes bedre kmpatibilitet da dagens løsning avhenger av utdatert teknlgi sm ActiveX i Windws XP. Mål fr ppgaven Målet med prsjektet er å utvikle et nytt system fr hundeklubber sm er tilknyttet Nrsk Kennel Klubb (NKK). I første mgang vil dette være NPK g NBK. Systemet sm skal utvikles skal erstatte det nåværende systemet g, m mulig, tilby nye funksjner. Samtidig er det viktig at systemet kan brukes med lite eller ingen pplæring, av medlemmer av NPK g NBK. Figur 3. NKK-lg Systemet skal: Kunne kjøres på "alle" OS (Windws 2000/XP/Vista/7, Mac OS X g Linux) Parse datafilene NKK sender ut Beskytte dataene fr innsyn av uvedkmmende Systemet bør: Være relativt billig å drifte, vedlikehlde g utvide Kunne fullstendig erstatte det nåværende systemet Med tanke på målene g rammene står vi ikke helt fritt til å velge akkurat hvilke tekniske løsninger vi vil. Plattfrmuavhengighet g kravet m billig drifting betyr at åpne gratisalternativer sm LAMPsystemet (Linux, Apache, MySQL, PHP/Perl/Pythn) blir favrisert ver lukkede løsninger sm Windws Server, C#.NET g MSSQL. 7

10 AirDg Hvedprsjekt ved Høgsklen i Osl 2009 Kravspesifikasjn 4 Funksjnelle krav fr systemet 4.1 En bruker skal kunne lgge seg inn fr å få persnlige innstillinger fr applikasjnen autentiseres med rller fr å kunne få tilgang til hundedata søke etter hund fr å kunne velge å se hundens prfil se en hund sin prfil slik at man kan se hundens data g resultater se avkm fr en hund gitt at hunden har avkm se jaktprøver g ppsummering fr en hund slik at man kan lese resultater se stamtavlen til en valgt hund se en liste ver hunder slik at man kan finne en hund se avlstall fr alle hunder slik at man kan finne hunder med gde avlstall se årsgjennmsnitter fr en rase eller en hund fr ett gitt år se alle utstillingsresultater fr en hund se siste resultater fr cup der hunder rangeres etter peng fra sine jaktprøver se hele rasens jaktprøveresultater fr et gitt år se prøvestatistikk på en stamgren fr en hund eksprtere alle rapprter (lister med data i systemet) til Excel-frmat velge t hunder g se den fiktive stamtavlen de utgjør bruke histrikk ved å navigere frem- g tilbakeknappene til nettleseren markere g kpiere hundens ID i søkeresultatet redigere egen e-pst (brukernavn), passrd g navn lese nyheter imprtert fra klubbenes egne sider via RSS. 4.2 En administratr skal kunne ppdatere databasen med data fra NKK legge til midlertidige resultater inntil neste imprt av data fra NKK håndtere prblematisk imprt av data slik at redigerte data i systemet ikke verskrives av feil data fra NKK redigere data fr en hund slik at man kan rette på data sm er feil legge inn bilde av en hund på hundens prfil redigere data fr en jaktprøve slik at man kan rette på data sm er feil kjenne igjen jaktprøveskjema slik det ser ut i virkeligheten administrere rller g rettigheter i et versiktlig grensesnitt ta sikkerhetskpi av databasen slik at bruker- g hundedata ikke går tapt 8

11 AirDg Hvedprsjekt ved Høgsklen i Osl 2009 Kravspesifikasjn rulle tilbake en backup dersm ne skulle gå galt legge til en bruker slette en bruker generere Wrd-dkument i årbkfrmat fr en hund generere Wrd-dkument i årbkfrmat fr alle hanner fr et gitt år generere Wrd-dkument i årbkfrmat fr alle tisper fr et gitt år redigere rller tilrdnet brukere i et versiktlig grensesnitt redigere infrmasjn m aktuell klubb legge til en litterær jaktprøvekritikk til jaktprøvene i tillegg til standardverdiene fra jaktprøveskjemaet fylle inn sted g navn på arrangementer i en tabell der de i utgangspunktet bare har en ID slik at arrangementer blir lettere å kjenne igjen 4.3 En superbruker skal kunne ha tilgang til all funksjnalitet i alle klubber i systemet 9

12 AirDg Hvedprsjekt ved Høgsklen i Osl 2009 Kravspesifikasjn 5 Dat-filene sin struktur Dat-filene fra NKK har ingen direkte kbling til hverandre slik en nrmalisert relasjnsdatabase har. Likevel er det en lgisk sammenheng i filene. Tabellene skal gjenskape dat-filenes struktur. Her vises første linje i hver dat-fil: 5.1 Eier EIER HUID RAID 5.2 Fugl PreveNr PrveDat PartiNr Klasse PEID_Dmm1 PEID_Dmm2 HUID SlippTid EgneStand EgneS tekk TmStand MakkerStand MakkerStekk JaktLyst Fart Stil Selvstendighet Bredde Reviering Samarbeid Pres_Upresis Pres_NeUpresis Pres_Presis Reis_Nekter Reis_Nelende Reis_Villig Reis _Djerv Sek_Stjeler Sek_Spntan App_IkkeGdkj App_Gdkj Rapp_Innkalt Rapp_Spnt Premiegra d CERTIFIKAT RegAv RegDat RAID 5.3 Hdsykdm AvlestAv Betaling Diagnse DiagnseKde EndretAv HDID HUID IdMerket IdMerkerKde Kde L idelse LidelseKde PEID RAID RegAv SekHyre SekHyreKde SekVenstre SekVenstreKde Send es VEID RntgenDat AvlestDat 5.4 Hund RAID KUID HUID Tittel Navn HUIDFar HUIDMr IDNR FargeBeskrivelse FargeVariant AD HD Ha arlag IDMerk Kjenn PEID EndretAv EndretDat RegDat Sterrelse 5.5 Kull KUID HUIDFar HUIDMr PEIDOppdretter EndretDat Fedt RAID 5.6 Oppdrett KUID Oppdretter RAID 5.7 Persn PEID Navn Adresse1 Adresse2 Adresse3 Pstnr Landkde RAID Status Telefn1 EndretDat Reg Dat Fedt 5.8 Premie DOID UTID HUID Katalgnr PEIDdmmer Klasse Kjnn RAID IM KIP JK JKK UK UKK BK BKK AK AKK VK CHK CHKK VTK VTKK HP CK CC CA BIK BIR BIM 5.9 Utstilling UTID KLID PEID RegDat RegAv Navn Adresse1 Adresse2 Pstnr SpesialAdresse UtstillingDat U tstillingsted ArrangerNavn1 ArrangerNavn2 OverfertDat 5.10 Veteriner VEID PEID Adresse1 Adresse2 Adresse3 Pstnr Telefn Telefax KlinikkNavn RegDat RegAv End retav 10

13 AirDg Hvedprsjekt ved Høgsklen i Osl 2009 Kravspesifikasjn 5.11 Aasykdm VEID AAID DiagnseKde IdMerkerKde LidelseKde SekHyreKde SekVenstreKde EndretAv R egav AvlestAv Betaling Diagnse HUID IdFeil IdMerket Kde Lidelse PEID Purring RAID Retur S ekhyre SekVenstre Sendes AvlestDat RntgenDat 11

14 AirDg Hvedprsjekt ved Høgsklen i Osl 2009 Kravspesifikasjn 6 Rammekrav i systemet Vi vil her gjøre rede fr ppgavens begrensninger i frhld til mfang g bruksmråde. Vi tar fr ss krav m sikring av data, kmpatibilitet, brukervennlighet, kdestruktur g tilrettelegging fr vedlikehld. 6.1 Kunden I første mgang vil dette være fuglehundklubbene Nrsk Pinterklub (NPK) g Nrsk Bretn Klubb (NBK). Disse klubbene frhlder seg til ppdragsgiver slik at kmmunikasjnskanalen alltid går gjennm Bekk. Løsningen skal legges pp generisk slik at flere klubber gså kan ta i bruk AirDg. 6.2 Sikring av tap, ødeleggelse, tyveri g misbruk av data Da NKK sine data har spesielle rettigheter g innehlder sensitive persndata, er det nødvendig å sette krav til sikkerhet Håndtering av passrd Passrd må håndteres på en slik måte at de ikke kan misbrukes. Ved innlgging g frespørsler skal ikke passrd sendes i klartekst. Passrd skal hashes i databasen slik at ikke de kan leses av andre Rettigheter g rller Brukere skal tildeles rller. Rller har ulike rettigheter sm sikrer at kun de med gitte rller kan få tilgang til restriktive deler i systemet. En administratr har en brukerrlle g en administratrrlle der administratrrllen gir fler rettigheter. Hvis brukeren ikke har rettighetene sm kreves blir han enten nektet tilgang ved å gi en beskjed eller bare skjule den funksjnaliteten sm brukeren ikke har tilgang til. Rettighetene kan dere strø rundt m i applikasjnen g derpå spørre innlgget bruker m han har de rettighetene. Ala user.harrettighet(kan_se_personer) - Ole Christian Langfjæran, Bekk Systemet skal ha rllene: Superbruker sm har tilgang til alle funksjner g hundeklubber. Administratr sm har tilgang til alle funksjner innenfr den klubben han er medlem i. Disse er definert nærmere under krav til administratrrllen. Bruker har brukerrettigheter sm er de krav beskrevet fr brukersystemet. Gjest vil være en begrenset brukerpplevelse med lite eller ingen tilgang til hund- g persndata Sikkhertskpiering Det skal være mulig å ta sikkerhetskpier av databasen i applikasjnen slik at bruker- g hundedata ikke går tapt. 12

15 AirDg Hvedprsjekt ved Høgsklen i Osl 2009 Kravspesifikasjn 6.3 Kmpatibilitet Applikasjnen skal kunne kjøres på dagens mest brukte perativsystemene: Windws, Mac OS X g Linux. 6.4 Krav til design g brukervennlighet Brukervennlighet Systemet skal kunne brukes av persner med lite eller ingen pplæring. Med det menes at systemet skal være selvfrklarende så langt det er mulig frutsatt at brukerne har grunnleggende kjennskaper til de begreper g fagtermer relatert til fuglehunder Brukertester Systemet skal testes av reelle brukere i klubbene underveis i utviklingen Frem- g tilbakeknapp Fr mindre frvirring skal det være mulig å navigere frem g tilbake med knappene i nettleseren. På denne måten blir det ikke frem g tilbakeknapp i applikasjnen i tillegg til i nettleseren. 6.5 Krav til kde g vedlikehld Deplye til airdg.n Prsjektgruppen skal kunne deplye applikasjnen til airdg.n slik at den kan testes. Under utviklingen skal det jevnlig legges ut delleveranser av systemet på prsjektets prduksjnsserver airdg.n. Kunden skal kunne teste ut g tidlig vurdere brukerpplevelsen til applikasjnen Remte bject Prsjektet skal benytte PHP sm serverdel fr Flex sm klient. Systemet skal kunne sende bjekter mellm klient g server fr å unngå å sende ren tekst. Dette skal sikre systemet mt ppsnapping, fabrikkering g mdifisering av datastrømmen samt å ptimalisere ytelsen til systemet Designmønstre Systemet skal kunne være skalerbart g enkelt å vedlikehlde. Det skal være mulig fr en annen utvikler å kunne sette seg inn i kildekden uten å måtte bruke stre ressurser på å finne ut hvrdan systemet fungerer. Fr å støtte pp til kravet venfr skal kildekdens struktur baseres på kjente g fleksible designmønstre sm gjør applikasjnen skalerbar g samtidig versiktlig. Systemets designmønster skal følge Mdel View Cntrller Service prinsippet ved å skille presentasjn g datamdell g støtte pp applikasjnen ved hjelp av kntrllere g servertjenester. Det vil da være mulig å bytte ulike kmpnenter uten å måtte endre stre deler av systemet. 13 Figur 4. Overrdnet arkitektur

16 AirDg Hvedprsjekt ved Høgsklen i Osl 2009 Kravspesifikasjn 6.6 Fremtidig utvidelse av systemet Systemet vil driftes av veilederne fra Bekk. Dette stiller krav til at systemet er strukturert på en versiktlig måte Oppbygning Det stilles krav til et gdt fundament i prgrammet. Fkus på gd arkitektur sm er mdulær g lett g utvide. Det skal være mulig fr en utenfrstående fr systemet å kunne raskt sette seg inn i arkitekturen g systemets virkemåte. 7 Andre krav Vi lister her pp verktøy g hjelpemidler sm skal benyttes i utviklingen av applikasjnen. 7.1 Lave driftskstnader g bruk av åpen kildekde Systemet skal ha lave driftskstnader. Hundeklubbene er ikke interessert i å betale fr dyre webhtell fr å drifte applikasjnen. Det må være med i vurderingen m hvilken web-teknlgi sm skal benyttes i løsningen. Det skal vurderes alternativer sm er åpne g gratis. 7.2 Adbe Flex Bekk er interessert i å få laget applikasjnen med Adbe Flex teknlgi. Adbe Flex er en Flash-basert teknlgi sm lager Flash-baserte web-grensesnitt. I utviklingen skal det benyttes Flex 3, sm den nyeste utgaven fra Adbe. 7.3 Pivtal Tracker Pivtal Tracker skal benyttes sm planlegging- g styringsverktøy under utviklingsperiden. 7.4 Ggle Cde Systemet skal være åpent g gratis g ligge tilgjengelig på Ggle Cde. Kden skal lastes pp g være tilgjengelig fr alle. 14