OpenZaak API minimale configuratie

ZGW OpenZaak Api functionaliteit

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.

In de tabel tbendpointlist (beheerportaal: zie 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.

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.

Waarschuwing

Indien de client_secret gecrypt wordt opgeslagen, dan moet de ONgecrypte versie met de zender worden gecommuniceerd.

Bij de medewerkerskaart:

vul de organistatienaam (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 3 (beide)
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

Vul de kolom Tekst van Sectie: Operations en Item: Servernaam_hyperlink met de base-URL van de OpenWave installatie bijvoorbeeld https://acc.rommeldam.open-wave.nl
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/

OpenWave ondersteunt GET berichten op de endpoints:

api/zgw/catalogi/api/v1/zaaktypen /

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 Creëer ZGW zaak conform OpenZaak API voor een omgevingzaak. Zie aldaar onder kopje Uitzondering extra waarnemings-items.

Door in Sectie:ZGW het Item: CheckEenRolContactPerZaakaan te vinken wordt geregeld dat dubbele contacten/rollen worden genegeerd.

StUF Zaak/DMS-koppeling

Alleen indien sprake is van StUF Zaak/DMS-koppeling, dan vul de kolom Getal1 van Sectie: ZGW en Item: KeyVoorlopigeAanvager met een valide verwijzing naar de primary key van een contactadreskaart die gaat functioneren als 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.

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 (online zijn er diverse programma's die dat kunnen) en geplaatst in de kolom dvzgwuuid. Deze code(s) moeten 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 Opvragen lijst met zaaktypes conform OpenZaak API

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 tbadressoort moeten bij één of meer adressoorten 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 roltype in de body van het creeer rol/contactpersoon-bericht kan vullen. Deze kunnen ook opgehaald worden op het GET endpoint lijst zaaktypen onder het item roltyen : hierbij gaat het dus om de geldige adressoorten die voorzien zijn van een zgwuuid-code en waarbij in de kolom dvvantoepop de leytter O en/of W is opgenomen.

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 tbzaaktypoedocumentsoorten.