Sjablonen

Open Forms ondersteunt sjablonen voor verschillende aspecten. Sjablonen zijn teksten die aangepast kunnen worden op basis van het ingevulde formulier.

Note

Voor de ontwikkelaars documentatie, zie Templating.

De tekst kan in sjablonen aangepast worden met variabelen en voorwaardelijke weergave. De variabelen die beschikbaar zijn, zijn afhankelijk van het type sjabloon en het formulier.

Stel, we hebben een formulier met daarin onderstaande velden en een gebruiker heeft voor elk formulierveld een bepaalde waarde ingevuld. Technisch heeft elk veld een eigenschap-attribuut. Dit attribuut identificeert elk veld uniek en dit is ook het attribuut dat we gebruiken als variabele.

Variabele	Waarde
leeftijd	19
geslacht	M
voornaam	John
achternaam	Doe

Hoe het werkt

Variabelen

Met behulp van variabelen kunt u de waarden uit formuliervelden toevoegen aan de sjabloon.

Om dit te doen gebruikt u de naam van de eigenschap tussen dubbele accolades: {{ <eigenschap> }}. Hierbij is <eigenschap> de daadwerkelijk naam van de eigenschap, bijvoorbeeld: {{ leeftijd }}.

Voorbeeld

SjabloonWeergave

Hallo {{ voornaam }} {{ achternaam }}!

Tip

Als er speciale syntaxkarakters zoals . of - in de variabele bestaan, dan kan je {% get_value variabele 'mijn.speciale-sleutel' %} gebruiken. Zie Template tags voor meer details.

Voorwaardelijke weergave

Met behulp van voorwaardelijke weergave kunt u bepaalde teksten in sjablonen tonen of verbergen op basis van bepaalde voorwaarden. Dit zijn zogenaamde Als dit dan dat-constructies.

Om dit te doen kunt u {% if <eigenschap> %}, {% elif <eigenschap> %}, {% else %} en {% endif %} opnemen in sjablonen. De voorwaarde (if <eigenschap>) wordt geëvalueerd naar waar of onwaar. Indien waar, dan wordt de tekst tussen twee van de {% %}-instructies weergeven. Een if-instructie moet worden afgesloten met een endif-instructie.

U kunt and en or gebruiken om meerdere eigenschappen te evalueren en u kunt variabelen vergelijken met een bepaalde waarde door verschillende operatoren te gebruiken: == (gelijk aan), != (niet gelijk aan), > (groter dan) of < (kleiner dan). De laatste twee kunnen alleen met numerieke waarden.

Als u geen vergelijking maakt, controleert de if-instructie simpelweg of de waarde van de eigenschap niet leeg is. Ten slotte kunt u controleren of een variabele leeg is door not ervoor te zetten: {% if not <eigenschap> %}...

Het is mogelijk om voorwaarden binnen andere voorwaarden te gebruiken.

Voorbeeld

SjabloonWeergave

Hallo {% if geslacht == 'M' %} Dhr. {% elif geslacht == 'V' %} Mevr. {% else %} Dhr/Mevr. {% endif %} {{ achternaam }}!

{% if leeftijd < 21 and voornaam %} Hallo {{ voornaam }} {% else %} Hallo {{ achternaam }} {% endif %}

Formattering van variabelen

Vaak wilt u variabelen op een bepaalde manier formatteren. Dit is mogelijk met behulp van de sjabloonfilters die standaard ingebouwd zijn. Alle beschikbare filters zijn gedocumenteerd op de Django defaultfilters reference. Het patroon is typisch: {{ <variable>|<sjabloonfilter> }}

Hieronder vindt u een tabel met vaak-voorkomende patronen.

Expressie	Voorbeeld waarde	Toelichting
{{ now|date:"l j F Y" }}	dinsdag 23 augustus 2022	Datum van vandaag, tekstueel
{{ now|date:"d/m/Y" }}	23/08/2022	Datum van vandaag, d/m/y
{{ now|date:"m" }}	08	Huidige maand
{{ now|date:"d" }}	23	Huidige dag
{{ now|date:"Y" }}	2022	Huidig jaar
{{ now|date:"F" }}	augustus	Huidige maandnaam
{{ now|date:"l" }}	dinsdag	Huidige dagnaam
{{ now|date:"W" }}	34	ISO-8601 weeknummer
{{ now|time:"H:i" }}	09:08	Huidig tijstip (uren en minuten)
{{ now|time:"H:i:s" }}	09:08:42	Huidig tijstip (uren, minuten en seconden)
{{ legeVariabele|default:"-" }}	-	Terugvalwaarde indien de variabele “leeg” is
{{ filesize|filesizeformat }}	117,7 MB	Weergave van bytes (nummer) in leesbare vorm
{{ consent|yesno:"ok,niet ok"}}	niet ok	Weergave op basis van True/ False waarde
{{ getal|add:"2" }}	5	Equivalent van de som getal + 2
{{ getal|add:"-2" }}	1	Verminder de variabele getal met 2
{{ getal|floatformat }}	3,1	Rond een getal af op één decimaal als er een decimaal gedeelte is
{{ getal|floatformat }}	3	Indien er geen decimaal gedeelte is, toon dan geen decimalen
{{ getal|floatformat:"2" }}	3,00	Rond altijd het getal af op twee decimalen
{{ getal|floatformat:"-2" }}	3	Rond het getal af op twee decimalen als er een decimaal gedeelte is
{{ getal|floatformat:"2g" }}	3.000,00	De g suffix past groepering toe
{{ getal|stringformat:"i" }}	2023	Geef de waarde (als integer) zonder groepering van duizendtallen
{{ lijst|join:", " }}	a, b, c	Voeg elementen in een lijst van waarden samen, gescheiden door een komma
{{ variabele|length }}	12	Bereken de lengte van een lijst of string
{{ variabele|lower }}	kleine letters	Converteer een tekst naar kleine letters
{{ variabele|upper }}	HOOFDLETTERS	Converteer een tekst naar hoofdletters
{{ value|timesince }}	1 week, 2 dagen	Tijd geleden, relatief ten opzichte van “nu”
{{ value|timesince|yesterday }}	1 dag	Tijd geleden, relatief ten opzichte van de variabele yesterday
{{ value|timeuntil }}	1 week, 2 dagen	Tijd tot, relatief ten opzichte van “nu”
{{ value|timeuntil|tomorrow }}	1 dag	Tijd tot, relatief ten opzichte van de variabele tomorrow
{{ variabele|title }}	Een Omgezette Tekst	Maak alle woorden startend met hoofdletter, de rest worden kleine letters
{{ variabele|truncatechars:5 }}	Twee…	Breek tekst af tot 5 karakters
{{ variabele|truncatewords:3 }}	Eén twee …	Breek tekst af tot 3 woorden
{{ variabele|urlize }}	<a href="$url">$url</a>	Maak hyperlinks in de variabele klikbaar
{{ getal|divisibleby:"3" }}	True	True/False indien de variabele wel/niet deelbaar is
{{ lijst|first }}	Eerste waarde	Geef het eerste element in een lijst van waarden terug

Je kan ook meerdere filters combineren om geavanceerde manipulaties te doen, bijvoorbeeld:

{{ today|date:'Y'|add:"-1"|stringformat:"i" }}

In het jaar 2024 produceert dit de output 2023:

1. today is een datetime met de waarde 29 februari 2024

2. today|date:'Y' leidt tot enkel het jaar, dus 2024

3. 1 aftrekken van 2024 geeft 2023

4. Tot slot wordt 2023 als integer weergegeven zodat de output 2023 is en niet 2.023 (dus zonder groepering van duizendtallen)

Note

Sjablonen worden in dezelfde taal/localisatie gerenderd als de taal van de inzending.

Template tags

De volgende template tags kunnen ook worden gebruikt in opmaakcomponenten.

get_value

Geeft de mogelijkheid om een waarde uit een sleutel-waarde variabele te halen. Bijvoorbeeld, als deze variabele in het formulier bestaat:

eenVariabele = {"optie 1": "waarde 1", "optie 2": "waarde 2"}

Dan zal de template tag get_value de waarde waarde 1 teruggeven:

{% get_value eenVariabele 'optie 1' %}

Bevestigingsmail

De bevestigingsmail is een optionele e-mail die wordt verzonden wanneer een gebruiker een formulier verstuurt. De bevestigingsmail heeft toegang tot alle gegevens uit het formulier en de waarden ingevuld door de gebruiker.

Er zijn twee varianten voor de bevestigingsmail - formulieren zonder en formulieren met mede-ondertekenen. De sjablonen voor deze varianten stel je apart in.

Als een formulier een medeondertekenencomponent bevat, dan wordt na het ondertekenen een bevestigingsmail gestuurd naar de hoofdpersoon die het formulier heeft ingestuurd. De medeondertekenaar wordt hierbij in de CC opgenomen en ontvangt deze e-mail dus ook.

Speciale instructies

Dit zijn aanvullende variabelen en instructies die beschikbaar zijn voor de sjabloon. Als een variabele niet beschikbaar maar wel aanwezig is in het sjabloon, dan wordt deze niet getoond.

Variabele	Beschrijving
{% confirmation_summary %}	Kop “Samenvatting” gevolgd door een volledige samenvatting van alle formuliervelden die zijn gemarkeerd om in de e-mail weer te geven.
{{ form_name }}	De naam van het formulier.
{{ submission_date }}	De datum waarop het formulier is verzonden.
{{ public_reference }}	De openbare referentie van de inzending, bijvoorbeeld het zaaknummer. We raden aan om dit nummer altijd op te nemen zodat de klant altijd contact op kan nemen, ongeacht het stadium waarin de inzending zich bevindt.
{{ registration_completed }}	Een waar/vals-waarde die aangeeft of de inzending verwerkt is of niet. Nuttig voor Voorwaardelijke weergave.
{{ waiting_on_cosign }}	Een waar/vals-waarde die aangeeft of de inzending wel of niet al mede-ondertekend is.
{% appointment_information %}	Kop “Afspraakinformatie” gevolgd door de afspraakgegevens, zoals product, locatie, datum en tijdstip.
{% product_information %}	Zonder kop, geeft dit de tekst weer uit het optionele veld “informatie” van het product dat aan dit formulier is gekoppeld.
{% payment_information %}	Kop “Betaalinformatie” gevolgd door een betaallink indien nog niet is betaald en anders de betalingsbevestiging.
{% cosign_information %}	Kop “Medeondertekeneninformatie” gevolgd door informatie over de status van medeondertekenen.

Removed in version 3.0.0: De speciale instructie {% summary %} is vervangen door {% confirmation_summary %}.

Voorbeeld

Sjabloon (zonder opmaak)Weergave (impressie)

Beste {{ voornaam }} {{ achternaam }},

U heeft via de website het formulier "{{ form_name }}" verzonden op {{ submission_date }}.

Uw referentienummer is: {{ public_reference }}

{% cosign_information %}

Let u alstublieft op het volgende:

{% product_information %}

{% confirmation_summary %}
{% appointment_information %}
{% payment_information %}

Met vriendelijke groet,

Open Formulieren

Sjablonen voor mede-ondertekenen

Als het formulier mede-ondertekening vereist, dan worden altijd de sjablonen voor mede-ondertekenen gebruikt. Dezelfde sjablonen worden meermaals gebruikt in verschillende fasen van het verwerkingsproces:

• wanneer het formulier ingestuurd is, vóór de verwerking plaatsvindt en mogelijks ook voor de eventuele betaling

• wanneer de aanvraag betaald is, maar nog niet mede-ondertekend

• wanneer de aanvraag mede-ondertekend is, maar nog niet betaald

• wanneer de aanvraag mede-ondertekend (en betaald, wanneer relevant) is

We raden aan om de inhoud met de conditie registration_completed te sturen, bijvoorbeeld:

Beste {{ voornaam }} {{ achternaam }},

{% if not registration_completed %}
    Uw formulierinzending met referentienummer {{ public_reference }} op
    {{ submission_date }} is nog niet verwerkt omdat er extra stappen nodig zijn.

    {% cosign_information %}
{% else %}
    Uw formulierinzending met referentienummer {{ public_reference }} van
    {{ submission_date }} is verwerkt.
{% endif %}

Let u alstublieft op het volgende:

{% product_information %}

{% confirmation_summary %}
{% payment_information %}

Met vriendelijke groet,

Open Formulieren

Formulier opslaan e-mail

Speciale instructies

Dit zijn aanvullende variabelen en instructies die beschikbaar zijn voor de sjabloon. Als een variabele niet beschikbaar maar wel aanwezig is in het sjabloon, dan wordt deze niet getoond.

Variabele	Beschrijving
{{ form_name }}	De naam van het formulier.
{{ save_date }}	De datum waarop het formulier is opgeslagen.
{{ expiration_date }}	De datum waarop het formulier zal vervallen.
{{ continue_url }}	De URL om het formulier te hervatten. Deze URL begint al met https://, dus u kunt ‘Nee’ kiezen wanneer de pop-up in de editor vraagt om dit toe te voegen.

E-mailverificatie e-mail

Gebruikers die hun e-mailadres moeten verifiëren ontvangen een verificatiecode op het opgegeven e-mailadres. Het onderwerp en de inhoud van deze e-mail kan je instellen in de algemene configuratie.

Speciale instructies

De volgende sjabloonvariabelen zijn beschikbaar voor het onderwerp- en inhoudsjabloon.

Variabele	Beschrijving
{{ form_name }}	De naam van het formulier.
{{ code }}	De verificatiecode die de gebruiker dient in te voeren in het formulier.

Bevestigingspagina

De bevestigingspagina is de pagina die wordt weergegeven nadat het formulier is verstuurd. De bevestigingspagina heeft toegang tot alle gegevens uit het formulier en de waarden ingevuld door de gebruiker.

Speciale instructies

Dit zijn aanvullende variabelen en instructies die beschikbaar zijn voor de sjabloon. Als een variabele niet beschikbaar maar wel aanwezig is in het sjabloon, dan wordt deze niet getoond.

Variabele	Beschrijving
{{ public_reference }}	De openbare referentie van de inzending, bijvoorbeeld het zaaknummer.
{% product_information %}	Geeft de tekst weer uit het optionele veld “informatie” van het product dat aan dit formulier is gekoppeld.

Voorbeeld

Sjabloon (zonder opmaak)Weergave (impressie)

Bedankt voor uw inzending.

{% product_information %}

Registratie e-mail

De registratie-e-mail is een optionele e-mail die wordt verzonden wanneer een formulier is geconfigureerd om de ‘e-mailregistratie-backend’ te gebruiken. De registratie-e-mail heeft toegang tot alle gegevens uit het formulier en de waarden ingevuld door de gebruiker.

Speciale instructies

Dit zijn aanvullende variabelen en instructies die beschikbaar zijn voor het sjabloon. Als een variabele niet beschikbaar maar wel aanwezig is in het sjabloon, dan wordt deze niet getoond.

Variabele	Beschrijving
{{ form_name }}	De naam van het formulier.
{{ completed_on }}	Het moment (datumtijd) waarop het formulier werd ingezonden.
{{ public_reference }}	De publieke referentie van de inzending.
{{ payment_received }}	Indicatie of de gebruiker wel of niet heeft betaald.
{{ payment_order_id }}	De referentie van de betaling.
{{ submission_language }}	De taal van het formulier die werd ingezonden, bijvoorbeeld ‘nl’.
{{ co_signer }}	De details van de medeondertekening, zie hieronder. Bij de verouderde medeondertekening geeft dit de voorletters, achternaam en ID (bijvoorbeeld het BSN) van de persoon die het formulier heeft mede-ondertekend.
{% registration_summary %}	Kop “Samenvatting” gevolgd door een volledige samenvatting van alle formuliervelden en gebruikersvariabelen.

Structuur co_signer-variabele

Deze structuur is enkel van toepassing in de niet-verouderde medeondertekenencomponent.

co_signer.plugin

ID van de authenticatieplugin waarmee de medeondertekenaar ingelogd is. Bijvoorbeeld digid.

co_signer.attribute

Het authenticatietype. Mogelijke waarden zijn bsn, kvk, pseudo en employee_id.

co_signer.value

Het identificatiekenmerk van de medeondertekenaar. De betekenis van de waarde hangt samen met co_signer.attribute.

co_signer.cosign_date

Het moment (datumtijd) waarop de medeondertekening plaatsvond.

Voorbeeld

Sjabloon (zonder opmaak)Weergave (impressie)

{% if payment_received %}

Betaling ontvangen voor {{ form_name }} (verzonden op {{ completed_on }})
Betalings-order ID: {{ payment_order_id }}

{% else %}

Inzendingdetails van {{ form_name }} (verzonden op {{ completed_on }})

{% endif %}

Onze referentie: {{ public_reference }}
Inzendingstaal: {{ submission_language }}

{% registration_summary %}

{% if co_signer %}
Mede-ondertekend door: BSN {{ co_signer.value }}
{% endif %}

E-mail mede-ondertekenverzoek

De mede-ondertekenverzoek-e-mail wordt verstuurd naar de persoon die aangeduid is als mede-ondertekenaar als er een mede-ondertekencomponent aan het formulier toegevoegd is.

Deze e-mail bevat de instructies om de inzending te ondertekenen.

Variabelen

Enkel de volgende variabelen zijn beschikbaar in dit sjabloon. Geen van deze variabelen zijn verplicht - je kan bijvoorbeeld instructies opnemen dat de persoon die het formulier ingevuld heeft de relevante informatie handmatig zal doorgeven.

Variabele	Beschrijving
{{ form_name }}	De naam van het formulier.
{{ submission_date }}	De datum waarop het formulier is verzonden.
{{ form_url }}	De directe link naar het formulier.
{{ code }}	De code om de inzending mee op te halen.

Voorbeeld

Sjabloon (zonder opmaak)Weergave (impressie)

<p>Beste lezer,</p>

<p>
  Via de website heeft iemand het formulier "{{ form_name }}"
  op {{ submission_date }} ingediend. Deze is nog
  niet compleet zonder je handtekening.
</p>

<h2>Medeondertekening nodig</h2>

<p>
  Via deze link kun je inloggen om het formulier te ondertekenen. Daarna nemen wij de
  aanvraag in behandeling.
</p>

<p>
  <a href="{{ form_url }}">{{ form_url }}</a>
</p>

<p>Je referentienummer is {{ code }}.</p>

Objecten API registratie

Note

We adviseren om gebruik te maken van de Variabelekoppelingen in plaats van sjablonen.

De Objecten API-registratiebackend maakt een object aan in de geconfigureerde Objecten API met de gegevens van een inzending. Een voorbeeld van de JSON die naar de Objecten API wordt gestuurd:

{
  "type": "https://objecttype-example.nl/api/v2/objecttype/123",
  "record": {
      "typeVersion": 1,
      "data": {},
      "startAt": "2023-01-01"
  }
}

De structuur van het veld data is per formulier instelbaar met een sjabloon. De Objecten API-registratie heeft toegang tot alle gegevens uit het formulier en de waarden ingevuld door de gebruiker.

Note

U bent waarschijnlijk gewend om in andere sjablonen een variabele direct in het sjabloon te gebruiken, zoals {{ voornaam }}. Echter, in de sjablonen voor de Objecten API dient u deze als variables.<variabele> te refereren, bijvoorbeeld {{ variables.voornaam }}. Dit zal in de toekomst voor alle sjablonen gelden.

See also

See Kaartmateriaal en registratie in de Objecten API for a more detailed example.

Voor formulieren die een betaling vereisen, is het ook mogelijk om informatie over de betaling toe te voegen. Als de gebruiker betaalt, kan de status van de betaling in de Object API bijgewerkt worden. Hier ook is de structuur van het record veld per formulier instelbaar met een sjabloon. In dit sjabloon kunnen alleen de inzendingsvariabelen (variables.<naam van variabele>) en de payment variabele (zie tabel hieronder) gebruikt worden.

Note

De payment.amount in een JSON sjabloon geeft een number. Het objecttype schema zou de nauwkeurigheid van het amount veld moeten vastleggen door bijvoorbeeld type: number, multipleOf: 0.01 te specificeren.

Speciale instructies

Dit zijn aanvullende variabelen en instructies die beschikbaar zijn voor het sjabloon. Als een variabele niet beschikbaar maar wel aanwezig is in het sjabloon, dan wordt deze niet getoond.

Variabele	Beschrijving
{{ productaanvraag_type }}	Het productaanvraag type.
{{ submission.public_reference }}	De publieke referentie van de inzending.
{{ submission.kenmerk }}	Het interne ID van de inzending (UUID).
{{ submission.language_code }}	De taal waarin de gebruiker het formulier invulde, bijvoorbeeld ‘nl’ of ‘en’.
{{ submission.pdf_url }}	De URL van het inzendingsrapport (in PDF formaat) in de documenten API.
{{ submission.csv_url }}	De URL van het inzendingsrapport (in CSV formaat) in de documenten API. Dit document is mogelijk niet aangemaakt
{% json_summary %}	JSON met "<variabele-eigenschapsnaam>": "<waarde>" van alle formuliervelden.
{% uploaded_attachment_urls %}	Een lijst met de URLs van documenten toegevoegd door de inzender. De URLs verwijzen naar het geregistreerde document in de Documenten API.
{% as_geo_json variables.map %}	Sluit de gerefereerde variabele (variables.map) in als JSON.
{{ payment.completed }}	Indicatie of de betaling voltooid is.
{{ payment.amount }}	Bedrag dat betaald moet worden.
{{ payment.public_order_ids }}	Lijst van bestelling IDs die naar de externe betaalprovider meegestuurd zijn.
{{ cosign_data.date }}	De datum waarop de inzending mede is ondertekend.
{{ cosign_data.bsn }}	Het BSN van de medeondertekenaar, indien beschikbaar.
{{ cosign_data.kvk }}	Het KvK van de medeondertekenaar, indien beschikbaar.
{{ cosign_data.pseudo }}	Het pseudo van de medeondertekenaar, indien beschikbaar.
{% as_json auth_context %}	De meta-informatie over de formulierauthenticatie. Dit is een complexe structuur, zie Authenticatie-metadata.

Voorbeeld

Sjabloon (zonder opmaak)Resultaat

{
  "form_data": {% json_summary %},
  "type": "{{ productaanvraag_type }}",
  "bsn": "{{ variables.auth_bsn }}",
  "pdf_url": "{{ submission.pdf_url }}",
  "attachments": {% uploaded_attachment_urls %},
  "submission_id": "{{ submission.kenmerk }}",
  "language_code": "{{ submission.language_code }}",
  "public_reference": "{{ submission.public_reference }}",
  {% if cosign_data %}
  "cosign_date": "{{ cosign_data.date.isoformat }}",
  "cosign_bsn": "{{ cosign_data.bsn }}"
  {% endif %}
}

Authenticatie-metadata

Je kan doorgeven op welke manier een gebruiker al dan niet ingelogd was tijdens het invullen van het formulier, en of het een machtiging betreft of niet. Dit hangt samen met de beschikbare authenticatiemethoden.

De informatie is beschikbaar in de sjabloonvariabele variables.auth_context. Om deze één op één over te nemen kan je deze direct insluiten:

{
    "form_data": {% json_summary %},
    "authenticatie": {% as_json variables.auth_context %}
}

Zie Authenticatiecontext voor een voorbeeld van de structuur, en een overzicht van alle “onderdelen” waaruit de auth_context variabele bestaat. Je kan deze allemaal individueel gebruiken in de sjablonen.