OpenZaak API minimale configuratie

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 Open Zaak 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.
LET OP: indien de client_secret gecrypt wordt opgeslagen, dan moet deze gecrypte 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 1 (robot)
• Voeg de robot toe aan een rechtengroep die minimaal het insertrecht op omgevingzaken heeft (tbomgrechten.dlomgins)
• 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 Open Zaak berichten gaat posten in OpenWave.
OpenWave ondersteunt de 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/

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 Getal1 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 de Items: CheckEenRolContactPerZaak en CheckOpRegistratienummer aan te vinken wordt geregeld dat dubbele registratienummers en/of contacten/rollen worden genegeerd.

LET OP: alleen indien sprake is van StUF Zaak/DMS-koppeling:
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.

In de zaaktypetabel tbsoortomgverg 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.
Indien de zaak ook aangemaakt moet worden in het externe zaaksysteem/DMS (via de StUF-standaard) dan moeten bij deze zaaktypes ook de kolom Verplichte adressoort (rol) (dvadressoortverpl) gevuld worden met de codering van tbadressoort die daartoe aangewezen wordt.
De contactpersoon bij dit roltype geldt dan als initiator voor het DMS.
LET OP er kan in dat geval maar één adressoort gebruikt worden (dus maar één adressoort mag voorzien worden van en unieke UUID-code (zie hieronder).

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.

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.