Verschillen

Dit geeft de verschillen weer tussen de geselecteerde revisie en de huidige revisie van de pagina.

--- stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:vereiste_minimale_instellingen [2026/07/15 10:16] – ↷ Pagina verplaatst van stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:vereiste_minimale_instellingen naar dev:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:vereiste_min Kars Gottschal
+++ stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:vereiste_minimale_instellingen [2026/07/15 11:07] (huidige) – aangemaakt - Externe bewerking 127.0.0.1
@@ Regel 1: / Regel 1: @@
+====== OpenZaak API minimale configuratie ======
+{{tag>openwave:1.34:applicatiebeheer:functionaliteiten:zgw}}
+Er wordt pas een messagelogkaart aangemaakt indien de whitelist controle en de token-controle met succes zijn doorlopen.
+De verzender van de OpenZaak berichten krijgt wel bij het falen van whitelist- of token-controle een duidelijk foutbericht.
+===== Whitelist =====
+In de tabel tbendpointlist (beheerportaal: zie [[stable:applicatiebeheer:probleemoplossing:portalen_en_moduleschermen:beheerportaal_nieuw:tegels_kolom_gebruikers:endpoints_whitelist]]) moet een kaart worden gedefinieerd met als waarde ///api/zgw//
+Vervolgens dienen de IP-adressen die toestemming moeten krijgen om de ondersteunde OpenZaak API berichten te posten aan dit endpoint te worden toegevoegd.
+===== Robotmedewerker =====
+Er moet een robotmedewerker aangemaakt worden in de medewerkerstabel speciaal voor het ontvangen van de postberichten m.b.t. de OpenZaak API.
+Deze robotmedewerker moet een //loginaam// (dvloginnaam) krijgen en een gevulde kolom
+//Client secret bij loginnaam tbv accesstoken// (dvclientsecret in blok overig).
+Deze //loginnaam// en //client secret// moet de functioneel beheerder communiceren met de instantie die OpenZaak berichten gaat posten in OpenWave. Op grond hiervan worden de accesstokens gegenereerd.
+<adm warning>
+Indien de client_secret gecrypt wordt opgeslagen, dan moet de ONgecrypte versie met de zender worden gecommuniceerd.
+</adm>
+Bij de medewerkerskaart:
+  * vul de organisatienaam (dvorganisatie) met een benaming voor de ontvangende instantie (bijvoorbeeld OD Rommeldam e.o.)
+  * vul de achternaam van de robot (dvomschrijving) met een benaming voor de zendende instantie (bijvoorbeeld milieuklachten Gelderland)
+  * vul de kolom 1=robot, 2=browser, 3=beide (dnmaginapp) met **1** (robot)
+  * Voeg de robot toe aan een rechtengroep die minimaal het insertrecht op omgevingzaken heeft (tbomgrechten.dlomgins) indien de aangebracht zaken in tbomgvergunning kunnen worden opgeslagen.
+  * Voeg de robot (ook) toe aan een rechtengroep die minimaal het insertrecht op APV/Overige zaken heeft (tbovrechten.dlovvins) indien de aangebracht zaken in tbovvergunningen kunnen worden opgeslagen.
+  * kies bij de kolom //Endpoint (robotmedewerker is gedefinieerd voor binnenkomende berichten op endpoint)// (dnkeyendpointlist) voor de whitelist met de waarde ///api/zgw//
+===== Instellingen in tbinitialisatie =====
+Vul de kolom //Tekst// van //Sectie: Operations en Item: Servernaam_hyperlink// met de base-URL van de OpenWave installatie bijvoorbeeld  //<nowiki> https://acc.rommeldam.open-wave.nl</nowiki>//
+Deze //base-URL// moet gecommuniceerd worden met de instantie die OpenZaak berichten gaat posten in OpenWave.
+OpenWave ondersteunt POST berichten op de endpoints:
+    * //base-url///api/zgw/zaken/api/v1/zaken/
+    * //base-url///api/zgw/zaken/api/v1/rollen/
+    * //base-url///api/zgw/documenten/api/v1/enkelvoudiginformatieobjecten/
+    * //base-url///api/zgw/zaken/api/v1/zaakinformatieobjecten/
+    * //base-url///api/zgw/authentication/token/
+    * //base-url///api/zgw/zaken/api/v1/zaakobjecten/
+    * //base-url///api/zgw/zaken/api/v1/zaken/{zaak-uuid}/zaakeigenschappen
+OpenWave ondersteunt GET berichten op de endpoints:
+    * //base-url//api/zgw/catalogi/api/v1/zaaktypen/
+    * //base-url//api/zgw/catalogi/api/v1/informatieobjecttypen/
+    * //base-url//api/zgw/catalogi/api/v1/roltypen/
+    * //base-url//api/zgw/catalogi/api/v1/eigenschappen/
+    * //base-url//api/zgw/catalogi/api/v1/zaakobjecttypen/
+    * //base-url//api/zgw/zaken/api/v1/zaken/{zaak-uuid}
+Vul de kolom //Getal1// van //Sectie: ZGW en Item: KeyAnoniemContactAdres// met een valide verwijzing naar de primary key van een contactadreskaart die gaat functioneren als anoniem contactpersoon.
+De kolom //Getal2// van de instelling //Sectie: Koppeling ZAAK en Item: DummyLokatiePerceelkey// moet gevuld zijn met een waarde die verwijst naar een dnkey van tbperceeladressen die gebruikt wordt om de zaak aan een locatie te koppelen bij ontbrekende locatie-informatie.
+Vul het aanvinkvakje van //Sectie: ZGW en Item: Messagelog// zodat binnenkomende en uitgaande berichten gelogd worden.
+Door in //Sectie:ZGW het Item: CheckOpRegistratienummer// aan te vinken wordt geregeld dat dubbele registratienummers worden genegeerd. Het gaat hier om extra informatie - buiten de Open Zaak API standaard om - die kan worden meegegeven in het [[stable:applicatiebeheer:probleemoplossing:programmablokken:zgw_open_zaak_api_functionaliteit:creeer_zgw_zaak]] voor een omgevingzaak. Zie aldaar onder kopje //Uitzondering extra waarnemings-items//.
+Door in //Sectie: ZGW het Item: CheckEenRolContactPerZaak// aan te vinken wordt geregeld dat dubbele contacten/rollen worden genegeerd.
+<adm StUF Zaak/DMS-koppeling>
+Alleen indien sprake is van StUF Zaak/DMS-koppeling, dan vul de kolom //Getal1// van //Sectie: ZGW en Item: KeyVoorlopigeAanvrager// met een valide verwijzing naar de primary key van een contactadreskaart die gaat functioneren als voorlopige initiator voor de StUF Zaak/DMS-bericht.
+Dit is nodig omdat bij het creëren van een zaak in het DMS via StUF een initiator verplicht is. Die initiator zit echter niet in het Open Zaak API - creeer Zaak bericht, op grond waarvan het Stuf bericht voor het creëren van de zaak in het DMS wordt gefabriceerd. Bij het ontbreken van deze verwijzing zal er geen zaak in het DMS worden aangemaakt en kunnen dus ook geen documenten gestald worden.
+Wanneer
+  * nadat een ZGW-zaak is aangemaakt en deze zaak is succesvol doorgezet naar het ZAAK/DMS systeem (in dat geval is de kolom //dvintzaakcode gevuld//)
+  * EN er naderhand een //ZGW-Creëer rol en contactadres// binnenkomt, waarbij het roltype uuid verwijst naar de intiator-rol (die uuid wordt opgezocht in de tabel tbzgwroltypes: de mogelijke rollen per zaaktype. De adressoort van die gevonden kaart in tbzgwrollen moet verwijzen naar een kaart in tbadressoorten met dvzgwgeneriekeoms = //initiator//).
+dan zal OpenWave alsnog automatisch in een StUF-UpdateZaakbericht deze contactgegevens als initiator doorgegeven aan het ZAAK/DMS.
+Voor een goede ZAAK/DMS koppeling met betrekking tot de initiator aangeleverd via een ZGW-bericht moet het volgende ingesteld worden:
+  * Er moet een instelling zijn met in kolom //Getal1// van //Sectie: ZGW en Item: KeyVoorlopigeAanvrager// een valide verwijzing naar de primary key van een contactadreskaart die gaat functioneren als voorlopige initiator voor de StUF Zaak/DMS -bericht.
+  * Op het detailscherm van het ZGW-zaaktype (zaakbeheerportaal: of tbsoortomgverg of tbsoortovverg) zal in het blok //Roltypes tbv ZGW-api// een rij aanwezig moeten zijn met een gevulde uuid voor het ZGW-roltype die verwijst naar een adressoort met tbadressoort.dvzgwgeneriekeoms = //initiator//
+  * Die initator-adressoort moet gelijk zijn aan het de inhoud van de kolom verplichte adressoort tbsoortomgverg.dvadressoortverpl of tbsoortovverg.dvadressoortverpl) bij het zaaktype
+</adm>
+==== UUID's voor zaaktypes, roltypes en documenttypes, zaakobjecten ====
+OpenWave bepaalt op grond van het doorgegeven zaaktype in het creeer-zaakbericht (vanaf de laatste slash in item zaaktype) of er een zaak aangemaakt moet worden in tbomgvergunning of in tbovvergunningen. Eerst wordt de kolom dvzgwuuid van tbsoortomgverg nagelopen op een match en daarna de kolom dvzgwuuid van tbsoortovverg.
+In deze **zaaktypetabellen tbsoortomgverg en of tbsoortovverg** moeten bij één of meer zaaktypes een unieke UUID-code worden gegenereerd en geplaatst in de kolom dvzgwuuid. Deze code(s) kunnen vervolgens buiten OpenWave om eenmalig gecommuniceerd worden met de zender zodat deze het item zaaktype in de body van het creeer zaakbericht kan vullen. Deze kunnen ook opgehaald worden op het GET endpoint //base-url//api/zgw/catalogi/api/v1/zaaktypen\\.
+Indien de zaak ook door OpenWave aangemaakt moet worden in het externe zaaksysteem/DMS (via de StUF-standaard) dan moeten bij deze zaaktypes de kolom //Verplichte adressoort (rol)// (dvadressoortverpl) gevuld worden met de codering van tbadressoort die gaat gelden als de rol initiator voor het DMS.
+In de **roltypetabel tbzgwroltypes** (koppeltabel tussen de zaaktypes uit tbsoortomgverg en uit tbsoortovverg met de tabel tbadressoort) moeten bij één of meer combinaties zaaktype/adressoort een unieke UUID-code worden gegenereerd en geplaatst in de kolom //tbzgwroltypes.dvzgwuuid//. Deze tabel is via het detailscherm van tbsoortomgverg en/of tbsoortovverg (zaakbeheer) te benaderen in het blok roltypes onder aan de pagina.
+Bij een insert om een roltype toe te voegen aan een zaaktype moet de beheerder kiezen uit de niet-vervallen adressoorten waarvoor geldt dat de kolom dvvantoepop is gevuld met een W (indien aan een omgevingzaaktype wordt gekoppeld) of met een O (indien uit een APV-Overige zaaktype wordt gekoppeld).
+Deze uuid-code(s) moeten vervolgens buiten OpenWave om eenmalig gecommuniceerd worden met de zender zodat deze het item roltype in de body van het creeer rol/contactpersoon-bericht kan vullen.\\
+<adm warning>
+Elke combinatie adressoort en zaaktype heeft dus een eigen uniek uuid.
+Deze roltypen kunnen ook opgehaald worden op het GET endpoint //base-url///api/zgw/catalogi/api/v1/roltypen
+</adm>
+In de **documenttypetabel tbdocumenttype** moeten bij één of meer documenttypes een unieke UUID-code worden gegenereerd en geplaatst in de kolom dvzgwuuid. Deze code(s) moeten vervolgens buiten OpenWave om eenmalig gecommuniceerd worden met de zender zodat deze het item informatieobjecttype in de body van het upload document-bericht kan vullen. In de op te vragen lijst zaaktypen worden de documenttypes (informatieobjecttypen) doorgegeven per zaaktype van de koppeltabel tbzaaktypedocumentsoorten. Deze kunnen ook opgehaald worden op het GET endpoint //base-url//api/zgw/catalogi/api/v1/informatieobjecttypen\\.
+In de **zaakobjecttypentabel tbzgwzaakobjecttypen** (dochtertabel van de zaaktypes uit tbsoortomgverg en tbsoortovverg) kunnen bij één of meer zaaktypes een objecttype met een unieke UUID-code worden geplaatst (de kolommen //tbzgwzaakobjecttypen.dvobjecttype en dvzgwuuid//). Deze tabel is via het detailscherm van tbsoortomgverg en/of tbsoortovverg (zaakbeheer) te benaderen in het blok zaakobjecttypen onder aan de pagina.
+Bij een insert om een zaakobjecttype toe te voegen aan een zaaktype kan de beheerder vooralsnog alleen kiezen uit //medewerker// of //adres//.
+Deze uuid-code(s) moeten vervolgens buiten OpenWave om eenmalig gecommuniceerd worden met de zender zodat deze het item roltype in de body van het creeer rol/contactpersoon-bericht kan vullen.\\
+<adm warning>
+Elke combinatie objecttype en zaaktype heeft dus een eigen uniek uuid.
+Deze uuid's kunnen ook opgehaald worden op het GET endpoint //base-url///api/zgw/catalogi/api/v1/zaakobjecttypen
+</adm>