Vejledninger, best practices samt tips og tricks

I dette område af Wikien har vi prøvet at samle en række vejledninger, best practices samt tips og tricks til brugen af Blanketmotoren.

Best practices

Nedenfor finder du en række af de best practices, der er opstået gennem Blanketmotorens levetid og som er gode at have for øje, når du skal til at lave blanketter.

Navngivning af sektioner, felter m.v.

Ved indsættelse af nye sektioner og felter i blanketter, så kommer de med nogle generiske navne som Section-3 og Control-4, der ikke giver nogen information om, hvad de omhandler.

Du bør derfor altid stræbe efter at give sektioner, felter m.v. mere retvisende navne, så de er nemmere at bruge og vedligehold i formler eller ved fejlsøgning i selve XML’en

Læs mere om navngivning i vores beskrivelse af Toolboxen

Sæt validering af filtype på vedhæftningsfelter

Når der anvendes vedhæftningsfelter i en blanket, så vil der ofte være en antagelse om, hvilke typer filer brugeren skal kunne uploade, og I bør derfor altid overveje at opsætte validering på filtyper.

Læs mere om validering af filtyper under Attachment controls

Ryd værdien af felter når de skjules

Det er en god ide at bruge visningsregler, der gør, at et tidligere vist felt kan blive skjult hvis brugeren fortryder sit valg. Da Orbeon ikke automatisk rydder værdien af et felt som skjules, så er det vigtigt, at man selv sætter dette op i blanketten, HVIS IKKE feltet skal have en anden beregnet værdi, mens det er skjult.

Felter ryddes nemmest ved blot at lave en calculated value som følger:

if (<visningsregel>) then . else ''

Ovenstående formel virker på næsten alle felttyper, men der er et par undtagelser. For “Single checkboxes” skal den tomme streng erstattes med false() og for “Multiple File Attachments” kan data pt. ikke tømmes ved en formel.

Bemærk: Ved almindelige inputfelter, så er det kun selve vedhæftningen der fjernes, mens at XML’en stadig har spor efter filnavn og filstørrelse. Disse kan desværre ikke fjernes via en formel

Genbrug data

Undgå at bede om oplysninger, der allerede er registreret andetsteds. Skal du bruge en virksomheds navn og adresse, så nøjes med at spørge efter CVR-nummer, og hent oplysningerne fra CVR. Skal du bruge brugerens navn, så hent det fra loginet.

Læs mere om udhentning af eksisterende data under XPath og logik i blanketter og Integrationer

Minimer data

Undgå at bede om oplysninger, du ikke har brug for. Har du fx brug for en mailadresse, hvis efterfølgende korrespondance kommer til at ske med digital post?

Skjul indhold, der ikke er relevant

Skjul felter, der ikke skal benyttes af alle Blanketbrugere. Hvis man fx skal vedhæfte dokumentation, når man svarer 'Ja' på et spørgsmål, men ikke når man svarer 'Nej', så gør visning af dit Grid med File Attachment betinget af, at der sættes hak i 'Ja'.

Læs mere om visning og skjulning af felter under Controls

Lav valideringer

Undgå at returnere blanketter, der ikke er udfyldt korrekt. Få blanketten til at tjekke, at det indtastede data er af den type, som forventes i et givent inputfelt, og at obligatoriske felter er udfyldt.

Læs mere om valideringer under Controls

Virk Myndighedsteam har med udgangspunkt i erfaringer omkring brugen af Blanketmotoren og Virk portalen også lavet en række best practices, der findes under overskriften “Administration af indhold på Virk via DIA”.

Vejledninger

Vi har på en række undersider hertil prøvet at lave udførlige vejledninger til en række konkrete opsætninger ifm. brugen af Blanketmotoren

Tips og tricks

FDS Skilte

HTML-koden herunder indsættes i label for et Calculated Value felt. Herefter sættes hak i 'Use HTML'.

<div class="fds-alert fds-alert-info fds-alert--show-icon" role="alert" style="max-width: 66ch;"> 
  <div class="fds-alert-body"> 
    <p class="fds-alert-heading">Overskrift</p> 
    <p class="fds-alert-text">Brødtekst indsættes her</p> 
  </div> 
</div>

Skiltet kommer herefter til at se således ud under udfyldelse af blanketten:

Hvis der i stedet skal vises en fejlbesked (rød) eller en advarsel (gul), kan info erstattes af hhv. error og warning.

Hvis skiltet ikke skal vises på opsummeringssiden og PDF'en, sørg derfor for at tilføje følgende til synlighedsreglen: not(fr:mode() = ('view', 'pdf'))

Spær for hhv. private og virksomhedslogin via NemLog-in

Der kan nogle gange være behov for at en blanket kun må udfyldes og indsendes med enten privat NemLog-in eller et medarbejdercertifikat, men da NemLog-in altid tilbyder alle mulighederne, så må disse blokeringer laves i de enkelte blanketter

Blanketmotorens sandkasse indeholder to eksempler, som blokerer for hhv. private login og virksomhedslogin