Dossiertype instellingen

Dossiertype-instellingen openen

Het scherm met dossiertype-instellingen is toegankelijk door op Instellingen in het navigatiemenu links in de Studio interface te klikken. Beweeg tussen de drie tabbladen en verken de verschillende instellingen.

Algemeen

Eigenschap	Beschrijving
Naam	Naam van het dossiertype.
Key	Key van het dossiertype.
Beschrijving	Korte, beschrijvende en gebruiksvriendelijke tekst die verschijnt op de tegel van de dienstverlening in het frontoffice dashboard.
Opstart als concept (draft) `"startAsDraft": "true"`	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.
Opstart via backoffice
Proces bij start via 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. 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).
Opstart via frontoffice
Kan gestart worden via de frontoffice	Geef aan of een nieuw dossier handmatig kan worden gestart door een frontoffice gebruiker. Zo niet, dan wordt het hoofdproces gestart vanuit de backoffice (zie `Proces bij start via backoffice`), of via de exposed API.
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’).
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.
Label startknop bij opstart vanuit de frontoffice	Tekst op de startknop voor het proces in de frontoffice. 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’.
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.
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.
Dossierinformatie	Tekstuele informatie over het proces die wordt weergegeven op een aparte pagina nadat gebruikers de dienstverlening hebben aangeklikt en voordat ze hun aanvraag effectief starten. Dossierinformatie wordt gestructureerd in verschillende secties, elk met een eigen titel.
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.
Opstart via exposed API
Kan gestart worden via de exposed API	Geef aan of een nieuw dossier kan worden opgestart door een technische gebruiker (externe applicatie) via de exposed API.
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’).
Dossierlabel
Dossierlabelformat	Labelformaat 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.
Apart label bij opstart frontoffice	Je hebt ook de mogelijkheid om in de frontoffice een alternatief dossierlabel (alias) te visualiseren.
Apart label bij opstart als concept `“draftLabelProviderConfiguration”`	Indien het dossier in concept (draft) modus opgestart wordt, heb je hier de mogelijkheid om een alternatief dossierlabel te configureren.

Overzichtsvelden

Met de functionaliteit overzichtsvelden kan je als configurator bepalen welke informatie wordt gevisualiseerd in het dossieroverzicht in de backoffice en op de individuele backoffice dossierpagina's.

Lees meer over het configureren van overzichtsvelden.

Gelinkte dossiertypes

Door verschillende dossiertypes aan elkaar te koppelen, maak je onderlinge informatieuitwisseling mogelijk.

Lees meer over hoe je dossiertypes kunt linken en wat de mogelijke voordelen zijn.

Formaat

De dossiertype instellingen worden opgeslagen als een JSON-bestand met extensie .dosdef. Voorbeeld hieronder. Het is mogelijk om binnen Studio de instellingen als JSON-bestand te bekijken en editeren.

CODE

{
  "name": "inschrijvenInfoavond20241201",
  "label": "Inschrijven infoavond 2024-12-01",
  "description": "Infoavond financiële en praktische ondersteuning bij de organisatie van sportevenementen. De infoavond staat enkel open voor mensen die verbonden zijn aan een sportfederatie, een sportclub of een overheidsbestuur.",
  "creationModes": [
    {
      "key": "eLoket",
      "grantRole": "aanvrager",
      "labelProviderConfiguration": {
        "type": "counter",
        "includeYearPrefix": false,
        "counterLabel": "Inschrijving2024-12-01",
        "counterDigits": 3
      },
      "processMessagesOnStartup": [
        "inschrijvingStart"
      ]
    }
  ],
  "startButtonLabel": "Inschrijving starten",
  "labelProviderConfiguration": {
    "type": "counter",
    "includeYearPrefix": false,
    "counterLabel": "Inschrijving2024-12-01",
    "counterDigits": 3
  },
  "processesOnStartup": [
    "aanvraagInschrijvingInfoavond20241201"
  ],
  "dossierProgressSteps": [
    {
      "name": "Aanvraag ingediend",
      "relatedMilestoneKey": "Event_0fu5bbv",
      "description": "<p>Uw aanvraag is verstuurd. Binnenkort krijgt u van ons een bevestiging.</p>"
    },
    {
      "name": "Inschrijving goedgekeurd",
      "relatedMilestoneKey": "Event_1lfa4lv",
      "description": ""
    },
    {
      "name": "Inschrijving afgerond",
      "relatedMilestoneKey": "Event_16quvxx",
      "description": ""
    }
  ],
  "shouldShowGDPRCheckbox": true,
  "linkedDossierTypes": [
    "testDossierBart"
  ],
  "dossierInfoSteps": [
    {
      "title": "Doelgroep?",
      "description": "<p>De infoavond is bedoeld voor mensen die betrokken zijn bij de organisatie van sportevenementen. Deelnemers moeten deel uitmaken van ofwel een sportclub, een sportfederatie of een overheidsdienst. We aanvaarden enkel inschrijvingen van deelnemers met een concreet sportevenement op hun planning.</p>"
    },
    {
      "title": "Wat?",
      "description": "<p>De infoavond biedt deelnemers informatie die nuttig is bij de organisatie van sportevenementen. Denk daarbij aan relevante wetgeving, veiligheidsmaatregelen, best practices rond communicatie, enzovoort.</p>"
    },
    {
      "title": "Praktisch?",
      "description": "<p>De infoavond wordt vier keer herhaald. Op basis van waar de deelnemer woont, stellen we een sessie in Gent, dan wel in Hasselt voor.</p><p>Gent 5/12/2024 - naam &amp; adres locatie<br />Hasselt 10/12/2024 - naam &amp; adres locatie<br />Gent 15/12/2024 - naam &amp; adres locatie<br />Hasselt 20/12/2024 - naam &amp; adres locatie</p>"
    },
    {
      "title": "Programma?",
      "description": "<p>19u30: Ontvangst<br />20u30: Spreker 1<br />21u30: Pauze<br />22u00: Spreker 2<br />23u00: Einde</p>"
    }
  ],
  "textForGDPRCheckbox": "Uw verzamelde gegevens houden we tot drie jaar na de infoavond bij. We gebruiken de gegevens enerzijds om contact met u op te nemen, anderzijds om specifieke opvolgacties te definiëren. Zo kan het zijn dat we u na de infoavond uitnodigen om de organisatie van uw concreet sportevenement verder te bespreken.",
  "summaryFields": [
    {
      "heading": "Dossier",
      "predefinedField": "label",
      "dashboardDossierList": true,
      "dossierOverview": false
    },
    {
      "heading": "Status",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "predefinedField": "latestMilestone"
    },
    {
      "heading": "Naam",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "multiFormField": {
        "fields": [
          {
            "document": "inschrijving",
            "path": "voornaam",
            "label": "Voornaam",
            "type": "text"
          },
          {
            "document": "inschrijving",
            "path": "naam",
            "label": "Naam",
            "type": "text"
          }
        ]
      }
    }
  ]
}