Modelleren met het Zaakdetailobject

Het zaakdetailobject is het belangrijkste object in GZAC Zaakdossiers. Dit is het hart van het Zaakdossier. Er is maximaal 1 Zaakdetailobject per Zaakdossier. Het Zaakdetailobject wordt primair opgeslagen in GZAC, en (indien ingesteld) bij elke wijziging gesynchroniseerd naar een Objects API.

De gegevens in het Zaakdetailobject zijn (voor zover rechten zijn verstrekt) toegankelijk voor elke applicatie in het ZGW-landschap.

Welke data hoort niet thuis in het Zaakdetailobject?

• Gegegevens uit basisregistraties. Het principe is dat deze gegevens zo min mogelijk worden gedupliceerd. Ze worden realtime opgehaald zodra ze nodig zijn. Uitzonderingen op deze regel:

  • Als er de wens is een 'foto' te maken van de situatie in tijd, de situatie vast te leggen zoals deze op een bepaald moment is. Praktisch voorbeeld is het woonadres ten tijde van een aanvraag. In dit geval worden de gegevens gekopieerd naar het zaakdetailobject.

  • Als de wens is te filteren op gegevens of ze in de lijstschermen te tonen. Als voorbeeld, als de Achternaam van een aanvrager moet worden getoond in het lijstscherm, wordt dit gegeven opgenomen in het zaakdetailobject.

• Gegevens uit andere registraties.

• Technische ofwel 'stuurinformatie'. Daarvoor zijn process variables beschikbaar. Als voorbeeld 'kopie paspoort aanwezig'.

Best practise / goede gewoontes

• Maak altijd een JSON schema. Een JSON schema dwingt een bepaalde kwaliteit van elk document af. De ervaring leert dat voor productiewaardige systemen een JSON schema nodig is.

• Zorg voor een stabiel ontwerp en wijzig het model zo min mogelijk. Bespreek de impact van wijzigingen goed voor ze door te voeren. Als voorbeeld, als in een v2 van het schema een attribuut verplicht wordt gesteld dat in v1 nog niet verplicht was, moeten de formulieren die deze gegevens leveren worden gedupliceerd en worden aangepast aan de nieuwe Document definition.

• Het Zaakdetailobject moet bruikbaar zijn voor Formio formulieren. Complexiteiten zoals arrays in arrays kan het bouwen van formulieren compliceren. Tip: neem niet klakkeloos een JSON schema over van een bron.