diff --git a/README.md b/README.md index 0cfb292d..6a7dbbd2 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # Over de WOO en Open Woo App -> **WooBinar** -> -> Meer weten over deze oplossing? Dat kan! Vanuit de aangesloten leveranciers worden regelmatig webinars georganiseerd. +> **Ondersteuning en bijeenkomsten** > +> Meer weten over deze oplossing? Dat kan! Hiervoor hebben we een appart [slack kanaal](https://samenorganiseren.slack.com/archives/C067Q3UE9F0) binnen commonground. We helpen je daar graag verder +> +> Tevens worden vanuit de aangesloten leveranciers worden regelmatig webinars georganiseerd. +> > Terug kijken afgelopen webinars? -> [xxllnc Woobinar 17-11-2023](https://www.youtube.com/watch?v=NCnLDEoPh5A) +> - [xxllnc Woobinar 17-11-2023](https://www.youtube.com/watch?v=NCnLDEoPh5A) De Wet Open Overheid (WOO) is een initiatief gericht op het verbeteren van de openbaarheid van overheidsinformatie. Het doel is om overheidsinformatie beter toegankelijk te maken voor iedereen. Meer informatie over de Wet Open Overheid kan [hier](https://www.open-overheid.nl/themas/wet-open-overheid/) worden gevonden. @@ -17,7 +19,7 @@ De implementatie van de Wet Open Overheid brengt twee kernuitdagingen met zich m 2. **Proactieve Publicatie:** Overheden moeten informatie proactief te publiceren. Dit betekent dat publicatie onderdeel moet worden van het normale werkproces. Hiermee is het richting de toekomst niet haalbaar om Woo-publicaties handmatig via een apart systeem (bijvoorbeeld CMS website) te laten verlopen. -Deze uitdagingen kunnen niet effectief worden aangepakt met een enkel Content Management Systeem (CMS) of door levering vanuit één systeem. Handmatige publicatie van alle overheidsinformatie zou een aanzienlijke personele inzet vereisen, wat onpraktisch is. Daarbij komt dat de verscheidenheid aan publicatietypen vaak verdeeld is over meerdere systemen, wat de situatie verder compliceert. +Deze uitdagingen kunnen niet effectief worden aangepakt met een enkel Content Management Systeem (CMS) of door levering vanuit één systeem. Handmatige publicatie van alle overheidsinformatie zou een aanzienlijke personele inzet vereisen, wat onpraktisch is. Daarbij komt het voor dat verscheidende categorieën vaak verdeeld zijn over meerdere systemen, wat de situatie verder compliceert. ## Oplossing @@ -30,7 +32,7 @@ De Open Woo-app biedt een geïntegreerde oplossing die bestaat uit een aantal ho Een interface waarmee belanghebbenden binnen een organisatie naar relevante informatie kunnen zoeken. 3. **Koppelvlak:** - Een module die in staat is om informatie uit verschillende systemen te verzamelen, waardoor een gecentraliseerde toegang tot diverse publicatietypen mogelijk wordt. + Een module die in staat is om informatie uit verschillende systemen te verzamelen, waardoor een gecentraliseerde toegang tot diverse categorieën mogelijk wordt. 4. **CMS-module:** Een aanvullende module voor het handmatig invoeren van informatie die niet automatisch kan worden opgehaald, en voor het beheren van de gepubliceerde pagina's. @@ -73,8 +75,8 @@ De Woo specificeert een aantal categorieën (zie configuratie) die door een orga ## Praktijk voorbeelden Op dit moment wordt de OpenWoo.app al door een aantal organisaties gebruikt -| Organisatie | Type | Woo Pagina | Woo Bron(en) | Zaaksysteem | Status | -|-------------|------|------------|--------------|-------------|--------| +| Organisatie | Type | Woo Pagina | Woo Bron | Status | +|-------------|------|------------|--------------|--------| | [Noordwijk](https://www.noordwijk.nl/) | Gemeente | [Pagina](https://conductionnl.github.io/woo-website-noordwijk/) | Zaaksysteem.nl | Acceptatie | | [Tubbergen](https://www.tubbergen.nl/) | Gemeente |[Pagina](https://conductionnl.github.io/woo-website-tubbergen/) | Zaaksysteem.nl | Acceptatie | | [Epe](https://www.epe.nl/) | Gemeente |[Pagina](https://open.epe.nl/) | Zaaksysteem | Productie | diff --git a/docs/Architectuur.jpeg b/docs/Architectuur.jpeg new file mode 100644 index 00000000..0593cd6f Binary files /dev/null and b/docs/Architectuur.jpeg differ diff --git a/docs/Architectuur.md b/docs/Architectuur.md index 5cff9790..fc7c792d 100644 --- a/docs/Architectuur.md +++ b/docs/Architectuur.md @@ -1,75 +1,109 @@ # Architectuur -## Woo Publicatie Object - -Het Woo Publicatie Object vormt de kern van zowel de Woo API als de Woo-website. Dit object bevat alle essentiële informatie over een Woo-publicatie, inclusief metadata, publicatiedatum, bijlagen en andere relevante eigenschappen. Het dient als de centrale entiteit waaromheen de functionaliteiten van de API en de website zijn gebouwd. Door deze gecentraliseerde aanpak is het eenvoudiger om Woo-publicaties efficiënt te beheren, op te halen en weer te geven, en draagt het bij aan een coherente en gestroomlijnde gebruikerservaring. +## Opzet -Toegepaste norm: [NL API Strategie over property namen](https://docs.geostandaarden.nl/api/cv-hr-API-Strategie-20190213/#veldnamen-in-snake_case-camelcase-uppercamelcase-of-kebab-case) +OpenWoo.app bestaat in essentie uit een aantal componenten die samenwerken rondom een integratievoorziening, het lijnt daarmee uit met de architectuurlagen van Common Ground. Daarbij is de keuze aan de ontsluitende overheid welke componenten van welke leveranciers zij inzet. Het is daarmee bewust de bedoeling dat de inrichting per overheid kan verschillen, zodat deze beter in het landschap van die betreffende overheid past. Binnen de OpenWoo.app kennen we momenteel de volgende componenten: -## Varianten +> **Hulp nodig?** +> +> Hiervoor hebben we een appart [slack kanaal](https://samenorganiseren.slack.com/archives/C067Q3UE9F0) binnen commonground. We helpen je daar graag verder. -### Open Webconcept variant +### Open Webconcept-variant zonder integratie -Met deze variant kunnen Woo-verzoeken en convenanten eenvoudig worden beheerd vanuit de bestaande webomgeving en CMS door middel van een directe koppeling met de gateway. Dit vereist geen extra installatie of beheerinspanningen van de organisatie, op voorwaarde dat er al een OpenWebconcept-installatie met de benodigde plugins beschikbaar is. Dit biedt een serverloze en kostenefficiënte oplossing door het hergebruik van bestaande Common Ground-componenten. +Met deze variant kunnen Woo-verzoeken en convenanten eenvoudig worden beheerd vanuit de bestaande webomgeving en CMS . Dit vereist geen extra installatie of beheerinspanningen van de organisatie, op voorwaarde dat er al een OpenWebconcept-installatie met de benodigde plugins beschikbaar is. **Nadelen:** - Woo-verzoeken en convenanten moeten handmatig worden geüpload in de CMS-omgeving. -- De zoekbalk wordt niet ondersteund. +- De integrale zoekvraag wordt alleen ondersteund op de in WordPress aanwezige gegevens. -![OpenWeb Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/openweb.svg) +![OpenWeb Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/OpenWebconceptZonder.svg) -### Common Gateway variant +### Open Webconcept met integratie -Deze variant maakt het mogelijk om de front-end te koppelen aan een Common Gateway-installatie met de Open Woo-plugin. Dit biedt de mogelijkheid om direct te koppelen aan het zaaksysteem, waardoor Woo-verzoeken en convenanten automatisch kunnen worden gepubliceerd. Dit bespaart handmatig werk en vermindert de kans op fouten. De zoekbalk wordt in deze variant wel ondersteund. Het is tevens mogelijk om gegevens uit andere bronnen te integreren, zoals een raadsinformatiesysteem of een Open Webconcept CMS. +Het is ook mogelijk om een bestaande Open Webconcept-omgeving te combineren met de integratievoorziening. In dat geval gebruikt de integratievoorziening Open Webconcept, zowel als bron als dat het naar Open Webconcept toe publiceert. Dit betekent dat de organisatie de voordelen van de integratievoorziening kan benutten, terwijl de bestaande Open Webconcept-omgeving kan worden gebruikt om Woo-verzoeken en convenanten te beheren. -**Nadelen:** +**Nadelen** -- De organisatie moet de Common Gateway zelf installeren of als SaaS afnemen. +- Er moet een integratievoorziening worden geïnstalleerd of afgenomen -![Commongateway Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/commongateway.svg) +![OpenWeb Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/OpenWebconceptMet.svg) -### Ophalen informatie +### (Losse) Frontend met integratie -De Open Woo-plugin "scraped" elke nacht alle relevante zaken. De stappen zijn als volgt: +Er zijn diverse frontends die in theorie direct kunnen koppelen op de OpenWoo.app API. -1. Ophalen van alle zaaktypen. -2. Per zaaktype worden de beschikbare eigenschappen gecontroleerd (zie inrichting zaaksysteem). -3. Voor elk zaaktype dat aan de voorwaarden voldoet, worden de zaken opgehaald. -4. Per zaak wordt gecontroleerd of er een publicatiedatum is; zo ja, wordt de zaak opgenomen in de index. -5. Zaken die niet zijn gevonden in bovenstaande loop maar wel in de index staan, worden verwijderd. +**Voordelen** + +- De frontend hoeft maar één API te koppelen voor toegang tot meerdere bronnen. +- De gebruiker kan een integrale zoekvraag over meerdere bronnen heen stellen (bijvoorbeeld aan zowel een zaaksysteem als een raadsinformatiesysteem). +- Als de frontend zelf een CMS is, kan deze ook als bron dienen (voor bijvoorbeeld nieuwsberichten en categorieomschrijvingen) +- Componenten zijn te combineren (bijvoorbeeld de losstaande NL Design React voorkant op de Open Webconcept-verzoeken en -convenanten plugins). + +**Nadelen** -Dit proces zorgt ervoor dat het zaaksysteem leidend is en dat zaken zowel kunnen worden gepubliceerd als gedepubliceerd. +- Er moet een integratievoorziening worden geïnstalleerd of afgenomen -## Federatie via OpenCatalogi +**Beschikbare componenten voor frontend** +| Component | Framework | Open Source | Leveranciers | Beschrijving | +|-------------|------|------|------------|--------------| +| OpenWOO Site | NL Design (React) | Ja | [Conduction](https://conduction.nl/) | Een losse NL Design zoekpagina in de huisstijl van uw organisatie | +| OpenWoo Plugin | Wordpress | Ja | [Yard](https://www.yard.nl/), [Acato](https://acato.nl/) | Een NL Design weergave component voor wWordPress-websites | +| Open Gemeente | Typo-3 | Ja | [Open Gemeente](https://www.opengemeenten.nl/) | Een weergave component voor Typo3-websites | +| SIM Drupal | Drupal | ? | [Sim Groep](https://www.simgroep.nl/) | Een weergave component voor Drupal | -OpenWoo.app maakt gebruik van het federatieve stelstel van OpenCatalogi om de verschillende varianten te kunnen ontsluiten. Dit betekent dat organisaties zelf kunnen bepalen welke variant ze willen gebruiken en dat ze niet afhankelijk zijn van een centrale partij. +> **notice** +> Voor Open Source componenten bent u natuurlijk niet beperkt tot deze leveranciers, dit zijn de op dit moment bij ons bekende leveranciers. +> +> Weet u niet welk frontend framework uw organisatie op dit moment gebruikt? Kijk dan eens op [digimonitor](https://www.digimonitor.nl/cms-en/gemeenten/). +> +![OpenWeb Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/LosseFrontend.svg) -## Landelijke API +### Bronnen met integratie -Iedereen kan de landelijke API bevragen om alle Woo-verzoeken en convenanten op te halen. De API is gebaseerd op de [NL API Strategie](https://docs.geostandaarden.nl/api/cv-hr-API-Strategie-20190213/). +Als er wordt gekozen voor het implementeren van het integratievoorziening, wordt het mogelijk om geautomatiseerd te publiceren vanuit meerdere bronnen. -(wordt nog aangevuld) +Dit bespaart handmatig werk en vermindert de kans op fouten. Tevens ondersteunt het gebruik van het integratiemechanisme de integrale zoekvraag en is het mogelijk om ook gegevens uit andere bronnen te integreren, zoals een raadsinformatiesysteem of een Open Webconcept CMS. -## Componenten +**Nadelen** -Een variant bestaat uit een aantal componenten die samen de functionaliteit van de variant vormen. Deze componenten zijn: +- Er moet een integratievoorziening worden geïnstalleerd of afgenomen -- [Woo API]() -- [Woo Website]() -- [Woo Plugin]() -- [Woogle](https://woogle.wooverheid.nl/search?q=*) -- [Raadsinformatie Systeem]() -- [KOOP-index]() -- [Common Gateway]() -- [Open Webconcept CMS]() -- [Zaaksysteem]() +**Beschikbare componenten voor bronnen** +| Component | Framework | Open Source | Leveranciers | Beschrijving | +|-------------|------|------|------------|--------------| +|Zaaksysteem.nl | ZGW | Ja | [Xxllnc](https://xxllnc.nl/) |--------------| +|RX Fundament | ZGW | Nee | [Roxit](https://www.roxit.nl/) |--------------| +|Decos Join | ZGW | Nee | [Decos](https://www.decos.com/nl) |--------------| +|Open Zaak | ZGW | Ja | [Maykin media](https://www.maykinmedia.nl/nl/) |--------------| -Alle componenten worden getest met [zaaksysteem.nl](https://xxllnc.nl/zaakgericht/), Rx.Fundament en Decos JOIN +![OpenWeb Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/Bronnen.svg) -## Verschil OpenWoo.app en de OpenWoo plugin +### Hoe werkt dat scrapen vanuit de integratievoorziening? -De OpenWoo.app is een verzameling van componenten die samen een oplossing vormen voor het publiceren van Woo-verzoeken en convenanten. De OpenWoo plugin is een onderdeel van deze oplossing en kan worden gebruikt om Woo-verzoeken en convenanten te publiceren vanuit een Open Webconcept CMS. De OpenWoo plugin is een onderdeel van deze oplossing en kan worden gebruikt om Woo-verzoeken en convenanten te publiceren vanuit een Open Webconcept CMS. +De integratievoorziening "scraped" elke nacht alle relevante informatie en bouwt hier een organisatie-specifieke index over op. De stappen zijn als volgt: + +1. Ophalen van alle zaaktypen. +2. Per zaaktype worden de beschikbare eigenschappen gecontroleerd (zie inrichting zaaksysteem). +3. Voor elk zaaktype dat aan de voorwaarden voldoet, worden de zaken opgehaald. +4. Per zaak wordt gecontroleerd of er een publicatiedatum is; zo ja, wordt de zaak opgenomen in de index. +5. Zaken die niet zijn gevonden in bovenstaande loop, maar wel in de index staan, worden verwijderd. + +Dit proces zorgt ervoor dat het zaaksysteem leidend is en dat zaken zowel kunnen worden gepubliceerd als worden gedepubliceerd. + +## Federatie (via OpenCatalogi) + +OpenWoo.app maakt gebruik van het federatieve stelsel van [OpenCatalogi](https://opencatalogi.nl/) om verschillende integratievoorzieningen samen te binden. Hierbij verhoudt de organisatiespecifieke voorziening zich tot wat we binnen OpenCatalogi een catalogus noemen. + +Dat betekent dat de integrale zoekvraag ook organisatie-overstijgend kan worden gesteld aan meerdere organisatie tegelijkertijd zonder dat er noodzaak is voor een landelijke index, dit concept is verder uitgewerkt in [koophulpje.nl](https://koophulpje.nl/) waarbij ook een voorziening is gerealiseerd voor het genereren van `robot.txt` en `sitemap.xml` bestanden. De facto is hiermee dus ook een landelijke Woo-API gerealiseerd met de beperking dat deze alleen organisaties bevat die participeren in OpenWoo.app + +De reden dat we hebben gekozen voor OpenCatalogi is dat in deze `variant` van FSC géén PKI of overige certificaten nodig zijn. Dat lijnt beter uit met de gedachte dat dit open data betreft die conform de wet juist anoniem toegankelijk zou moeten zijn. + +![OpenWeb Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/Federatie.svg) + +## Woo Publicatie Object + +Het Woo Publicatie Object vormt de kern van zowel de Woo API als de Woo-website. Dit object bevat alle essentiële informatie over een Woo-publicatie, inclusief metadata, publicatiedatum, bijlagen en andere relevante eigenschappen. Het dient als de centrale entiteit waaromheen de functionaliteiten van de API en de website zijn gebouwd. Door deze gecentraliseerde aanpak is het eenvoudiger om Woo-publicaties efficiënt te beheren, op te halen en weer te geven, en draagt het bij aan een coherente en gestroomlijnde gebruikerservaring. ## Roadmap diff --git a/docs/Bronnen.puml b/docs/Bronnen.puml new file mode 100644 index 00000000..b6ea3695 --- /dev/null +++ b/docs/Bronnen.puml @@ -0,0 +1,29 @@ +@startuml +title Integratie op bronnen + +' User Interface Component +interface "Een of meerdere afnemers" as Afnemer + +' Backend Components +component "Integratie" as Integratie +component "Zaaksysteem" as Zaaksysteem +component "CMS" as CMS +component "Raads informatie systeem" as Raadsinfo +component "eDepot" as eDepot +component "DMS" as DMS +component "VTH" as VTH + +' Relationships +Afnemer -down-> Integratie : Directly connected +Integratie -down-> CMS : Scrapes periodically\nUses as source +Integratie -down-> Zaaksysteem : Scrapes periodically\nUses as source +Integratie -down-> Raadsinfo : Scrapes periodically\nUses as source +Integratie -down-> eDepot : Scrapes periodically\nUses as source +Integratie -down-> DMS : Scrapes periodically\nUses as source +Integratie -down-> VTH : Scrapes periodically\nUses as source + +' Notifications +CMS -up-> Integratie : Notifies of changes or deletes +Zaaksysteem -up-> Integratie : Notifies of changes or deletes + +@enduml \ No newline at end of file diff --git a/docs/Bronnen.svg b/docs/Bronnen.svg new file mode 100644 index 00000000..ac9f386c --- /dev/null +++ b/docs/Bronnen.svg @@ -0,0 +1 @@ +Integratie op bronnenEen of meerdere afnemersIntegratieZaaksysteemCMSRaads informatie systeemeDepotDMSVTHDirectly connectedScrapes periodicallyUses as sourceNotifies of changes or deletesScrapes periodicallyUses as sourceNotifies of changes or deletesScrapes periodicallyUses as sourceScrapes periodicallyUses as sourceScrapes periodicallyUses as sourceScrapes periodicallyUses as source \ No newline at end of file diff --git a/docs/Configuratie.md b/docs/Configuratie.md index 15bd55d3..56caaa37 100644 --- a/docs/Configuratie.md +++ b/docs/Configuratie.md @@ -56,7 +56,7 @@ Daarnaast is het mogelijk om bijlagen van publicaties te clusteren aan de hand v ## Categorieën -Hoewel we er vanuit gaan dat categorieën voldoen aan de onder [Algemene inrichting zaaksysteem]() vermelde kenmerken voor `woo_categorie` is het technisch mogelijk voor organisaties om eigen categorieën te hanteren. Het toevoegen van een eigen categorie (e.g. algoritme's of dataset) leidt er automatisch toe dat deze in de voorkant wordt opgenomen in de `onderwerpen` lijst (mits er ten minimale één publicatietype van deze categorie gepubliceerd is). Deze toegevoegde categorie en publicaties daarin worden echter **NIET** doorgegeven aan de landelijke index van KOOP. +Hoewel we er vanuit gaan dat categorieën voldoen aan de onder [Algemene inrichting zaaksysteem]() vermelde kenmerken voor `woo_categorie` is het technisch mogelijk voor organisaties om eigen categorieën te hanteren. Het toevoegen van een eigen categorie (e.g. algoritmes of dataset) leidt er automatisch toe dat deze in de voorkant wordt opgenomen in de `onderwerpen` lijst (mits er ten minimale één publicatietype van deze categorie gepubliceerd is). Deze toegevoegde categorie en publicaties daarin worden echter **NIET** doorgegeven aan de landelijke index van KOOP. ## Bijlagen diff --git a/docs/Federatie.puml b/docs/Federatie.puml new file mode 100644 index 00000000..79fd62fd --- /dev/null +++ b/docs/Federatie.puml @@ -0,0 +1,25 @@ +@startuml +title Federatie + +' User Interface Component +interface "Landelijke API" as Api + +' Backend Components +component "NLX/FSC/FDS" as NLX +component "Intergratie voorziening Org 1" as Org1 +component "Intergratie voorziening Org 2" as Org2 +component "Intergratie voorziening Org 3" as Org3 +component "Bronnen" as BronnenOrg1 +component "Bronnen" as BronnenOrg2 +component "Bronnen" as BronnenOrg3 + +' Relationships +Api -down-> NLX : Connected trough outway +NLX -down-> Org1 : Connected trough inway +NLX -down-> Org2 : Connected trough inway +NLX -down-> Org3 : Connected trough inway +Org1 -down-> BronnenOrg1 : Internal connection +Org2 -down-> BronnenOrg2 : Internal connection +Org3 -down-> BronnenOrg3 : Internal connection + +@enduml \ No newline at end of file diff --git a/docs/Federatie.svg b/docs/Federatie.svg new file mode 100644 index 00000000..9acea2f9 --- /dev/null +++ b/docs/Federatie.svg @@ -0,0 +1 @@ +FederatieLandelijke APINLX/FSC/FDSIntergratie voorziening Org 1Intergratie voorziening Org 2Intergratie voorziening Org 3BronnenBronnenBronnenConnected trough outwayConnected trough inwayConnected trough inwayConnected trough inwayInternal connectionInternal connectionInternal connection \ No newline at end of file diff --git a/docs/FooterContent.json b/docs/FooterContent.json index b38ee557..eb8de561 100644 --- a/docs/FooterContent.json +++ b/docs/FooterContent.json @@ -1,6 +1,6 @@ [ { - "title": "Documentatie", + "title": "Over", "items": [ { "value": "Architectuur", @@ -18,7 +18,7 @@ "markdownLink": "https://github.com/ConductionNL/woo-website-template/blob/main/docs/Privacyverklaring.md" }, { - "value": "Security", + "value": "Beveiliging", "type": "readme", "markdownLink": "https://github.com/ConductionNL/woo-website-template/blob/main/docs/SECURITY.md" }, @@ -31,26 +31,41 @@ "value": "Roadmap", "type": "readme", "markdownLink": "https://github.com/ConductionNL/woo-website-template/blob/main/docs/Roadmap.md" + }, + { + "value": "Veel gestelde vragen", + "type": "readme", + "markdownLink": "https://github.com/ConductionNL/woo-website-template/blob/main/docs/FAQ.md" } ] }, { - "title": "Installatie", + "title": "Techniek", "items": [ + { + "value": "Naar Productie", + "type": "readme", + "markdownLink": "https://github.com/ConductionNL/woo-website-template/blob/main/docs/Productie.md" + }, + { + "value": "Architectuur", + "type": "readme", + "markdownLink": "https://github.com/ConductionNL/woo-website-template/blob/main/docs/Architectuur.md" + }, { "value": "Installatie", "type": "readme", "markdownLink": "https://github.com/ConductionNL/woo-website-template/blob/main/docs/Installatie.md" }, { - "value": "Configuratie", + "value": "Integratie", "type": "readme", - "markdownLink": "https://github.com/ConductionNL/woo-website-template/blob/main/docs/Configuratie.md" + "markdownLink": "https://github.com/ConductionNL/woo-website-template/blob/main/docs/Integratie.md" }, { - "value": "Naar Productie", + "value": "Configuratie", "type": "readme", - "markdownLink": "https://github.com/ConductionNL/woo-website-template/blob/main/docs/Productie.md" + "markdownLink": "https://github.com/ConductionNL/woo-website-template/blob/main/docs/Configuratie.md" }, { "value": "Testscenario's", diff --git a/docs/HeaderContent.json b/docs/HeaderContent.json index 9e194558..e043a378 100644 --- a/docs/HeaderContent.json +++ b/docs/HeaderContent.json @@ -96,6 +96,15 @@ }, "handleClick": { "link": "https://github.com/ConductionNL/woo-website-template/blob/main/docs/Installatie.md" } }, + { + "label": "Integratie", + "type": "markdown", + "current": { + "pathname": "/over/us", + "operator": "equals" + }, + "handleClick": { "link": "https://github.com/ConductionNL/woo-website-template/blob/main/docs/Integratie.md" } + }, { "label": "Configuratie", "type": "markdown", diff --git a/docs/Installatie.md b/docs/Installatie.md index c0bd2d2b..078e6190 100644 --- a/docs/Installatie.md +++ b/docs/Installatie.md @@ -64,12 +64,14 @@ Configuratie vindt plaats via environment (env) waardes. In het geval van een se Voor de backend zijn twee opties beschikbaar. In beide gevallen moet de resulterende URL worden opgenomen onder `API_BASE_URL` in de frontend-configuratie. ### Open Webconcept met Open Woo en Open Convenanten Plugin -In dit geval koppel je de react frontend rechtstreek op een wordpress installatie, dat betekend dat alle publicaties handmatig moeten worden geupload. + +In dit geval koppel je de React frontend rechtstreeks op een WordPress installatie, dat betekent dat alle publicaties handmatig moeten worden geüpload. Volg de installatiehandleiding op [https://github.com/OpenWebconcept/plugin-openwoo](https://github.com/OpenWebconcept/plugin-openwoo) en op [https://github.com/OpenWebconcept/plugin-openconvenanten](https://github.com/OpenWebconcept/plugin-openconvenanten). ### Common Gateway met Open Woo Plugin -In dit geval koppel je de react frontend op een gatewat installatie, dat betekend dat alle publicaties automatisch worden opgehaald uit bestaande bronnen. + +In dit geval koppel je de React frontend op een gateway installatie, dat betekent dat alle publicaties automatisch worden opgehaald uit bestaande bronnen Volg de installatiehandleiding op [Woo Bundle](https://github.com/ConductionNL/WooBundle/tree/main). diff --git a/docs/Integratie.md b/docs/Integratie.md new file mode 100644 index 00000000..aae7d956 --- /dev/null +++ b/docs/Integratie.md @@ -0,0 +1,177 @@ +# Integratie + +OpenWoo.app is essentie een koppelvlak waar aan de bovenkant meerdere weergaven of user interfaces op kunnen worden gekoppeld en aan de onderkant meerdere bronnen ontsloten. + +> **Hulp nodig?** +> +> Hiervoor hebben we een appart [slack kanaal](https://samenorganiseren.slack.com/archives/C067Q3UE9F0) binnen commonground. We helpen je daar graag verder. + +## Het koppelen van een user interface + +Als u als organisatie of leverancier OpenWoo.app wilt koppelen aan een huidige interface (bijvoorbeeld door de resultaten uit uw gemeente in uw website te integereren) and kunt u daarvoor gebruikmaken van de OpenWoo.app API. + +### Locatie en Authenticatie + +U vindt de API op [https://api.gateway.commonground.nu/api/publicaties](https://api.gateway.commonground.nu/api/publicaties). Voor het stellen van zoekvragen is géén authenticatie vereist (het doel van OpenWOO.app is immers het verspreiden van openbare informatie). Er is echter wel sprake van throttling op response tijden (de API reageert langzamer) en rate-limiting (het aantal bevragingen per minuut en uur zijn beperkt) zonder authenticatie. Ook zijn alleen de GET (ophalen) acties toegestaan zonder authenticatie. + +Als u vanuit uw casus een API nodig heeft zonder throttling, ratelimit of namens een organisatie wijzigingen wilt doen (POST,PUT,DELETE) dan kunt u een mail sturen naar . + +### Documentatie + +Voor de API is een [redoc documentatie](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/oas.yaml) beschikbaar met voorbeelden van de verschillende API endpoints, calls en resultaten. Omdat de API daarnaast kan worden gebruikt zonder authenticatie is deze ook goed te beproeven via onze [Postman collectie](). We raden developers van ook van harte aan om aan de hand van deze collectie te spelen en ontwikkelen. + +### Voorbeelden + +In het merendeel van de gevallen zult u een zoekvraag willen uitvoeren binnen de Woo publicaties van OpenWoo.app, het endpoint daarvoor is: . Er zijn 4 voor de hand liggende zoekparameters waarmee gezocht wordt (overige opties vind u terug in de [Redoc documentatie]()). + +1. Op een of meerdere zoek woorden, b.v. `_search=test` +2. Op organisatie, dit gaat aan de hand van OIN (de volledige OIN lijst vind u [hier](https://oinregister.logius.nl/oin-register)) b.v. `oin=00000001001299992000` +3. Op categorie, `categorie=Convenant` +4. Op datum, Hierbij kunt u een begin en eindatum opgeven om een periode (bijvoorbeeld jaar) te doorzoeken publicatiedatum[after]=2022-12-31T23:59:59Z&publicatiedatum[before]=2024-01-01T00:00:00Z& + +````cli +GET 'https://api.gateway.commonground.nu/api/publicaties?extend[]=all&_search=Afvalwaterakkoord&_order[publicatiedatum]=desc&_limit=12&_page=1' + +Response + +{ + "results": [ + { + "_id": "3c75db6d-55b5-48da-aef8-a5768dd8ec89", + "id": "3082", + "titel": "Afvalwaterakkoord", + "beschrijving": null, + "samenvatting": "In dit bestuursakkoord is afgesproken door de koepelorganisaties, dat het waterschap en de gemeenten moeten samenwerken in de afvalwaterketen "als ware het één bedrijf’.", + "categorie": "Convenant", + "publicatiedatum": "2023-11-24 11:31:47", + "portalUrl": "https://conductionnl.github.io/woo-website-epe/19cdec3f-896f-4765-8d62-c6c8570926b7", + "bijlagen": [ + { + "id": null, + "titel": "Naam_Bijlage", + "categorie": null, + "type": null, + "status": null, + "url": "https://openpub.ridderkerk.nl/wp-content/uploads/sites/3/2023/02/ondertekend-afvalwaterakkoord-Ridderkerk-2022.pdf" + } + ], + "themas": [ + { + "hoofdthema": "Milieu", + "subthema": null, + "aanvullendThema": null + } + ], + "organisatie": { + "naam": "Gemeente Ridderkerk", + "rsin": null, + "tooi": null, + "oidn": "ridderkerk", + "id": "37165afb-0e33-4813-8f66-d504501e6128" + }, + "metadata": { + "volgnummer": null, + "besluitdatum": "2022-12-21", + "verzoek": { + "inventarisatielijst": { + "categorie": null, + "type": null, + "status": "accepted", + "url": "http://localhost/api/view-file/f9358a25-ee51-4079-a1d1-e98d53c4ca80", + "titel": "Temporarily title so a object gets created for file fetching and url genering.", + "id": null + }, + "informatieverzoek": { + "categorie": null, + "type": null, + "status": "accepted", + "url": "http://localhost/api/view-file/f723f34c-ef3d-453b-b395-fe60b5127cde", + "titel": "Temporarily title so a object gets created for file fetching and url genering.", + "id": null + }, + "besluit": { + "categorie": null, + "type": null, + "status": "accepted", + "url": "http://localhost/api/view-file/4b7978e8-6cf9-469e-b27c-08f895e5f653", + "titel": "Temporarily title so a object gets created for file fetching and url genering.", + "id": null + }, + "termijnoverschrijding": null, + "ontvangstdatum": "2023-10-02T10:31:12Z", + "ontvangerInformatieverzoek": null, + "status": null + }, + "id": "8e1084b5-ba4d-4d33-a5c2-f98e7f893f07" + } + } + ], + "count": 1, + "limit": 12, + "total": 1, + "offset": 0, + "page": 1, + "pages": 1 +} +```` + +Vanuit een het weergeven van een zoekformulier is het goed mogelijk dat u alleen bestaande waardes wilt weergeven (bijvoorbeeld bij jaartal of categorie). U kunt daarvoor de queries parameter gebruiken, deze verteld u welke zoekwaarde welke resultaten opleveren. + +````cli +GET 'https://api.gateway.commonground.nu/api/publicaties?_queries[]=categorie' + +Response + +{ + "categorie": [ + { + "_id": "Woo verzoek", + "count": 36 + }, + { + "_id": "Convenant", + "count": 9 + } + ] +} +```` + +### Metadata +De kern gegevens van een WOO publicatie zitten in het metadata object, de inhoud van dit object is 'semi' vrij, hij kan per publicatie `categorie` verschillen. Daarnaast zijn er een paar algemene properties die altijd kunnen voorkomen in de metadata + +#### Algemene properties + +| Property | Verplicht | Gebruik | Toegestane waardes | +|---------------------|-----------|---------------------------------------------------------------------------------------------------------|--------------------| + + +#### Convenanten + +| Property | Verplicht | Gebruik | Toegestane waardes | +|---------------------|-----------|---------------------------------------------------------------------------------------------------------|--------------------| + +#### Woo verzoeken + +| Property | Verplicht | Gebruik | Toegestane waardes | +|---------------------|-----------|---------------------------------------------------------------------------------------------------------|--------------------| + +#### Klachten + +| Property | Verplicht | Gebruik | Toegestane waardes | +|---------------------|-----------|---------------------------------------------------------------------------------------------------------|--------------------| + +### Spelregels + +- Er mogen géén kopiën worden gemaakt van data uit de API, dit zodat overheden de mogelijkheid hebben data te depubliceren (bijvoorbeeld bij het per abuis publiceren van persoonsgegevens) +- Er mag wel gebruik worden gemaakt van caching voor het verbeteren van performance, maar er mag niet langer worden gecachet dan aangegeven in de caching header van het responseobject. Ofwel de bron bepaald hoe lang er gecachet mag worden. + +## Het koppelen van een bron + +Er zijn twéé manieren waarop een bron kan worden gekoppeld, beide vereisen dat de bron beschikt over een koppelvlak dat benaderbaar is door de OpenWoo.app. + +1. **De bron biedt een reeds door OpenWoo.app ondersteund koppelvlak aan of ontwikkelt deze.** Dit is vanuit de OpenWoo.app natuurlijk de snelste route +2. **OpenWoo.app ontwikkeld ondersteuning voor een bron specifiek koppelvlak.** Deze route vergt minder van de aan te sluiten bron (die zal doorgaans al over een koppelvlak zo als API beschikken). Maar vergt inspanning aan de kant van de OpenWoo.app leveranciers. Daarnaast zal de OpenWoo.app community akkoord moeten gaan met de ontwikkeling en bekostiging (in de praktijk zal de aanvragen worden gevraagd de kosten te dekken). + +## Het koppelen van een organisatie + +Zie voor het koppelen van een organisatie de [naar productie pagina](https://openwoo.app/github/Naar_Productie/?link=https://github.com/ConductionNL/woo-website-template/blob/main/docs/Productie.md). diff --git a/docs/KoopHulp.md b/docs/KoopHulp.md new file mode 100644 index 00000000..b70102a1 --- /dev/null +++ b/docs/KoopHulp.md @@ -0,0 +1,36 @@ +# Koop Hulp(je) + +Vanuit de gemeente Buren is Koophulpje.nl opgezet. Het doel van Koophulpje is het doen van een proof of concept (poc) met de OpenWoo.app en het stellen van integrale zoek vragen aan de hand van het federale data stelsel (FSC) en API's. + +## Voorgeschiedenis + +asd + +## Voordelen + +- Het uitvragen van informatie via API's is gemakkelijker te integreren dan sitemap.xml +- Het uitvragen van informatie via API's maakt de sitemap.xml overbodig +- Het federaliseren van de API's maakt een index onnodig + +## Opzet + +- Koophulpje.nl is een 'platte' React pagina, ze beschikt niet over een eigen server, maar maakt direct gebruikt van één API +- Deze API bevat de gegevens van meerdere gemeenten aan de hand van federale bevraging +- Ter vergelijking creëren we ook sitemap en robot bestanden voor dezelfde gemeenten t.b.v van de door KOOP voorgestelde harverster + +## Bevindingen + +Dataveiligheid: Tijdens vroege testen kwam snel naar voren dat het via API de bron bevragen in plaats van het opbouwen van een index een databeveiligheidsverbeteringen opleverde. Foutieve test data kon snel worden verwijderd en was na verwijdering in het bronsysteem geen onderdeel meer van het federale netwerk en daardoor niet meer vindbaar via Koophulpje. +Hoewel dit bij het testen vooral fijn was, levert het bij daadwerkelijke productie gang een sterk voordeel op. Het stelt organisaties in staat om gegevens terug te trekken. Bijvoorbeeld bij het per ongeluk publiceren van persoonsgegevens kunnen de gegevens onmiddellijk worden teruggetrokken (i.p.v. dat er moet worden gewacht op de volgende keer data de harvester langs komt). + +Schaalbaarheid: Het generen van sitemap.xml-bestanden aan de hand van grotere datasets (1000+) blijkt intensief te zijn + +Belasting en kosten: Het genereren van grote sitemap bestanden is server intensief, het confronteert de publicerende overheid daarmee met relatief hoge kosten. We vermoeden dat dit ook geld aan de kant van de harvester. + +Actualiteit: Doordat de sitemap xml bestanden groot zijn blijkt het niet uitvoerbaar om ze bij elke wijziging bij te werken (bijvoorbeeld toegekende vergunning of afgeronde zaak) ipv daarvan worden ze 's nachts gegenereerd. Dit betekent dat het koppelvlak per definitie achterloopt. + +We interpreteren de WOO als alle niet vertrouwelijke gegevens moeten pro-actief openbaar worden gemaakt. Door gebruik te maken van API's in plaats van sitemap xml bestanden zorgen we dat de gegevens alleen worden verstuurd op het moment dat ze worden opgevraagd. Dat vergroot het dataverkeer bij gebruik, maar voorkomt dataverkeer vooraf. + +## Conclusie + +De voorgestelde oplossing van Sitemap.xml bestanden lijkt in de praktijk onveiliger, duurder en minder actueel dan het inzetten van een API. diff --git a/docs/Kosten.md b/docs/Kosten.md index ce0ef53b..9e1b9272 100644 --- a/docs/Kosten.md +++ b/docs/Kosten.md @@ -1,25 +1,27 @@ # Kosten -Het is mogelijk om de Woo Website af te nemen als SAAS of ondersteuning te krijgen op uw eigen installatie in de vorm van een SLA of implementatie. Conduction en xxllnc bieden momenteel de volgende ondersteuningsmogelijkheden aan. +OpenWoo.app bestaat uit een collectie van Common Ground componenten waarbij u als organisatie zelf de keuze heeft welke componenten toepast (gaat u bijvoorbeeld integereren in uw huidige website of een losse pagina opstarten). De kosten hangen daarmee sterk af van uw wensen en keuzes. Niet te min proberen we de kosten vooraf zo goed en open mogelijk in beeld te brengen. -Bent u geïnteresseerd of wilt u meer informatie? Neem dan contact op met een van de leveranciers. +Onderstaande treft u de bij ons bekende kosten per component die leveranciers in rekening brengen voor een SLA of SAAS. Als u een beter beeld wilt krijgen bij welke componenten uw organisatie wil toepassen kunt u kijken bij [architectuur](https://openwoo.app/github/Architectuur/?link=https://github.com/ConductionNL/woo-website-template/blob/main/docs/Architectuur.md). -## Leveranciers +## Contactgegevens leveranciers -| Leverancier | Contactpersoon | -|-------------|----------------------------------------------| -| Conduction | Ruben van der Linde () | -| xxllnc | Remco Damhuis () | +| Leverancier | Contactpersoon | +|--------------------------------------|--------------------------------------------------| +| [Conduction](https://conduction.nl/) | Ruben van der Linde () | +| [xxllnc](https://xxllnc.nl/) | Arthur van Ulden () | +| [Sim Groep](https://www.simgroep.nl/) | | ## Frontend Kijk op [de demo pagina](https://conductionnl.github.io/woo-website-xxllnc/) voor een voorbeeld van de omgeving of op [de product homepage](https://openwoo.app/) voor een overzicht van de omgevingen die in ontwikkeling zijn. -| Dienst | Kosten | -|------------------------------------------------|------------------------| -| Implementatie | €1750,- (eenmalig) | -| NL Design Tokens (indien nog niet beschikbaar) | €2000,- (eenmalig) | -| SLA of SAAS frontend | €250,- (maandelijks) | +| Component | Leverancier | Eenmalig | Maandelijks | +|------------------------------------------------|-------------|-------------|-------------| +| NL Design Tokens (indien nog niet beschikbaar) | Conduction | € 1750,- | € 250.- | +| Integratie in Open Webconcept | Yard | Onbekend | Onbekend | +| Integratie in Open Webconcept | Acato | Onbekend | Onbekend | +| Sim Site | Sim Groep | Onbekend | Onbekend | **Waarop zijn de maandelijkse kosten gebaseerd?** Los van hosting verwachten we naar aanleiding van eerdere ervaringen dat de frontend maandelijks moet worden bijgewerkt in verband met veiligheidsupdates, nieuwe functionaliteit of aanpassingen in NL Design. Met name de ontwikkelingen in de Woo zullen ervoor zorgen dat de pagina de komende jaren continu in beweging is. @@ -27,30 +29,43 @@ Los van hosting verwachten we naar aanleiding van eerdere ervaringen dat de fron > **Opmerking** > NL Design tokens zijn een randvoorwaarde (vereiste) voor het gebruik van de frontend. Als uw organisatie hier reeds over beschikt, hoeven deze uiteraard niet opnieuw te worden gemaakt. Wel is het mogelijk dat uw huidige token set moet worden uitgebreid; in dat geval volgt een maatwerkofferte. Let op! De prijsstelling is gebaseerd op een aangeleverde en volledige huisstijlgids. Indien deze niet beschikbaar is, moeten de tokens worden gereverse-engineerd vanaf uw website. Daar zijn extra kosten aan verbonden. -## Koppeling op zaaksysteem +## Integratie voorziening -Het is mogelijk om de Open Woo Website rechtstreeks aan uw zaaksysteem te koppelen aan de hand van ZGW of een Search endpoint (in het geval van zaaksysteem.nl) +Het is mogelijk om de Open Woo Website rechtstreeks aan uw zaaksysteem te koppelen aan de hand van ZGW of een Search-endpoint (in het geval van Zaaksysteem.nl) -| Dienst | Kosten | -|----------------------------------------------|------------------------| -| Implementatie koppelvlak | € 3000,- (eenmalig) | -| SAAS | € 250,- (maandelijks) | +| Component | Leverancier | Eenmalig | Maandelijks | +|------------------------|-------------|----------|-------------| +| Integratie voorziening | Conduction | €3000,- | €250.- | +| Integratie voorziening | xxlnc | €3000,- | €250.- | > **Opmerking** > Via een Stuf ↔ ZGW-koppelvlak is het in theorie ook mogelijk een zaaksysteem te koppelen aan de hand van Stuf, dit is in de praktijk echter nog niet beproeft. Andere koppelvlakken en maatwerk zijn uiteraard bespreekbaar, neem daarvoor contact op met een leverancier. -## Configuratie en inrichting xxllnc Zaken +## Bronnen -Klanten van xxllnc Zaken (zaaksysteem.nl) kunnen voor het inrichten van het modelzaaktype t.b.v. WOO-publicatie en de configuratie van de integratie gebruik maken van een Consultant. +Klanten van xxllnc Zaken (zaaksysteem.nl) kunnen voor het inrichten van het modelzaaktype t.b.v. WOO-publicatie en de configuratie van de integratie gebruikmaken van een Consultant. -Klanten van xxllnc Zaken (zaaksysteem.nl) kunnen voor het inrichten van het modelzaaktype t.b.v. Woo-publicatie en de configuratie van de integratie gebruikmaken van een Consultant. - -| Dienst | Kosten | -|------------------------------|------------------------| -| Installatie en configuratie Woo-index integratie | € 3000,- (eenmalig) | +| Component | Leverancier | Eenmalig | Maandenlijks | +|-------------------|-------------|----------|--------------| +| Zaaksysteem.nl | xxllnce | € 3000,- | n.v.t | +| Open Pub | Yard | Onbekend |Onbekend | +| Open Verzoeken | Yard | Onbekend |Onbekend | +| Open Conventanten | Yard | Onbekend |Onbekend | +| Open Klachten | Yard | Onbekend |Onbekend | +| Open Zaak | - | Onbekend |Onbekend | +| Join | Decos | Onbekend |Onbekend | +| Fundament | Roxit | Onbekend |Onbekend | Mocht u nog niet beschikken over xxllnc Zaken (zaaksysteem.nl) maar wel behoefte hebben aan een manier om de documenten conform een ingericht proces te gaan publiceren en achteraf correct te kunnen archiveren neem dan contact met ons op via: . Wij gaan graag in gesprek over de mogelijkheden hiervoor! +## Overige + +Buiten het leveren van componenten om kan het ook zijn dat er nog overige diensten noodzakelijk zijn (bijvoorbeeld omdat een component hiervan afhankelijk is), + +| Component | Leverancier | Eenmalig | Maandenlijks | +|------------------------------------------------|----------------------|---------------|-----------------------------| +| NL Design Tokens (indien nog niet beschikbaar) | Conduction | € 2000,- | € 250,- (SLA niet verplicht) | + ## Leverancier worden? Bent u enthousiast over de Woo Website en wilt u deze ook aanbieden aan uw klanten? Neem dan contact op met Conduction en mail ons op . diff --git a/docs/LosseFrontend.puml b/docs/LosseFrontend.puml new file mode 100644 index 00000000..b735e615 --- /dev/null +++ b/docs/LosseFrontend.puml @@ -0,0 +1,23 @@ +@startuml +title Losse frontend met integratie + +' User Interface Component +interface "Open Webconcept Website" as Website +interface "Koop Harvester" as Harvester +interface "API" as Api + +' Backend Components +component "Open Webconcept CMS" as CMS +component "Integratie" as Integratie +component "Bronnen" as Bronnen + +' Relationships +API -down-> Integratie : Directly connected +Website -down-> Integratie : Directly connected +Integratie -down-> Bronnen : Scrapes periodically\nUses as source + +' Notifications +CMS -up-> Integratie : Notifies of changes or deletes +Zaaksysteem -up-> Integratie : Notifies of changes or deletes + +@enduml \ No newline at end of file diff --git a/docs/LosseFrontend.svg b/docs/LosseFrontend.svg new file mode 100644 index 00000000..474116b7 --- /dev/null +++ b/docs/LosseFrontend.svg @@ -0,0 +1 @@ +Losse frontend met integratieOpen Webconcept WebsiteKoop HarvesterAPIOpen Webconcept CMSIntegratieBronnenAPIZaaksysteemDirectly connectedDirectly connectedScrapes periodicallyUses as sourceNotifies of changes or deletesNotifies of changes or deletes \ No newline at end of file diff --git a/docs/OpenWebConceptMet.puml b/docs/OpenWebConceptMet.puml new file mode 100644 index 00000000..532a30f4 --- /dev/null +++ b/docs/OpenWebConceptMet.puml @@ -0,0 +1,27 @@ +@startuml +title Open Webconcept met integratie + +' User Interface Component +interface "Open Webconcept Website" as Website +interface "Koop Harvester" as Harvester +interface "API" as Api + +' Backend Components +component "Open Webconcept CMS" as CMS +component "Integratie" as Integratie +component "Zaaksysteem" as Zaaksysteem + +' Relationships +API -down-> Integratie : Directly connected +Website -down-> Integratie : Directly connected +Harvester -down-> Integratie : Generated from +Integratie -down-> CMS : Scrapes periodically\nUses as source +Integratie -down-> Zaaksysteem : Scrapes periodically\nUses as source +Integratie -down-> Raadsinfo : Scrapes periodically\nUses as source +Integratie -down-> eDepot : Scrapes periodically\nUses as source + +' Notifications +CMS -up-> Integratie : Notifies of changes or deletes +Zaaksysteem -up-> Integratie : Notifies of changes or deletes + +@enduml \ No newline at end of file diff --git a/docs/OpenWebConceptMet.svg b/docs/OpenWebConceptMet.svg new file mode 100644 index 00000000..33c1d17b --- /dev/null +++ b/docs/OpenWebConceptMet.svg @@ -0,0 +1 @@ +Open Webconcept met integratieOpen Webconcept WebsiteKoop HarvesterAPIOpen Webconcept CMSIntegratieZaaksysteemAPIRaadsinfoeDepotDirectly connectedDirectly connectedGenerated fromScrapes periodicallyUses as sourceNotifies of changes or deletesScrapes periodicallyUses as sourceNotifies of changes or deletesScrapes periodicallyUses as sourceScrapes periodicallyUses as source \ No newline at end of file diff --git a/docs/OpenWebconceptZonder.puml b/docs/OpenWebconceptZonder.puml new file mode 100644 index 00000000..67cc071c --- /dev/null +++ b/docs/OpenWebconceptZonder.puml @@ -0,0 +1,13 @@ +@startuml +title Open Webconcept zonder integratie + +' User Interface Component +interface "Open Webconcept Website" as Website + +' Backend Components +component "Open Webconcept CMS" as CMS + +' Relationships +Website -down-> CMS : Directly connected + +@enduml \ No newline at end of file diff --git a/docs/OpenWebconceptZonder.svg b/docs/OpenWebconceptZonder.svg new file mode 100644 index 00000000..34d3b3ce --- /dev/null +++ b/docs/OpenWebconceptZonder.svg @@ -0,0 +1 @@ +Open Webconcept zonder integratieOpen Webconcept WebsiteOpen Webconcept CMSDirectly connected \ No newline at end of file diff --git a/docs/Productie.md b/docs/Productie.md index 45f15596..0af0f16a 100644 --- a/docs/Productie.md +++ b/docs/Productie.md @@ -1,44 +1,47 @@ # In productie nemen -Het in productie nemen van de Open WOO App voor uw organisatie is makkelijker dan u wellicht denkt. Hieronder vindt u de stappen die u moet volgen om succesvol over te gaan naar de productiefase. +Het in productie nemen van OpenWoo.app voor uw organisatie is makkelijker dan u wellicht denkt. Hieronder vindt u de stappen die u moet volgen om succesvol over te gaan naar de productiefase. -- (optioneel) Kies een [leverancier](https://openwoo.app/pages/Documentatie/Kosten) om de OpenWOO App bij af te nemen. Of implementeer hem zelfstandig. -- Versamel van te voren alle benodigde informatie -- Vraag tijdig een PKI certificaat en DNS wijzig bij uw ICT leveranciers -- Zorg dat u tijd beschikbaar hebt voor het grondig doortesten van de keten aan de hand van de test senario's +- (optioneel) Kies een [leverancier](https://openwoo.app/pages/Documentatie/Kosten) om de OpenWoo.app bij af te nemen. Of implementeer hem zelfstandig. +- Verzamel van tevoren alle benodigde informatie +- Vraag tijdig een PKI-certificaat en DNS wijziginging aan bij uw ICT-leverancier(s) +- Zorg dat u tijd beschikbaar hebt voor het grondig doortesten van de keten aan de hand van de testscenario's -Als u de OpenWOO APP zelfstandig instaleerd zult u de [acties voor leverancier](#acties-voor-leverancier) uiteraard zelf moeten uitvoeren. +Als u de OpenWOO APP zelfstandig installeerd zult u de [acties voor leverancier](#acties-voor-leverancier) uiteraard zelf moeten uitvoeren. ## Benodigde informatie voor de vormgeving -Om de vormgeving van de OpenWOO-app aan te passen aan uw organisatie, heeft uw leverancier of u de volgende informatie nodig: + +Om de vormgeving van OpenWoo.app aan te passen aan uw organisatie, heeft uw leverancier of u de volgende informatie nodig: - Logo in vector formaat (e.g. .svg, .eps of .ai) -- Huisstijl handboek of webstie die als voorbeeld gebruikt kan worden -- Contact gegevens (naam, email adres, telefoon nummer en functie) van een medewerker die eventueele vragen over de huisstijl kan beantwoorden. +- Huisstijl handboek of website die als voorbeeld gebruikt kan worden +- Contactgegevens (naam, email adres, telefoonnummer en functie) van een medewerker die eventuele vragen over de huisstijl kan beantwoorden. -Om te beoordelen of uw organsatie NL Design tokens moet maken of aanpassen kunt u het [landelijke overicht van design tokens](https://github.com/nl-design-system/themes/tree/main/proprietary) raadplegen. +Om te beoordelen of uw organisatie NL Design tokens nodig heeft of moet aanpassen kunt u het [landelijke overzicht van NL Design tokens](https://github.com/nl-design-system/themes/tree/main/proprietary) raadplegen. ## Benodigde informatie voor de inrichting -Voor de inrichting van de OpenWOO-app heeft uw leverancier of u de volgende informatie nodig: + +Voor de inrichting van OpenWoo.app heeft uw leverancier of u de volgende informatie nodig: - Welke afbeelding moet er worden getoond in de jumbotron? (afbeelding boven aan de landingspagina) -- Welke contact gegevens moeten er in de footer worden getoond? Denk daarbij aan +- Welke contactgegevens moeten er in de footer worden getoond? Denk daarbij aan - Adresgegevens (bezoekadres en postadres) - Email - Telefoonnummer - Website - e.v.t socialmedia (Facebook, Instagram etc) - - Verplichte context pagina's waarvoor word doorverwezen naar uw eigen site (privacy, over deze pagina, toegankenlijkheid) + - Verplichte context pagina's waarvoor word doorverwezen naar uw eigen site (privacy, over deze pagina, toegankelijkheid) - Overige website waar u naar wilt verwijzen -- Op welk (sub) domein moet de pagina worden getoond? b.v. open.`uw organisatie naam`.nl +- Op welk (sub) domein moet de pagina worden getoond? b.v. open.`uw organisatienaam`.nl - Moet er gebruik worden gemaakt van een custom certificaat? bijvoorbeeld PKIo -- Word er gekoppeld op een of meerder zaaksystemen? zo ja welke -- Word er gekoppeld op een of meerder raadsinformatie systemen? zo ja welke -- Word er gekoppeld op CMS van de huidige website? zo ja welke -- Is er een wens voor het kopelleen op overige systemen? (zo als geo, drop publicaties of powerbrowser) -- Email addres waar eventueel foutraportages naar kunnen worden verstuurd +- Wordt er gekoppeld op een of meerdere zaaksystemen? Zo ja, welke +- Wordt er gekoppeld op een of meerdere raadsinformatiesystemen? Zo ja, welke +- Wordt er gekoppeld op CMS van de huidige website? Zo ja, welke +- Is er een wens voor het koppelen op overige systemen? (zoals geo, DROP-publicaties of PowerBrowser) +- E-mailadres waar eventuele foutrapportages naar toe kunnen worden gestuurd ## Acties voor uitvragende organisatie + Om het neerzetten van een omgeving soepel te laten verlopen, zijn er verschillende acties die de uitvragende organisatie zelf moet ondernemen: - [ ] Verzamelen en aanleveren benodigde informatie voor de vormgeving @@ -47,17 +50,18 @@ Om het neerzetten van een omgeving soepel te laten verlopen, zijn er verschillen - [ ] Aanvragen en aanleveren bij leverancier van certificaat (indien custom zoals PKIo) - [ ] Verzamelen en aanleveren beoogde zaaksystemen, denk hierbij aan: - [ ] Endpoint (waar kan de OpenWoo App bevragen). - - [ ] Credentials (hoe kan de OpenWoo App zich authentiseren). + - [ ] Credentials (hoe kan de OpenWoo App zich authenticeren). - [ ] Protocol (welk protocol moet er worden gebruik e.g. xxllnc search, ZGW, StUF, ZDS etc.). - [ ] Verzamelen en aanleveren beoogde raadsinformatie denk hierbij aan: - - [ ] Endpoint (waar kan de OpenWoo App bevragen). - - [ ] Credentials (hoe kan de OpenWoo App zich authenticeren). + - [ ] Endpoint (waar kan de OpenWoo App bevragen). + - [ ] Credentials (hoe kan de OpenWoo App zich authenticeren). - [ ] Verzamelen en aanleveren gegevens van websitekoppeling indien gewenst. - [ ] DPIA opstellen. - [ ] Inregelen DNS voor (sub)domein. - [ ] Inrichten zaaksysteem (zie configuratie). ## Acties voor leverancier + Aan de hand van de acties voor de opdrachtgever kan uw leverancier vervolgens aan de slag. Als u geen leverancier heeft moet u deze acties zelf verzetten. - [ ] Uitbreiden of aanmaken NL Design tokens aan de hand van de informatie voor de vormgeving. @@ -67,10 +71,12 @@ Aan de hand van de acties voor de opdrachtgever kan uw leverancier vervolgens aa - [ ] Aan uitvrager laten weten dat er een acceptatie kan plaatsvinden. Wat doet de leverancier niet + - Aanleveren WCAG raportage (deze staat [hier](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/WCAG-Raportage.pdf)) - Aanleveren PEN test (deze staat [hier]()) ## Naar productie (Acceptatie) + Als uw leverancier alles heeft klaar gezet is het tijd voor acceptatie en livegang - [ ] Doorlopen van de [Acceptatie tests](https://documentatie.opencatalogi.nl/pages/Handleidingen/Testen) @@ -78,4 +84,3 @@ Als uw leverancier alles heeft klaar gezet is het tijd voor acceptatie en livega - [ ] Indien alles correct, aan leverancier laten weten dat er geaccepteerd is. - [ ] Op eigen website verwijzen naar de Open Catalogi (deeplinks) - [ ] Vier de livegang met een feestje - diff --git a/docs/Roadmap.md b/docs/Roadmap.md index 2529d128..2b913e98 100644 --- a/docs/Roadmap.md +++ b/docs/Roadmap.md @@ -3,42 +3,47 @@ Organisaties kunnen bijdragen aan deze roadmap door items aan te dragen, deze zelf op te pakken en uit te voeren, of door de uitvoering ervan te financieren. ## Raadsinformatie Systemen (Medio December) + **Inschatting: 40 uur per RIS** Medio september gaat de gebruikersgroep verkennen of het mogelijk is om ook de Raadsinformatiesystemen te ontsluiten via Open WOO. Deze ontwikkeling zal de dienstverlening naar de inwoners verbeteren door de transparantie van de gemeente te vergroten. Het draagt ook bij aan de invulling van de Wet Open Overheid door overheidsinformatie beter toegankelijk te maken. ## Robot.txt en sitemap.xml (Medio December) + **Inschatting: 20 uur** Begin oktober wil KOOP graag de decentrale portalen harvesten om een centrale index op te bouwen. Dit zal de zoekbaarheid van overheidsinformatie verbeteren, wat de dienstverlening aan de inwoners ten goede komt. Het past ook binnen de kaders van de Wet Open Overheid door het vergroten van de toegankelijkheid van overheidsinformatie. ## Aanleveren DROP (Geen ontwikkeling gepland) + **Inschatting: 120 uur** DROP staat voor Decentrale Regelgeving en Officiële Publicaties. Dit platform helpt dubbele of foutieve invoer te voorkomen en draagt zo bij aan een sneller en correcter publicatieproces bij aanlevering naar het Gemeenteblad, Het Provinciaal blad, het Waterschapsblad en de Staatscourant. - ## Koppelen e-Depot (Geen ontwikkeling gepland) + **Inschatting: 80 uur** Voor het bewaren van stukken voor langere termijn is een koppeling met het archiefsysteem van het Nationaal Archief gewenst. Hierdoor wordt de houdbaarheid van de informatie gewaarborgd voor langere tijd. ## Koppeling met het CMS van Open Webconcept (Medio November) -**Inschatting: 40 uur** - +**Inschatting: 40 uur** ## Open Online Plugin (Geen ontwikkeling gepland) + **Inschatting: 80 uur** Open Online is een Dimpact-project waarbij een gemeentelijke versie van het bekende Drupal CMS wordt ontwikkeld. Het creëren van een Drupal-plugin zal het voor Dimpact-gemeenten gemakkelijker maken om hun WOO-indexpagina handmatig aan te vullen. Dit verbetert de dienstverlening door het bieden van een meer gestroomlijnde gebruikerservaring en draagt bij aan de Wet Open Overheid door de toegankelijkheid van informatie te vergroten. ## Static JSON Content (Geen ontwikkeling gepland) + **Inschatting: 40 uur** WOO-objecten veranderen zelden. Door de dataset na iedere wijziging om te zetten in statische JSON-bestanden en deze op te nemen in de website-repository, kan de website worden gedraaid zonder backend server. Dit verlaagt de operationele kosten en vergroot de betrouwbaarheid, wat bijdraagt aan betere dienstverlening. Daarnaast voldoet het aan de Wet Open Overheid door de beschikbaarheid van overheidsinformatie te vergroten. ## Landingspagina aan de hand van Thema's (Geen ontwikkeling gepland) + **Inschatting: 80 uur** Het thematiseren van WOO-objecten met een overkoepelende themapagina kan dienen als landingspagina voor de index. Dit verbetert de navigeerbaarheid van de website, wat de dienstverlening aan inwoners verbetert. Het biedt ook een gestructureerde manier om overheidsinformatie toegankelijk te maken, in lijn met de Wet Open Overheid. @@ -49,6 +54,7 @@ Voorbeelden: - [Amsterdam](https://open.amsterdam/) ## Uitlegpagina of categorieën (Geen ontwikkeling gepland) + **Inschatting: 40 uur** Het toevoegen van een uitlegpagina of categorieën kan helpen bij het beter organiseren van de informatie. Dit maakt het gemakkelijker voor inwoners om de informatie te vinden die ze nodig hebben, wat bijdraagt aan betere dienstverlening. Het is ook in overeenstemming met de Wet Open Overheid, die streeft naar een betere toegankelijkheid en vindbaarheid van overheidsinformatie. @@ -58,22 +64,25 @@ Voorbeelden: - [Amsterdam](https://open.amsterdam/categorieen) ## Kaartweergave (Geen ontwikkeling gepland) + **Inschatting: 80 uur** WOO-objecten die geografisch te relateren zijn kunnen op een kaart worden weergegeven. Dit maakt het voor inwoners gemakkelijker om informatie te vinden die relevant is voor hun specifieke locatie, wat de dienstverlening verbetert. Daarnaast draagt het bij aan de doelen van de Wet Open Overheid door de toegankelijkheid van geografische informatie te vergroten. - ## Extra categorieën + **Inschatting: 20 uur** In princiepe kunnen extra categorieën vanuit de reeds gekopelde bronnen worden ingelezen. Het zou echter kunnen voorkomen dat er een nieuwe categorie ontstaat vanuit KOOP waarvoor wel aanvullende acties moeten worden genomen. Dit is een stelpost die we daarvoor hebben opgenomen. ## Installeren via Helm Chart + **Inschatting: 40 uur** Het is mogelijk om de openwoo.app te installeren via een Helm Chart. Dit maakt het gemakkelijker om de website te installeren op een Kubernetes cluster, wat de operationele kosten verlaagt en de betrouwbaarheid verhoogt. Dit draagt bij aan de dienstverlening door de beschikbaarheid van de website te vergroten. De Helm chart zal voldoen aan de Haven-standaard. ## Installeren via GitHub Actions + **Inschatting: 10 uur** De serverless Woo-pagina kan ook geinstalleerd worden via een GitHub Action. Door de installatie te automatiseren wordt het gemakkelijker om de website te installeren en te onderhouden, wat de operationele kosten verlaagt en de betrouwbaarheid verhoogt. Dit draagt bij aan de dienstverlening door de beschikbaarheid van de website te vergroten. diff --git a/docs/Toegankelijkheid.md b/docs/Toegankelijkheid.md index 5d3cb036..e00d2871 100644 --- a/docs/Toegankelijkheid.md +++ b/docs/Toegankelijkheid.md @@ -1,4 +1,5 @@ # Toegankelijkheid + De OpenWoo.app streeft er naar om Woo (pagina's) toegankelijk te maken voor een zo breed mogelijk publiek, ongeacht technologie of vermogen. Er daarom actief gewerkt aan het verhogen van de toegankelijkheid en bruikbaarheid van de react frontend en deze is gehouden aan veel van de beschikbare standaarden en richtlijnen. Deze oplossing streeft ernaar te voldoen aan niveau AA van de Web Content Accessibility Guidelines (WCAG 2.1). Deze richtlijnen leggen de basis voor het toegankelijk maken van webinhoud voor mensen met een scala aan beperkingen, waaronder visuele, auditieve, motorische en cognitieve beperkingen.