Document status |
| ||||||
Version | 1.0 | ||||||
Date |
|
...
| Info |
|---|
Once-Only-principle: minimale input voor een maximaal hergebruik Door het gebruik van IPDC en once-only principes streven we maximaal naar eenvoudige en eenduidige configuraties die de gebruiker een consistente ervaring geven doorheen het platform. De minimaal verpichte velden zijn hieronder aangegeven met * |
Key | Beschrijving | ||||
|---|---|---|---|---|---|
| De link naar het fomulier dat geëmbed wordt in Mijn Burgerprofiel. Conform JSON-HAL kan dit een templated link zijn. Indien het formulier SSO verwacht (zie hieronder), dan kan in de URI template query expansion gedaan worden van
| ||||
| De link naar een formulier dat een gebruiker kan openklikken wanneer het formulier niet kan worden geëmbed, bijv. door browser-incompatibiliteit.
| ||||
| Alleen nodig als de formulieren worden aangeboden via een third-party domein, niet indien onder een CNAME van Voor meer details, zie https://vlaamseoverheid.atlassian.net/wiki/spaces/IKPubliek/pages/6180832603/Aanvraagmodule+-+Third+Party+Cookies#Alternatieve-oplossing:-Third-party-cookie-API-endpoint | ||||
| Verplicht voor formulieren die een aangemelde context vereisen (samen met Geeft aan op welk endpoint de aangemelde context van MBP overgedragen kan worden. Voor meer details, zie Aanvraagmodule - Authenticatie via Single Sign-on (SSO) | ||||
| Verplicht wanneer Geeft aan voor welke doelgroep of “audience” (ACM Client-ID) de token exchange moet gebeuren wanneer de burger het formulier opent.
| ||||
| Het IPDC- | ||||
| Voor formulieren die voor één ofmeerdere lokale besturen beschikbaar zijn. Bijv.
|
...
Zodra de pagina geladen is, moet dit aan Mijn Burgerprofiel worden gemeld, zodat de iframe kan worden getoond (in plaats van de loading state).
De Dit event zorgt ervoor dat de formulier-pagina moet rapporteren rapporteert over welke reële hoogte/breedte die momenteel heeft (in pixels):
...
Mijn Burgerprofiel gebruikt de informatie om rekening te houden met eventuele overflows, en om indien nodig lay-outaanpassingen te doen.
FORM_INITIALIZED event
Van zodra Zodra de gebruiker het formulier begint in te vullen, kan er dataverlies zijn indien als de aanvraag gesloten wordt vooraleer ze bevestigd en ingediend is. Dit event wordt in eerste plaats gebruikt om aan te geven dat de gebruiker interactie heeft gehad met het formulier.
| Info |
|---|
Het is aangeraden |
...
een informatieve pagina te tonen waarbij de gebruiker expliciet |
...
de aanvraag |
...
moet te starten. Die actie kan dan de |
...
triggeren |
Zodra dit event getriggerd is in de context van een formulier, kan de gebruiker het zijpaneel in Mijn Burgerprofiel niet sluiten zonder meer sluiten. Vanaf dan wordt een waarschuwing getoond waarbij de gebruiker moet bevestigen dat ze zeker zijn dat het formulier gesloten mag wordeneen waarschuwing te krijgen.
| Code Block | ||
|---|---|---|
| ||
window.parent.postMessage({
"action": "FORM_INITIALIZED"
}) |
...
Wanneer de gebruiker de aanvraag wil onderbreken zonder dat ze volledig ingediend kan wordendie ze in te dienen, of wanneer alle stappen in het formulier doorlopen zijn zonder dat er een dossier opgestart wordtte starten, kan het formulier een knop tonen die ervoor zorgt dat om de aanvraag gesloten wordtte sluiten. Er wordt
| Info |
|---|
De gebruiker krijgt geen extra waarschuwing |
...
en het zijpaneel wordt toegeklapt. De gebruiker blijft op de pagina |
...
waar de aanvraag gestart is. |
| Code Block | ||
|---|---|---|
| ||
window.parent.postMessage({
"action": "FORM_FINISHED"
}) |
...
Wanneer de gebruiker de aanvraag volledig heeft ingevuld, kan ze ingediend worden. Dit houdt ook in dat achter de schermen een dosis dossier opgestart is (Na indiening wordt er een dossier opgestart zodat de gebruiker later de status van hun de aanvraag kan opvolgen). Van zodra
Zodra de aanvraag succesvol met succes is ingediend is bij het loket, dient moet de pagina dit te melden aan Mijn Burgerprofiel. Op basis van dit event wordt het zijpaneel gesloten (zonder extra waarschuwing). De gebruiker wordt naar de overzichtspagina van met aanvragen gestuurd, en krijgt daar een alert te zien die aangeeft ziet daar de bevestiging dat de aanvraag ingediend is.
| Info |
|---|
Idealiter is het |
...
dossier |
...
ook direct zichtbaar als ingediende aanvraag |
...
. Dit is echter afhankelijk van de flow die bij het loket gevolgd wordt voor |
...
de integratie met de dossierstatusinformatie. |
| Code Block | ||
|---|---|---|
| ||
window.parent.postMessage({
"action": "FORM_SUBMITTED",
"submissionTitle": "Uw aanvraag is ingediend",
"submissionMessage": "Loket X verwerkt nu uw aanvraag. U ontvangt een melding wanneer ze in behandeling is.",
"dosis": "urn://loket.burgerprofiel.be/aanvraag/86-XIOSJP-91352"
}) |
submissionTitleensubmissionMessage
...
(optioneel) kunnen meegegeven worden om de boodschap in de alert aan te passen.
dosiskan (optioneel) meegegeven worden om aan te geven wat de dossierbron & dossiernummer zijn van het nieuwe dossier (op die manier kan het relevante dossier opgehaald worden in het aanvragen-overzicht)