Skip to content

Commit

Permalink
More docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@rubenvdlinde
rubenvdlinde committed Sep 21, 2023
1 parent 582c1d8 commit 41d4f0c
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 79 deletions.
12 changes: 12 additions & 0 deletions docs/Architectuur.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
83 changes: 51 additions & 32 deletions docs/Configuratie.md
View file
Original file line number Diff line number Diff line change
@@ -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 |
|------------------------------------|--------------------------------------------------------|
Expand All @@ -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
Let op: Alleen documenten die zijn gelabeld als woo_publiceren worden daadwerkenlijk overgenomen door de plugin
Loading

0 comments on commit 41d4f0c

Please sign in to comment.