diff --git a/docs/Architectuur.md b/docs/Architectuur.md index d1603e33..445420f3 100644 --- a/docs/Architectuur.md +++ b/docs/Architectuur.md @@ -17,3 +17,15 @@ Het is ook mogelijk om de voorkant te koppelen aan een Common Gateway-installati Nadeel van deze oplossingsrichting is dat de gemeente de Common Gateway (open source framework) of zelf zal moeten installeren of als SAAS afnemen. ![https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/commongateway.svg](https://raw.githubusercontent.com/ConductionNL/woo-website-template/main/docs/commongateway.svg "Commongateway Architecture") + +### Ophalen informatie + +In principe "scraped" de Open WOO plugin elke nacht alle relevante zaken, hierbij zijn de stappen + +1. Ophalen alle zaaktypen +2. Per zaaktype controleren op beschikbare eigenschappen (zie inrichting zaaksysteem) +3. Per zaaktype dat aan de voorwaarden voldoet de zaken ophalen +4. Per zaak controleren of er een publicatiedatum is, indien ja de zaak opnemen in de index +5. Zaken die niet in bovenstaande loop zijn gevonden, maar momenteel wel in de index zijn opgenomen verwijderen + +In principe is bovenstaande genoeg om te zorgen dat het zaaksysteem leidend is en zaken zowel gepubliceerd als gedepubliceerd kunnen worden. diff --git a/docs/Configuratie.md b/docs/Configuratie.md index 26b30a7c..1e95539b 100644 --- a/docs/Configuratie.md +++ b/docs/Configuratie.md @@ -1,39 +1,58 @@ # Configuratie +## Algemene inrichting zaaksystem +Voor het kunnen publiceren van zaken vanuit het zaaksysteem is het belangrijk dat het zaaksysteem beschikt over de juiste inrichting. Indien er via de Common Gateway (met Open Woo plugin) zaken worden opgehaald gelden daarvoor de volgende spelregels. + +Zaken dienen te beschikken over de volgende properties (zaak attributen): + +| Property | Verplicht | Gebruik | Toegestane waardes | +|---------------------|-----------|---------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| woo_publicatiedatum | Ja | De datum vanaf wanneer de publicatie wordt gepubliceerd, bij leeg wordt de publicatie niet gepubliceerd | string formated as date-time (e.g. 2023-09-12 09:00) or string formated as date (e.g. 2023-09-12) or NULL. if a date is presented instead of a date-time the time wil be automaticly set to 00:00. | +| woo_categorie | Ja | De categorie van de WOO-Publicatie | One of ("Wetten en algemeen verbindende voorschriften","Overige besluiten van algemene strekking","Ontwerpen van wet- en regelgeving met adviesaanvraag","Organisatie en werkwijze","Bereikbaarheidsgegevens","Bij vertegenwoordigende organen ingekomen stukken","Vergaderstukken Staten-Generaal","Vergaderstukken decentrale overheden","Agenda's en besluitenlijsten bestuurscolleges","Adviezen","Convenanten","Jaarplannen en jaarverslagen","Subsidieverplichtingen anders dan met beschikking","WOO-verzoeken en -besluiten","Onderzoeksrapporten","Beschikkingen","Klachtoordelen")               | +| woo_thema | Nee | Een optionele titel van thema waar de zaak onder valt | string, max 255 characters | +| woo_beschrijving | Nee | De beschrijving van de publicatie zo als online getoond | string, max 255 characters | +| woo_samenvatting | Nee | De samenvatting van de publicatie zo als online getoond | string, max 255 characters | +| woo_datum_besluit | Nee | | string formated as date-time (e.g. 2023-09-12 09:00) or string formated as date (e.g. 2023-09-12). if a date is presented instead of a date-time the time wil be automaticly set to 00:00. | + +Daarnaast is het mogelijk om bijlagen van publicaties te clusteren aan de hand van labels. + +> **Note** +> Op dit moment doet Open WOO nog niets met thema's behalve ze weergeven bij de zaak. Er zijn echter plannen om in de toekomst een thema overzichtspagina te maken en WOO-publicaties filterbaar te maken op thema. + ## Mapping van XXLLNC zaken (opgehaald via search endpoint) Gebaseerd op: https://github.com/CommonGateway/WooBundle/blob/main/Installation/Mapping/woo.xxllncCaseToWoo.mapping.json -| Woo publicatie (conform open web) | Zaaksysteem case | -|-----------------------------------|----------------------------------| -| UUID | id | -| ID | id | -| Object_ID | object_id | -| Portal_url | {{config}}.{{id}} | -| Behandelend_bestuursorgaan | {{config}} | -| Ontvanger_informatieverzoek | (Empty) | -| Volgnummer | (Empty) | -| Titel | values.case.subject_external | -| Beschrijving | values.attribute.woo_beschrijving | -| Samenvatting | values.values.attribute.woo_samenvatting | -| Categorie | values.attribute.woo_categorie | -| Verzoeker | (Empty) | -| Ontvangstdatum | values.case.date_of_registration | -| Besluitdatum | values.attribute.woo_datum_besluit | -| Behandelstatus | values.case.status | -| Publicatiedatum | values.attribute.woo_publicatiedatum | -| Besluit | is de bijlage gelabeld als "besluit" | -| Termijnoverschrijding | case.date_target - case.date_of_completion | -| URL_informatieverzoek | is de bijlage gelabeld als "informatie verzoek" | -| URL_inventarisatielijst | is de bijlage gelabeld als "inventarisatielijst" | -| URL_besluit | is de bijlage gelabeld als "besluit" | -| Geografisch_gebied | (Empty) | -| BAG_ID | (Empty) | -| BGT_ID | (Empty) | -| Postcodegebied | (Empty) | -| Adres | (Empty) | -| COORDS | (Empty) | -| Geografische_positie | (Empty) | -| Bijlagen | values.attribute.test_documenten | +| Woo publicatie (conform open web) | Zaaksysteem veld | +|-----------------------------------|--------------------------------------------------| +| UUID | id | +| ID | id | +| Object_ID | object_id | +| Portal_url | {{config}}/{{id}} | +| Behandelend_bestuursorgaan | {{config}} | +| Ontvanger_informatieverzoek | (Empty) | +| Volgnummer | (Empty) | +| Titel | values.case.subject_external | +| Beschrijving | values.attribute.woo_beschrijving | +| Samenvatting | values.values.attribute.woo_samenvatting | +| Categorie | values.attribute.woo_categorie | +| Verzoeker | (Empty) | +| Ontvangstdatum | values.case.date_of_registration | +| Besluitdatum | values.attribute.woo_datum_besluit | +| Behandelstatus | values.case.status | +| Publicatiedatum | values.attribute.woo_publicatiedatum | +| Besluit | is de bijlage gelabeld als "besluit" | +| Termijnoverschrijding | case.date_target - case.date_of_completion | +| URL_informatieverzoek | is de bijlage gelabeld als "informatie verzoek" | +| URL_inventarisatielijst | is de bijlage gelabeld als "inventarisatielijst" | +| URL_besluit | is de bijlage gelabeld als "besluit" | +| Geografisch_gebied | (Empty) | +| BAG_ID | (Empty) | +| BGT_ID | (Empty) | +| Postcodegebied | (Empty) | +| Adres | (Empty) | +| COORDS | (Empty) | +| Geografische_positie | (Empty) | +| Bijlagen | values.attribute.test_documenten | | Bijlage | values.attribute.test_documenten | |------------------------------------|--------------------------------------------------------| @@ -43,4 +62,4 @@ Gebaseerd op: https://github.com/CommonGateway/WooBundle/blob/main/Installation/ | Titel_Bijlage | filename | | URL_Bijlage | (Empty) | -Let op: Alleen documenten die zijn gelabeld als woo_publiceren worden \ No newline at end of file +Let op: Alleen documenten die zijn gelabeld als woo_publiceren worden daadwerkenlijk overgenomen door de plugin \ No newline at end of file diff --git a/docs/Installatie.md b/docs/Installatie.md index b54d48e0..6050c858 100644 --- a/docs/Installatie.md +++ b/docs/Installatie.md @@ -1,5 +1,7 @@ # Installatie +Deze installatie handleiding is bedoeld voor overheden en levernciers die zelfstandig aan de slag willen met Open WOO Website, als je Open WOO website als SAAS wilt afnemen kijk dan onder [kosten](/kosten). + Het Open WOO Website template is gebaseerd op het Conduction [Productpage template](https://github.com/ConductionNL/product-website-template) voor commonground. Onderstaande tref je ene verkorte installatie handleiding die vooral focust op de onderliggende bronnen. Voor meer en uitgebreidere details kunt u de documentatie van de Productpage website template gebruiken. ## Randvoorwaarden @@ -30,19 +32,19 @@ Dit template is in eerste instantie opgezet om serverless gebruikt te worden via Configuratie vindt plaats via environment (env) waardes. In het geval van een serverless configuratie moeten de env waardes worden aangepast in de [page deploy workflow](/.github/workflows/woo-page-deploy.yml). In het geval van een server installatie in het .env bestand in de Gatsby root map. We ondersteunen de volgende configuratieopties -| Key | Required | Usage | Allowed Value | Default / Example | -|---------------------------|------------------------|---------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------------------------------| -| GITHUB_PAGES_BRANCH | Alleen bij serverless | De branche waarop de pagina wordt gebouwd | string, max 255 characters | gh-pages | -| GITHUB_REPOSITORY_NAME | Alleen bij serverless | | string, max 255 characters | `${{ github.event.repository.name }}` | -| API_BASE_URL | Yes | De locatie van de Open WOO API | string , string, max 255 characters | "" | -| NL_DESIGN_THEME_CLASSNAME | Yes | De naam van het thema van de organisatie | string, max 255 characters | "conduction-theme" | -| FAVICON_URL | Yes | De locatie van de favicon van de organisatie | string , max 255 characters | "" | -| HEADER_LOGO_URL | Yes | De locatie van het primaire logo van de organisatie | string, moet een base encoded afbeelding zijn OF url | "" | -| ORGANISATION_NAME | Yes | De naam van de Organisatie | string, max 255 characters | "Conduction" | -| JUMBOTRON_IMAGE_URL | No | De locatie van de gebruikte header, bij leeg wordt er geen header getoont | string , max 255 characters | "" | -| FOOTER_LOGO_URL | Yes | De locatie van het primaire logo van de organisatie | string, moet een base encoded afbeelding zijn OF url | ... | -| FOOTER_LOGO_HREF | Yes | De homepage van de organisatie | string , max 255 characters | "" | -| OIDN_NUMBER | No | Het OIDN nummer van de organisatie, bij leeg worden WOO publicaties mogenlijk niet beperkt tot de eigen organisatie | integer, max 16 characters | 1234567890 | +| Key | Verplicht | Usage | Allowed Value | Default / Example | +|---------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------------------------------| +| GITHUB_PAGES_BRANCH | Alleen bij serverless | De branche waarop de pagina wordt gebouwd | string, max 255 characters | gh-pages | +| GITHUB_REPOSITORY_NAME | Alleen bij serverless | | string, max 255 characters | `${{ github.event.repository.name }}` | +| API_BASE_URL | Ja | De locatie van de Open WOO API | string , string, max 255 characters | "" | +| NL_DESIGN_THEME_CLASSNAME | Ja | De naam van het thema van de organisatie | string, max 255 characters | "conduction-theme" | +| FAVICON_URL | Ja | De locatie van de favicon van de organisatie | string , max 255 characters | "" | +| HEADER_LOGO_URL | Ja | De locatie van het primaire logo van de organisatie | string, moet een base encoded afbeelding zijn OF url | "" | +| ORGANISATION_NAME | Ja | De naam van de Organisatie | string, max 255 characters | "Conduction" | +| JUMBOTRON_IMAGE_URL | Nee | De locatie van de gebruikte header, bij leeg wordt er geen header getoont | string , max 255 characters | "" | +| FOOTER_LOGO_URL | Ja | De locatie van het primaire logo van de organisatie | string, moet een base encoded afbeelding zijn OF url | ... | +| FOOTER_LOGO_HREF | Ja | De homepage van de organisatie | string , max 255 characters | "" | +| OIDN_NUMBER | Nee | Het OIDN nummer van de organisatie, bij leeg worden WOO publicaties mogenlijk niet beperkt tot de eigen organisatie | integer, max 16 characters | 1234567890 | ## Backend @@ -57,38 +59,5 @@ Volg de installatiehandleiding op [https://github.com/OpenWebconcept/plugin-open Volg de installatiehandleiding op [WOO Bundle](https://github.com/ConductionNL/WooBundle/tree/main). ## Externe systemen +Voor het koppelen van externe systemen geld dat zij op de juiste manier moeten zijn geconfigureerd, kijk daarvoor onder [configuratie](/Configuratie). -### Inrichting Zaaksysteem - -Voor het kunnen publiceren van zaken vanuit het zaaksysteem is het belangrijk dat het zaaksysteem beschikt over de juiste inrichting. Indien er via de Common Gateway (met Open Woo plugin) zaken worden opgehaald gelden daarvoor de volgende spelregels. - -Zaken dienen te beschikken over de volgende properties (zaak attributen): - -| Property            | Required | Usage                                                                                                 | Allowed Value               | -|---------------------|----------|-------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| woo_publicatiedatum | Yes      | De datum vanaf wanneer de publicatie wordt gepubliceerd, bij leeg wordt de publicatie niet gepubliceerd | date-time or NULL           | -| woo_categorie       | Yes      | De categorie van de WOO-Publicatie                                                                    | One of ("Wetten en algemeen verbindende voorschriften","Overige besluiten van algemene strekking","Ontwerpen van wet- en regelgeving met adviesaanvraag","Organisatie en werkwijze","Bereikbaarheidsgegevens","Bij vertegenwoordigende organen ingekomen stukken","Vergaderstukken Staten-Generaal","Vergaderstukken decentrale overheden","Agenda's en besluitenlijsten bestuurscolleges","Adviezen","Convenanten","Jaarplannen en jaarverslagen","Subsidieverplichtingen anders dan met beschikking","WOO-verzoeken en -besluiten","Onderzoeksrapporten","Beschikkingen","Klachtoordelen")               | -| woo_thema           | No       | Een optionele titel van thema waar de zaak onder valt                                                 | string, max 255 characters | -| woo_beschrijving | | | string, max 255 characters | -| woo_samenvatting | | | string, max 255 characters | -| woo_datum_besluit | | | string, max 255 characters | -| | | | | -Daarnaast is het mogelijk om bijlagen van publicaties te clusteren aan de hand van labels. - -Note: Op dit moment doet Open WOO nog niets met thema's behalve ze weergeven bij de zaak. Er zijn echter plannen om in de toekomst een thema overzichtspagina te maken en WOO-publicaties filterbaar te maken op thema. - -#### Voor XXLLNC (zaaksysteem.nl) - -Er kan worden gekoppeld via de zoeken-optie - -### Ophalen informatie - -In principe "scraped" de Open WOO plugin elke nacht alle relevante zaken, hierbij zijn de stappen - -1. Ophalen alle zaaktypen -2. Per zaaktype controleren op beschikbare eigenschappen (zie inrichting zaaksysteem) -3. Per zaaktype dat aan de voorwaarden voldoet de zaken ophalen -4. Per zaak controleren of er een publicatiedatum is, indien ja de zaak opnemen in de index -5. Zaken die niet in bovenstaande loop zijn gevonden, maar momenteel wel in de index zijn opgenomen verwijderen - -In principe is bovenstaande genoeg om te zorgen dat het zaaksysteem leidend is en zaken zowel gepubliceerd als gedepubliceerd kunnen worden. diff --git a/docs/Kosten.md b/docs/Kosten.md new file mode 100644 index 00000000..bdc15b4f --- /dev/null +++ b/docs/Kosten.md @@ -0,0 +1 @@ +# Kosten