Sjablonen

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

Note

Voor de ontwikkelaars documentatie, zie Templating.

Momenteel worden sjablonen gebruikt voor:

  • Bevestigingsmail

  • Formulier opslaan e-mail

  • Bevestigingspagina

  • Registratie e-mail

De tekst kan in deze elementen 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

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

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

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|time:"H:i" }}

09:08

Huidig tijstip (uren en minuten)

{{ now|time:"H:i:s" }}

09:08:42

Huidig tijstip (uren, minuten en seconden)

{{ now|date:"W" }}

34

ISO-8601 weeknummer

{{ 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

Note

Op dit moment krijgt u altijd de Nederlandse vertalingen/lokalisatie. Er is nog geen ondersteuning voor andere talen.

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 verstuurd. De bevestigingsmail heeft toegang tot alle gegevens uit het formulier en de waarden ingevuld door de gebruiker.

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.

{% 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.

Note

De speciale instructie {% summary %} is verouderd en zal vanaf versie 3.0.0 niet meer beschikbaar zijn.

Voorbeeld

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

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.

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

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 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.

Voorbeeld

{% 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: {{ co_signer }}
{% endif %}

Objecten API registratie

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.

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.

Voorbeeld

{
  "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 }}"
}