An integration connecting Open-forms as adding extra documents into the existing cases to the ZDS back-end system. The integration can be configured to host an "Objects API" endpoint that can be configured in Open-forms as "Objects API" registration back-end. Alternatively the integration can be configured to retrieve the object from an "Objects API" when triggered by a notification from the "Notificatie API". This integration does not create a new case but just add the extra documents to the existing cases. Only authorized with DigiD or E-Herkenning users can add extra document to their existing cases.
This integration leverages Frank!Framework and its debugger Ladybug. Ladybug shows for each incoming request the exact steps that were executed to process the message in great detail. If there are errors, this information can be used for easy debugging.
Features:
- Objects API endpoint to configure as registration back-end in Open-forms.
- Notificatie API callback endpoint to retrieve the object given in the notification.
- Filter notifications based on configurable "producttype".
- Register Notificatie API callback endpoint with Notificatie API (subscribe).
- Support for person only with DigiD.
- Support for organisation only with E-Herkenning.
- Fetch exiting case from ZDS.
- Add Open-forms form result pdf case.
- Retrieve form attachments from Documenten API, add document metadata to the case with the Exxellence "document-service", upload the filedata to the document vault with the "mtom-service" and mark the document as uploaded to the vault with the "BasicStatusUpdate-service".
- Translate JSON formdata to XML and add it to the case.
- Automatically prepend JSON key-names that result in llegal element names in XML.
Ensure that Docker is installed on your computer and proceed as follows:
- Clone GitHub project https://github.com/wearefrank/openforms2xxllnc 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 openforms2xxllnc:local .. - Run Openforms2bpel using a command like the following:
docker run -p 8080:8080 -e dtap.stage=LOC --name=openforms2xxllnc openforms2xxllnc:local. - To see the openforms2xxllnc integration running in the Frank!Console, open a webbrowser and visit http://localhost:8080.
- Navigate to "docusaurus" subfolder with
cd ./docusaurus. - Install dependencies with
npm install. - Serve Docusaurus webserver locally with
docusaurus start. By default it is served athttp://localhost:3000/. - Basic guide on how to use Docusaurus and a styleguide can be found at
./docusaurus/docs/_README.md.
- Navigate to "docusaurus" subfolder with
cd ./docusaurus. - Update dependencies with
npm i @docusaurus/core@latest @docusaurus/preset-classic@latest @docusaurus/module-type-aliases@latest @docusaurus/tsconfig@latest @docusaurus/types@latest.