PRODUKTDOKUMENT. Studieprogram: Postadresse: Postboks 4 St. Olavs plass, 0130 Oslo Besøksadresse: Holbergs plass, Oslo .NET

Transkript

1 Produktdokumentasjon Mamut Webforms 1 av 48 PROSJEKT NR Studieprogram: Postadresse: Postboks 4 St. Olavs plass, 0130 Oslo Besøksadresse: Holbergs plass, Oslo TILGJENGELIGHET Åpen Telefon: Telefaks: PRODUKTDOKUMENT HOVEDPROSJEKTETS TITTEL System for generering av webskjemaer for Mamut ASA DATO ANTALL SIDER 48 PROSJEKTDELTAKERE Kjetil Hårtveit, s INTERN VEILEDER Alfred Bratterud OPPDRAGSGIVER Mamut ASA KONTAKTPERSON Espen Johannessen SAMMENDRAG Systemet som er utviklet brukes til å generere webskjemaer. Hensikten med systemet er å øke datakvalitet ved å fjerne manuelle rutiner, redusere svinn av leads og øke salg gjennom bedre oppfølging av leads. Systemet er utviklet med Microsoft teknologier C#/ASP.NET med MSSQL og Windows Service. 3 STIKKORD Mamut Webforms Webskjemagenerering.NET

2 Produktdokumentasjon Mamut Webforms 2 av 48 Innholdsfortegnelse 1. Introduksjon Hvem bør lese dokumentet Hvilken kompetanse forventes Beskrivelse av systemet Målet med systemet Hva kan systemet gjøre? Systemkrav Innholdsstruktur Grensesnitt Hovedmeny Seksjon: User Seksjon: Forms Seksjon: Categories Seksjon: Analysis Seksjon: Export Seksjon: Logging Systemets oppbygning Oversikt Classes Dynamic Query Mamut Webforms Mamut Webforms Service Application Mamut Webforms Test Databasestruktur Program CDen Installeringer og rutiner Installering av systemet Installering av Mamut Webforms Service Uinstallering av Mamut Webforms Service Debugging/lese feilmeldinger av service Referanseliste Referanser Figurliste... 48

3 Produktdokumentasjon Mamut Webforms 3 av Introduksjon 1.1 Hvem bør lese dokumentet Dataansvarlige som skal installere, vedlikeholde eller modifisere systemet. Det kan også være nyttig for dem som eventuelt skal markedsføre systemet eller drive brukerstøtte på det. 1.2 Hvilken kompetanse forventes Utviklere som skal vedlikeholde eller videreutvikle systemet bør ha kunnskaper om MVC2 eller forståelse for MVC prinsippet. De bør også ha kunnskaper til MSSQL eller kjennskap til relasjonsdatabaser og programmering med disse. En bør også ha god erfaring med det underliggende språket C#.

4 Produktdokumentasjon Mamut Webforms 4 av Beskrivelse av systemet 2.1 Målet med systemet Mamut ASA ønsket ett å få utviklet ett nytt system for å generere webskjemaer for innsamling av lead fra kampanjeaktiviteter. Det eksisterende CMS systemet og den eksisterende rutinen for registrering av leads hadde svakheter som både hadde negativ virkning på det totale salget og tilgjengelige ressurser. Det nye systemet har som mål å strømlinjeforme og automatisere leadinnsamlingen så mye som mulig og dermed løse opp flokene som er tilstede. Oppsummert skal det gi følgende fordeler: Ressursbesparelser gjennom automatisering av rutineoppgaver. Øke datakvalitet ved å fjerne manuelle rutiner. Gir bedre informasjon i forhold til hvilke prosjekter som selger. Reduserer svinn av leads. Øke salget gjennom bedre oppfølging av leads. 2.2 Hva kan systemet gjøre? Følgende aktiviteter er mulige i Mamut Webforms: Innlogging og utlogging av systemet. Endring av brukerpassord. Opprettelse og håndtering skjema. o Generering av kode. o Visning av innhentet data. Opprettelse og håndtering av kategorier. Automatisk og manuell eksportering av leads (skjemadata) til CSV format med fast kolonnebredde. Endre innstillinger for lagring av informasjon for analyseringsbruk. Endre innstillinger for loggføring av systemtilbakemeldinger. Slik ser det ut når man generer skjemakode

5 Produktdokumentasjon Mamut Webforms 5 av Systemkrav Følgende krav er forutsetninger for kjøring av systemet. Windows 7 / Windows Vista ASP.NET 4.0 / C# Microsoft SQL Server 2008 IIS

6 Produktdokumentasjon Mamut Webforms 6 av Innholdsstruktur Systemet er delt inn i flere seksjoner for å segmentere innholdet. Seksjonene listes opp og beskrives under: Seksjon Beskrivelse Aktiviteter User Her legges sider med funksjonalitet Change password som pårører brukeren. Login Forms Categories Analysis Export Logging Her legges sider som er knyttet til opprettelsen, håndteringen og bruken av skjemaer. Her legges sider som er knyttet til opprettelse og håndtering av kategorier. Her legges sider som er mest aktuelle for analysering av dataen som blir matet inn med skjemaene. Her legges sider som pårører eksportering av skjemaleads, samt konfigureringer som er relaterte til automatiske eksporteringer. Her legges sider som pårører funksjonalitet relatert til logging. Logout List all (index) Create new Edit form Edit fields Generate form code View formdata List all (index) Create new Edit Overview (index) Google utmccn Project URL parameters Custom URL parameters Overview (index) Manual export Automatic export settings Overview (index) Log Settings NB: Merk at filstrukturen ikke er den samme som innholdsstrukturen på grunn av at systemet kodes i MVC mønsteret. Innholdsstrukturen er derimot en nøyaktig indikator på hvordan sluttbrukeren opplever systemet. Innholdsstruktur vs. MVC Seksjonene kan sammenliknes med controllers og aktivitetene kan sammenliknes med actions.

7 Produktdokumentasjon Mamut Webforms 7 av 48 Figur 1 - Innholdsstruktur diagram

8 Produktdokumentasjon Mamut Webforms 8 av Grensesnitt 4.1 Hovedmeny Hovedmenyen er delt inn i seksjonene som er oppgitt i innholdsstrukturen. Den vil bli plassert på høyre siden av innholdet for å ikke stå midt i fokus, men alltid være lett tilgjengelig. Figur 2 Hovedmeny

9 Produktdokumentasjon Mamut Webforms 9 av Seksjon: User Login Figur 3 - Login Formål Logge seg inn på systemet. Forklaring av grensesnitt Type Felt Beskrivelse Tekstboks Username Brukernavn Tekstboks Password Passord Checkbox Remember me Om brukeren skal huskes ved senere besøk Knapp Login Logger deg inn i systemet Unntak Ved feil brukernavn eller passord vil en feilmelding vises og brukeren blir ikke logget inn i systemet.

10 Produktdokumentasjon Mamut Webforms 10 av 48 Change password Figur 4 - Change password Formål Endre bruker passord. Forklaring av grensesnitt Type Felt Beskrivelse Tekstboks Old password Gammelt passord Tekstboks New password Nytt passord Tekstboks Confirm Bekreftelse av nytt passord password Knapp Update Utfører endring av passord Unntak Følgende logikk må stemme for at feilmelding ikke skal oppstå: o Old password må være likt det gamle passordet o New password og confirm password må være like o New password kan ikke være likt som old password

11 Produktdokumentasjon Mamut Webforms 11 av Seksjon: Forms Create form Figur 5 - Create form Formål Opprette nytt webskjema. Forklaring av grensesnitt Type Felt Beskrivelse Tekstboks Name Navn på skjema Dropboks Country Hvilket land skjemaet skal registreres i Dropboks Category Hvilken kategori skjemaet skal tilhøre Knapp Create Oppretter skjema Unntak Tomt navn er ikke tillatt og feilmelding vil vises.

12 Produktdokumentasjon Mamut Webforms 12 av 48 Edit form Figur 6 - Edit form Formål Endre generell informasjon om skjemaet. Forklaring av grensesnitt Type Felt Beskrivelse Tekstboks Name Skjemanavn Dropboks Category Kategorien som skjemaet er knyttet til Tekstboks Redirect Hvilken side brukeren skal bli send til etter innsending av skjema Radio HTML/Text Om skal bruke HTML format eller i rentekst Tekstboks From Hvem som vises i Fra feltet Tekstboks Bcc to Hvem som skal få en blind kopi av e- mailen Tekstboks Subject Emne på en Tekstområde tekst Checkboks Enable no lead detection Innholdet i en Om skjemaet skal bli sjekket for at leads har kommet inn den siste perioden

13 Produktdokumentasjon Mamut Webforms 13 av 48 Unntak Name feltet kan ikke være tomt. Redirect feltet må være en gyldig nettadresse (bruke http eller https protokoller og ha gyldig hostname) eller tomt From feltet må være utfylt og en gyldig om reply brukes. Bcc to feltet må være en gyldig om fylt ut

14 Produktdokumentasjon Mamut Webforms 14 av 48 Edit fields Figur 7 - Edit fields Formål Endre skjemaets felter. Forklaring av grensesnitt Type Felt Beskrivelse Hakeboks Active Om feltet skal bli inkludert i genereringen Tekst Field Internasjonale navnet på feltet. Engelsk versjon av feltnavnet står i parantese for å hjelpe utvikleren. Tekstboks Order Hvilken rekkefølge feltet skal vises i. Lavere tall blir prioritert først Dropdownboks DataType Hva slags datatype feltet skal vises og tolkes som Hakeboks Required Om feltet skal være nødvendig eller ikke Knapp Update Utfør lagring av endringer

15 Produktdokumentasjon Mamut Webforms 15 av 48 Generate formcode Figur 8 - Generate formcode Formål Generere HTML kode for skjemaet, som deretter kan kopieres og limes inn på en nettside. Bistå med valgmuligheter som gjør det enklere for webutvikleren å integrere skjemaet på nettsiden. Forklaring av grensesnitt Type Felt Beskrivelse Dropdown Template style Hvilken mal (ang. designet) skjemaet skal bruke Hakeboks Clean + fill fields script Om skjemaet skal bruke rengjør og fyll felt script. Dette vil si at når brukeren trykker på feltet så renskes teksten, og teksten opprettes igjen om boksen er tom Tekstboks Width Bredden på skjemaet Dropdown Submit button Typen innsendingsknapp. Valgene er tekst eller bilde. Om bilde blir brukt vil det vises to nye tekstboksfelt: original og hover. Her oppgir man url til original og hover bilde som skal brukes. Tekstboks Submit button Teksten på innsendingsknappen. Tekstboks Submit button onclick Kode som skal settes inn i onclick attributtverdien på innsendingsknappen

16 Produktdokumentasjon Mamut Webforms 16 av 48 Tekstboks Form onsubmit Kode som skal settes inn i onsubmit attributtverdien på skjemaet Checkbox Use ajax for validationmessages Om ajax skal brukes for å hente valideringsbeskjeder, eller om de skal genereres direkte inn i koden Knapp Generate Genererer kode Unntak Bruk av anførselstegn i onclick/onsubmit feltene er ikke tillatt.

17 Produktdokumentasjon Mamut Webforms 17 av 48 View formdata Figur 9 - View formdata Formål Vise dataene som er sendt inn med skjemaene.

18 Produktdokumentasjon Mamut Webforms 18 av 48 List forms Figur 10 - List forms Formål Vise oversikt over opprettede skjemaer. Vise leadrelevant informasjon slik som hvilke skjemaer som er mest brukt og hvilke som er aktive. Forklaring av grensesnitt Type Felt Beskrivelse Dropdown Show Hvilken mengdegruppe med skjemaer som skal vises Tekst ID Det unike ID nummer til skjemaet Tekst Name Navnet på skjema Tekst Category Navn på kategorien til skjema Tekst Country Landet skjemaet ble opprettet i Tekst Date created Når skjemaet ble opprettet Tekst Last submittion Når skjema sist ble brukt Tekst Total submits Totalt antall personer som har sendt inn data med skjema Man kan sortere både asc og desc ved å trykke på en av overskriftene Skjemaene blir delt inn i sider for å begrense antall skjemaer per visning. Hver side kan inneholde 50 skjemaer.

19 Produktdokumentasjon Mamut Webforms 19 av Seksjon: Categories Create category Figur 11 - Create category Formål Opprette kategori Forklaring av grensesnitt Type Felt Beskrivelse Tekstboks Name Navnet til kategorien Knapp Create Oppretter kategori Unntak Tomt name verdi er ikke tillatt og feilmelding vil vises.

20 Produktdokumentasjon Mamut Webforms 20 av 48 Edit category Figur 12 - Edit category Formål Endrer kategori Forklaring av grensesnitt Type Felt Beskrivelse Tekstboks Name Navnet til kategorien Knapp Update Oppdaterer kategori Unntak Tomt name verdi er ikke tillatt og feilmelding vil vises.

21 Produktdokumentasjon Mamut Webforms 21 av 48 List categories Figur 13 - List categories Formål Vise oversikt over opprettede kategorier. Forklaring av grensesnitt Type Felt Beskrivelse Dropdown Show Hvilken mengdegruppe med kategorier som skal vises Tekst ID Det unike ID nummer til kategorien Tekst Name Navnet på skjema Man kan sortere både asc og desc ved å trykke på en av overskriftene Kategoriene blir delt inn i sider for å begrense antall skjemaer per visning. Hver side kan inneholde 50 kategorier.

22 Produktdokumentasjon Mamut Webforms 22 av Seksjon: Analysis Analysis Overview Figur 14 - Analysis overview Formål Vise nyttig lead informasjon

23 Produktdokumentasjon Mamut Webforms 23 av 48 Google utmccn Figur 15 - Google Utmccn Formål Kontrollere lagring av google analytics cookie verdi sammen med skjemadataen. Forklaring av grensesnitt Type Felt Beskrivelse Hakeboks Enable storage of utmccn value Valget mellom å lagre utmccn verdien eller ikke Knapp Update Lagrer endringene

24 Produktdokumentasjon Mamut Webforms 24 av 48 Project Url parameters Figur 16 - Project URL parameters Formål Opprette og håndtere henting av kampanjekoder (vil bli lagret i project feltet i skjemadata tabellen). Forklaring av grensesnitt Type Felt Beskrivelse Tekstboks Value Parameteren i urlen som vil bli forsøkt hentet Tekstboks Priority Hvilken prioritet parameteren vil ha. Prioriteten går fra lavest til høyest. Knapp - (minus) Fjerner en parameter Knapp Update Oppdaterer endringene Knapp Add new Legger til ny parameter Unntak Tom Value verdi er ikke tillatt og feilmelding vil vises.

25 Produktdokumentasjon Mamut Webforms 25 av 48 Custom Url parameters Figur 17 - Custom URL parameters Formål Endre brukerdefinerte parametre som blir flettet inn sammen med lead data. Forklaring av grensesnitt Type Felt Beskrivelse Tekstboks Parameter Parameteren i urlen som vil bli forsøkt hentet Knapp Update Oppdaterer endringene

26 Produktdokumentasjon Mamut Webforms 26 av Seksjon: Export Export Overview Figur 18 - Export overview Formål Vise nyttig informasjon om tidligere eksporteringer.

27 Produktdokumentasjon Mamut Webforms 27 av 48 Manual export Figur 19 - Manual export Formål Eksportere skjemadata til CSV fil manuelt. Forklaring av grensesnitt Type Felt Beskrivelse Dropdown Country Hvilket land det skal filtreres på Dropdown Category Hvilken kategori det skal filtreres på Tekst/kal. Date from Startdato for dataen som skal eksporteres Tekst/kal. Date to Sluttdato for dataen som skal eksporteres Knapp Export Eksporterer skjemadata Unntak Startdato og sluttdato må være oppgitt. Startdato må være før sluttdato.

28 Produktdokumentasjon Mamut Webforms 28 av 48 Automatic export basic settings Figur 20 - Automatic export basic settings Formål Endre innstillinger som pårører automatisk eksportering av skjemadata. Forklaring av grensesnitt Type Felt Beskrivelse Dropbox Run export Definering av intervall mellom hver automatisk eksportering Checkbox Unexported leads only Om bare ueksporterte leads skal eksporteres Dropbox Mode Om eksporteringen er markert som startet eller stoppet Knapp Update Lagring av innstillinger

29 Produktdokumentasjon Mamut Webforms 29 av 48 Automatic export advanced settings Figur 21 - Automatic export advanced settings Formål Endre innstillinger som pårører automatisk eksportering av skjemadata. Forklaring av grensesnitt Type Felt Beskrivelse Textbox Service update Hvor ofte servicen skal oppdatere seg interval selv med data fra datbasen. Verdi oppgis Textbox Trigger parameter value i minutter. Verdien som må matche verdien i url parameteren Trigger for at automatisk eksportering skal gjennomføres på eksporteringssiden. Textbox to Hvis spesifisert, hvilken konto den eksporterte filen skal sendes til Knapp Update Lagring av innstillinger Unntak Service update interval feltet kan bare bestå av tall og tallet må være mellom 5 og 120 to feltet hvis oppgitt må være en gyldig Trigger parameter value kan bare bestå av bokstaver og tall

30 Produktdokumentasjon Mamut Webforms 30 av Seksjon: Logging Logging overview Figur 22 - Logging overview Formål Vise nyttig loggføring informasjon.

31 Produktdokumentasjon Mamut Webforms 31 av 48 Log Figur 23 - Log Formål Vise innholdet i loggen.

32 Produktdokumentasjon Mamut Webforms 32 av 48 Log settings Figur 24 - Log settings Formål Endre innstillinger som pårører loggføring og effekter av dette. Forklaring av grensesnitt Type Felt Beskrivelse Textbox to send en log beskjeden skal bli sendt log messages Checkbox Send at occourence Om det skal sendes en av typen Type når en logginnføringen av Dropdown No lead detection trigger time samme typen forekommer Antall timer som må ha gått for å utløse no lead detection feilen Knapp Update Lagring av innstillinger Unntak to send log messages feltet må være en gyldig

33 Produktdokumentasjon Mamut Webforms 33 av Systemets oppbygning 5.1 Oversikt Mamut Webforms og tilleggsystemer som utgjør det totale prosjektet er samlet i en VS2010 løsning. I Visual Studio kalles de enkelte prosjektene for forsamlinger (assemblies) og det er ett slikt prosjekt en forsamling referer til. Forsamlingene kan ha forskjellige funksjoner, de kan være av forskjellig type og til og med være kodet i forskjellig.net versjon. Hva som er likt ved dem er at de er alle små delsystemer som til slutt danner ett eller flere systemer. Løsningens forsamlinger beskrives kort under: Forsamling Classes Dynamic Query Mamut Webforms Mamut Webforms Service Application Mamut Webforms Test Beskrivelse Hovedklassebiblioteket for Mamut Webforms systemet. Ett tilleggsbibliotek som tillatter dynamiske LINQ/SQL spørringer. MVC2 prosjektet som utgjør Mamut Webforms nettstedet. Windows Service applikasjonen som brukes til automatisk eksportering. Testprosjekt som inneholder enhetstestene for systemet. Figur 25 - Avhengigheter mellom forsamlingene 5.2 Classes Nesten alle klassene i det totale Mamut Webforms systemet er samlet i denne forsamlingen. Grunnen til at klassene er plassert i en separat forsamling er å skille logikk mellom presentasjon, samt gjøre det mulig for andre forsamlinger å referere til klassene som brukes i biblioteket. Under skrives det kort om noen av nøkkel modulene i systemet: Configuration Modul som inneholder klasser som håndterer globalt tilgjengelig konfigurasjonsdirektiver. Database

34 Produktdokumentasjon Mamut Webforms 34 av 48 Håndterer forbindelser med databaser. DataObjects Inneholder Repositories, Objects og BusinessLogic. En Repository klasse har som oppgave å håndtere database kall til en spesifikk database tabell. Man kan se de representerer datatilgang laget. En Object klasse representerer en database rad returnert fra ett Reprository kall. BusinessLogic inneholder forretningslogikk laget og fungerer over Repository klasser. Exporting Inneholder logikk involvert med automatisk og manuell eksportering. Extensions Her ligger alle utvidelsesmetodene. General All generell funksjonalitet som ikke passer inn i en spesifikk modul havner her. Logging Inneholder logikk involvert med loggføring til både fil og e-post kontoer. Mvc Mvc er kjernen i hele systemet. Modulen består av Controllers, Models, Logic og Results. En Controller klasse representerer en kontrollør i MVC arkitekturen. En Model klasse representerer en modell i MVC arkitekturen. Logic inneholder logikk som er nært knyttet til noen av MVC elementene. Results inneholder egendefinerte resultater som kan bli returnert av en kontrollør. Ett resultat kan være for eksempel HTML kode, javascript kode, xml kode og mer. Resource Klasser knyttet til ressurshenting og håndtering ligger i Resource modulen. Ressurser er ofte tekststrenger som kan være på flere språk og disse trenger å kunne hentes ut dynamisk på det språket som er gjeldende. Modulen bruker databasen som datalager for ressursene. Session Her ligger all kode som brukes til å håndtere serverside sesjoner. Serverside sesjoner brukes hovedsakelig for å håndtere innloggede og utloggede brukere, men kan også brukes til annet slik som handlekurver og å lagre korte persistente meldinger som kan hentes ved neste side kall. 5.3 Dynamic Query Dynamic Query er ett tilleggsbibliotek som tillatter dynamiske LINQ/SQL spørringer. 5.4 Mamut Webforms I denne forsamlingen ligger MVC applikasjonen som utgjør selve nettsiden for Mamut Webforms systemet. Alle filene som skal være synlige på nettet plasseres her; det vil si de enkelte sidene (views), scriptsene og grafikk.

35 Produktdokumentasjon Mamut Webforms 35 av 48 I MVC2 kaller applikasjonen kontrollørene som ligger i Classes forsamlingen bak kulissene. Om en kontrollør blir funnet så letes det etter en Action metode som den igjen kaller. Denne metoden returnerer ett resultat eller ett View. Om resultatet er ett View så letes det i filstrukturen etter en fil som regel med samme navn som Action metoden som ble kalt tidligere. For eksempel om nettadressen er mysite.com/controller/action så tolkes verdien Controller som kontrollør og Action som Action metoden. Det vil si at det letes etter en fil kalt Action i mappen Controller i Views mappen Views. Vanligvis sendes det med en Model sammen med viewet og viewet bruker modellen til å presentere informasjonen. Dette er kjernen i MVC2.

36 Produktdokumentasjon Mamut Webforms 36 av 48 Figur 26 - Mamut Webforms sin filstruktur som MVC2 applikasjon (NB: ikke samme struktur som hvordan brukeren opplever det)

37 Produktdokumentasjon Mamut Webforms 37 av Mamut Webforms Service Application Forsamlingen er definert som ett Windows Service prosjekt. Det inneholder noen få egne klasser som brukes til og blant annet administrere nedtellerne som igjen brukes til å utløse automatisk eksportering. 5.6 Mamut Webforms Test Denne forsamlingen er definert som ett testprosjekt. Her ligger alle enhetstester for hele Mamut Webforms og dets delsystemer.

38 Produktdokumentasjon Mamut Webforms 38 av Databasestruktur Figur 27 - Database diagram

39 Produktdokumentasjon Mamut Webforms 39 av 48 Databasen som blir brukt er av typen Microsoft SQL Server (MSSQL). MSSQL er en relasjonell modell database utviklet av Microsoft for bruk med Windows kompatible applikasjoner. Under følger en liste over definerte tabeller og felter i databasen. Legg merke til at alle felter er i utgangspunktet NOT NULL og blir ikke nevnt eksplisitt i definisjonen. Null felter blir definert med betegnelsen Nullable. Forms FormId Integer PK, AI Name Varchar (250) UK DateCreated Datetime DateLastEdit Datetime Nullable CountryId Integer FK [Countries: CountryId], ON UPDATE: CASCADE, ON DELETE: RESTRICT CategoryId Integer FK [Categories: CategoryId], ON UPDATE: CASCADE, ON DELETE: RESTRICT Redirect Varchar (250) UseReply Tinyint Reply From Varchar (250) Reply Bccto Varchar (250) Reply Subject Varchar (250) Reply Text Varchar (MAX) EnableNoLeadDetection Tinyint Fields Felter som assosieres med skjemaer. FieldId Integer PK, AI FormId Integer FK [Forms: FormId], ON UPDATE: CASCADE, ON DELETE: CASCADE Active Tinyint Name Varchar (100) FieldType Integer Order Integer Required Tinyint DataType Integer CodeGenerationSettings Tabell som lagrer tidligere brukte innstillinger for generering av kode. CodeGenerationSettingId Integer PK, AI

40 Produktdokumentasjon Mamut Webforms 40 av 48 FormId Integer FK [Forms: FormId], ON UPDATE: CASCADE, ON DELETE: CASCADE TemplateStyle Integer Width Integer SubmitButton Varchar (100) SubmitButtonType Integer SubmitButtonImg Varchar (200) SubmitButtonImgHover Varchar (200) SubmitButtonOnclick Varchar (255) FormOnsubmit Varchar (255) UseAjaxForValMessages Tinyint CleanFillFieldsScript Tinyint Categories Kategorier skjemaer kan bli segmentert etter. CategoryId Integer PK, AI Name Varchar (250) UK Formdata Data for skjemaer (leads) FormdataId Integer PK, AI FormId Integer FK [Forms: FormId], ON UPDATE: CASCADE, ON DELETE: CASCADE DateSubmitted Datetime Url Varchar (250) Url hvor skjema ble fylt ut Project Varchar (250) GoogleUtmccn Varchar (250) FieldsFormdata Skjemadata fra feltene assosiert med skjema. Forklaring: En skjemadefinisjon har flere felter og når en bruker sender inn skjema med data så blir feltene i skjemaet brukeren fylte ut og verdiene av disse lagret her. Man kan da gjøre en kryssreferanse mellom feltene og verdiene som ble fylt ut av brukeren mot feltene som er definert i skjemaet. FieldFormdataId Integer PK, AI FormdataId Integer FK [Formdata: FormdataId], ON UPDATE: CASCADE, ON DELETE: CASCADE FieldType Integer Name Varchar (150)

41 Produktdokumentasjon Mamut Webforms 41 av 48 Value Varchar (250) FormdataExports Denne tabellen brukes for å flagge eksporterte leads som eksportert eller ikke eksportert. FormdataExportId Integer PK, AI FormdataId Integer UK, FK [Formdata: FormdataId], ON UPDATE: CASCADE, ON DELETE: CASCADE Exported Tinyint Exports Data om utførte eksporteringer. ExportId Integer PK, AI ExportDate DateTime NumLeads Integer Type Integer Result Integer CustomUrlParameters Her defineres egendefinerte url parametre som blir flettet inn sammen med skjema under innsending og assosiert med ett lead. CustomUrlParameterType Integer PK Name Varchar (250) CustomUrlParametersFormdata Paramaterdata assosiert med skjemadata. CustomUrlParameterFormdataId Integer PK, AI FormdataId Integer FK [Formdata: FormdataId], ON UPDATE: CASCADE, ON DELETE: CASCADE CustomUrlParameterType Integer FK [CustomUrlParameters: CustomUrlParameterType], ON UPDATE: CASCADE, ON DELETE: CASCADE Value Varchar (250) ProjectUrlParameters Her defineres hvilke url parametre som sjekkes for å finne Project verdien i skjemadata. ProjectUrlParameterId Integer PK, AI Name Varchar (250) Priority Integer

42 Produktdokumentasjon Mamut Webforms 42 av 48 Settings Her lagres globale konfigurasjoner. Samtlige urelatert funksjonalitet bruker denne tabellen til å lagre persistente data. Blant annet google utmccn, automatisk eksportering innstillinger og logging bruker denne tabellen. Name Varchar (250) PK Value Varchar (250) Users Brukere av systemet. UserId Integer PK, AI Username Varchar (100) Password Char (32) CookieLogin Felt for å lagre informasjon om persistente innlogginger ved bruk av cookies. CookieLoginId Char (23) PK UserId Integer FK [Users: UserId], ON UPDATE: CASCADE, ON DELETE: RESTRICT MachineName Varchar (100) Platform Varchar (100) Browser Varchar (100) Countries Landene som brukes i systemet. CountryId Integer PK Name Varchar (100) CountriesLanguages Tabell som binder tabellene Countries og Languages sammen. CountryId Integer PK, UK, FK [Countries: CountryId], ON UPDATE: CASCADE, ON DELETE: RESTRICT Languages Integer PK, FK [Languages: LanguageId], ON UPDATE: CASCADE, ON DELETE: RESTRICT Languages Språkene som brukes for å hente ressurser på språk. LanguageId Integer PK Name Varchar (100) CultureName Varchar(10)

43 Produktdokumentasjon Mamut Webforms 43 av 48 Resources Her lagres ressursstrenger. Internasjonalisering er også støttet. Name Varchar (250) PK Value Varchar (250) LanguageId Integer PK, FK [Languages: LanguageId], ON UPDATE: CASCADE, ON DELETE: RESTRICT ResourceCategoryId Integer PK, FK [ResourceCategories: ResourceCategoryId], ON UPDATE: CASCADE, ON DELETE: RESTRICT

44 Produktdokumentasjon Mamut Webforms 44 av Program CDen Hele systemet inkluderes på en CD som leveres sammen med prosjektrapporten. Innholdet på CDen kan brukes til å installere systemet, samt videreutvikle det om ønsket. Når en Program CD blir referert til i dokumentasjonen er det denne CDen det er snakk om. Følgende filer fra CDen er relevante for dataansvarlige og lesere av dette dokumentet: Filene som oppgjør nettstedet. Database filer som brukes til å opprette database strukturen og data. Service programmet som brukes til automatisk eksportering. Kildekoden til hele systemet.

45 Produktdokumentasjon Mamut Webforms 45 av Installeringer og rutiner 8.1 Installering av systemet 1. Installer IIS webserver. 2. Installer Microsoft SQL Server. 3. Kjør scriptet for å opprette database tabeller og data. a. Åpne Microsoft SQL Server Management Studio. b. Logg deg inn til databasen. c. Utvid Database seksjonen. d. Lokaliser og høyre klikk på korrekt database, velg deretter New Query. e. Naviger deg i Program CDen til mappen Database. f. Åpne scriptet Startup.sql, og kopier innholdet. g. Lim inn scriptet i spørringsvinduet du nettopp åpnet i Microsoft SQL Server Management Studio. h. Trykk på Execute og databasen skal bli opprettet. 4. Last opp filene til filserver. a. Åpne ditt favoritt FTP program. b. Logg deg inn med riktige kredensialer. c. Overfør filene i mappen Website fra Program CDen til filserveren. 5. Konfigurer konfigurasjonsfil med riktig database-, smtp-, ftpinfo også videre. Filen heter Web.config og finnes i rotmappen av nettstedet. Endre bare verdier som er kommentert mellom Modify here og End modify here. 8.2 Installering av Mamut Webforms Service 1. Installer Mamut Webforms service: a. Sørg for at du har kopiert innholdet i mappen Service på Program CDen til en mappe på maskinen du ønsker å kjøre servicen på. Det trenger ikke være samme maskin som kjører webserveren. b. Start command line. c. Kjør installutil.exe applikasjonen (finnes i mappen installutil for NET 4.0) med argumentene /i MamutWebformsServiceApplication.exe (finnes i bin mappen). Eksempel: ServiceMappe/installutil for NET 4.0/installutil.exe /i ServiceMappe/bin/MamutWebformsServiceApplication.exe 2. Kontroller konfigureringene i konfigurasjonsfilen. Filen heter MamutWebformsServiceApplication.exe.config og ligger i bin mappen sammen med MamutWebformsServiceApplication.exe. Endre bare verdier som er kommentert mellom Modify here og End modify here. 3. Start Mamut Webforms service (merk at dette gjelder for Windows Vista, derfor kan stegene under variere i din versjon): a. Åpne kontrollpanel. b. Naviger til system og vedlikehold. c. Åpne administrative verktøy. d. Trykk på Services snarveien. e. Naviger deg til servicen Mamut Webforms service. f. Trykk på Start the service. Til slutt burde du kontrollere eksporteringsinnstillingene. Disse kan endres gjennom Mamut Webforms på nettet.

46 Produktdokumentasjon Mamut Webforms 46 av Uinstallering av Mamut Webforms Service 1. Stopp Mamut Webforms service (merk at dette gjelder for Windows Vista, derfor kan stegene under variere i din versjon): a. Åpne kontrollpanel. b. Naviger til system og vedlikehold. c. Åpne administrative verktøy. d. Trykk på Services snarveien. e. Naviger deg til servicen Mamut Webforms service. f. Trykk på Stop the service. 2. Start command line. 3. Kjør installutil.exe applikasjonen (finnes i mappen installutil for NET 4.0) med argumentene /u MamutWebformsServiceApplication.exe (finnes i bin mappen). Eksempel: ServiceMappe/installutil for NET 4.0/installutil.exe /u ServiceMappe/bin/MamutWebformsServiceApplication.exe. 8.4 Debugging/lese feilmeldinger av service 1. Åpne kontrollpanel. 2. Naviger til system og vedlikehold. 3. Åpne administrative verktøy. 4. Åpne Event viewer. 5. Utvid Custom Views seksjonen og deretter Administrative Events. 6. Se etter feil med kilde (source) Mamut Webforms Service.

47 Produktdokumentasjon Mamut Webforms 47 av Referanseliste 9.1 Referanser Microsoft logo

48 Produktdokumentasjon Mamut Webforms 48 av Figurliste Figur 1 - Innholdsstruktur diagram... 7 Figur 2 Hovedmeny... 8 Figur 3 - Login... 9 Figur 4 - Change password Figur 5 - Create form Figur 6 - Edit form Figur 7 - Edit fields Figur 8 - Generate formcode Figur 9 - View formdata Figur 10 - List forms Figur 11 - Create category Figur 12 - Edit category Figur 13 - List categories Figur 14 - Analysis overview Figur 15 - Google Utmccn Figur 16 - Project URL parameters Figur 17 - Custom URL parameters Figur 18 - Export overview Figur 19 - Manual export Figur 20 - Automatic export basic settings Figur 21 - Automatic export advanced settings Figur 22 - Logging overview Figur 23 - Log Figur 24 - Log settings Figur 25 - Avhengigheter mellom forsamlingene Figur 26 - Mamut Webforms sin filstruktur som MVC2 applikasjon (NB: ikke samme struktur som hvordan brukeren opplever det) Figur 27 - Database diagram... 38