De status van dit document is voorlopig en zou nog kunnen wijzigen.
Uitleg uitvoeren WOZ-cases
Omgeving
Om deze casussen zelf lokaal uit te kunnen voeren dient de repository POC-Python te worden gecloned en dient de development omgeveniog opgezet te zijn zoals beschreven in de README.md van die repository.
Zorg voor een werkende Docker- en Docker-compose installatie.
Ga in de main-folder van de geclonede repository staan en voor het commando “make dev” uit.
Casussen uitvoeren:
De casussen kunnen worden uitgevoerd door in de main-folder van de repository het make-commando uit te voeren waarmee een casus kan worden uitgvoerd. Diverse casussen zijn met een aparte make-file te starten, maar er is een make-commando (make test_woz) waarmee alle casussen achter elkaar door worden uitgevoerd.
Voor deze opzet is gekozen omdat het mogelijk moet zijn (met name voor het opstellen van de documentatie) om reesultaten van specifieke casussen te kunnen weergeven.
In de beschrijving van de casussen schetsen hoe een casus uitgevoerd kan worden zodat dit herhaalbaar is voor iedereen die de poc-python repository beschikbaar heeft en een werkende python omgeving heeft.
Lineage
Het weergeven van de lineage kan gedaan worden door het commandId op te geven van het commando waarvan de lineage gewenst is en vervolgens “make lineage” uit te voeren.
Hiermee worden alle commands, gevolgen en claims in beeld gebracht die als gevolg van het uitvoeren van een command zijn geregistreerd. (Zie de Readme van de poc-python repository hoe deze moet worden uitgevoerd).
Bij de lineage zijn er drie typen weergave beschikbaar:
- Alleen de rollen en hun waarden: Lineage_Roles
- Volledige claimexpressies in state-vorm: Lineage-State")
- Deze weergave is alleen mogelijk als de casus is verwerkt met schema_variant=“structure_state.gql” (regel 27 )
- Volledige claimexpressies in event-vorm: Lineage-Event)
- Deze weergave is alleen mogelijk als vul_partijen is verwerkt met schema_variant=“structure_event.gql” (regel 27)
De lineage geeft de context weer tussen command, gevolgen en claims of annotaties per objecttype. Om de lineage te kunnen weergeven is ieder claim (ook annotaties) voorzien van een context-annotatie die verwijst naar het commando of het gevolg dat geleid heeft tot het vastleggen van deze claim. De context wordt in dit overzicht gerepresenteerd door de lijnen tussen de blokjes. Alle individuele context_annotaties van een gegroepeerd object zijn dus geconsolideerd in 1 verbindings-lijn.
De output van de lineage wordt vastgelegd in de folder “lineage”. Deze output is een definitie van een maermaid-classdiagram. De md-file is in github als grafische weergave te zien. Ook kunnen de regels (zonder de ``` - regels) in mermaid.live worden geplakt om een grafische weergave te krijgen.
Objectweergave
Nog een inzicht dat geboden wordt is een weergave waarbij de claims zijn gegroepeerd op object-niveau content_claims. Daarbij worden ook alle annotaties die zijn geregistreerd getoond.
In de casusbeschrijvingen zijn images ter illustratie opgenomen en kan via de een weergave op mermaid.live getoond kan worden waarbij ingezoomd kan worden. Voordat het aanmaken van de content_claims wordt gedraaid dient eerst in regel 58 van content_claims opgegeven te worden van welk(e) objecttype(n) de weergave gewenst is.
Zie de Readme van de poc-python repository hoe deze moet worden uitgevoerd. De output (content_claims) is vastgelegd in de poc-python/register_woz/content folder.
In deze beschrijvingen worden alleen de claim-rollen en de daarbij behorende waarden beschreven.