Dossiertype instellingen

Naam

Naam van het dossiertype.

"label": "Mijn dossiertype"

Key

Key van het dossiertype.

"name": "mijnDossiertype"

Beschrijving

Korte, beschrijvende en gebruiksvriendelijke tekst die verschijnt op de tegel van de dienstverlening in het frontoffice dashboard.

"description": "Beschrijving van Mijn dossiertype"

Automatisch verwijderen na afronden

Niet via Studio UI, enkel via de JSON

Zorgt ervoor dat een dossier automatisch verwijderd wordt van zodra er geen enkele gelinkte procesinstantie meer actief staat. Vindt zijn use case bij bulkworkflows.

“canBeDeactivatedWhenReady”: true

Label startknop bij opstart vanuit de frontoffice

Tekst op de startknop voor het proces in de frontoffice.

"startButtonLabel": "Dossier opstarten"

• Indien er geen dossierinformatie gedefinieerd is (zie lager), dan triggert de knop inderdaad de opstart van een nieuw dossier. Geef in dat geval een korte, beschrijvende en actiegerichte tekst op. Bijvoorbeeld ‘Start bouwaanvraag’, ‘Vraag terrasvergunning aan’, enzovoort.

• Indien er wel dossierinformatie gedefinieerd is (zie lager), dan triggert de knop niet onmiddellijk de opstart van een nieuw dossier. De frontoffice gebruiker krijgt dan eerst een tussenliggende pagina met de dossierinformatie te zien. Onderaan deze pagina staat vervolgens een knop ‘Aanvraag starten’ waarmee dan de effectieve opstart van het dossier getriggerd wordt. Geef in dit scenario voor ‘Label startknop’ een tekst op zoals ‘Meer info’.

Opstart als concept (draft)

Geef aan of het dossier moet opgestart worden als concept (draft), dan wel onmiddellijk de status van volwaardig ingediend dossier moet krijgen. Klik hier voor meer info over het onderscheid tussen concept dossiers en ingediende dossiers.

"startAsDraft": "true"

Apart label bij opstart als concept

Indien het dossier in concept (draft) modus opgestart wordt, heb je hier de mogelijkheid om een alternatief dossierlabel te configureren. Het label wordt omgezet naar het standaard dossierlabel (zie hoger) van zodra je in de workflow de ‘Dossier indienen' functie uitvoert via de service taak template.

"draftLabelProviderConfiguration": {
  "type": "counter",
  "includeYearPrefix": true,
  "counterLabel": "mijnDossierConcept",
  "counterDigits": 3
}

Dossierinformatie

Tekstuele informatie over het proces die wordt weergegeven op een aparte pagina nadat frontoffice gebruikers de dienstverlening hebben aangeklikt en voordat ze hun aanvraag effectief starten.

Dossierinformatie wordt gestructureerd in verschillende secties, elk met een eigen titel.

  "dossierInfoSteps": [
    {
      "title": "Titel sectie 1",
      "description": "<p>Body sectie 1</p>"
    },
    {
      "title": "Titel sectie 2",
      "description": "<p>Body sectie 2</p>"
    }
  ],

Toon de GDPR checkbox op dossier info pagina

Indien geselecteerd, moeten frontoffice gebruikers een GDPR-tekst lezen en hiermee akkoord gaan door een checkbox aan te vinken voordat ze hun aanvraag opstarten. GDPR verwijst naar de Europese wetgeving met betrekking tot de privacy van persoonlijke gegevens. Organisaties die persoonlijke gegevens van individuele burgers verzamelen, opslaan en verwerken, moeten inzicht geven in hun gegevensbeleid.

Opgelet: de GDPR-tekst kan enkel gevisualiseerd worden op de pagina met dossierinformatie (zie lager). Indien er geen dossierinformatie is gedefinieerd, wordt deze pagina en dus ook de GDPR-tekst niet weergegeven aan de gebruiker.

"shouldShowGDPRCheckbox": true

Aangepaste GDPR tekst

Als de tekst die je hier definieert is ingevuld, wordt deze weergegeven als GDPR-tekst. Zo niet, dan wordt een default GDPR-bericht weergegeven (“I give permission to retrieve data about me from authentic sources (e.g. rijksregister, kbo,...) that is relevant to the request and will be used to process the request.”).

Opgelet: de GDPR-tekst kan enkel gevisualiseerd worden op de pagina met dossierinformatie (zie lager). Indien er geen dossierinformatie is gedefinieerd, wordt deze pagina en dus ook de GDPR-tekst niet weergegeven aan de gebruiker.

"textForGDPRCheckbox": "Dit is de aangepaste GDPR-tekst"

Dossiervoortgang

Selecteer mijlpalen (signal throw events) die zijn gedefinieerd in de BPMN-workflow om ze weer te geven in de frontoffice samen met een woordje uitleg voor de gebruiker. Via dossiervoortgang kunnen frontoffice gebruikers de status van hun dossier opvolgen.

  "dossierProgressSteps": [
    {
      "name": "Titel eerste mijlpaal",
      "relatedMilestoneKey": "Event_0f4cadw",
      "description": "<p>Body eerste mijlpaal</p>"
    },
    {
      "name": "Titel tweede mijlpaal",
      "relatedMilestoneKey": "Event_1mkyea0",
      "description": "<p>Body tweede mijlpaal</p>"
    }
  ]

Dossierlabelformat

Formaat standaard label voor elk nieuw dossier. Twee opties: vaste tekst betekent dat elk nieuw dossier hetzelfde gespecificeerde label krijgt, terwijl volgnummer een uniek label genereert voor elk nieuw dossier.

"labelProviderConfiguration": {
  "type": "counter",
  "includeYearPrefix": true,
  "counterLabel": "mijnDossier",
  "counterDigits": 3
},

Starten via de backoffice

Een dossiertype kan meerdere processen bevatten, d.w.z. een hoofdproces en een aantal subprocessen. Hier moet je het hoofdproces selecteren binnen het dossiertype. Dit is de workflow die wordt geactiveerd bij het starten van een nieuw dossier vanuit de backoffice. Om dit te laten werken, mag het proces maar één ‘untyped’ start event hebben. Bovendien zal opstarten vanuit de backoffice enkel mogelijk zijn voor gebruikers met de juiste rechten (dossiertype) en UI-autorisatie (dossier-, proces- en documentcreatie). Naast dat ‘untyped’ start event kan de workflow ook een extra message start event hebben dat wordt gebruikt als de workflow wordt gestart via de frontoffice (zie Kan gestart worden via de frontoffice en Message start event eigenschappen) of via de exposed API.

De JSON-snippet hieronder komt uit een dossiertype dat enkel opstartbaar is via de backoffice (er zijn geen creationModes gedefinieerd). Je herkent de labelconfiguratie en de key van het hoofdproces dat moet opgestart worden.

  "creationModes": [],
  "labelProviderConfiguration": {
    "type": "counter",
    "includeYearPrefix": true,
    "counterLabel": "mijnDossier",
    "counterDigits": 3
  },
  "processesOnStartup": [
    "testWorkflowH"
  ]
}

Merk op dat het mogelijk is om twee of meerdere processen tegelijkertijd te laten opstarten. Niet ondersteund in de Studio UI, maar wel via de JSON.

  "processesOnStartup": [
    "testWorkflowH",
    "testjeWorkflowB"
  ]

Formulier aanbieden in pop-up aanmaak dossier

Niet via Studio UI, enkel via de JSON

Bij opstart van nieuw dossier vanuit de backoffice krijg je een popup te zien waar je het correcte dossiertype kan invullen. Via “dossierCreationDefinitionKey” kan je via deze pop-up de gebruiker al meteen een formulier laten invullen.

Opgepast: wanneer je deze optie activeert, zijn alle formuliervelden aangeboden in de pop-up, verplicht in te vullen om het dossier effectief te kunnen opstarten.

"dossierCreationDefinitionKey": "mijnFormulierKey"

Kies subprocessen die binnen het dossier gestart kunnen worden

Vanuit de dossierpagina van een opgestart dossier kunnen backoffice medewerkers met de juiste rechten en rollen optioneel bijkomende workflows toevoegen. Dit gebeurt via een actieknop rechts bovenaan.

Merk op dat enkel gebruikers met de juiste UI-autorisatie (dossier-, proces- en formuliercreatie) dit kunnen.

Om workfows toevoegbaar te maken moet je de keys ervan definiëren onder de eigenschap “processes”.

"processes": [
  "bijkomendOpstartbareWorkflow1",
  "bijkomendOpstartbareWorkflow2"
],

Bijkomende formulieren toevoegen vanuit de backoffice

Niet via Studio UI, enkel via de JSON

Vanuit de dossierpagina van een opgestart dossier kunnen backoffice medewerkers met de juiste rechten en rollen optioneel bijkomende workflows toevoegen. Dit gebeurt via een actieknop rechts bovenaan.

Merk op dat enkel gebruikers met de juiste UI-autorisatie (dossier-, proces- en formuliercreatie) dit kunnen.

Om workfows toevoegbaar te maken moet je de keys ervan definiëren onder de eigenschap “documents”.

"documents": [
  "bijkomendOpstartbaarFormulier1",
  "bijkomendOpstartbaarFormulier2"
],

Deze eigenschap lijkt ‘deprecated’ te zijn. Het aangemaakte formulier is read-only en dus niet-bewerkbaar.

Starten via de frontoffice

Geef aan of een nieuw dossier handmatig kan worden gestart door een frontoffice gebruiker. Zo niet, dan kan het hoofdproces gestart worden vanuit de backoffice (zie Proces bij start via backoffice), of via de exposed API.

In de JSON wordt eLoket toegevoegd bij creationModes. Er is een gepreconfigureerd dossierlabel, de gebruiker die het dossier aanmaakt vanuit de frontoffice, krijgt automatisch de rol aanvrager toegewezen. Het aan te roepen hoofdproces zal starten bij het start event met message startfromfo.

  "creationModes": [
    {
      "key": "eLoket",
      "labelProviderConfiguration": {
        "type": "counter",
        "includeYearPrefix": true,
        "counterLabel": "mijnDossier",
        "counterDigits": 3
      },
      "grantRole": "aanvrager",
      "processMessagesOnStartup": [
        "startfromfo"
      ]
    }
  ],

Merk op dat het mogelijk is om twee of meerdere start events tegelijkertijd aan te roepen. Niet ondersteund in de Studio UI, maar wel via de JSON.

"processMessagesOnStartup": [
   "startfromfo",
   "startfromfo2"
]

Apart label bij opstart frontoffice

Je hebt ook de mogelijkheid om een alternatief dossierlabel (alias) te visualiseren wanneer een dossier opgestart wordt vanuit de frontoffice. Deze kan je later in de flow omzetten naar het standaard dossierlabel (zie hoger) door via een service taak de recalculate label functie uit te voeren.

Mogelijke use cases:

• Via het dossierlabel visualiseren of een dossier al dan niet via de frontoffice is opgestart.

• Via het dossierlabel onderscheid maken tussen opgestarte dossiers (draft) en werkelijk ingediende (na check door dossierbeheerder). Deze use case wordt sinds versie 25.0.X afgedekt door de feature concept (draft) modus.

Opgelet: dit alternatief dossierlabel bij opstart vanuit frontoffice wordt genegeerd als er apart dossierlabel bij opstart als concept is (zie hieronder). Deze laatste krijgt dus voorrang!

"labelProviderConfiguration" onder creation mode met key “eLoket”

"creationModes": [
 {
   "key": "eLoket",
   "labelProviderConfiguration": {
     "type": "counter",
     "includeYearPrefix": true,
     "counterLabel": "mijnDossierFrontOffice",
     "counterDigits": 3
   },
   "grantRole": "aanvrager",
   "processMessagesOnStartup": [
     "startfromfo"
   ]
 }
],

Rol voor dossierstarter bij opstart vanuit frontoffice

Rol die automatisch wordt toegewezen aan de gebruiker die het dossier start vanaf de frontoffice (meestal is dit ‘aanvrager’).

"grantRole": "aanvrager"

Message start event bij opstart vanuit frontoffice

Alleen in het scenario dat een frontoffice gebruiker het proces kan starten (zie Kan gestart worden via de frontoffice). Het proces wordt gestart door een message start event binnen de workflow. Hier moet je de message key van dit start event opgeven.

"processMessagesOnStartup": [
   "startfromfo"
]

Merk op: via de JSON is het mogelijk om twee of meerdere message start events te definiëren en dus meerdere flows tegelijkertijd op te starten bij de aanmaak van het dossier.

Zonder aanmelden toestaan (guest mode)

Er is de bijkomende mogelijkheid om het dossier opstartbaar te maken in ‘guest mode' (d.w.z. de gebruiker hoeft zich niet te authenticeren of in te loggen).

Enkele opmerkingen:

• Voorafgaande applicatie instelling vereist.

• Opstart via guest mode vertrekt vanuit een apart message start event in de workflow. Je moet ook instellen welke rol toegekend wordt aan de starter van het dossier. Verder is er ook de mogelijkheid om het dossierlabel te overschrijven in het geval het dossier via de guest flow wordt opgestart.

• Opstart in guest mode enkel mogelijk als ook de gebruikelijke frontoffice opstart met verplichte authenticatie aanwezig is.

In de JSON ziet dit er als volgt uit: bovenaan vind je de guest mode terug; onderaan zie je de gebruikelijke frontoffice opstart met verplichte authenticatie. Elk vertrekt vanuit zijn eigen message start event.

  "creationModes": [
    {
      "key": "eLoketGuest",
      "labelProviderConfiguration": {
        "type": "counter"
      },
      "grantRole": "aanvrager",
      "processMessagesOnStartup": [
        "startParkeerverbodGuest"
      ]
    },
    {
      "key": "eLoket",
      "labelProviderConfiguration": {
        "type": "counter"
      },
      "grantRole": "aanvrager",
      "processMessagesOnStartup": [
        "startParkeerVerbodAuthenticated"
      ]
    }
  ],

Kies het message start event dat moet worden gestart (guest mode)

Alleen in het scenario dat een niet-geauthenticeerde frontoffice gebruiker het proces kan starten (zie Kan gestart worden via de frontoffice). Het proces wordt gestart door een message start event binnen de workflow. Hier moet je de message key van dit start event opgeven.

"processMessagesOnStartup": [
   "startfromfo"
]

Merk op: via de JSON is het mogelijk om twee of meerdere message start events te definiëren en dus meerdere flows tegelijkertijd op te starten bij de aanmaak van het dossier.

Rol die automatisch wordt toegewezen aan de starter van het dossier (guest mode)

Rol die automatisch wordt toegewezen aan de niet-geauthenticeerde frontoffice gebruiker die het dossier start (meestal is dit ‘aanvrager’).

"grantRole": "aanvrager"

Dossierlabel overschrijven (guest mode)

Bevestigingspagina voor niet-geauthenticeerde gebruikers (guest mode)

Voorlopig enkel via JSON, niet via Studio UI

Titel en body van de guest user bevestigingspagina.

"guestDossierConfirmation": {
    "title": "Bedankt voor je aanvraag!",
    "description": "We gaan zo snel mogelijk voor je aan de slag."

Start via exposed API

Geef aan of een nieuw dossier kan worden opgestart door een technische gebruiker (externe applicatie) via de exposed API.

Achterliggend wordt in het JSON-bestand een specifieke creationMode toegevoegd met key exposedApi.

"creationModes": [
 {
   "key": "exposedApi",
   "processMessagesOnStartup": [
     "startfromfo"
   ],
   "grantRole": "aanvrager"
 }
],

Message start event bij opstart via de exposed API

Message start event dat getriggerd wordt bij opstart van het dossier. Je kan hier één of meerdere events definiëren.

"processMessagesOnStartup": [
  "startfromfo"
],

Rol voor dossierstarter bij opstart via de exposed API

Rol die automatisch wordt toegewezen aan de technische gebruiker die het dossier via de exposed API (meestal is dit ‘aanvrager’).

"grantRole": "aanvrager"

Apart label bij opstart via exposed API

Je hebt ook de mogelijkheid om een alternatief dossierlabel (alias) te visualiseren wanneer een dossier opgestart wordt via de exposed API. Deze kan je later in de flow omzetten naar het standaard dossierlabel (zie hoger) door via een service taak de recalculate label functie uit te voeren.

    {
      "key": "exposedApi",
      "processMessagesOnStartup": [
        "startG"
      ],
      "grantRole": "aanvrager",
      "labelProviderConfiguration": {
        "type": "counter",
        "includeYearPrefix": true,
        "counterLabel": "EXPOSED",
        "counterDigits": 3
      }
    },