diff --git a/.github/workflows/dockerimage.yml b/.github/workflows/dockerimage.yml index 3931a768..9790803f 100644 --- a/.github/workflows/dockerimage.yml +++ b/.github/workflows/dockerimage.yml @@ -44,15 +44,15 @@ jobs: - name: Print definitive APP_ENV run: echo "APP_ENV is now $APP_ENV and APP_BUILD is now $APP_BUILD" - name: Build the Docker image - run: docker-compose build --build-arg APP_ENV=$APP_ENV --build-arg APP_BUILD=$APP_BUILD --build-arg APP_BUILD_ALL_FIXTURES=true + run: docker compose build --build-arg APP_ENV=$APP_ENV --build-arg APP_BUILD=$APP_BUILD --build-arg APP_BUILD_ALL_FIXTURES=true - name: Run the docker image - run: docker-compose up -d + run: docker compose up -d - name: Taking some sleep (for containers to come up) run: sleep 20 - name: Check if all containers are running run: docker ps - name: Dumping the logs - run: docker-compose logs + run: docker compose logs - name: Show all images run: docker images - name: Login to Container Registry @@ -66,13 +66,13 @@ jobs: fi - if: steps.containerregistry-login.outputs.success == 'true' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/development') name: Push to Container Registry - run: docker-compose push + run: docker compose push - if: steps.containerregistry-login.outputs.success == 'true' && github.ref == 'refs/heads/main' name: Push versioned containers to Container Registry id: version-push run: | - images=$(docker-compose images -q | xargs docker inspect --format='{{ index .RepoTags 0}}' | cut -d':' -f1 | grep $APP_NAME) + images=$(docker compose images -q | xargs docker inspect --format='{{ index .RepoTags 0}}' | cut -d':' -f1 | grep $APP_NAME) for image in $images do docker push "${image}":"${APP_BUILD}" @@ -96,4 +96,4 @@ jobs: prerelease: false - name: Chores if: (success() || failure()) - run: docker-compose down + run: docker compose down diff --git a/README.md b/README.md index dc7eb15c..25786cfa 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ > **Ondersteuning en bijeenkomsten** > -> +> > Meer weten over deze oplossing? Dat kan! Hiervoor hebben we een apart [Slack kanaal](https://samenorganiseren.slack.com/archives/C067Q3UE9F0) binnen Common Ground. We helpen je daar graag verder. Uiteraard kan je ook altijd mailen naar [info@conduction.nl](mailto:info@conduction.nl) > > Tevens worden vanuit de aangesloten leveranciers worden regelmatig webinars georganiseerd. > > - [10 Juli 10:00 | Community Meeting](https://www.linkedin.com/events/7206649524776284161/comments/?originTrackingId=BVZjR39lT72%2BfNaik99cew%3D%3D). -> +> > Terug kijken afgelopen webinars en meetings? > > - [12-06-2024 | Community Meeting](https://www.youtube.com/watch?v=ab_FEexYYMY). @@ -18,8 +18,8 @@ > - [13-03-2024 | Community Meeting](https://www.youtube.com/watch?v=TNZghskRu5c). > - [14-02-2024 | Community meeting](https://www.youtube.com/watch?v=ri5U8x-lsxo) > - [30-01-2024 | OpenGemeente Woobinar](https://vimeo.com/909134953) -> - [19-12-2023 | xxllnc Demo ](https://www.youtube.com/watch?v=_FGpUYH1yd0) -> - [17-11-2023 | xxllnc Woobinar ](https://www.youtube.com/watch?v=NCnLDEoPh5A) +> - [19-12-2023 | xxllnc Demo](https://www.youtube.com/watch?v=_FGpUYH1yd0) +> - [17-11-2023 | xxllnc Woobinar](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/onderwerpen/actieve-openbaarmaking) worden gevonden. @@ -39,19 +39,20 @@ Deze uitdagingen kunnen niet effectief worden aangepakt met een enkel Content Ma |-----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|--------------------------------------------------------------------------------| | [](https://www.conduction.nl/) | [](https://xxllnc.nl/) | [](https://www.opengemeenten.nl/) | [](https://www.simgroep.nl/) | [](https://acato.nl/) | [](https://www.notubiz.nl/)| [](https://www.drupalvoorgemeenten.nl/)| -## Belangrijkste functionaliteiten en voordelen van OpenWoo.app: +## Belangrijkste functionaliteiten en voordelen van OpenWoo.app + - **Centrale Index Pagina:** Een overzichtelijke locatie voor alle openbare data van uw organisatie voor verbeterde vindbaarheid van informatie. - **Multibron Dataweergave:** Een naadloze integratie en presentatie van data uit diverse bronnen, zoals het zaaksysteem, websites, raadsinformatiesystemen en archieven. - **Keuze uit Publicatieplatformen:** Met opties zoals NL Design React en Open Gemeente Typo 3, biedt OpenWoo.app flexibiliteit in de manier waarop uw gegevens gepubliceerd worden, terwijl het tegelijkertijd eenvoudig integreerbaar is in uw huidige website. - **Automatische Data-aanlevering:** Efficiënte aanlevering bij landelijke indexen zoals KOOP en Woogle, door middel van sitemap.xml-bestanden en API's, vergroot het bereik en de zichtbaarheid van uw gegevens. - **Proactieve Publicatie:** Automatiseer het publicatieproces en verminder handmatige inspanningen met de slimme, proactieve publicatiefuncties van OpenWoo.app. -- **Toekomstbestendig en Veilig:** Bereid uw organisatie voor op toekomstige ontwikkelingen met configureerbare publicatietypen en verhoog de veiligheid en efficiëntie door het verminderen van directe bevragingen op bronnen. +- **Toekomstbestendig en Veilig:** Bereid uw organisatie voor op toekomstige ontwikkelingen met configureerbare publicatietypen en verhoog de veiligheid en efficiëntie door het verminderen van directe bevragingen op bronnen. ![epe.png](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/epe.png "Woo Website van de Gemeente Epe") Wil je meer weten over de functionaliteiten van de Open Woo-app? Kijk dan op de [architectuur pagina](/docs/product/Features.md). -## Oplossing van OpenWoo.app: +## Oplossing van OpenWoo.app OpenWoo.app gaat verder dan alleen deze basisfunctionaliteiten door een geïntegreerde oplossing aan te bieden die bestaat uit essentiële componenten: @@ -60,12 +61,12 @@ OpenWoo.app gaat verder dan alleen deze basisfunctionaliteiten door een geïnteg - **Zoekpagina (Optioneel):** Een op NL Design gebaseerd publicatieplatform dat belanghebbenden in staat stelt om naar relevante informatie te zoeken. - **Open WooService:** Deze module verzamelt informatie uit verschillende bronnen, waardoor een gecentraliseerde toegang tot diverse categorieën van gegevens mogelijk wordt. - **Open Index:** Een opgebouwde index van openbare informatie die samen met andere zoekindexen een landelijke federatie vormt. -- **Overige Bronnen (Optioneel):** Bronnen zoals het Zaaksysteem, Raadsinformatiesysteem en archief kunnen optioneel worden gekoppeld, met ondersteuning voor handmatige uploads via het CMS van uw huidige website. - +- **Overige Bronnen (Optioneel):** Bronnen zoals het Zaaksysteem, Raadsinformatiesysteem en archief kunnen optioneel worden gekoppeld, met ondersteuning voor handmatige uploads via het CMS van uw huidige website. Deze geïntegreerde aanpak zorgt voor een naadloze, efficiënte en effectieve implementatie van de Wet Open Overheid (Woo), waardoor overheidsorganisaties hun informatie op een gebruiksvriendelijke en toegankelijke wijze kunnen delen. OpenWoo.app is niet alleen een tool om te voldoen aan de Wet open overheid (Woo), maar een strategische partner die handwerk vermindert, transparantie bevordert, en de toegankelijkheid van overheidsinformatie aanzienlijk verbetert. De OpenWoo.app architectuur is bewust ontworpen om gemeenten de keuze te geven in hoe zij willen omgaan met de Wet Open Overheid en KOOP + - Wil je automatisch publiceren uit je huidige zaaksysteem? dat kan! - Liever publiceren uit je huidige website? dat kan ook! - Of wil je bij KOOP aanleveren vanuit een kleine openzaak installatie? dan kan dat natuurlijk ook. @@ -82,6 +83,8 @@ Op dit moment wordt de OpenWoo.app al door een aantal organisaties gebruikt |-------------|------|------------|--------------|--------| | [Noordwijk](https://www.noordwijk.nl/) | Gemeente | [Pagina](open.noordwijk.nl) | Zaaksysteem.nl | Productie | | [Epe](https://www.epe.nl/) | Gemeente |[Pagina](https://open.epe.nl/) | Zaaksysteem | Productie | +| [Roosendaal](https://www.roosendaal.nl/) | Gemeente |[Pagina](https://open.roosendaal.nl/) | Zaaksysteem | Productie | +| [Zutphen](https://www.zutphen.nl/) | Gemeente |[Pagina](https://open.zutphen.nl/) | Zaaksysteem | Productie | | [Tubbergen](https://www.tubbergen.nl/) | Gemeente |[Pagina](https://conductionnl.github.io/woo-website-tubbergen/) | Zaaksysteem.nl | Acceptatie | | [Dinkelland](https://www.dinkelland.nl/) | Gemeente |[Pagina](https://conductionnl.github.io/woo-website-dinkelland/) | Zaaksysteem.nl | Acceptatie | | [Gouda](https://www.gouda.nl/) | Gemeente |[Pagina](https://conductionnl.github.io/woo-website-gouda/) | Zaaksysteem.nl | Acceptatie | diff --git a/docs/GOVERNANCE.md b/docs/GOVERNANCE.md index 401a5c8d..cdbcafd6 100644 --- a/docs/GOVERNANCE.md +++ b/docs/GOVERNANCE.md @@ -6,7 +6,7 @@ Het succes en de continue verbetering van het OpenWoo.app project zijn afhankeli OpenWoo.app is een doorontwikkeling van de OpenWoo WordPress-plugin uit Open Webconcept. Vanuit die oorsprong is OpenWoo.app eigenlijk een subcommunity van OpenWebconcept. De community staat echter nadrukkelijk open voor niet OWC-afnemers en leveranciers. -De gemeente Gouda vormt hierin de linking pin +De gemeente Gouda vormt hierin de linking pin. Gemeenten zo als Noordwijk, Gouda, Barendrecht, Alblasserwaard, Ridderkerk en Hoeksche Waard vormen met de deelname aan diff --git a/docs/NavbarContent.json b/docs/NavbarContent.json index 28a51f60..1ca1be28 100644 --- a/docs/NavbarContent.json +++ b/docs/NavbarContent.json @@ -78,7 +78,7 @@ }, "handleClick": { "internalMarkdown": { - "directoryName": "docs", + "directoryName": "/docs", "fileName": "GOVERNANCE" } } diff --git a/docs/product/Features.md b/docs/product/Features.md index bd00f8a1..315cef00 100644 --- a/docs/product/Features.md +++ b/docs/product/Features.md @@ -2,34 +2,36 @@ Een federaale search API - ## Centrale Index Pagina + Een overzichtelijke locatie voor alle openbare data van uw organisatie, verbetert de vindbaarheid van informatie. ## Multibron Dataweergave + Een naadloze integratie en presentatie van data uit diverse bronnen, zoals het zaaksysteem, websites, raadsinformatiesystemen en archieven. ## Keuze uit Publicatieplatformen + Met opties zoals NL Design React en Open Gemeente Typo 3, biedt OpenWoo.app flexibiliteit in de manier waarop uw gegevens gepubliceerd worden, terwijl het tegelijkertijd eenvoudig integreerbaar is in uw huidige website. ## Automatische Data-aanlevering + Efficiënte aanlevering bij landelijke indexen zoals KOOP en Woogle, door middel van sitemap.xml-bestanden en API's, vergroot het bereik en de zichtbaarheid van uw gegevens. ## Proactieve Publicatie + Automatiseer het publicatieproces en verminder handmatige inspanningen met de slimme, proactieve publicatiefuncties van OpenWoo.app. ## Toekomstbestendig en Veilig -Bereid uw organisatie voor op toekomstige ontwikkelingen met configureerbare publicatietypen en verhoog de veiligheid en efficiëntie door het verminderen van directe bevragingen op bronnen. - +Bereid uw organisatie voor op toekomstige ontwikkelingen met configureerbare publicatietypen en verhoog de veiligheid en efficiëntie door het verminderen van directe bevragingen op bronnen. | Functionaliteit | Component | Laag | Beschrijving | -| Publicatie platform | Woo Website Template | 5 (UI) | +| Publicatie platform | Woo Website Template | 5 (UI) | | Search (Openbaar) | Open Index | API (2) | Een zoek index met geavenceerde facet search opties | Search (Vertrouwlijk) |Open Index | API (2) | | Publicatie Register | Open Register | API (2) | Het publicatie register bevat de publicatie objecten, en onder -| Publicatie Beheer | OpenWoo.plugin voor drupal (Io), OpenWoo app voor nextCloud (Conduction), React container (Acato) | +| Publicatie Beheer | OpenWoo.plugin voor drupal (Io), OpenWoo app voor nextCloud (Conduction), React container (Acato) | | Document Creatie | OpenWoo app voor nextCloud (Conduction) | | Creert PDF versies van documenten en bijvoorbeeld voorbladen en inhouds opgaven | | Harvesting | Woo Service | 3(integratie) | -| - +| diff --git a/docs/techniek/Architectuur.md b/docs/techniek/Architectuur.md index 85b75e6a..40b460c1 100644 --- a/docs/techniek/Architectuur.md +++ b/docs/techniek/Architectuur.md @@ -15,17 +15,17 @@ De OpenWoo.app heeft als doel om een ecosysteem van samenwerkende componenten te - [X] Het (door)zoeken, vinden en raadplegen van documenten en metadata door burgers; - [X] Het beheren van autorisaties, configuratie en publicaties door beheerders; - [X] Integratie met de landelijke voorziening PLOOI/KOOP, WooGLe, Koophulpje, DSO. -- [X] Integratie met standaard gemeentenlijke bronnen zoals zaaksysteem, raadsinformatiesysteem en website +- [X] Integratie met standaard gemeentelijke bronnen zoals een zaaksysteem, raadsinformatiesysteem of website - [X] Afhandelingsflow voor zowel publiceren als Woo-verzoeken - [X] Het kunnen terugtrekken van publicaties t.b.v herstel op procedurele fouten - [X] Help functie voor medewerkers aan de hand van werk instructies - [X] Interne publicaties die niet openbaar toegankelijk zijn -- [ ] (Roadmap) Generatie van documenten ten behoefe van publiceren en inhoudslijsten +- [ ] (Roadmap) Generatie van documenten ten behoeve van publiceren en inhoudslijsten - [ ] (Roadmap) Koppeling met anonimiseringssoftware - [ ] (Roadmap) Naar PDF kunnen omzetten van documenten - [ ] (Roadmap) Archiveren - [ ] (Roadmap) Opslaan van zoekfilters en resultaten -- [ ] (Roadmap) Abboneren op nieuwe publicaties die voldoen aan een opgeslagen zoekfilter +- [ ] (Roadmap) Abonneren op nieuwe publicaties die voldoen aan een opgeslagen zoekfilter We hebben deze functionaliteit opgedeeld in drie blokken @@ -33,53 +33,54 @@ We hebben deze functionaliteit opgedeeld in drie blokken 2. Motorblok 3. Bronnen -Secundair doel daarbij is wat idealistischer: om een gemeenschappelijke codebase te realiseren die door meerdere leveranciers kan worden uitgeleverd en deze vanaf dag één te betrekken. Het voorkomen van een locked in vraagt om een open source oplossing die door en door begrepen wordt door meerdere markt partijen. +Secundair doel daarbij is wat idealistischer: om een gemeenschappelijke codebase te realiseren die door meerdere leveranciers kan worden uitgeleverd en deze vanaf dag één te betrekken. Het voorkomen van een lock-in vraagt om een open source oplossing die door en door begrepen wordt door meerdere markt partijen. ## Hergebruik tot op het bot OpenWoo.app maakt voor haar onderliggende techniek en architectuur gebruik van [OpenCatalogi](https://documentatie.opencatalogi.nl/). Meer technische informatie over publiceren naar het federatief datastelsel vind je dan ook in de [architectuurdocumentatie van OpenCatalogi](https://documentatie.opencatalogi.nl/Handleidingen/Architectuur/). Er zijn echter een paar zaken die we binnen OpenWoo.app aanvullend regelen. -1. In plaats van de standaard Open Catalogi voorkant gebruikeren en een publicatie pagina die geoptimalisseerd is voor de WOO, dit kan een (sub)site zijn bij de website leverancier van de gemeente, of een van de twee losstaande react pagina's. We laten de keuze hiervoor bewust bij de deelnemende overheden zelf. +1. In plaats van de standaard OpenCatalogi-voorkant gebruikt OpenWoo en een publicatiepagina die geoptimaliseerd is voor de Woo, dit kan een (sub)site zijn bij de website leverancier van de gemeente, of een van de twee losstaande React pagina's. We laten de keuze hiervoor bewust bij de deelnemende overheden zelf. -2. We gebruiken een aantal aanvullende metadata moddelen in plaats van DCAT en PublicCode, deze wordenn landelijk onderhouden. +2. We gebruiken een aantal aanvullende metadata modellen in plaats van DCAT en PublicCode, deze worden landelijk onderhouden. -3. We maken gebruik van een lose WOO (micro) service die vanuit verschillende bronnen (o.a. zaaksystemen en raadsinformatie systemen) informatie ophaalt en klaar zet als publicatie. Of en hoe publicaties vervolgens automatisch worden gepubliseerd is een configuratie keuze. +3. We maken gebruik van een losse WOO (micro) service die vanuit verschillende bronnen (o.a. zaaksystemen en raadsinformatie systemen) informatie ophaalt en klaar zet als publicatie. Of en hoe publicaties vervolgens automatisch worden gepubliceerd is een configuratie keuze. -4. Er is naast de standaard beheer omgeving van Open Catalogi ook een Publicatie Taak applicatie beschickbaar die specifiek gericht is op het (handmatig) verwerken van WOO verzoeken en beheren van publicacties +4. Er is naast de standaard beheer omgeving van Open Catalogi ook een Publicatie Taak applicatie beschikbaar die specifiek gericht is op het (handmatig) verwerken van Woo-verzoeken en beheren van publicaties. -In een meer algemene zin hebben we bij OpenWoo.app voor andere (sub)doelgroepen gekozen dan binnen Open Catalogi, inwoners, onderzoekers, journalisten, raadsleden en ondernemers staan centraal. +In een meer algemene zin hebben we bij OpenWoo.app voor andere (sub)doelgroepen gekozen dan binnen Open Catalogi, inwoners, onderzoekers, journalisten, raadsleden en ondernemers staan centraal. ## Codebases -Voor de installatie van OpenWoo.app zijn meerdere codebases bechickbaar, dat heeft zowel een historische achtergrond als dat het een bewuste keuze is om van (met name UI) componenten meerdere versies te hebben. Omdat deze ook nog eens over verschillede organisaties verdeeld zijn kan het moeilijk zijn om overzicht te houden op welke code waar staat. We houden daarom hier een overizcht bij van de extra componenten en codebases ten opzichte van de standaard Open Catalogi componenten. + +Voor de installatie van OpenWoo.app zijn meerdere codebases beschikbaar, dat heeft zowel een historische achtergrond als dat het een bewuste keuze is om van (met name UI) componenten meerdere versies te hebben. Omdat deze ook nog eens over verschillende organisaties verdeeld zijn, kan het moeilijk zijn om overzicht te houden op welke code waar staat. We houden daarom hier een overzicht bij van de extra componenten en codebases ten opzichte van de standaard OpenCatalogi-componenten. | Codebase | Rol | Leverancier | Licentie | |----------|------------------------------| | | -| [Github]() | Taakapplicatie publiceren, Publicatie Platform | IO Digital | | +| [Github]() | Taakapplicatie publiceren, Publicatieplatform | IO Digital | | | [Github]() | Taakapplicatie publiceren | Acato | | -| [Github]() | Publicatie Platform | Acato | | -| [Github](https://github.com/OpenWebconcept/plugin-openwoo) | Publicatie Platform | Yard | EUPL | -| [Github](https://github.com/ConductionNL/woo-website-template) | Publicatie Platform | Conduction | EUPL | -| [Github](https://github.com/ConductionNL/plugin-openwoo) | Synchronysatie Service | Conduction | EUPL | - +| [Github]() | Publicatieplatform | Acato | | +| [Github](https://github.com/OpenWebconcept/plugin-openwoo) | Publicatieplatform | Yard | EUPL | +| [Github](https://github.com/ConductionNL/woo-website-template) | Publicatieplatform | Conduction | EUPL | +| [Github](https://github.com/ConductionNL/plugin-openwoo) | Synchronisatieservice | Conduction | EUPL | Hierop zijn een paar opmerkingen te maken -- We gebruiken de synchronisatie service van Open Catalogi niet (die is immers gericht op Github, Gitlab en Dcat), in plaats daarvan is er een WOO synchronysatie service gericht op ZGW, STUF, DRC en ORI. -- We gebruiken voorkant van Open Catalogi niet (die is immers sotware en data gericht), in plaats daarvan hebben meerdere leveranciers eigen publicatie platformen ontwikkeld. + +- We gebruiken de synchronisatie service van Open Catalogi niet (die is immers gericht op GitHub, GitLab en DCAT), in plaats daarvan is er een Woo-synchronisatieservice gericht op ZGW, STUF, DRC en ORI. +- We gebruiken voorkant van Open Catalogi niet (die is immers software en datagericht), in plaats daarvan hebben meerdere leveranciers eigen publicatieplatformen ontwikkeld. ## Uitdagingen Bij het ontwikkelen van een publicatie voorziening komen een aantal uitdagingen in beeld - Woo gegevens staan vaak opgeslagen in bronnen die niet makkelijk toegankelijk zijn -- De scope van de WOO (alle niet vertrouwelijke gegevens) in combinatie met het concept actieve openbaarmaking raakt de volledige informatie huishouden -- Handmatig publiceren kan daarmee geen eindoplossing zijn, maar eigenlijk ook al geen tussen oplossing +- De scope van de Woo (alle niet vertrouwelijke gegevens) in combinatie met het concept actieve openbaarmaking raakt de volledige informatie huishouden +- Handmatig publiceren kan daarmee geen eindoplossing zijn, maar eigenlijk ook al geen tussenoplossing - Er mogen géén fouten worden gemaakt met anonimiseren, dit vraagt om een afgebakende proces flow met checks en balances rondom publiceren -Dat leidt tot de conclusie dat we niet op zoek zijn naar een WOO-publicatieplatform maar een algemene publicatie voorzienen die één of meerdere publicatie kanalen kan 'voeden', daarbij denken we naast de WOO-Index (koop) ook nadrukkelijk aan een organisatie eigen publicatie platform, WooGLe en bijvoorbeeld een gemeentelijke website. In het verlengde hiervan liggen ook DROP, SDG, Algoritme registers en WHO als kanalen die vanuit een generiek publicatie platform moeten kunnen worden ontsloten. +Dat leidt tot de conclusie dat we niet op zoek zijn naar een WOO-publicatieplatform maar een algemene publicatie voorzienen die één of meerdere publicatie kanalen kan 'voeden', daarbij denken we naast de WOO-Index (koop) ook nadrukkelijk aan een organisatie eigen publicatie platform, WooGLe en bijvoorbeeld een gemeentelijke website. In het verlengde hiervan liggen ook DROP, SDG, Algoritme registers en WHO als kanalen die vanuit een generiek publicatieplatform moeten kunnen worden ontsloten. ## Belangrijkste verschillen ten opzicht van OpenWoo.app 1.0 -**Splitsing opslag en search** Binnen de OpenWoo.app 1.0 werd er één mongoDB instance als opslag en search gebruikt, we hebben deze zowel qua opslag uit elkaar getrokken in een Elasticsearch en ORC-instantie als verdeeld over twee aparte API's (zoeken en beheer). +**Splitsing opslag en search** Binnen de OpenWoo.app 1.0 werd er één MongoDB-instance als opslag en search gebruikt, we hebben deze zowel qua opslag uit elkaar getrokken in een Elasticsearch en ORC-instantie als verdeeld over twee aparte API's (zoeken en beheer). **Lostrekken integratie component** De 1.0 versie was direct gebouwd op de Common Gateway, een integratie voorziening. Vanaf 2.0 zijn de zoek-API en beheer-API gepositioneerd als losse componenten die (desgewenst) ook op NLX/FSC kunnen worden ontsloten. **Publicatie flow** De 1.0 versie was gebouwd op de gedachte dat objecten vanuit de bron altijd automatisch moesten worden gepubliceerd. In de 2.0 is dit omgedraaid en wordt er vanuit gegaan dat er actief beheer is op publicaties en dat ze pas worden gepubliceerd als daartoe is geaccordeerd. Wel kunnen er nog steeds automatische spelregels worden afgesproken. @@ -87,12 +88,12 @@ Dat leidt tot de conclusie dat we niet op zoek zijn naar een WOO-publicatieplatf Woo-publicaties moeten worden uiteraard ergens worden gepubliceerd, dat gebeurd via een organisatie specifiek Woo-publicatieplatform. Open Catalogi kent haar eigen zoeken UI, maar voor de gemiddelde gemeente is die te generiek. Daarom zijn er vanuit het OpenWoo.app project een aantal alternatieve user interfaces beschikbaar waarbij de overheid zelf kan kiezen welke interface het beste bij haar past. Hierbij kunt u zowel kiezen voor de zoekinterface als los component als voor een integratie binnen uw huidige website. -Let op, alle interfaces maken onderwater gebruik van de [zoeken-API](https://documentatie.opencatalogi.nl/Handleidingen/Architectuur/#de-zoek-api). U kunt de interfaces dan ook niet gebruiken zonder een Open Catalogi zoeken-API. +Let op, alle interfaces maken onderwater gebruik van de [zoeken-API](https://documentatie.opencatalogi.nl/Handleidingen/Architectuur/#de-zoek-api). De interface is dan ook niet te gebruiken zonder een OpenCatalogi zoeken-API. . | Component | Open Source | Leverancier(s) | Beschrijving | Meer informatie | |-------------------------------|-------------|----------------------------------------------------------|-------------------------------------------------------------------|-----------------| -| Open Catalogi zoeken-Ui | Ja | [Conduction](https://conduction.nl/) | Een losse NL Design zoekpagina in de huisstijl van uw organisatie | | +| OpenCatalogi zoeken-Ui | Ja | [Conduction](https://conduction.nl/) | Een losse NL Design zoekpagina in de huisstijl van uw organisatie | | | OpenWoo.app default zoeken-Ui | Ja | [Conduction](https://conduction.nl/), [Shift2](https://www.shift2.nl/) | Een losse NL Design zoekpagina in de huisstijl van uw organisatie | | Tilburgse frontend | Ja | [Acato](https://acato.nl/) | Een losse NL Design zoekpagina in de huisstijl van uw organisatie | | | Integratie in Open Webconcept | Ja | [Yard](https://www.yard.nl/), [Conduction](https://conduction.nl/) | Een NL Design weergavecomponent voor WordPress-websites | | @@ -116,11 +117,11 @@ Naast het lokale publicatieplatform ondersteund OpenWoo.app ook altijd de volgen ### Motorblok (onderdeel 2) -Het kloppende hart (of motorblok) onder het publicatieplatform is het [Common Ground](https://commonground.nl/) project [Open Catalogi](https://documentatie.opencatalogi.nl/) vanuit dit project nemen we een 2-tal componenten over; te weten [Open Index](https://openindex.online/) en [Open Registers](https://openregisters.app/). +Het kloppende hart (of motorblok) onder het publicatieplatform is het [Common Ground](https://commonground.nl/) project [OpenCatalogi](https://documentatie.opencatalogi.nl/) vanuit dit project nemen we een tweetal componenten over; te weten [Open Index](https://openindex.online/) en [Open Registers](https://openregisters.app/). **Open Index** stelt ons in staat om snel en organisatie-overstijgend te zoeken in meerdere Woo-categorieën tegelijkertijd. Hierbij wordt onder water gebruik gemaakt van Elasticsearch. Open Index normaliseert en standaardiseert Elasticsearch voor ons door het toevoegen van JSON-ld, contextuele metadata, organisaties, directory en catalogi waardoor de onderliggende infrastructuur ontstaat voor een federatieve zoekvraag. Het vormt daarmee het hard van zoeken in OpenWoo.app. Meer informatie over hoe we de techniek van Open Index inzetten vind je in de [architectuurdocumentatie van OpenCatalogi](https://documentatie.opencatalogi.nl/Handleidingen/Architectuur/). -**Open Registers** levert voor ons een publicatie register waar publicaties binnen komen (automatisch aan de hand van synchronisatie of handmatig) en we deze behandelen voordat ze verder worden gecommuniceerd naar Open Index. +**Open Registers** levert voor ons een publicatieregister waar publicaties binnen komen (automatisch aan de hand van synchronisatie of handmatig) en we deze behandelen voordat ze verder worden gecommuniceerd naar Open Index. Er is dus een bewuste en harde scheiding tussen de werkbak (Open Registers) en de publicatiebak (Open Index) waarbij de zoek-API (en daarmee de burger interface) gebruik maakt van de zoekbak. De medewerkers maken via de Admin-UI en beheerinterface gebruik van Open Registers om publicaties te behandelen. Onder het behandelen van publicatie verstaan we onder andere: @@ -132,7 +133,7 @@ Er is dus een bewuste en harde scheiding tussen de werkbak (Open Registers) en d - Eventueel terugtrekken van publicaties - Archiveren -Hierbij dient te worden opgemerkt dat het publicatieprincipe niet allen de WOO maar ook WHO en DSO ondersteund. +Hierbij dient te worden opgemerkt dat het publicatieprincipe niet alleen de Woo, maar ook [WHO](https://wetten.overheid.nl/BWBR0036795/2024-06-19/0) en [DSO](https://iplo.nl/digitaal-stelsel/) ondersteund. Afhankelijk van de specifieke configuratie wensen van overheden kunnen sommige van deze handelingen worden geautomatiseerd (bijvoorbeeld terugtrekken van en DSO-publicatie die ter inzage ligt na het verloop van de termijn). Hiervoor ondersteunen we twee patronen @@ -199,7 +200,7 @@ Deze Open Index is echter ook buiten OpenWoo bruikbaar en kan bijvoorbeeld worde ## Federatief (Landelijk) zoeken -OpenWoo.app maakt gebruik van de federatieve zoekvraag ontwikkeld binnen [OpenCatalogi](https://opencatalogi.nl/) om verschillende integrale zoekvragen virtueel samen te voegen.  Simpel gezegd roept de landelijke zoek API meerdere instanties van [Open Index]() aan en aggregeert de resultaten. Technisch zitten daar nog wat haken en ogen aan die binnen Open Index worden [uitgelegd](). +OpenWoo.app maakt gebruik van de federatieve zoekvraag ontwikkeld binnen [OpenCatalogi](https://opencatalogi.nl/) om verschillende integrale zoekvragen virtueel samen te voegen.  Simpel gezegd roept de landelijke zoek-API meerdere instanties van [Open Index](https://index.openregisters.app) aan en aggregeert de resultaten. Technisch zitten daar nog wat haken en ogen aan die binnen Open Index worden [uitgelegd](). Er wordt hierbij dus géén gebruik gemaakt van een landelijke index, het geen data duplicatie voorkomt en organisaties zelf in controle houdt op hun publicaties. Dit 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 (ten behoeve van KOOP). 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 bevragingen tussen de federale zoekvraag en de verschillende organisaties kan via [NLX/FSC]( https://www.nlx.io/) lopen, of daarbuiten. Gezien het publieke bevragingen zijn op openbare informatie is NLX an sich niet verplicht en kan het inregelen van een PKI-certificaat nodeloos complex zijn. Dat gezegd hebbende biedt NLX ook voordelen met betrekking tot het monitoren en loggen van verkeer. ![OpenWeb Architecture](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/Federatie.svg) @@ -225,15 +226,15 @@ OpenWoo.app is een organisatie specifieke applicatie waarvan de installaties ond Dit zijn de aangeboden domeinen vanuit OpenWoo.app, daarnaast zien de dat de meeste organisaties hun publicatiepagina ontsluiten op hun eigen domein e.g. open.[organisatie_naam].nl -## Documenten vs Publicatie Objecten +## Documenten vs Publicatieobjecten -Vanuit de WOO denken we doorgaans aan documenten die gepubliceerd moeten worden, vanuit OpenWoo.app denken we echter in publicatie objecten waar een of meer documenten aan kunnen worden gekoppeld. Publicatie objecten omvatten de metadata waarmee documenten kunnen worden gevonden, geclusterd en weergegeven (zoals bijvoorbeeld thema's en typen). Publicatie objecten kunnen ook aan elkaar worden gerelateerd, dat is met name relevant in de casus van raadsinformatiesystemen waarbij een stuk hoort bij een agenda-item dat hoort bij een agenda bij een vergadering en gekoppeld kan zijn aan stemgedrag van personen of facties. +Vanuit de Woo denken we doorgaans aan documenten die gepubliceerd moeten worden. Vanuit OpenWoo.app denken we echter in termen van publicatieobjecten waaraan één of meer documenten kunnen worden gekoppeld. Publicatieobjecten bevatten de metadata waarmee documenten kunnen worden gevonden, geclusterd en weergegeven, zoals thema's en typen. Ook kunnen publicatieobjecten aan elkaar worden gerelateerd. Dit is vooral relevant in raadsinformatiesystemen, waar een stuk hoort bij een agenda-item, dat weer hoort bij een agenda van een vergadering en gekoppeld kan zijn aan stemgedrag van personen of fracties. Het onderling aan elkaar relateren van publicatieobjecten leidt onder water tot een driedimensionaal datamodel en is een van de redenen waarom er binnen OpenWoo.app is gekozen voor linked data. ## Metadata -Ieder publicatie object beschikt over een type (bijvoorbeeld woo_verzoek) en een voorgedefinieerde metadata set. De metadataset beschrijft wat er in de publicatie aan gegevens wordt verwacht en typeert deze (bijvoorbeeld heeft titel, de titel is een string) en biedt daarmee context voor de weergave van de publicatie. Dit bied de search UI de mogelijkheid om cards te maken die geoptimaliseerd zijn voor specifieke WOO-categorieën en een algemene card voor niet op voorhand gedefinieerde of onbekende categorieën. +Ieder publicatie object beschikt over een type (bijvoorbeeld woo_verzoek) en een voorgedefinieerde metadataset. De metadataset beschrijft wat er in de publicatie aan gegevens wordt verwacht en typeert deze (bijvoorbeeld heeft titel, de titel is een string) en biedt daarmee context voor de weergave van de publicatie. Dit biedt de search UI de mogelijkheid om cards te maken die geoptimaliseerd zijn voor specifieke WOO-categorieën en een algemene card voor niet op voorhand gedefinieerde of onbekende categorieën. Dat laatste kan voorkomen als een organisatie zelf metadata sets toevoegt, dat mag. Het is mogelijk voor organisaties om zelf extra metadata beschrijvingen te definiëren en hierop te publiceren. Organisaties zijn daarmee ook niet gelimiteerd tot de door KOOP gedefinieerde categorieën. Dit is ook een van de redenen waarom zoeken in de UI de faceted search MOET implementeren (zie ook de [architectuur documentatie van open catalogi](https://documentatie.opencatalogi.nl/Handleidingen/Architectuur/)). Het is niet op voorhand voorspelbaar op welke aspecten kan worden gezocht, dit is afhankelijk van de publicaties en gedefinieerde metadata zoals gepubliceerd door deelnemende organisaties. diff --git a/docs/techniek/Configuratie.md b/docs/techniek/Configuratie.md index e54c10ca..4736a18e 100644 --- a/docs/techniek/Configuratie.md +++ b/docs/techniek/Configuratie.md @@ -4,9 +4,9 @@ Om te zorgen dat de OpenWoo-website goed werkt, is het belangrijk dat de onderli - [Configuratie](#configuratie) - [Gebruik variabelen](#gebruik-variabelen) - - [Algemene inrichting zaaksysteem](#algemene-inrichting-zaaksysteem) - - [Categorieën](#categorieën) - - [Bijlagen](#bijlagen) + - [Algemene inrichting zaaksysteem](#algemene-inrichting) + - [Categorieën](#eigenschappen-naar-categorie) + - [Bijlagen](#documentenbijlagen) - [Mapping ZGW](#mapping-zgw) - [Mapping vanuit zaaksysteem.nl search endpoint](#mapping-vanuit-zaaksysteemnl-search-endpoint) @@ -38,16 +38,16 @@ In de overzichtspagina worden de properties op de volgende plekken weergegeven. Voor het kunnen publiceren van zaken vanuit het zaaksysteem is het belangrijk dat het zaaksysteem beschikt over de juiste inrichting. Indien er via de [OpenWoo service](https://openwoo.openservices.online/) zaken worden opgehaald, gelden daarvoor de volgende spelregels. - OpenWoo.app kijkt alleen naar eigenschappen die vooraf worden gegaan door `woo_` -- Er zijn algemene eigenschappen (geldend voor alle categorien) en specifieke eigenschapen (alleen geldend voor bepaalde categoerien) -- Voor de gedefineerde categeriën volgen we de [informatiecategorieen-en-werkdefinities](https://www.open-overheid.nl/onderwerpen/actieve-openbaarmaking/informatiecategorieen-en-werkdefinities) van koop -- Voor de velden volgen we daarnaast ook [diwoo](https://standaarden.overheid.nl/diwoo/metadata/diwoo-handleiding-sitemapindex-en-sitemaps). -- Naast deze categoerien mag een organisatie ook eigen categorien voeren maar dan worden alleen de algemene eigenschappen over genomen +- Er zijn algemene eigenschappen (geldend voor alle categorieën) en specifieke eigenschappen (alleen geldend voor bepaalde categorieën) +- Voor de gedefinieerde categorieën volgen we de [informatiecategorieen-en-werkdefinities](https://www.open-overheid.nl/onderwerpen/actieve-openbaarmaking/informatiecategorieen-en-werkdefinities) van koop +- Voor de velden volgen we daarnaast ook [DiWoo](https://standaarden.overheid.nl/diwoo/metadata/diwoo-handleiding-sitemapindex-en-sitemaps). +- Naast deze categorieën mag een organisatie ook eigen categorieën voeren, maar dan worden alleen de algemene eigenschappen over genomen -Het is niet per definitie nodig om alle eigenschappen in het bron systeem handmatig in te regelen en vullen, sommige eigenschapen kunnen worden overgenomen uit algemene metadata van een bron systeem. Kijk onder [Mappings](#Mappings) om te zien welke eigenschappen automatisch worden gevuld. +Het is niet per definitie nodig om alle eigenschappen in het bronsysteem handmatig in te regelen en vullen, sommige eigenschappen kunnen worden overgenomen uit algemene metadata van een bron systeem. Kijk onder [Mappings](#mappings) om te zien welke eigenschappen automatisch worden gevuld. ### Algemene eigenschappen -Een aantal zaakatributen zijn noodzakenlijk voor het voor het goed werken van de OpenWoo.app, ze zijn dan ook altijd verplicht ongeacht de Woo categori. +Een aantal zaakattributen zijn noodzakelijk voor het voor het goed werken van de OpenWoo.app, ze zijn dan ook altijd verplicht ongeacht de Woo categorie.   | Property | Verplicht | Gebruik | Toegestane waardes | |---------------------|-----------|---------------------------------------------------------------------------------------------------------|--------------------| @@ -100,7 +100,7 @@ Een aantal zaakatributen zijn noodzakenlijk voor het voor het goed werken van de | 2l | Klachtoordelen | `woo_datum_ontvangst`, `woo_organisatieonderdeel`, `woo_functiebenaming`, `woo_gedraging`, `woo_bevindingen`, `woo_oordeel`, `woo_conclusies`, `woo_datum_besluit`,`woo_termijnoverschrijding` | [definitie](https://www.open-overheid.nl/onderwerpen/actieve-openbaarmaking/instrumenten-en-diensten/richtlijnen/2024/2/16/werkdefinitie-klachtoordelen) | > **Note** -> Nog niet vastgestelde categorien of categorien die buiten de OpenWoo.app vallen kunnen wel worden ontsloten via OpenWoo.app, daarbij kan gebruik worden gemaakt van de algemene eigenschappen en documenten/bijlagen. De specifieke eigenschappen worden echter pas opgenomen op het moment dat de categorie door KOOP is vastgesteld. +> Nog niet vastgestelde categorieën of categorieën die buiten de OpenWoo.app vallen kunnen wel worden ontsloten via OpenWoo.app, daarbij kan gebruik worden gemaakt van de algemene eigenschappen en documenten/bijlagen. De specifieke eigenschappen worden echter pas opgenomen op het moment dat de categorie door KOOP is vastgesteld. ### Documenten/Bijlagen @@ -114,14 +114,14 @@ Bijlagen nemen een bijzondere positie in binnen de OpenWoo.app, ze vormen de ker | woo_besluit | Documenten met dit label worden weergegeven onder de titel 'Besluit' in plaats van onder bijlagen | | woo_convenant | Documenten met dit label worden weergegeven onder de titel 'Convenant' in plaats van onder bijlagen | -> **Spelregels omtrend labels** +> **Spelregels omtrent labels** > -> - Het is mogelijk om als organisatie zelf extra labels toe te voegen, als deze het juist format volgen `woo_[[labelnaam]]]` worden deze automatisch overgenomen in de weergave door boven de rij `Bijlagen` een extra rij toe te voegen in de form `[[labelnaam]]: Alle hieraan gekoppelde bestanden`. +> - Het is mogelijk om als organisatie zelf extra labels toe te voegen, als deze het juiste format volgen `woo_[[labelnaam]]]` worden deze automatisch overgenomen in de weergave door boven de rij `Bijlagen` een extra rij toe te voegen in de form `[[labelnaam]]: Alle hieraan gekoppelde bestanden`. > - Bestanden die geen andere label hebben dan `woo_publicatie` worden getoond in de rij `Bijlagen`. > - Als bestanden meerdere labels hebben worden ze op meerdere plekken getoond (met uitzondering van `Bijlagen` daar worden alleen bestanden getoond zonder label) -> - Bestanden zonder het label `woo_publicatie` worden niet getoond (ook al zijn ze wel van een ander `woo_` label voorzien) +> - Bestanden zonder het label `woo_publicatie` worden niet getoond (ook al zijn ze wel van een ander `woo_`-label voorzien) -## Mappigns +## Mappings ### Mapping ZGW @@ -153,7 +153,7 @@ Bijlagen ## Configuratie -Als laatste zijn er ook een aantal waarde op het publicatie object die worden gezet aan de hand van configuratie in de [OpenWoo service](https://openwoo.openservices.online/), te weten +Als laatste zijn er ook een aantal waarde op het publicatieobject die worden gezet aan de hand van configuratie in de [OpenWoo service](https://openwoo.openservices.online/), te weten | Eigenchap | Invulling | Gebruik | |------------------|-------------------------------------|-------------------| diff --git a/docs/techniek/Installatie.md b/docs/techniek/Installatie.md index acf5c110..2696ab38 100644 --- a/docs/techniek/Installatie.md +++ b/docs/techniek/Installatie.md @@ -1,6 +1,6 @@ # Installatie -Deze installatiehandleiding is bedoeld voor overheden en leveranciers die zelfstandig aan de slag willen met OpenWoo-website. Als je OpenWoo-website als SaaS wilt afnemen, kijk dan onder [kosten](/docs/product/Kosten.md). +Deze installatiehandleiding is bedoeld voor overheden en leveranciers die zelfstandig aan de slag willen met OpenWoo-website. Als je OpenWoo-website als SaaS wilt afnemen, kijk dan onder [kosten](../product/Kosten.md). Het template voor de OpenWoo-website is gebaseerd op de Conduction [Productpage-template](https://github.com/ConductionNL/product-website-template) voor Common Ground. Hieronder tref je een verkorte installatiehandleiding aan die vooral focust op de onderliggende bronnen. Voor meer en uitgebreidere details kun je de documentatie van het Productpage-website-template gebruiken. @@ -93,7 +93,7 @@ Volg de installatiehandleiding op [Woo Bundle](https://github.com/ConductionNL/W ## Externe Systemen -Voor het koppelen van externe systemen geldt dat zij op de juiste manier moeten zijn geconfigureerd. Kijk daarvoor onder [configuratie](/docs/techniek/Configuratie.md). +Voor het koppelen van externe systemen geldt dat zij op de juiste manier moeten zijn geconfigureerd. Kijk daarvoor onder [configuratie](./Configuratie.md). ## Verdere documentatie diff --git a/docs/techniek/Integratie.md b/docs/techniek/Integratie.md index 35504d7b..250a46af 100644 --- a/docs/techniek/Integratie.md +++ b/docs/techniek/Integratie.md @@ -24,11 +24,11 @@ Als u vanuit uw casus een API nodig heeft zonder throttling, ratelimit of namens ### 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](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/Woo.postman_collection.json). We raden developers van ook van harte aan om aan de hand van deze collectie te spelen en te ontwikkelen. +Voor de API is een [Stoplight documentatie](https://conduction.stoplight.io/studio/open-catalogi?) 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](https://github.com/ConductionNL/opencatalogi/blob/feature/docs/postmancollection/docs/assets/Opencatalogi%20CRUD.postman_collection.json). We raden developers van ook van harte aan om aan de hand van deze collectie te spelen en te 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 vindt u terug in de [Redoc documentatie](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/oas.yaml)). +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 een aantal voor de hand liggende zoekparameters waarmee gezocht wordt (overige opties zijn terug te vinden in de [Stoplight documentatie](https://conduction.stoplight.io/studio/open-catalogi?)). 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` @@ -36,88 +36,76 @@ In het merendeel van de gevallen zult u een zoekvraag willen uitvoeren binnen de 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' +GET 'https://api.gateway.commonground.nu/api/publicaties?extend[]=all&_search=verzoek&_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": "385628ef-dd81-4ab2-98e1-3051ab1b3ef6", + "_self": { + "id": "385628ef-dd81-4ab2-98e1-3051ab1b3ef6", + "name": "informatieverzoek evenementenvergunning", + "self": "/api/publicaties/385628ef-dd81-4ab2-98e1-3051ab1b3ef6", + "schema": { + "id": "40c1041c-1526-4494-b191-244fdd30aefd", + "name": "Publicatie", + "ref": "https://commongateway.nl/woo.publicatie.schema.json" + }, + "level": 1, + "dateCreated": "2024-07-03T07:51:59+00:00", + "dateModified": "2024-08-02T12:26:46+00:00", + "dateDeleted": null, + "database": { + "id": null, + "name": null, + "ref": null + }, + "owner": { + "id": "06ef47a7-a2f1-4589-af59-b00a611d5692", + "name": "Default User", + "ref": "https://docs.commongateway.nl/user/default.user.json" + }, + "organization": { + "id": "a1c8e0b6-2f78-480d-a9fb-9792142f4761", + "name": "Default Organization", + "ref": "https://docs.commongateway.nl/organization/default.organization.json" + }, + "application": { "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 + "name": null, + "ref": null }, - "id": "8e1084b5-ba4d-4d33-a5c2-f98e7f893f07" + "synchronizations": [ + { + "id": "c04f118a-d853-48c4-a8d4-d4d86ef11b36", + "source": { + "id": "f1cf401b-fbbc-4416-b2da-519eac0163b9", + "ref": "https://commongateway.woo.nl/source/conduction.zaaksysteem.source.json", + "name": "Conduction zaaksysteem", + "description": "Conduction zaaksysteem api", + "location": "https://openwoo.zaaksysteem.net/api" + }, + "endpoint": null, + "sourceId": "001046b9-0a9b-4068-a6bf-3e7efcf75c67", + "dateCreated": "2024-07-03T07:51:59+00:00", + "dateModified": "2024-07-03T07:52:00+00:00", + "lastChecked": null, + "lastSynced": null, + "sourceLastChanged": null + } + ] } } + // 1 enkele voorbeeld publicaite, in dit geval zijn het er 64 ], - "count": 1, + "count": 12, "limit": 12, - "total": 1, + "total": 64, "offset": 0, "page": 1, - "pages": 1 + "pages": 6 } ```` @@ -125,7 +113,7 @@ Vanuit een het weergeven van een zoekformulier is het goed mogelijk dat u alleen ````cli GET 'https://api.gateway.commonground.nu/api/publicaties?_queries[]=categorie' -Content-Type: application/json+aggregations +Accept: application/json+aggregations Response @@ -168,7 +156,7 @@ De kerngegevens van een Woo-publicatie zitten in het metadata-object, de inhoud | Property | Verplicht | Gebruik | Toegestane waardes | |-----------------------|---------------|--------------|-----------------------| -#### Klachten +#### Klachtoordelen | Property | Verplicht | Gebruik | Toegestane waardes | |-----------------------|---------------|--------------|-----------------------| @@ -183,8 +171,8 @@ De kerngegevens van een Woo-publicatie zitten in het metadata-object, de inhoud 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). +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 zoals een 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 productiepagina](/docs/techniek/Productie.md). +Zie voor het koppelen van een organisatie de [naar productiepagina](../techniek/Productie.md). diff --git a/docs/techniek/Productie.md b/docs/techniek/Productie.md index b97c7bf9..ecb1ae6f 100644 --- a/docs/techniek/Productie.md +++ b/docs/techniek/Productie.md @@ -7,13 +7,13 @@ Het in productie nemen van OpenWoo.app voor uw organisatie is makkelijker dan u - Vraag tijdig een PKI-certificaat en DNS-wijziging 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 installeert zult u de [acties voor leverancier](#acties-voor-leverancier) uiteraard zelf moeten uitvoeren. +Als u de OpenWoo.app zelfstandig installeert zult u de [acties voor leverancier](#acties-voor-leverancier) uiteraard zelf moeten uitvoeren. ## Benodigde informatie voor de vormgeving 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) +- Logo in vector formaat (e.g. `.svg`, `.eps` of `.ai`) - Huisstijlhandboek of website die als voorbeeld gebruikt kan worden - Contactgegevens (naam, e-mailadres, telefoonnummer en functie) van een medewerker die eventuele vragen over de huisstijl kan beantwoorden. @@ -24,7 +24,7 @@ Om te beoordelen of uw organisatie NL Design tokens nodig heeft of moet aanpasse 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 contactgegevens 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