Wat is een referentielijst?

Concept

Referentielijsten worden gebruikt om mogelijke inputwaarden te definiëren voor een tekstveld in een formulier. Een referentielijst wordt als configuratie artefact centraal opgeslagen in de application repository. Het is een tekstbestand in JSON-formaat met .reflist extensie.

Use case

Gebruik een referentielijst als er een groot aantal keuzeopties zijn, als je de lijst makkelijk wil onderhouden via het .reflist artefact (tekstbestand) of als je dezelfde lijst in meerdere formulieren wil gebruiken. Denk aan een gebouwenlijst (bijvoorbeeld een bestuur dat verschillende kantoren heeft verspreid doorheen het land), een lijst van erkende verenigingen, een lijst van contactpersonen, enzovoort.

Ervaring voor frontoffice gebruiker

Neem een kijkje op de formulierveld visualisaties pagina om te bekijken hoe een tekstveld geconfigureerd met behulp van een referentielijst eruit ziet vanuit het perspectief van een frontoffice gebruiker.

Verschil met keuzeveld

Dankzij de koppeling met een referentielijst kan je van een vrij in te vullen tekstveld een soort keuzeveld maken. Toch zijn er belangrijke verschilpunten met een echt keuzeveld.

Tekstveld met referentielijst	Keuzeveld
Lijst is makkelijk te onderhouden via het `.reflist` artefact (tekstbestand).	Een keuzeveld moet je volledig opzetten binnen de context van een formulier en is aldus lastiger om te onderhouden.
Lijst kan je centraal beheren, maar gebruiken in meerdere formulieren binnen de applicatie.	Een keuzeveld moet je volledig opzetten binnen de context van een formulier. Je moet dit dus voor elk formulier apart doen.
Mits configuratie is het mogelijk om de gebruiker een nieuwe, zelf gedefinieerde waarde te laten invullen.	Bij een keuzeveld liggen de opties op voorhand vast. De gebruiker kan geen zelf gedefinieerde waarde invullen.
Een tekstveld biedt beperktere mogelijkheden op vlak van dynamisch gedrag (zoals conditioneel tonen of verbergen van opties).	Een keuzeveld laat toe om opties te verbergen, aan te bieden en/of standaard te selecteren op basis van logica.