Working version v32.1.X v32.0.X v29.1.X
Working version v32.1.X v32.0.X v29.1.X Dutch

Basisvelden

Bedrag

Type “currency”, achterliggend is dit een getal met een masker.

Eigenschap

Beschrijving

Minimum

Ondergrens voor het in te voeren bedrag (validatieregel).

Maximum

Bovengrens voor het in te voeren bedrag (validatieregel).

Er is een ingebouwde validatie die het aantal decimale getallen checkt.

image-20250828-150050.png
Validatie bedrag veld

In de JSON-formulierdefinitie:

    {
      "name": "totaal",
      "label": "Totaal",
      "type": "currency",
      "validators": [
        {
          "minimum": 0
        },
        {
          "maximum": 15
        }
      ]
    }

Bestand

Type “attachment2”

Eigenschap

Beschrijving

Geen specifieke eigenschappen

Geen specifieke eigenschappen

Gebruiker kan een bestand uploaden. Standaard worden volgende bestandsformaten ondersteund: application/pdf,image/jpeg,image/jp2,image/jpx,image/jpm,image/png.

Indien je hiervan wil afwijken, kan je zelf een eigen whitelist definiëren in het application.properties bestand van de applicatie. Bijvoorbeeld: skryv.attachments.allowed-mime-types=application/pdf. Klik hier voor meer info over de applicatie-instellingen.

Bijlages worden na upload opgeslagen in de database van de applicatie. Klik hier voor meer info over bijlages en over hoe die in de applicatie beheerd worden.

Voorbeeld 1

Visualisatie in de backoffice:

image-20241216-161038.png
Bijlage uploaden veld backoffice

In de JSON-formulierdefinitie:

    {
      "name": "uploadFactuur",
      "label": "Upload factuur",
      "type": "attachment2"
    },

Voorbeeld 2

Zelfde als voorbeeld 1, maar gevisualiseerd in de frontoffice:

image-20241217-083728.png
Bijlage uploaden veld frontoffice

Bestandenlijst

Type "list" (met daarin bijlages als elementen).

Eigenschap

Beschrijving

Zie lijsten.

Zie lijsten.

We maken een onderscheid tussen enerzijds een klassieke bestandenlijst waarbij een gebruiker in frontoffice of backoffice een aantal bestanden manueel kan uploaden, en anderzijds een verborgen bestandenlijst die gebruikt wordt om bestanden in context van het formulier te plaatsen.

Voorbeeld klassieke bestandenlijst

image-20260403-095621.png
Bestandenlijst in backoffice formulier - default weergave

Een bestandenlijst is een specifiek type lijst "customComponentName": "skrAttachmentsList". Voor meer info over lijsten, zie het topic ‘lijst’ op de pagina ‘layout’.

{
  "label": "Mijn formulier",
  "name": "mijnFormulier",
  "sectionBasedValidation": false,
  "fields": [
    {
      "name": "uploadAlleFacturen",
      "label": "Upload alle facturen",
      "type": "list",
      "initialLength": 1,
      "minimumLength": 1,
      "maximumLength": 10,
      "labelForAdd": "Toevoegen",
      "labelForDelete": "Verwijderen",
      "fields": [
        {
          "name": "attachment",
          "label": "Bijlage",
          "type": "attachment2"
        }
      ],
      "customComponentName": "skrAttachmentsList"
    }
  ]
}

Voorbeeld verborgen bestandenlijst als formuliercontext

Een bestandenlijst is een specifiek type lijst met specifieke naam ("name": "document_context") en label ("label": "attachments in context") die verborgen is in het formulier zelf "customComponentName": "skrHiddenComponent", maar die wel in context van het formulier zit. Er zijn ook drie specifieke expressies “computedExpressions” noodzakelijk.

{
  "label": "Mijn formulier",
  "name": "mijnFormulier",
  "sectionBasedValidation": false,
  "fields": [
    {
      "name": "document_context",
      "label": "attachments in context",
      "type": "list",
      "customComponentName": "skrHiddenComponent",
      "fields": [
        {
          "name": "context_file",
          "label": "attachment in context",
          "type": "attachment2"
        }
       ] 
    },
  ],
  "computedExpressions": {
    "cc_context_manipulator": "$$.propertyManipulators.document_context",
    "cc_content_manipulator": "$$",
    "cc_content_component": "'component'"
  }
}

Datum

Type “date”

Eigenschap

Beschrijving

Geen specifieke eigenschappen

Geen specifieke eigenschappen

Merk op dat een datum een string is met als structuur “31-01-2025” (dus “DD-MM-YYYY”). Als je ermee wil gaan rekenen binnen een expressie of je wil er een timer event mee configureren, dan moet je de deze string omzetten naar een ISO datumtijd waarde via de expressie: “moment($.datum)" of een ISO datumwaarde via de expressie: “moment($.datum).format('YYYY-MM-DD')”. Meer info over de syntax en enkele voorbeelden van formulierexpressies waarbij met datums gerekend wordt.

Voorbeeld

Gebruiker selecteert datum uit een datum picker. Verplicht ingesteld op Altijd. De eigenschap Alleen lezen is conditioneel ingesteld: enkel lezen wanneer beoordelingstaak (logische expressie) true retourneert. Een conditie (validatieregel) stelt dat de gekozen datum niet in het verleden mag liggen.

Visualisatie in backoffice formulier vanuit de taak 'inschrijven':

image-20241216-080806.png
Weergave backoffice formulier met datumpicker

Foutmelding wanneer de aangeduide datum in het verleden ligt:

image-20241216-081915.png
Datumveld validatie

Visualisatie in backoffice formulier vanuit de taak ‘beoordelen’ (alleen lezen):

image-20241216-082501.png
Verplicht datumveld - alleen lezen

In de JSON-formulierdefinitie:

{
          "name": "datumEvent",
          "label": "Datum event",
          "type": "date",
          "required": true,
          "read-only": "beoordelingstaak",
          "conditions": [
            {
              "name": "newConditionSvhnqz",
              "level": "error",
              "expression": "$ !== undefined ? moment($).hour(23).minute(59).second(59) >= moment():true",
              "errorMessage": "De gekozen datum kan niet in het verleden liggen."
            }
          ]
        },

E-mail

Type “email”

Eigenschap

Beschrijving

Geen specifieke eigenschappen

Geen specifieke eigenschappen

Voorbeeld

Gebruiker voert een e-mailadres in. Het veld is Verplicht. Impliciet wordt er een conditie (validatieregel) ingesteld (niet configureerbaar in Studio).

Visualisatie in de frontoffice:

image-20241121-111121.png
Verplicht e-mailadres veld

Voorbeeld van een ongeldig e-mailadres (foutmelding).

image-20241121-111218.png
Validatie e-mailadres

In de JSON-formulierdefinitie:

    {
      "name": "eMailadres",
      "label": "E-mailadres",
      "type": "email",
      "required": true,
    },

Getal

Type “number”

Eigenschap

Beschrijving

Geen specifieke eigenschappen

Geen specifieke eigenschappen

Voorbeeld 1

Gebruiker moet een getal invoeren. Standaard wordt de waarde 0 ingevoerd. Het veld is verplicht in te vullen door de gebruiker.

image-20241216-154240.png
Getalveld met default waarde 0

In de JSON:

{
      "name": "gewensteHoeveelheid",
      "label": "Gewenste hoeveelheid",
      "type": "number",
      "required": true,
      "default": 0
    },

Voorbeeld 2

Gebruiker voert een getal die tussen de 100 en de 500 moet liggen. Standaard wordt de waarde 100 ingevoerd.

Visualisatie in de backoffice na initialisatie van het formulier:

image-20241216-153513.png

Visualisatie in de backoffice na invoeren ongeldig getal:

image-20241216-153333.png
Validatie ingevoerd getal

In de JSON:

    {
      "name": "prijsAangekochtItem",
      "label": "Prijs aangekocht item",
      "type": "number",
      "default": 100,
      "conditions": [
        {
          "name": "newCondition7Kbtsa",
          "level": "error",
          "expression": "$ !== undefined ? $ < 500 && $ >= 100 : true",
          "errorMessage": "Het ingevoerde bedrag moet tussen de 100 en de 500 liggen."
        }
      ]
    },

Informatie

Type “information”

Eigenschap

Beschrijving

Visualisatie

Keuze tussen error callout (foutmelding, rood) , info callout (informatief, grijs), success callout (bevestiging, groen), warning callout (waarschuwing, oranje).

Help

“helpInLine”: true,

“help”: “Iets langere tekst die in de callout wordt weergegeven”

De tekst kan ook markup (vet, italic of onderlijnd) of een hyperlink bevatten.

“help”: “Dit is een <a href=https://docs.skryv.be>hyperlink</a>, dit staat <i>schuin</i>, dit staat <b>vet</b> en dit is <u>onderlijnd</u>.”

Help (dynamisch)

“helpInLine”: true,

“computedWith”: myExpression

Hiermee kan je de tekst in de callout dynamisch samenstellen via een expressie. Zie ook formulier expressie voorbeelden voor een uitgewerkte use case.

Voorbeeld 1

Visualisatie in de backoffice:

image-20250317-104439.png
Callouts in de backoffice

In de JSON-formulierdefinitie:

    {
      "name": "info",
      "label": "Callout info",
      "type": "information",
      "help": "Hier komt een informatieve callout.",
      "helpInLine": true,
      "visualisation": "callout-info"
    },
    {
      "name": "warning",
      "label": "Callout waarschuwing",
      "type": "information",
      "help": "Hier komt een waarschuwingsboodschap.",
      "helpInLine": true,
      "visualisation": "callout-warning"
    },
    {
      "name": "fout",
      "label": "Callout foutmelding",
      "type": "information",
      "help": "Hier komt een foutmelding boodschap.",
      "helpInLine": true,
      "visualisation": "callout-error"
    },
    {
      "name": "succes",
      "label": "Callout succes",
      "type": "information",
      "help": "Hier komt een callout success message.",
      "visualisation": "callout-success"
    },

Voorbeeld 2

De gebruiker selecteert een bepaalde optie. Op dat ogenblik verschijnt er een waarschuwing callout. Dit wordt getriggerd door de eigenschap Zichtbaar Als.

Het verschil tussen callouts en condities (validatieregels) is dat een validatieregel van het type error de gebruiker verhindert om zijn formulier in te dienen, terwijl dit bij een callout nooit het geval kan zijn.

image-20241216-090140.png
image-20241216-090121.png
Conditioneel getoonde callout

In de JSON-formulierdefinitie:

    {
      "name": "locatieBijnaVolzetCallout,
      "label": "Deze locatie is bijna volzet. Wacht niet te lang om je inschrijving aan te vragen.",
      "type": "information",
      "onlyWhen": [
        "locatieGent"
      ],
      "visualisation": "callout-warning"
    },

Voorbeeld 3

image-20260403-123912.png
Info callout met html opmaak (vet + hyperlink)

Infoboodschap met een link naar de documentatiesite docs.skryv.be.

{
  "label": "Mijn formulier",
  "name": "mijnFormulier",
  "sectionBasedValidation": false,
  "fields": [
    {
      "name": "warning",
      "label": "Callout info",
      "type": "information",
      "help": "Hier komt een <b>infoboodschap</b>. Deze <a href=http://docs.skryv.be>link</a> gaat naar de Skryv-website. ",
      "helpInLine": true,
      "visualisation": "callout-info"
    }
  ]
}

Voorbeeld 4

De gebruiker krijgt een dynamische succesboodschap. Zie ook dit formulier expressie voorbeeld voor de uitgewerkte use case.

2025.03.17_Bestelling.gif
Dynamisch berekende helptekst in callout

Ja/nee

Type “boolean”

Eigenschap

Beschrijving

Visualisatie

Hier heb je keuze tussen niet gespecificeerd (default), checkbox, compact, radio, andere.

Voorbeeld 1

Automatisch invullen ingeschakeld, gebruiker kan het altijd wijzigen met Vul vaste waarde in geselecteerd en Nee geselecteerd in de Beginwaarde dropdown. Het veld is bovendien Verplicht in te vullen.

Visualisatie in de frontoffice:

image-20241121-113120.png
Boolean in frontoffice

In de JSON-definitie:

    {
      "name": "benJeVegetarisch",
      "label": "Ben je vegetarisch?",
      "type": "boolean",
      "required": true,
      "default": false
    },

Voorbeeld 2

Visualisatie via checkbox. Het veld is Verplicht in te vullen. Er is een waarschuwing indien de gebruiker aangeeft geen vegetariër te zijn.

Visualisatie in de backoffice:

image-20241216-145621.png
Checkbox boolean in de backoffice

In de JSON-definitie:

{
      "name": "benJeVegetarisch",
      "label": "Vegetarisch",
      "type": "boolean",
      "required": true,
      "visualisation": "checkbox",
      "conditions": [
        {
          "name": "newConditionI4Cs3H",
          "level": "warning",
          "expression": "$ !== undefined ? $ === true : true",
          "errorMessage": "De kaart voor niet-vegetariërs is beperkt."
        }
      ]
    },

Voorbeeld 3

Visualisatie via compact. Veld enkel en alleen verplicht in te vullen indien locatie Gent is. Er is een waarschuwing indien de gebruiker aangeeft geen vegetariër te zijn.

Visualisatie in backoffice (locatie is Gent):

image-20241216-150222.png
Compact checkbox in de backoffice

In de JSON-definitie:

{
      "name": "benJeVegetarisch",
      "label": "Vegetarisch",
      "type": "boolean",
      "required": "locatieGent",
      "visualisation": "compact",
      "conditions": [
        {
          "name": "newConditionI4Cs3H",
          "level": "error",
          "expression": "$ !== undefined ? $ === true : true",
          "errorMessage": "De kaart voor niet-vegetariërs is beperkt."
        }
      ]
    },

Lookup

Type “lookup”

  • Voorlopig enkel beschikbaar in de frontoffice neutral style web interface.

  • Voorlopig enkel te definiëren via JSON-formulierdefinitie. Geen Studio UI ondersteuning.

Een lookupveld is een keuzelijst waarvan de opties niet in de formulierdefinitie staan, maar telkens opgehaald worden uit een externe bron wanneer het formulier opent. Denk aan de zittingen in een notulenpakket. Die bron heet een lookup source. Een lookup source is Java-code in de backend van de applicatie, meestal meegeleverd door een connector (maar kan ook in principe in om het even welke back-end component geïntegreerd worden). Als configurator kun je er geen toevoegen. Je gebruikt een bestaande, via haar naam. Welke lookup sources er zijn, staat op de pagina van de connector, bijvoorbeeld de notulen-connector.

Het verschil met een keuzeveld is dat de opties dynamisch zijn, en dat de gekozen optie volledig bewaard wordt: niet alleen de sleutel, maar ook het label en alle extra gegevens die de bron meestuurt.

Een lookup veld vertoont ook gelijkenissen met een tekstveld waaraan een referentielijst vastgekoppeld zit. Een referentielijst is echter statisch (wordt eenmalig ingeladen in de applicatie), terwijl een lookup veld dynamisch werkt (waardes worden telkens opnieuw opgehaald bij het openen van het formulier in de user interface).

Eigenschap

Beschrijving

Lookup source

Verwijst naar de lookup source zoals gedefinieerd in de connector (bijvoorbeeld de notulen-connector).

"lookupSource": "notulenMeetingTypes"

Parameters

Vaste parameters die het veld meestuurt naar de lookup source, bijvoorbeeld om de opties te beperken tot één soort zitting. Welke parameters een source verwacht, staat op de pagina van de connector. "params": { "meetingTypeId": "1" }

Berekende parameters

Parameters die je samenstelt met een formulierexpressie, meestal op basis van een eerdere keuze van de gebruiker. Zolang de expressie undefined teruggeeft, worden er geen opties opgehaald. "paramsWith": "soortZittingParams"

Je kunt params en paramsWith combineren. Ze worden samengevoegd. Zetten beide dezelfde parameter, dan wint de berekende waarde. De vaste parameter functioneert dus als de fallback waarde.

De naam van de lookup source wordt niet gecontroleerd wanneer je de formulierdefinitie opslaat. Een typfout merk je pas als het formulier opent: het veld meldt dan dat de opties niet geladen konden worden. Kopieer de naam dus zorgvuldig.

Opgeslagen waarde

Het veld bewaart de gekozen optie als geheel. Het document is zo een vastlegging van wat er gekozen werd, geen live kopie van het externe systeem.

Voorbeeld gekozen optie als JSON-object

"soortZitting": {
  "key": "1",
  "label": "College",
  "data": {
    "id": "1",
    "code": "CBS",
    "description": "College"
  }
}

In een formulierexpressie lees je de onderdelen uit met $.soortZitting.key, $.soortZitting.label of $.soortZitting.data.code. Welke gegevens in data zitten, verschilt per lookup source, en staat op de pagina van de connector (klik hier voor een concreet voorbeeld binnen de notulen-connector).

Wat de gebruiker ziet

Situatie

Gedrag van het veld

De opties worden opgehaald

Het veld toont een laadindicator, en kan nog niet geopend worden.

De bron heeft geen opties

Een waarschuwing dat er niets te selecteren valt.

De bron is niet bereikbaar, of de lookup source bestaat niet

Een melding dat de opties niet geladen konden worden.

De gekozen optie bestaat niet meer in de bron

Een foutmelding. De keuze blijft zichtbaar, met de vermelding dat ze niet meer beschikbaar is.

Het veld is alleen-lezen

Het veld toont het label van de gekozen optie. Er wordt niet bij de bron nagegaan of de optie nog bestaat.

Afhankelijke velden

Hangt een lookupveld via paramsWith af van een eerdere keuze (zie voorbeeld 2 hieronder, dan maakt het formulier dat veld leeg zodra de gebruiker die eerdere keuze wijzigt. In het voorbeeld van de notulen-connector kan een zitting van het college kan nooit juist zijn voor de gemeenteraad. Dat gebeurt alleen bij een wijziging door de gebruiker. Het openen van een document maakt niets leeg, en een waarde die een proces, een prefill of een import invulde, blijft ook staan.

Verberg een afhankelijk veld met onlyWhen zolang de keuze waar het van afhangt nog ontbreekt (zie voorbeeld 2 hieronder). Anders ziet de gebruiker een lege keuzelijst met de melding dat er niets te kiezen is.

Als de bron intussen gewijzigd is

Tussen het moment dat de gebruiker koos en het moment dat het document opnieuw opent, kan de lijst in de bron veranderd zijn. De regel is: wat de gebruiker ziet, verandert nooit zonder dat hij het weet, en wat hij niet ziet, wordt stil bijgewerkt.

Wijziging in de bron

Gedrag

De optie bestaat niet meer

De keuze blijft zichtbaar, met de vermelding dat ze niet meer beschikbaar is. De gebruiker kan ze niet opnieuw kiezen, en kan de taak pas indienen na een andere keuze. Daarna verdwijnt de oude optie.

De optie bestaat nog, maar de gegevens in data zijn gewijzigd

Het document wordt stil bijgewerkt. Er verandert niets zichtbaars, maar het document telt wel als gewijzigd: de knop om op te slaan wordt actief op een formulier dat onaangeroerd lijkt.

De optie bestaat nog, maar onder een ander label

Er gebeurt niets. Het oude label blijft staan, zonder melding. Dit is een gekende beperking.

Beperkingen

  • Een lookup veld wordt enkel gevalideerd op het moment dat een gebruiker het formulier opent. Er is geen validatie via Docmod op het ogenblik dat je het formulier vanuit een workflow expressie (bijvoorbeeld via de setField methode) aanpast.

  • Een formulier dat opnieuw geopend wordt, valideert ook de lookupvelden opnieuw. Een gekozen optie die niet meer in de bron staat, verhindert dan het indienen. Moet een eerder gekozen waarde behouden blijven als het formulier later opnieuw opent, zet het veld dan op alleen-lezen.

  • Een lookup veld integreren in een formulier met selectiewizard (de secties van het formulier worden aangeboden als aparte pagina’s) wordt niet ondersteund. Het is mogelijk, maar dit kan tot gedrag leiden dat vreemd aanvoelt voor een gebruiker.

  • Een formulier moet editeerbaar zijn, en niet read-only, opdat een gebruiker de gekozen optie in het lookup veld nog kan aanpassen, alsook opdat de lookupSource nogmaals aangesproken kan worden.

Voorbeeld 1

Visualisatie in neutrale frontoffice waarbij het lookup element verplicht is en gekoppeld zit aan de lookup source “notulenMeetingTypes” van de notulen-connector. In dit concreet geval krijgt de gebruiker twee mogelijke opties aangeboden: ‘College’ en ‘Burgemeester’. Deze opties zijn rechtstreeks opgehaald uit het externe notulenpakket.

image-20261026-133819.png
Soort zitting als lookup element

In de JSON-definitie:

JSON
    {
      "name": "soortZitting",
      "label": "Soort zitting",
      "type": "lookup",
      "required": true,
      "lookupSource": "notulenMeetingTypes"
    },

Voorbeeld 2

Visualisatie in neutrale frontoffice. Een lookup element dat afhankelijk is van de gekozen optie uit een eerder lookup element. De zittingen (datums en tijdstippen) worden aangeboden voor het soort zitting dat de gebruiker eerder koos, hier ‘College’.

image-20261026-134854.png
Zittingen als lookup element in functie van gekozen soort zitting

In de JSON-definitie:

    {
      "name": "zitting",
      "label": "Zitting",
      "type": "lookup",
      "required": true,
      "lookupSource": "notulenMeetings",
      "paramsWith": "soortZittingParams",
      "onlyWhen": "hasSoortZitting"
    },

Merk op dat we verwijzen naar twee formulierexpressies (computed expressions):

  "computedExpressions": {
    "hasSoortZitting": "Boolean($.soortZitting)",
    "soortZittingParams": "$.soortZitting ? { meetingTypeId: $.soortZitting.key } : undefined"
  • hasSoortZitting geeft true zodra de gebruiker een soort zitting gekozen heeft (zie Boolean()). Zolang dat niet zo is, blijft het veld zitting verborgen via onlyWhen.

  • soortZittingParams stelt de parameter samen die het veld zitting meestuurt naar de lookup source notulenMeetings: { meetingTypeId: $.soortZitting.key }, met de key van het gekozen soort zitting. Zolang er niets gekozen is, geeft de expressie undefined terug, en worden er geen zittingen opgehaald.

Kaart

Type “map”

Eigenschap

Beschrijving

Initiële locatie

Laat toe om een specifieke gemeente op te zoeken en te selecteren. Dit is de locatie (breedtegraad en lengtegraad) die bij initialisatie van het veld gecentreerd wordt op de kaart.

Breedtegraad

Breedtegraad van de initiële locatie (wordt automatisch ingevuld bij selectie initiële locatie). Je kan dit veld gebruiken om de initiële locatie te gaan fijnstellen.

"centerLat": 51.064784

Berekende breedtegraad

Zelfde als hierboven, maar op basis van formulier logica (computed expression).

"computedCenterLat": "initieleBreedtegraad"

Lengtegraad

Lengtegraad van de initiële locatie (wordt automatisch ingevuld bij selectie initiële locatie). Je kan dit veld gebruiken om de initiële locatie te gaan fijnstellen.

"centerLng": 3.101642

Berekende lengtegraad

Zelfde als hierboven, maar op basis van formulier logica (computed expression).

"computedCenterLng": "initieleLengtegraad"

Initiële zoom

Bepaalt hoe sterk de kaart is ingezoomd op de initiële locatie bij initialisatie van het veld. Hoe hoger het getal, hoe meer ingezoomd de kaart. Toegelaten range is 0 tot 22. Waarbij 10 tot 15 de meest relevante resultaten opleveren.

"zoom": 14

Berekende zoom

Zelfde als hierboven, maar op basis van formulier logica (computed expression).

"computedZoom": "initieleZoom"

Tekenmodus

  • Polygoon: de gebruiker kan door opeenvolgende coördinaten te selecteren een veelhoek (zone) opbouwen.

  • Punt: de gebruiker kan één en slechts één coördinaat aanduiden.

"drawMode": "POINT"

Kaartlaag

Standaard weergave van de kaart: straten, satelliet of GRB.

  • “defaultLayer”: “Streets”

  • “defaultLayer”: “Satellite”

  • “defaultLayer”: “GRB”

Voorbeeld 1

Initiële locatie Torhout, zoom 12. Backoffice visualisatie. Polygoon modus (zie zone links boven).

image-20250314-085406.png
Mapbox component zoom 12

Voorbeeld 2

Initiële locatie Torhout, zoom 14. Backoffice visualisatie. Punt modus (zie blauwe bol bovenaan).

image-20250314-085550.png
Mapbox component zoom 14

In de JSON-formulierdefinitie:

    {
      "name": "selecteerLocatie",
      "label": "Selecteer locatie",
      "type": "map",
      "zoom": 14,
      "centerLat": 51.064784,
      "centerLng": 3.101642,
      "drawMode": "POINT",
      “defaultLayer”: “Streets”
    }

Keuze

Type “choice”

De gebruiker kan één en slechts één optie aanduiden.

Eigenschap

Beschrijving

Optie naam

Klik op de knop Nieuwe optie. Voer de waarde van de optie in.

Optie key

De key van de optie wordt automatisch gegenereerd.

Hulp

Hulp voor de gebruiker van het formulier. Voer tekst in die de betekenis van de optie verduidelijkt.

Optie conditioneel inschakelen of weergeven

Vink het vakje aan als je inhoud dynamisch zichtbaar wil maken of inschakelen. Zie voorbeelden.

Alleen inschakelen als

Inschakelen als Berekende expressie waar is. Uitschakelen als Berekende expressie onwaar is. Zie voorbeelden.

In de JSON-formulierdefinitie: "onlyEnabledWhen" = "nietVegetarisch"

Alleen weergeven als

Zichtbaar als Berekende expressie waar is. Verbergen als Berekende expressie onwaar is. Zie voorbeelden.

In de JSON-formulierdefinitie: "onlyWhen" = "nietVegetarisch"

Berekende expressie

Alleen zichtbaar als Optie conditioneel inschakelen of weergeven aangevinkt is. Selecteer een variabele uit de dropdown. Expressies moeten worden aangemaakt binnen het tabblad logica in het element panel van het formulier.

Heeft een optie standaard geselecteerd

Vink het vakje aan als je een voorgeselecteerde standaardoptie wil aanduiden.

In de JSON-formulierdefinitie: "default" = "optie20H"

Selecteer standaardoptie

Alleen zichtbaar als Heeft een optie standaard geselecteerd aangevinkt is. Gebruik de keuzelijst om de standaardoptie aan te duiden.

Voorbeeld 1

Heeft een optie standaard geselecteerd is niet aangevinkt (+ Hulp tekst is Altijd zichtbaar)

Visualisatie in frontoffice formulier:

image-20241121-104942.png
Keuzeveld in frontoffice

In de JSON-formulierdefinitie:

    {
      "name": "selecteerMenu",
      "label": "Selecteer menu",
      "type": "choice",
      "help": "Eén tafel = één menu. Beslis nu of bij aankomst.",
      "helpInLine": true,
      "choices": [
        {
          "name": "kreeftMenu",
          "label": "Kreeft menu"
        },
        {
          "name": "steakMenu",
          "label": "Steak menu"
        },
        {
          "name": "falafelMenu",
          "label": "Falafel menu"
        },
        {
          "name": "linzenMenu",
          "label": "Linzen menu"
        }
      ]
    },

Voorbeeld 2

Heeft een optie standaard geselecteerd is aangevinkt (+ veld is Verplicht).

Visualisatie in frontoffice formulier:

image-20241121-105222.png
Verplicht in te vullen keuzeveld frontoffice

In de JSON-formulierdefinitie:

  {
      "name": "selecteerAankomsttijd",
      "label": "Selecteer aankomsttijd",
      "type": "choice",
      "required": true,
      "default": "optie20H",
      "choices": [
        {
          "name": "optie18H",
          "label": "18h"
        },
        {
          "name": "optie20H",
          "label": "20h"
        }
      ]
    },

Voorbeeld 3

Alleen inschakelen als opties enkel maar aanvinkbaar als aan een conditie (gebruiker mag geen vegetariër zijn) voldaan is (+ Hulp tekst is Altijd zichtbaar).

Visualisatie in frontoffice formulier (gebruiker is vegetariër):

keuzevraag.png
‘Alleen inschakelen als'-eigenschap

In de JSON-formulierdefinitie:

  {
      "name": "selecteerMenu",
      "label": "Selecteer menu",
      "type": "choice",
      "help": "Eén tafel = één menu. Beslis nu of bij aankomst.",
      "helpInLine": true,
      "choices": [
        {
          "name": "kreeftMenu",
          "label": "Kreeft menu",
          "onlyEnabledWhen": "nietVegetarisch"
        },
        {
          "name": "steakMenu",
          "label": "Steak menu",
          "onlyEnabledWhen": "nietVegetarisch"
        },
        {
          "name": "falafelMenu",
          "label": "Falafel menu"
        },
        {
          "name": "linzenMenu",
          "label": "Linzen menu"
        }
      ]
    },

Voorbeeld 4

Alleen zichtbaar als opties enkel maar zichtbaar als aan een conditie (gebruiker mag geen vegetariër zijn) voldaan is (+ Hulp tekst is Altijd zichtbaar).

Visualisatie in frontoffice formulier (gebruiker is vegetariër):

image-20241121-110959.png
‘Alleen zichtbaar als’-eigenschap

In de JSON-formulierdefinitie:

{
      "name": "selecteerMenu",
      "label": "Selecteer menu",
      "type": "choice",
      "help": "Eén tafel = één menu. Beslis nu of bij aankomst.",
      "helpInLine": true,
      "choices": [
        {
          "name": "kreeftMenu",
          "label": "Kreeft menu",
          "onlyWhen": "nietVegetarisch"
        },
        {
          "name": "steakMenu",
          "label": "Steak menu",
          "onlyWhen": "nietVegetarisch"
        },
        {
          "name": "falafelMenu",
          "label": "Falafel menu"
        },
        {
          "name": "linzenMenu",
          "label": "Linzen menu"
        }
      ]
    },

Meerkeuze

Type “multichoice”

De gebruiker kan geen, één of meerdere opties aanduiden.

Eigenschap

Beschrijving

Optie naam

Klik op de knop Nieuwe optie. Voer de waarde van de optie in.

Optie key

De key van de optie wordt automatisch gegenereerd. Je kan deze zelf nog aanpassen, indien je wenst.

Hulp

Hulp voor de gebruiker van het formulier. Voer tekst in die de betekenis van de optie verduidelijkt.

Beginwaarde

Bepaalt of deze optie standaard is aangevinkt of niet. Drie mogelijkheden: Altijd, Nooit of Als. Bij selectie van Als wordt de optie standaard enkel en alleen aangevinkt indien de in de bijhorende keuzelijst opgegeven variabele true retourneert. Deze variabele wordt opgehaald uit het tabblad logica in het element panel van het formulier.

In de JSON-formulierdefinitie: "default" = true (indien Altijd)

In de JSON-formulierdefinitie: "default" = "locatieHasselt" (indien Als)

Optie conditioneel inschakelen of weergeven

Vink het vakje aan als je inhoud dynamisch zichtbaar wil maken of inschakelen. Zie voorbeelden.

Alleen inschakelen als

Inschakelen als Berekende expressie waar is. Uitschakelen als Berekende expressie onwaar is. Zie voorbeelden.

In de JSON-formulierdefinitie: "onlyEnabledWhen" = "locatieGent"

Alleen weergeven als

Zichtbaar als Berekende expressie waar is. Verbergen als Berekende expressie onwaar is. Zie voorbeelden.

In de JSON-formulierdefinitie: "onlyWhen" = "locatieHasselt"

Berekende expressie

Alleen zichtbaar als Optie conditioneel inschakelen of weergeven aangevinkt is. Selecteer een variabele ("locatieHasselt" in voorbeeld hierboven) uit de dropdown. Expressies moeten worden aangemaakt binnen het tabblad logica in het element panel van het formulier.

Voorbeeld 1

Gebruiker kan één of meerdere items aanduiden op zijn of haar Sinterklaas wenslijst. Bij opstart van het formulier zijn alle opties standaard ingeschakeld.

Visualisatie in de frontoffice:

image-20241216-131847.png
Opties standaard ingeschakeld

In de JSON-formulierdefinitie:

    {
      "name": "wenslijstSinterklaas",
      "label": "Wenslijst Sinterklaas",
      "type": "multichoice",
      "choices": [
        {
          "name": "chocolade",
          "label": "Chocolade",
          "default": true
        },
        {
          "name": "picknicken",
          "label": "Picknicken",
          "default": true
        },
        {
          "name": "gezelschapsspel",
          "label": "Gezelschapsspel",
          "default": true
        }
      ]
    },

Voorbeeld 2

Geen enkele optie is standaard geselecteerd. Gebruiker kan de laatste optie enkel selecteren indien de variabele “locatieGent” true retourneert.

Visualisatie in de frontoffice (locatie is niet Gent):

image-20241216-132746.png
Optie niet beschikbaar

In de JSON-formulierdefinitie:

    {
      "name": "wenslijstSinterklaas",
      "label": "Wenslijst Sinterklaas",
      "type": "multichoice",
      "choices": [
        {
          "name": "chocolade",
          "label": "Chocolade"
        },
        {
          "name": "picknicken",
          "label": "Picknicken"
        },
        {
          "name": "gezelschapsspel",
          "label": "Gezelschapsspel",
          "onlyEnabledWhen": "locatieGent"
        }
      ]
    },

Voorbeeld 3

Gebruiker ziet enkel maar de wenslijst indien zijn of haar leeftijd lager is dan 12. Dit wordt berekend in de logische variabele “leeftijdMinderDan12” (zie logica tab van het formulier element panel). Geen enkele optie is standaard geselecteerd. Gebruiker kan de laatste optie enkel selecteren indien de variabele “locatieGent” true retourneert.

Visualisatie in de frontoffice (leeftijd < 12 en locatie is Gent):

image-20241216-133742.png
Keuzelijst enkel beschikbaar indien leeftijd lager dan 12

In de JSON-formulierdefinitie:

    {
      "name": "wenslijstSinterklaas",
      "label": "Wenslijst Sinterklaas",
      "type": "multichoice",
      "computedShow": [
        "leeftijdMinderDan12"
      ],
      "choices": [
        {
          "name": "chocolade",
          "label": "Chocolade"
        },
        {
          "name": "picknicken",
          "label": "Picknicken"
        },
        {
          "name": "gezelschapsspel",
          "label": "Gezelschapsspel",
          "onlyEnabledWhen": "locatieGent"
        }
      ]
    },

Voorbeeld 4

Gebruiker kan één of meerdere maaltijden aanduiden. Afhankelijk van de locatie zal een andere optie standaard aangevinkt zijn voor de gebruiker. Indien locatie Gent, zal ‘Menu (hoofdgerecht + drankje + koffie)' by default aangeduid zijn. Indien locatie Hasselt, zal ‘Belegd broodje’ standaard aanduid zijn. De opties ‘Pizza’ en ‘Vegetarische schotel’ zijn enkel beschikbaar in locatie Hasselt.

Visualisatie in de backoffice (geselecteerde locatie is Gent):

image-20241216-130040.png
Keuzelijst backoffice locatie Gent

Visualisatie in de backoffice (geselecteerde locatie is Hasselt):

image-20241216-131412.png
Keuzelijst backoffice locatie Hasselt

In de JSON-formulierdefinitie:

    {
      "name": "keuzeDagschotel",
      "label": "Keuze dagschotel",
      "type": "multichoice",
      "choices": [
        {
          "name": "menuHoofdgerechtDrankjeKoffie",
          "label": "Menu (hoofdgerecht + drankje + koffie)",
          "default": "locatieGent"
        },
        {
          "name": "soep",
          "label": "Soep"
        },
        {
          "name": "belegdBroodje",
          "label": "Belegd broodje",
          "default": "locatieHasselt"
        },
        {
          "name": "pizza",
          "label": "Pizza",
          "onlyWhen": "locatieHasselt"
        },
        {
          "name": "vegetarischeSchotel",
          "label": "Vegetarische schotel",
          "onlyWhen": "locatieHasselt"
        }
      ]
    },

Rekeningnummer

Type “iban”

Vanaf Skryv platform versie 24.1 is rekeningnummer een specifiek datatype (geen tekstveld met een specifiek masker).

Eigenschap

Beschrijving

Countries

Selecteer hier de landen waaruit je rekeningnummers wil toelaten. Standaard is België al geselecteerd, maar je kan andere landen toevoegen.

“countries”: [“be”,”fr”]

Allow all countries

Door de eigenschap “allowAllCountries" = true toe te voegen, wordt de volledige landenlijst (219 items) ingeladen. Opgelet: deze eigenschap verleent voorrang aan “countries” (whitelisted countries).

Visualisatie in de backoffice. De spaties verhogen het gebruiksgemak bij het invullen, maar worden achterliggend niet opgeslagen.

image-20260403-131610.png
Rijksregisternummer

Skryv platform versies ouder dan 24.1

Eigenschap

Beschrijving

Masker

Selecteer IBAN.

  • Merk op dat een rekeningnummer een string is met een specifiek masker.

  • Je kan steeds testen met volgende (dummy) waarde: BE 68 5390 0754 7034

  • Je kan ook een random dummy waarde genereren via deze website.

Type is Text. Masker is IBAN, hierdoor wordt automatisch een conditie (validatieregel) toegekend.

Visualisatie in frontoffice formulier:

image-20241121-111603.png
IBAN frontoffice

Voorbeeld in de JSON-formulierdefinitie:

  {
      "name": "newTextPmexdd",
      "label": "IBAN rekeningnummer",
      "type": "text",
      "maskConfig": {
        "predefinedMask": "iban"
      },
      "conditions": [
        {
          "name": "newConditionHxag8V",
          "level": "error",
          "expression": "typeof $ === 'string' && $.length > 0 ? ($.substring(0,2) === 'BE' ? ((($.substring(4,16) + '1114') % 97 + $.substring(2,4)) % 97 === 1) : ((($.substring(2,14) + '1114') % 97 + $.substring(0,2)) % 97 === 1)): true",
          "errorMessage": "Het opgegeven rekeningnummer is ongeldig"
        }
      ]
    }

Rijksregisternummer

Type “ssin”

Vanaf platform-versie 24.1 is rijksregisternummer een specifiek datatype (terwijl dit voorheen gedefinieerd werd binnen een tekstveld met specifiek masker).

Eigenschap

Beschrijving

Geen specifieke eigenschappen

Geen specifieke eigenschappen

Visualisatie in de backoffice. De punten en underscores verhogen het gebruiksgemak, maar worden achterliggend niet opgeslagen.

image-20260403-131348.png
Frontoffice weergave
    {
      "name": "newSsin1W0O5E",
      "label": "Rijksregisternummer",
      "type": "ssin"
    },

Platform versies ouder dan 24.1

Eigenschap

Beschrijving

Masker

RRN (rijksregisternummer)

Rijksregisternummer is een veld van het type tekst (string).

Voorbeeld (dummy) geldig rijksregisternummer: 11.11.11-111.61 Hiermee kan je testen.

De invoer moet voldoen aan een specifieke validatieregel. Indien niet, dan krijgt de gebruiker een foutmelding.

Voorbeeld

Visualisatie in de backoffice:

image-20241216-155431.png
Frontoffice weergave

In de JSON:

    {
      "name": "newTextW1Is2L",
      "label": "Rijksregisternummer",
      "type": "text",
      "maskConfig": {
        "predefinedMask": "ssin"
      },
      "conditions": [
        {
          "name": "newConditionPkmz53",
          "level": "error",
          "expression": "typeof $=== 'string' && $.length > 0 ? (97 - ($.substring(0,9) % 97) - $.substring(9,11) === 0) || (97 - ((2 + $.substring(0,9)) % 97) - $.substring(9,11) === 0) : true",
          "errorMessage": "Het ingegeven rijksregisternummer is ongeldig"
        }
      ]
    },

Tekst

Type “text”

Eigenschap

Beschrijving

Masker

Een masker is een vooraf gedefinieerde validatieregel (hetzelfde als de Conditie eigenschap). Het voorkomt dat de gebruiker een waarde doorstuurt die niet voldoet aan specifieke criteria. Mogelijke maskers: Niet gespecificeerd (geen masker), RRN (rijksregisternummer), IBAN (rekeningnummer), Datum, BTW nummer, Ondernemingsnummer (KBO gerelateerd), EAN (nummer van elektriciteits- of gasmeter), Telefoonnummer of Andere (Custom masker).

Custom masker

Alleen beschikbaar als Masker is ingesteld op Andere. Voer de key van het aangepaste masker in.

Gebruik referentielijst

Een referentielijst is een vooraf gedefinieerde lijst van mogelijke waardes. Afhankelijk van configuratie is het mogelijk om de gebruiker te dwingen om een specifieke waarde uit de lijst te selecteren, dan wel toe te laten een zelfgekozen waarde in te vullen. Qua gedrag lijkt dit op een keuzeveld, met dit verschil dat een referentielijst meestal een groot aantal mogelijke waardes bevat (bijvoorbeeld een lijst van alle landen), en makkelijker te onderhouden is (via het .reflist artefact).

Ja of Nee, standaard staat Nee aangeduid. Indien Ja, dan zijn de drie volgende eigenschappen (Referentielijst, Veldnaam, Laat enkel waardes uit de referentielijst toe) ook in te vullen.

Referentielijst

Dit is de key (naam) van de referentielijst (het .reflist artefact) waarnaar je wil verwijzen.

Veldnaam

Een referentielijst is een lijst van entries waarbij elke entry een object is met één of meerdere eigenschappen. In dat laatste geval moet je hier specifiëren uit welke eigenschap je de selecteerbare waarden wil ophalen.

Laat enkel waardes uit de referentielijst toe

Ja (aangevinkt) of Nee. Indien Nee, dan laat je de gebruiker toe om een eigen waarde in te vullen.

Voorbeeld 1

Verplicht ingesteld op Altijd, met Alleen lezen ingesteld op Als (de variabele beoordelingstaak moet true evalueren) en Masker ingesteld op Niet gespecificeerd.

Visualisatie in frontoffice (geen beoordelingstaak, dus wel editeerbaar):

image-20241121-111258.png
Tekstveld in frontoffice

In de JSON-definitie:

  {
      "name": "naam",
      "label": "Naam",
      "type": "text",
      "required": true,
      "read-only": "beoordelingstaak"
    },

Voorbeeld 2

Gebruiker kan een telefoonnummer invullen.

Visualisatie in de backoffice bij initialisatie:

image-20241216-151522.png
Telefoonnummer (masker)

In de JSON-definitie:

  {
      "name": "telefoonnummer",
      "label": "Telefoonnummer",
      "type": "text",
      "maskConfig": {
        "predefinedMask": "telephone"
      }
    },

Voorbeeld 3

Gebruiker kan slechts een maximaal aantal karakters invoeren.

Visualisatie in de backoffice:

image-20241216-152153.png
Maximum aantal karakters

In de JSON-definitie:

{
      "name": "redenAanvraag",
      "label": "Reden aanvraag",
      "type": "text",
      "conditions": [
        {
          "name": "newConditionMk123O",
          "level": "error",
          "expression": "$ !== undefined ? $.length < 20 : true",
          "errorMessage": "Maximum 20 karakters invoeren."
        }
      ]
    },

Voorbeeld 4

De gebruiker krijgt een keuzelijst te zien waarin hij of zij een item kan selecteren.

In de JSON-definitie:

{
   "name": "landAanvragerReflist",
   "label": "Land verblijf aanvrager",
   "type": "text",
   "referencelist": "landcodes",
   "referencelistKey": "land"
},

De referentielijst zelf ziet er conceptueel als volgt uit:

[
    {
        "land": "Afghanistan",
        "alpha2Code": "AF",
        "alpha3Code": "AFG",
        "numeriek": "4"
    },
    {
        "land": "Albanië",
        "alpha2Code": "AL",
        "alpha3Code": "ALB",
        "numeriek": "8"
    },
    {
        "land": "Algerije",
        "alpha2Code": "DZ",
        "alpha3Code": "DZA",
        "numeriek": "12"
    }
]

De eigenschap referencelistKey (Veldnaam in Studio) zorgt er dus voor dat de gebruiker een keuzelijst van voluit geschreven landen te zien krijgt.

Nadat de gebruiker een land geselecteerd heeft, wordt het geselecteerde object integraal opgeslagen in het formulierveld. Dit betekent dat ook de overige eigenschappen van het object bereikbaar zijn via een workflow expressie of een computed expression. Voorbeelden hieronder:

${skryv.dossierFromScope(execution).getOrCreateDocumentByDefinitionKey("testformulier").getField("landAanvragerReflist.alpha3Code")}

  "computedExpressions": {
    "alpha3Code": "$.landAanvragerReflist.alpha3Code"
  }

Tekstvak

Type “multiline”

Eigenschap

Beschrijving

Editor

Gebruik HTML-editor in de backoffice. Hierdoor kunnen backoffice gebruikers tekstopmaak (bijvoorbeeld vet of onderstrepen) toevoegen als ze dit veld invullen. Deze HTML-gebaseerde opmaak kan worden gekopieerd naar een communicatie (e-mail of document) als het veld tekstvlak de juiste referentie heeft.

Voorbeeld 1

Voorbeeld van tekstvak in een formulier. Het gebruik van de HTML-editor werd uitgeschakeld.

Visualisatie in de backoffice:

image-20241216-135650.png
Tekstvak

In de JSON-definitie:

    {
      "name": "motivatieWeigering",
      "label": "Motivatie weigering",
      "type": "multiline"         
    },

Voorbeeld 2

Het tekstvak wordt enkel getoond indien de logische variabele inschrijvingGeweigerd retourneert met true. Op dat ogenblik is het veld ook verplicht in te vullen. Binnen de context van de backoffice wordt het veld getoond met HTML-markup.

Visualisatie in de backoffice:

image-20241216-135254.png
Visualisatie backoffice

In de JSON-definitie:

    {
      "name": "motivatieWeigering",
      "label": "Motivatie weigering",
      "type": "multiline",
      "required": "inschrijvingGeweigerd",
      "computedShow": [
        "inschrijvingGeweigerd"
      ],
      "markup": "html"
    },

Telefoonnummer

Type “phone”

image-20260403-133056.png
Telefoonnummer in backoffice

Vanaf platform-versie 24.1 is telefoonnummer een specifiek datatype (terwijl dit voorheen gedefinieerd werd binnen een tekstveld met specifiek masker).

Eigenschap

Beschrijving

Countries

Selecteer hier de landen waaruit je rekeningnummers wil toelaten. Standaard is België al geselecteerd, maar je kan andere landen toevoegen.

“countries”: [“be”,”fr”]

Allow all countries

Door de eigenschap “allowAllCountries" = true toe te voegen, wordt de volledige landenlijst (219 items) ingeladen. Opgelet: deze eigenschap verleent voorrang aan “countries” (whitelisted countries).

Visualisatie in de backoffice. Prefix staat vooraf ingevuld. De spaties verhogen het gebruiksgemak bij het invullen, maar worden achterliggend niet opgeslagen.

{
  "label": "Mijn formulier",
  "name": "mijnFormulier",
  "sectionBasedValidation": false,
  "fields": [
    {
      "name": "newPhoneSxxb7R",
      "label": "Telefoonnummer",
      "type": "phone",
      "countries": [
        "be","fr","nl"
      ]
    }
  ]
}