Dossiertypes voorbeelden

Vooraf

Hieronder vind je enkele voorbeelden van .dosdef-bestanden, gaande van basic tot complex.

Voorbeeld 1: basic

Basic dossiertype waarbij je een dossier enkel vanuit de frontoffice kan opstarten (creation mode met key eLoket). Het start message event heeft de key start en de gebruiker krijgt automatisch de rol aanvrager binnen het dossier.

CODE

{
  "name": "borrowABook",
  "label": "(Demo) Borrow a book",
  "description": "Process for borrowing a book from the library",
  "creationModes": [
    {
      "key": "eLoket",
      "grantRole": "aanvrager",
      "processMessagesOnStartup": [
        "startBorrowABook"
      ]
    }
  ],
}

Voorbeeld 2: eenvoudig

Eenvoudig dossiertype waarbij elk dossier vanuit de frontoffice wordt opgestart in draft modus. Het dossier krijgt dan ook een aangepast DRAFT-label. Op een bepaald punt in de flow (afhankelijk van configuratie) krijgt het dossier de status ‘ingediend’ en switcht ook het label naar SUBMITTED.

CODE

{
  "name": "Aanvraag indienen",
  "label": "aanvraagIndienen",
  "description": "Proces om een aanvraag in te dienen",
  "startAsDraft": "true",
  "draftLabelProviderConfiguration": {
    "type": "counter",
    "counterLabel": "DRAFT",
    "includeYearPrefix": true,
    "counterDigits": 7
  },
  "labelProviderConfiguration": {
    "type": "counter",
    "counterLabel": "SUBMITTED",
    "includeYearPrefix": true,
    "counterDigits": 7
  },
  "creationModes": [
    {
      "key": "eLoket",
      "grantRole": "aanvrager",
      "processMessagesOnStartup": [
        "frontofficeStart"
      ]
    }
  ]
}

Voorbeeld 3: uitgebreid

Uitgebreid voorbeeld van een dossiertype waarbij een dossier enkel vanuit de backoffice opstartbaar is. Bijzonder zijn hier de geconfigureerde overzichtsvelden (summaryFields).

CODE

{
  "name": "borrowABook",
  "label": "(Demo) Borrow a book",
  "description": "Process to borrow a book from the library",
  "processesOnStartup": [
    "borrowABook"
  ],
  "summaryFields": [
    {
      "heading": "Title",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "formField": {
        "document": "chooseABook",
        "path": "theBookYouChoose.title",
        "label": "Title",
        "type": "text"
      }
    },
    {
      "heading": "Dossier",
      "predefinedField": "label",
      "dashboardDossierList": true,
      "dossierOverview": false
    },
    {
      "heading": "Created by",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "predefinedField": "creator"
    },
    {
      "heading": "All milestones",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "predefinedField": "allMilestones"
    },
    {
      "heading": "Creation date",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "predefinedField": "creationDate"
    },
    {
      "heading": "Description",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "predefinedField": "description"
    },
    {
      "heading": "Dossier type",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "predefinedField": "type"
    },
    {
      "heading": "Latest activity",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "predefinedField": "latestActivity"
    },
    {
      "heading": "Latest milestone",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "predefinedField": "latestMilestone"
    },
    {
      "heading": "Forms",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "predefinedField": "allForms"
    },
    {
      "heading": "Rijksregisternummer",
      "dashboardDossierList": false,
      "dossierOverview": true,
      "formField": {
        "document": "chooseABook",
        "path": "rrn",
        "label": "Rijksregisternummer",
        "type": "text"
      }
    },
    {
      "heading": "Adres",
      "dashboardDossierList": true,
      "dossierOverview": false,
      "multiFormField": {
        "fields": [
          {
            "document": "chooseABook",
            "path": "testAutoComplete.street",
            "label": "Straat",
            "type": "text"
          },
          {
            "document": "chooseABook",
            "path": "testAutoComplete.housenumber",
            "label": "Huisnummer",
            "type": "text"
          }
        ]
      }
    }
  ]
}

Voorbeeld 4: complex

Complex voorbeeld van een dossiertype met overzichtsvelden en onderaan ook toevoeging van dossierinformatie en mijlpalen.

CODE

{
  "name": "premieErfgoed",
  "label": "Premie Erfgoed",
  "description": "[PROD] Proces om een premie aan te vragen voor erfgoed.",
  "processesOnStartup": [
    "premieAanvraagErfgoed"
  ],
  "creationModes": [
    {
      "key": "eLoket",
      "grantRole": "aanvrager",
      "processMessagesOnStartup": [
        "startEventFO"
      ],
      "labelProviderConfiguration": {
        "type": "counter",
        "includeYearPrefix": true,
        "counterLabel": "PR-ERFGOED (ontwerp)",
        "counterDigits": 4
      }
    }
  ],
  "startButtonLabel": "Vraag premie aan",
  "labelProviderConfiguration": {
    "type": "counter",
    "counterLabel": "PR-ERFGOED",
    "counterDigits": 4,
    "includeYearPrefix": true
  },
  "summaryFields": [
    {
      "heading": "Dossier",
      "predefinedField": "label",
      "dashboardDossierList": true,
      "dossierOverview": false
    },
    {
      "heading": "Ingediend op",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "formField": {
        "document": "aanvraagFormulierPremieErfgoed",
        "path": "datumIndieningOnzichtbaar",
        "label": "Datum Indiening (Onzichtbaar)",
        "type": "date"
      }
    },
    {
      "heading": "Startdatum werken",
      "dashboardDossierList": false,
      "dossierOverview": true,
      "formField": {
        "document": "aanvraagFormulierPremieErfgoed",
        "path": "datumStartWerken",
        "label": "Datum Start Werken (Onzichtbaar)",
        "type": "date"
      }
    },
    {
      "heading": "Status",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "predefinedField": "latestMilestone"
    },
    {
      "heading": "Adres van het pand",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "multiFormField": {
        "fields": [
          {
            "document": "aanvraagFormulierPremieErfgoed",
            "path": "gegevensPand.finaalPandAdresVerborgen.finaalStraat",
            "label": "finaalStraat",
            "type": "text"
          },
          {
            "document": "aanvraagFormulierPremieErfgoed",
            "path": "gegevensPand.finaalPandAdresVerborgen.finaalHuisnummer",
            "label": "FinaalHuisnummer",
            "type": "text"
          },
          {
            "document": "aanvraagFormulierPremieErfgoed",
            "path": "gegevensPand.finaalPandAdresVerborgen.finaalBusnummer",
            "label": "FinaalBusnummer",
            "type": "text"
          },
          {
            "document": "aanvraagFormulierPremieErfgoed",
            "path": "gegevensPand.finaalPandAdresVerborgen.finaalPostcode",
            "label": "FinaalPostcode",
            "type": "text"
          },
          {
            "document": "aanvraagFormulierPremieErfgoed",
            "path": "gegevensPand.finaalPandAdresVerborgen.finaalGemeente",
            "label": "FinaalGemeente",
            "type": "text"
          }
        ]
      }
    },
    {
      "heading": "Aanvrager",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "multiFormField": {
        "fields": [
          {
            "document": "aanvraagFormulierPremieErfgoed",
            "path": "gegevensAanvrager.voornaam",
            "label": "Voornaam",
            "type": "text"
          },
          {
            "document": "aanvraagFormulierPremieErfgoed",
            "path": "gegevensAanvrager.naam",
            "label": "Familienaam",
            "type": "text"
          },
          {
            "document": "aanvraagFormulierPremieErfgoed",
            "path": "gegevensAanvrager.ondernemingsNaam",
            "label": "Naam Onderneming",
            "type": "text"
          }
        ]
      }
    },
    {
      "heading": "Categorie van de werken",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "formField": {
        "document": "aanvraagFormulierPremieErfgoed",
        "path": "categorie.welkeCategorieVanWerkenWilJeUitvoeren",
        "label": "Welke werken ga je uitvoeren?",
        "type": "choice",
        "options": [
          {
            "name": "buitenschrijnwerk",
            "label": "Buitenschrijnwerk (ramen, deuren …)"
          },
          {
            "name": "dak",
            "label": "Dak"
          },
          {
            "name": "gevel",
            "label": "Gevel"
          },
          {
            "name": "tuin",
            "label": "Tuin of paden rond het pand"
          },
          {
            "name": "onderzoek",
            "label": "Onderzoek"
          }
        ]
      }
    },
    {
      "heading": "CBS-nummer",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "formField": {
        "document": "controleerCbsAgenderenPremieErfgoed",
        "path": "cbsNummer",
        "label": "CBS-nummer",
        "type": "text"
      }
    },
    {
      "heading": "BA-nummer",
      "dashboardDossierList": true,
      "dossierOverview": true,
      "formField": {
        "document": "controleerCbsAgenderenPremieErfgoed",
        "path": "baNummer",
        "label": "BA-nummer",
        "type": "text"
      }
    }
  ],
  "dossierInfoSteps": [
    {
      "title": "Wat heb je nodig?",
      "description": "<ul><li>Informatie over het pand en de werken:<ul><li>Foto's</li><li>Detailtekeningen</li><li>Offertes (opgesplitst per kostenpost, prijs excl. btw)</li><li>Eventuele extra documenten</li><li>Toelating van de eigenaar om de werken te mogen doen (alleen als je huurt)</li></ul></li></ul><ul><li>Vraag je de premie aan als onderneming? Zorg dan voor:<ul><li>Laatst goedgekeurde en neergelegde jaarrekening</li><li>Financieel verslag</li><li>Verslag commissaris (revisor)</li></ul></li></ul><ul><li>Vraag je de premie aan als vereniging van mede-eigenaars (VME)? Zorg dan voor:<ul><li>Laatst goedgekeurde afrekening</li><li>Verslag over de goedkeuring van die afrekening</li></ul></li></ul>"
    }
  ],
  "dossierProgressSteps": [
    {
      "name": "Ingediend",
      "relatedMilestoneKey": "Aanvraag_Ingediend",
      "description": "<p>Je aanvraag is bij ons aangekomen.</p><p>We gaan voor je aan de slag.</p><p>Als we vragen hebben, contacteren we je.</p>"
    },
    {
      "name": "In behandeling",
      "relatedMilestoneKey": "Aanvraag_in_behandeling",
      "description": "<p>We kijken je aanvraag na.</p>"
    },
    {
      "name": "Afgerond",
      "relatedMilestoneKey": "Aanvraag_afgerond",
      "description": "<p>Je aanvraag is afgerond.</p>"
    }
  ]
}