Validatieregels

Owned by Daniel Tollenaar
Last updated: Dec 15, 2023
2 min read

Bijgewerkt tot versie: 1.2.0

Sets met validatieregels voor de Validatiemodule zijn beschikbaar op een daarvoor aangemaakte GitHub-pagina. Op deze pagina kunt u bestanden met validatieregels, waaronder een actuele voorbeeldset die u kunt gebruiken voor het valideren van uw HyDAMO gegevens.

De structuur waaraan uw bestand met validatieregels (validationrules.json) moet voldoen zijn vastgelegd in een JSON-schema, welke u kunt gebruiken voor het valideren van uw JSON voorafgaand aan het gebruik van de validatiemodule. Ook de validatiemodule zal zelf het de JSON met validatieregels valideren aan het JSON-schema voorafgaand aan de datavalidatie zelf.

Op deze pagina vindt u een beschrijving van de objecten binnen het validatie JSON bestand:

schema

De versie van het JSON-schema waaraan dit bestand moet voldoen.

hydamo_version

De versie van HyDAMO waaraan de objecte-lagen en attributen binnen de object-lagen aan moeten voldoen. We ondersteunen op dit moment alleen HyDAMO versie 2.2.

status_object

Een lijst met statussen waarop de datasets worden gefilterd. De mogelijke waarden hierin volgen de enumeratie van attribuutwaarden binnen het attribuut status_object van elke object-laag.

objects

Een lijst met hydamo object-lagen waarover contextuele datavalidatie wordt uitgevoerd. Elk item in de lijst bevat de volgende JSON-elementen, die in de secties hieronder nader worden toegelicht:

general_rules (optioneel)

Een optionele lijst met algemene regels die nieuwe numerieke variabele genereren binnen de HyDAMO object-laag. Deze variabelen zijn vanaf dat punt beschikbaar voor validatieregels en/of general_rules van andere object-lagen. Binnen general_rules worden de volgende objecten gespecificeerd

id

(integer-waarde) de index van de validatieregel; bepaald de volgorde waarin deze in de resultaattabel wordt opgenomen

result_variable

bepaalt attribuut-naam samen met id: general_{id}_{result_variable}

function

de functie waarmee de result_variable wordt berekend. Deze functies vormen de kern van de general_rules en staan beschreven in https://hkvconfluence.atlassian.net/wiki/spaces/VAL/pages/1986985985/Functies#Hulpfuncties-(general_rules).

validation_rules (optioneel)

(Topo)logische validatieregels die beoordelen of een object of attribuut-waarde wel of niet logisch zijn.

id

(integer-waarde) de index van de validatieregel; bepaalt de volgorde waarin deze in de resultaattabel wordt opgenomen

name

een beschrijvende naam voor de validatieregel

type

logic/topologic, type validatieregel

validation_rule_set

identificatie van de set waarbinnen de regel hoort, waarmee de gebruiker kan filteren

exceptions

een lijst met nen3610ids die moeten worden uitgesloten van validatie

tags

optionele lijst met tags waarop de gebruiker kan filteren

filter

een filter voor het opnemen/uitsluiten van objecten in de validatieregel middels een logische functie

error_type

critical/non-critical, indicatie voor het gewicht van de regel

error_message

foutmelding die in samenvatting wordt bijgeschreven wanneer een object faalt op een bepaalde regel

result_variable

bepaalt attribuut-naam samen met id: validate_{id}_{result_variable}

active

optie om een validatieregel mee te nemen/uit te sluiten in validatie

function

de functie waarmee de validatie wordt uitgevoerd. Deze functies formen de kern van de validation_rules en worden afhankelijk van het type (logic/topology) uitgevoerd met de functies beschreven in: