Installationsvejledning til Virk Tæller

Transkript

1 Installationsvejledning til Virk Tæller Version 1 Indhold Hvad er Virktælleren?... 2 Brugeradfærd... 2 Brugeranvisning til indsættelse af JavaScript Start-script... 2 Completed-script... 2 Test af script... 2 Brugeranvisning til direkte kald Start-kode... 3 Completed-kode... 3 Ekstra felter... 3 Særligt ved kommunale løsninger Fremgangsmåde ved brug af scripts... 4 Fremgangsmåde ved brug af direkte kald... 5 Hjælp og kontakt... 5

2 Hvad er Virktælleren? Virktælleren gør det muligt for myndigheder, at tælle antallet af påbegyndte og afsluttede indberetningsforløb i en indberetningsløsning. Du kan installere den ved enten at lægge to JavaScripts på din indberetningsløsning, eller ved at foretage to direkte kald til Virktælleren. Du finder en vejledning til begge metoder nedenfor. Brugeradfærd Virktæller-scriptet giver også mulighed for at indsamle information om, hvorledes brugerne bevæger sig rundt i indberetningsløsningen. Dette er ikke noget, der sker automatisk, men noget der kan ske i en afgrænset periode, efter aftale med VIRK-redaktionen. Kontakt redaktionen for mere information om, hvordan man sætter monitorering af brugeradfærd op. Brugeranvisning til indsættelse af JavaScript Den mest almindelige og anbefalede måde at installere Virktælleren på, er ved at indsætte to JavaScripts på den indberetningsløsning, som man ønsker at tælle på. Du skal indsætte to JavaScripts på din løsning, for at det virker: et start-script på alle formular-sider (de sider man skal udfylde for at indsende indberetning), og et completed-script på kvitterings-siden (den side man får vist ved afsluttet indberetning). Begge scripts kan bruges som de er, men du kan dog tilføje ekstra felter, hvis du har brug for dette. Se afsnittet om ekstra felter for yderligere information. Når du er logget ind i DIA har du adgang til de to scripts du skal anvende: start-script og completed-script. De ligger under fanen Statistik. Du skal blot kopiere disse og indsætte dem de rigtige steder. Start-script Dette script skal indsættes på alle sider. Scriptet skal placeres inde i <body> tagget, men det er lige meget, hvor i <body> det er placeret. Du finder start scriptet i DIA og copy/paster det der fra. Completed-script Dette script skal indsættes på sidste side i din formular. Det er vigtigt, at du kun indsætter det på slut- eller kvitteringssiden, som brugeren får vist efter endt indberetning. Scriptet skal ligeledes indsættes inde i <body> tagget. Test af script I feltet Seneste data kan du se de indkomne data fra de sidste 7 dage. Dette kan du bruge til at verificere at JavaScriptet er indsat korrekt. Brugeranvisning til direkte kald Som et alternativ til indsættelse af JavaScripts kan du benytte dig af et direkte kald. Det foregår ved at du indsætter en kodestump på din side, som henter en usynlig billedfil når siden loades.

3 Du skal være opmærksom på, at hvis du bruger denne metode, så kan du ikke følge brugeradfærd. Derfor anbefaler vi, at du anvender JavaScript-metoden. Start-kode Kopier HTML-koden fra DIA og indsæt den på startsiden i din indberetningsløsning. (OBS: dette gælder KUN for direkte kald. For indsættelse af script, se ovenfor. Completed-kode Kopier HTML-koden fra DIA og indsæt den nederst på din indberetningsløsnings afslutnings- eller kvitteringsside. Ekstra felter Som udgangspunkt kan du bruge begge løsninger som de er. Skulle du have særlige behov, er der mulighed for at bruge følgende ekstra felter: Cvr CVR-feltet udfyldes automatisk, hvis brugeren kommer ind via Virk.dk. Det er derfor kun nødvendigt, at anvende dette felt, hvis du ønsker at få CVR-information med, når folk kommer ind på indberetningsløsningen via dit eget site. Presenter Du kan anvende Presenter-feltet, hvis du benytter en formular, som ejes af en anden myndighed. Et eksempel kunne være, når flere kommuner deles om en løsning. I så tilfælde afgøres det, hvilken kommune den enkelte transaktion tilhører ved at opgive kommunenummeret i presenter-variablen. SubID Hvis du har behov for at registrere forskellige versioner af en formular, der kun eksisterer som en samlet formular i DIA, kan du anvende SubID-feltet til at angive et unikt ID for hver version. Du skal ikke anvende dette til at skelne imellem kommuner ved fælles kommunale løsninger. Der skal du anvende presenter. ProjectID Skal benyttes hvis man har længerevarende sessioner. Det der skal sendes med, er det unikke ID der, identificerer den givne formularudfyldning. For eksempel hvis der er tale om en løsning, hvor man kan lave kladder, som man kan vende tilbage til senere. Test Du skal benytte Test-feltet til når du skal teste indberetningsløsningen, og gerne vil undgå at test-brug optræder i statistikken. Har du sat Test-feltet til true vil data ikke komme med i rapporterne. Særligt ved kommunale løsninger Hvis der er tale om en kommunal løsning, der anvendes af flere forskellige kommuner, skal du anvende variablen presenter til at afgøre, hvilken kommune den enkelte transaktion tilhører. Presenter skal indeholde kommunenummeret og intet andet.

4 Hvis du vil tilføje de valgfrie felter skal du bruge forskellige fremgangsmåder, alt efter om du anvender JavaScript eller direkte kald. Anvender du JavaScript skal du huske, at de valgfrie felter også skal tilføjes til det direkte kald, der anvendes som fallback i tilfælde af at brugeren har scripts slået fra. Fremgangsmåde ved brug af scripts I de scripts du kan kopiere fra DIA er felterne allerede skrevet ind for din løsning. Du skal derfor kun ændre scriptet - ved at indsætte værdier i de felter, som du vil anvende - hvis du har særlige behov. Se hvordan i eksemplet nedenfor. Eksempel: I script løsningen indsættes den givne værdi i variabel deklarationen. Fx kan underformular (subid), som benyttes hvis formularen eksisterer i flere varianter, sættes til 123 som vist i nedenstående eksempel (den ændrede linje er markeret med fed). OBS DETTE ER ET EKSEMPEL. DEN RIGTIGE KODE SKAL TAGES FRA DIA. BRUG IKKE DENNE. <script> /* ---- EDIT THE VALUES BELOW FOR CONFIGURATION ---- */ var _eogstm = { // mandatory diaid : '1234', // Dia formular ID // optional - se installationsvejledningen cvr : '', // CVR nummer presenter : '', // ID på myndighed, hvis ikke formular-ejer subid : '123', // Benyttes hvis formularen eksisterer i flere varianter projectid : '', // Benyttes til formularudfyldninger, der løber over flere dage test : false // False in production, true in test }; /* ---- DON'T EDIT BELOW THIS LINE ---- */ (function(d,p,s){var e=d.createelement('script'),b=d.getelementsbytagname(p)[0];e.src=s+'/components/requirejs /require.js';e.setattribute('data-main', s+'/scripts/eostm');b.appendchild(e)}(document,'body',' </script> Desuden skal noscript delen ligeledes ændres således at den indeholder den givne variabel (markeret med fed): <noscript> <img alt="" height="1" width="1" src=" /> </noscript>

5 Fremgangsmåde ved brug af direkte kald Kald til handleren opbygges ved at sammensætte URL en med en liste af parametre, en såkaldt QueryString. Parameterlisten sættes i umiddelbar forlængelse af URL en. Starten på parameterlisten markeres med et? (spørgsmålstegn). Hver parameter angives som et name/value -par. Parameternavnet og parameterværdien adskilles af et = (lighedstegn). Når parameterlisten indeholder mere end en parameter adskilles hver parameter med et & (og-tegn). Ved direkte kald skal URL en opdateres med den nødvendige parameter (markeret med fed). I dette eksempel er det variablen subid, der er blevet tilføjet: OBS DETTE ER ET EKSEMPEL. DEN RIGTIGE KODE SKAL TAGES FRA DIA. BRUG IKKE DENNE. <img alt="" height="1" width="1" src=" ID%&status=start&subID=123" /> Hjælp og kontakt Hvis du har brug for hjælp eller har spørgsmål, kan du skrive til Virk redaktionen på [email protected]