Vejledning til scriptinstallation. Virk Tæller

Transkript

1 Vejledning til scriptinstallation Virk Tæller

2 Indhold Om Virk Tæller... 2 Forudsætninger for at installere scriptet... 2 Simpel installation... 2 Lineære indberetningsløsninger... 6 Fremdriftsscript... 6 Afslutningsscript... 7 Simpel variabeltabel... 8 Avanceret installation... 9 Komplekse indberetningsløsninger... 9 Flere indberetninger i ét forløb... 9 Kladdereference... 9 Alternative nøgler... 9 Fælles landing page script Avanceret variabel tabel Installationstest Troubleshoot Der kommer ikke data fra Virk Tæller scriptet? Installationstesten fejler? Mangler data i en indberetning Definitioner Få mere hjælp Side 1

3 Om Virk Tæller Virk Tæller er et digitalt overvågnings- og analyseværktøj, der overvåger brugen af siderne i indberetningsløsningen og genererer statistik på baggrund heraf. Ud over de data som automatisk sendes med Virk Tæller, er der en række data som udvikleren selv skal tage stilling til. Dette sker fordi data ikke er ens for alle indberetningsløsninger, og der er derfor behov for denne individuelle opsætning. Data kan f.eks. være Kommunekode, Sagsnummer eller Kladdereference. Forudsætninger for at installere scriptet Virk Tæller scriptet kan installeres af en udvikler, hvor følgende er opfyldt: Du skal have scriptet, det findes i DIA (stedet hvor indberetningsløsninger på Virk Indberet administreres). DIA log-in har I selv eller også har den involverede myndighed. Du skal have rettighed til at installere scriptet på indberetningsløsningen. Simpel installation De fleste indberetningsløsninger er simple lineære forløb fra start til slut. I det nedenstående beskrives en simpel scriptinstallation til en indberetningsløsning med et lineært forløb. Hvis indberetningsløsningen er mere kompleks, så se nærmere herom i afsnit Avanceret installation på side 9. De variable, der udfyldes skal have direkte sammenhæng med de variable, der er repræsenteret i indberetningsløsningen, hvilket f.eks. kan være diaid, Kommunekode eller P-nummer. Vigtigt! Husk at tage stilling til variablerne. Se afsnit Simpel variabeltabel side 8. For at kunne installere Virk Tæller scriptet skal du følge nedenstående skridt for skridt vejledning. Udvikleren henter Virk Tæller scriptet på Tæller scripts kan testes i PreProduktionsmiljøet. Scripts URL er mod Produktionsmiljø skal starte med Scripts URL er mod PreProduktionsmiljø skal starte med Hovedpunkter for installation, som er efterfulgt af en skridt for skridt vejledning: 1. Log in på 2. Kopier scripts til et tekstredigeringsprogram 3. Gå til den pågældende indberetningsløsning som udvikler (kildekode) 4. Installer scripts for hver side i indberetningsløsningen a. Gentag på hver side b. Ved test skal de to url er i hvert script ændres fra til 5. Husk at udfylde de rigtige scripts, på de rigtige sider Navigation Handling Billede 1) Log in på Søg indberetningsløsningen frem Gå til statistik- Side 2

4 fanebladet Markér, højre-klik og kopier hele Virk Tæller scriptet Til og med det sidste sted hvor der står </noscript> Figur 1: Billedet er et eksempel og udsnit, kan ikke kopieres 2) Gå til et tekstredigeringsprogram Indsæt scriptet Figur 2: Eksempelvis Notepad Alle de mulige variabler står på linjerne mellem var config = { }; Samt i <noscritp> efter noscript.png? Det er vigtigt at variable sættes BEGGE steder, da data ellers ikke vil blive indsamlet korrekt for alle brugere Udfyld de obligatoriske variable* Figur 3: Config -billedet er et eksempel og udsnit, kan ikke kopieres Figur 4: Noscript -billedet er et eksempel og udsnit, kan ikke kopieres Figur 5: Billedet er et eksempel og udsnit, kan ikke kopieres Marker, højre-klik og kopier hele Virk Tæller scriptet igen. Side 3

5 Figur 6: Billedet er et eksempel og udsnit, kan ikke kopieres 3) Gå til den pågældende indberetningsløsning som udvikler 4) For hver side i indberetningsløsningen Eksempel k/myndigheder/stat/e RST/Anmod_om_servic eattest Indsæt scriptet nederst i koden på den sidste tomme linje over </body> Figur 7: Billedet er et eksempel og vil se anderledes ud i virkeligheden 4a) Gentag på hver side 5) Husk at udfylde de rigtige scripts, på de rigtige sider Gentag indsættelse af scriptet for hver side i indberetningsløsningen Vær opmærksom** Fremdriftsscript (fra og med første side) Config: Noscript: Afslutningsscript (på sidste side) Den sidste side i indberetningsforløbet, menes kvitteringssiden hvor indberetningsforløbet er færdig for den pågældende indberetter. Config: Noscript: Side 4

6 *Se mere om variablerne i afsnit Simpel variabeltabel på side 8 **Er der tale om et komplekst indberetningsforløb, så se ydereliger i afsnit Komplekse indberetningsløsninger på side 9 Side 5

7 Lineære indberetningsløsninger Nedenfor beskrives de to scripts, der anvendes i et lineært indberetningsforløb. Udvikleren henter Virk Tæller scriptet på Der skal installeres to Virk Tæller scripts i lineære indberetningsforløb hhv.: Fremdriftsscriptet Afslutningsscriptet Fremdriftsscript Fremdriftsscriptet skal installeres på alle sider undtagen afslutningssider og kvitteringssider. Installer fra og med den første side - til og med den næstsidste side i indberetningsforløbet. Figur 8: Billedet er et eksempel og kan ikke kopieres Side 6

8 Afslutningsscript Afslutningsscriptet skal installeres på kvitteringssiden dvs. den allersidste side i indberetningsforløbet. Figur 9: Billedet er et eksempel og kan ikke kopieres Side 7

9 Simpel variabeltabel Nedenfor beskrives de forskellige almindelige variabler i scriptet. Har du en mere kompleks indberetningsløsning eller behov for avancerede installationsmuligheder, kan du se nærmere i afsnittet Avanceret installation på side 9. Alle variable som ikke benyttes, skal fremstå som oprindeligt i scriptet hos DIA. Titel Variabelnavn Beskrivelse Handling Eksempel DIA-ID diaid DIA Id et er indberetningsløsningens id. Kommunekode kommunekode Kommunekode er kommunens CVR nummer for virksomheden cvrindberet id. CVR nummer for den virksomhed, der indberettes på (og ikke den virksomhed, der indberetter). Obligatorisk og forudfyldt i scriptet hos DIA. Obligatorisk at udfylde for kommunale løsninger. Skal udfyldes hvis det ønskes opsamlet af Virk Tæller. Dataaftager kan se hvilken indberetningsløsning, der har været anvendt til indberetningen. Dataaftager kan sortere data efter kommune. Dataaftager kan få indblik i den virksomhed, der indberettes på ud over den virksomhed, som indberetter (eks. en revisionsvirksomhed eller en advokatvirksomhed, som indberetter på vegne af en anden virksomhed). Kladdereference kladdereference En reference til et givet påbegyndte indberetningsforløb. P-nummeret pnnummer P-nummeret repræsenterer det sted, hvor der drives virksomhed fra. Ikke obligatorisk at udfylde. Efterlad blank eller udfyld variablen med en funktion, der kan kalde kladdereferencen i indberetningsløsningen. Skal udfyldes hvis det ønskes opsamlet af Virk Tæller. Sagsnummer sagsnummer Sagsnummeret er sagens id. Ikke obligatorisk at udfylde. Efterlad blank eller udfyld variablen med en funktion, der kan kalde sagsnummeret i indberetningsløsningen. Dataaftager kan eksempelvis kæde indberetnings-data sammen, når en enkelt indberetnings med kladdereference startes i én session og fortsættes i en anden session. Dataaftager kan sortere efter hvilke dele p-enheder i organisationen, der anvender indberetningsløsningen. Dataaftager kan kæde sager og indberetninger sammen.

10 Avanceret installation De fleste indberetningsløsninger er simple og lineære forløb fra start til slut. Men der er undtagelser. I det nedenstående beskrives derfor de mere komplekse indberetningsforløb og de avancerede variable, som udvikleren har mulighed for at gøre brug af. Der er flere overvejelser forbundet med en avanceret installation, men overordnet er installationsprocessen mangen til den simple installationsproces gennemgået i afsnittet Simpel installation på side 2. Udvikleren henter Virk Tæller scriptet på Komplekse indberetningsløsninger Et komplekst indberetningsforløb indeholder én eller flere af følgende punkter: et forløb med flere indberetninger i. et forløb der indeholder kladdereferencer. et forløb med alternative nøgler. en indberetningsløsning med flere formularer der deler side landing page. Tabellen Avanceret variabel tabel på side 12 indeholder de avancerede variable til et komplekst indberetningsforløb. Vigtigt! Udvikleren skal ved en avanceret installation særligt have fokus på flg.: - Er der fælles landing pages i indberetningsløsning? - Er der behov for variablen Alternativ nøgle? - Er der behov for variablen Kladdereference? Flere indberetninger i ét forløb Hvis en løsning har et forløb der behandler/afslutter flere indberetninger, kan der i Afslutningsscriptet på dette forløb tilføjes flere kladdereferencer i dette format: ['XP-237-kladde', 'XP-131-kladde'] som vist på Avanceret variabel tabel på side 12. Det vil registreres af Tælleren, som at afslutte nævnte indberetningsforløb på de respektive Kladdereferencer. Kladdereference Kladdereference kan være referencer til en given indberetning. Referencen er specifik til den enkelte indberetning, men kan bruges forskelligt i de forskellige indberetningsløsninger. Eksempelvis kan den bruges til at komme tilbage til en indberetning igen, efter indberetteren er logget ud eller browseren er lukket. Alternative nøgler Denne variabel kan bruges til at indeholde nøgler eller/og værdier formularen i indberetningsløsning, som vist på Avanceret variabel tabel på side 12.

11 Fælles landing page script En fælles landing page er en side, der deles mellem flere formularer i samme indberetningsløsning. Scriptet til en fælles landing page, er et fremdriftsscript uden DIA id. Scriptet til fælles landing page skal installeres, hvis der er sider, der deles mellem flere formularer i en indberetningsløsning undervejs i indberetningsforløbene, som vist i Figur 10. Figur 10: Indberetningsforløb med fælles landing page Side 10

12 Vigtigt! Et script til en fælles landing page er det samme som et fremdriftsscript men uden DIA id et, som fjernes fra scriptet på denne side. Figurens Formular Start side indeholder fremdriftsscript. Det er kun komplekse indberetningsløsninger, der vil få brug for dette script. Side 11

13 Avanceret variabel tabel Nedenfor beskrives de avancerede variabler i scriptet. Titel Variabelnavn Beskrivelse Handling Eksempel Alternativ nøgle alternativnoegle En alternativ nøgle er en individuel nøgle til egne data. Kladdereference for flere indberetninger i et forløb/flere formularer i en løsning kladdereference Den samme variable som omtalt i afsnit Simpel variabeltabel på side 8. En reference til den påbegyndte indberetningskladde på indberetningsløsninger, der har flere indberetninger i et forløb eller flere formularer i en løsning. Ikke obligatorisk at udfylde. Efterlad blank, udfyld med statisk værdi eller udfyld variablen med en funktion, der kan kalde den særlig nøgle i indberetningsløsningen. Ikke obligatorisk at udfylde. Efterlad urørt eller udfyld variablen med en funktion, der kan kalde alle de afsluttede kladdereferencen i indberetningsløsningen på afslutningssiden. Dataaftager kan anvende egne nøgler til at sorterer data efter, eks. KLE-numre og lign. Formatet kan være en simpel tekststreg eller et JSON-formatet som Key/value. Eks. "foo" : "bar" Hvis der bruges JSON er det vigtigt at dette det overholder et korrekt format. Dataaftager kan kæde kladdereferencerne sammen på tværs af flere indberetninger i et forløb eller indberetningsløsninger, hvor der afsluttes flere formularer i ét indberetningsforløb. Eks. ['XP-237-kladde', 'XP-131-kladde']

14 Installationstest Installationstest foretages mod Tæller PreProd miljøet. Scripts URL er mod Prod starter med Scripts URL er mod PreProd starter med Når scriptet er installeret på alle sider i indberetningsløsningen, kan det testes ved at hente data ud af Tæller PreProd servicen. Til dette skal der bruges rettigheder til den service der udstille disse data i form af myndighedens brugernavn og password. Denne service kan tilgås via adresserne inkl. inputparametre: Event-data Felt-data Indberetningsforløbs-data Inputparametre: Eks: Enten diaid eller/og kommunekode og/eller CVR-nummer fra loginprofil og/eller CVRnummer som indberetningen omhandler. Minimum én af disse variable er obligatorisk. o diaid o kommunekode o cvr o cvrindberet Start- og slutperiode (begge eller ingen) i formatet yyyy-mm-ddthh:tt:ss (Dansk tid) o periodestart o periodeslut Resultatbegrænsning o maxresult periodestart= t08:30:00&periodeslut= T13:30:00&cvr= &cvrIndberet= &kokkunekode=111&maxResult=1 Hvis scriptet er korrekt installeret vil servicen svare med en liste af events i JSON-format: F.eks. for event-data for Fremdriftsscriptet med status fremdrift

15 Kontroller at URL og tidspunkt passer med at der kommet nye data til. Vær opmærksom på, at servicen vil kun kunne give data for myndighedens egne formularer dvs. det DIA-id og evt. kommunekode, der knyttet til myndighedens bruger. Servicen vil fortælle, hvis en bruger forsøger at tilgå data, der ikke er rettigheder til. Troubleshoot Der kommer ikke data fra Virk Tæller scriptet? Svar: Det kan være fordi indberetterne enten har: Meld Nej tak til cookies Sat Do Not Track i browseren. Vigtigt! Når en indberetter har meld Nej tak til cookies eller sat Do Not Track i browseren, opsamler Virk Tæller ikke data, fordi indberetteren hermed har sagt nej til at give indblik i sine data. Dette kan kontrolleres ved at åbne udviklerværktøj i browseren og se hvad svaret på index.js er. Hvis indsamling er slået fra, vil Tælleren svare //do not collect data Installationstesten fejler? Svar: Tjek at installationsscriptet er korrekt installeret og syntaksen matcher Figur 11. Kig efter om kommaerne er korrekte og at der ikke er for mange mellemrum. Hvis der mangler et komma eller der er et mellemrum for meget, vil data ikke komme korrekt ud. Side 14

16 Der er komma her Der er mellemrum her Figur 11: Eksempel på faldgruber Mangler data i en indberetning Hvis indberetteren har slået Javascript fra i browseren, vil No-script løsningen aktiveres. Noscript vil indsamle data fra hver side i indberetningsløsningen, hvor scriptet er installeret, men vil ikke være i stand til at indsamle data på feltniveau. Løsningen fungerer ved at der hentes et gennemsigtigt billede fra tælleren, hvor data sendes med og registreres. Da noscript kræver at opsætningsparametre gives med direkte i adressen på billedet, er det vigtigt at der også testes at dataindsamling fungerer med Javascript slået fra. Definitioner Indberetter En bruger af indberetningsløsningen. Eksempelvis en medarbejder hos den pågældende virksomhed, kommune eller myndighed, der foretager indberetningen. Dataaftager Den myndighed eller kommune, der anvender data fra Virk Tæller og administrerer indberetningsløsningen. Eksempel: Erhvervsstyrelsen er dataaftager og bruger data, fra Virk Tæller til at forbedre indberetningsløsningen Scriptinstallatør Den person, der installerer scriptet på den pågældende indberetningsløsning. Indberetningsløsning Den it-løsning, hvor en indberetter foretager en indberetning af eks. et regnskabsdokument. Side 15

17 Få mere hjælp Telefonnummer: Jakob Jensen eller Anne Pedersen Mail: eller Side 16