Successor of Open-ZaakBrug, an app for Dutch municipalities that supports the transition from "zaak- en documentatieservices" (zds) to "zaakgericht werken" (zgw).
Dutch municipalities provide services that are delivered many times. An example of such a service is to provide passports. This service is delivered many times because each citizen needs a passport or an ID card. An instance of a service that is provided multiple times is referred by the Dutch word "zaak" (case).
There is a new specification named "zaakgericht werken" (zgw) for case register systems. Zgw is part of the Common Ground specification for software used by Dutch municipalities. Zgw will replace an old specification called "zaak- en documentatieservices" (zds). The municipality of Súdwest Fryslân wants to migrate to the zgw standard without having to invest in zds interfaces. To this end, the municipality has built the system Open-ZaakBrug (brug means bridge). It acts as an interface between a zgw case register system on the one hand and zds systems connecting to the case register system on the other hand. The Open-ZaakBrug source code is hosted on GitHub Sudwest-Fryslan/OpenZaakBrug. For a comparison of zgw and zds see API-standaarden voor Zaakgericht Werken vergeleken met de Zaak- en Documentservices.
This project, ZaakBrug, is meant to be a successor of Open-ZaakBrug. It leverages the Frank!Framework and its debugger Ladybug. The debugger shows for each incoming request which steps are executed to process the message. If there are errors, this information can be used for easy debugging. ZaakBrug does not only connect zds systems with case register system OpenZaak, but with any case register system that implements zgw.
When you are doing development work on ZaakBrug, you may want to boot it using WeAreFrank!'s Frank!Runner. When you use the Frank!Runner, you can boot ZaakBrug from within your Integrated Development Environment (IDE); we support the two IDEs Visual Studio Code and Eclipse.
To boot ZaakBrug using the Frank!Runner, you need version control system Git. Choose or create some empty directory in which you can clone Git repositories. For the sake of the argument, we assume it to be work. Please do the following:
-
Open a command prompt and change directory to
work. -
Clone the Frank!Runner:
git clone https://github.com/ibissource/frank-runner. -
Clone ZaakBrug:
git clone https://github.com/ibissource/zaakbrug. -
Start the Frank!Runner with one of the boot scripts in the Frank!Runner checkout directory:
start.batorrestart.batfor Windows orstart.shorrestart.shfor Linux or Mac. This step lets the Frank!Runner download Ant, a build tool for Java applications. -
Configure your IDE as described in the Frank!Runner's documentation, see https://github.com/ibissource/frank-runner. For VS Code, these instructions let you install the Task Explorer plugin by Scott Meesseman.
-
If your IDE is Visual Studio Code, you should have a link to open ZaakBrug, see number 2 in the figure below. Use the menu option number 1 to get access to the link. Click the link to open ZaakBrug using the Frank!Runner.
In a production environment it is recommended to run ZaakBrug with Docker. Ensure that Docker is installed on your computer and proceed as follows:
-
Clone GitHub project https://github.com/ibissource/zaakbrug if you have not done so yet.
-
Open a command prompt and change directory to the checkout directory.
-
Build your Docker image from the source code using a command like the following:
docker build -t zaakbrug:test .. -
Run ZaakBrug using a command like the following:
docker run -p 8080:8080 -e dtap.stage=LOC --name=zaakbrug zaakbrug:test. -
To see the user interface of ZaakBrug, open a webbrowser and visit http://localhost:8080.
-
ZaakBrug provides an automated health check. You can run it with the following command:
docker inspect --format='{{json .State.Health.Status}}' zaakbrug.Warning: In a DOS command window under Windows, the string after
--format=has to be enclosed between"". You havedocker inspect --format="{{json .State.Health.Status}}" zaakbrug.Info: If you know the Frank!Framework, the following information may be helpful. If the health check produces the value
healthy, it is guarenteed that all adapters in the Frank configuration have booted without errors.
The properties zaakbrug.zgw.zaak-identificatie-template and zaakbrug.zgw.document-identificatie-template can be configured to specify how the zaak- and documentidentificatie should be generated and formatted.
The syntax for variable substitution is as follows {[variable-name][:formatting-string]}
| Variable | Description |
|---|---|
| id | Auto-incrementing identifier with 'D' as formatting option, indicating the amount of digits. Example: {id:D5} with id-123 will result in '00123'. |
| datetime | The current date and time with '[Y]' as formatting option, according to XSLT datetime formatting. Examples:
|