Skip to content

Commit

Permalink
Markdown linter fixes (#10)
Browse files Browse the repository at this point in the history
* restructure sections

* add first specs per component

* add specs en initial architecture

* Add content and first ADR

* Add decision records, expand goal

* expand specs and first extension

* Fix markdownlinter errors

* Wijzig structuur specificaties

* Toevoegen besluiten en herstructuring

* Fix component-logboek.md

* Verwerken feedback deel 1

* Markdown linter fixes
  • Loading branch information
ehotting authored Jun 24, 2024
1 parent dc7e968 commit 5b6dbc6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@
Om te optimaliseren voor de het lezen en begrijpen van de logs is het denkbaar om vrijwel alle informatie redundant wordt weggeschreven in elk logrecord, zodat er geen afhankelijkheid bestaat van andere bronnen.

Dit heeft nadelen, zoals:

- Wanneer de statische gegevens (zoals bewaartermijn, verantwoordelijke, etc.) wijzigen, zou dit moeten worden aangepast in alle logrecords. Dat verhoudt zich slecht tot het 'inmutable' zijn van deze logrecords.
- De grote vrijheid in alle clients om invulling te geven aan deze gegevens leidt er vrijwel zeker toe dat verdere divergentie optreedt. Dit heeft o.a. tot gevolg dat het lastig wordt om te rapporteren uit de logs
- De API voor het wegschrijven van logs wordt ingewikkeld en relatief traag voor het wegschrijven van records

In de gewenste situatie:

- staan alle statische gegevens in het Register van de Verwerkingsactiviteiten (RvVA), en bevatten logrecords verwijzigen naar dat register. Specifiek gaat dit om de resources 'verwerkingsactiviteiten' en 'organisaties'.
- kan bij het configureren van clients in de RvVA-API worden opgezocht welke organisaties en verwerkingsactiviten van toepassing zijn
- kunnen wijzigingen in verwerkingsactiviteiten worden doorgevoerd zonder dat logrecords gewijzigd behoeven te worden
Expand All @@ -38,6 +40,7 @@ Logregels bevatten geen informatie over Verwerkingsactiviteiten en Veranwoordlei

Met de volgende sequentie diagrammen wordt in beeld gebracht wat de gevolgen zijn voor de diverse flows in het gebruik van de standaard.


### Loggen van een verwerking

Het wegschrijven van een verwerking in de log-API is uiterst simpel:
Expand All @@ -53,6 +56,7 @@ sequenceDiagram

Deze transactie is geoptimaliseerd op eenvoud en snelheid, want deze heeft rechtstreeks invloed op de snelheid van verwerkingen. Deze transactie moet schaalbaar zijn naar bijv. tienduizenden transacties per seconde.


### Tonen van een verwerking

Voor het op betekenisvolle manier tonen van verwerkingen aan bijvoorbeeld een betrokkene is het dan nodig om gegevens op te vragen uit zowel de logs als het RvVA. Deze flow mag wat complexer zijn, omdat deze niet voor alle vastgelegde data wordt uitgevoerd en het belang van de bevraging rechtvaardigt dat een bevraging wat langer kan duren.
Expand Down
1 change: 1 addition & 0 deletions sections/02-architectuur/04-flows.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Flows


## Wegschrijven van een logregel na een Dataverwerking

```mermaid
Expand Down

0 comments on commit 5b6dbc6

Please sign in to comment.