Skip to content

Latest commit

 

History

History
17 lines (16 loc) · 3.37 KB

02-Uitgangspunten.md

File metadata and controls

17 lines (16 loc) · 3.37 KB

Uitgangspunten

De volgende uitgangspunten gelden bij het samenstellen van de matrix:

  • De regels in dit document gaan over documenten die worden aangeboden in de ‘Van plan to publicatie’ keten. Vereisten aan deze document die nodig zijn voor correcte verwerking zijn hier wel in meegenomen.
  • De regels in dit document zijn altijd herleidbaar tot (1) een standaard, (2) een koppelvlakafspraak of (3) en interne verwerkingsregel. Dit document is zelf dus geen bron van nieuwe regels.
  • Als gevolg hiervan is de Validatiematrix dus ook geen standaard, maar een hulpmiddel bij het implementeren van de standaard.
  • Voor sommige validatieregels geldt dat ze wijzen op een fout in de interne consistentie van de keten (bijvoorbeeld als een id wel bekend is in de LVBB maar niet in OZON). Wanneer één van deze regels een foutmelding genereert is dat niet te wijten aan een fout in het aangeleverde bestand, maar op een ketenprobleem. Dit soort fouten wordt zoveel mogelijk afgevangen voordat ze bij de gebruiker terechtkomen.
  • Wijzigingen in dit document zijn altijd te herleiden tot wijzigingen in de standaard, of het expliciet maken van een regel die al in de standaard stond.
  • Niet alle validatiesregels in dit document zijn geïmplementeerd. En hoewel dit niet de bedoeling is, is het mogelijk on niet valide documenten de keten in te krijgen. Welke validatieregels geïmplementeerd zijn is geen onderdeel van dit document (omdat het ervan afhangt in welke omgeving je werkt). Er wordt naar gestreefd per werkomgeving bij te houden welke validatieregels afgedwongen worden. Bijvoorbeeld in de release notes.
  • Voor wijzigingsbeheer betekent dit dat de impact van dit document altijd klein is: de impact zit in het wijzigen van de standaard of in het feit dat de regel in een systeem wordt geïmplementeerd.
  • Validatieregels worden zo nauwkeurig mogelijk gespecificeerd in natuurlijke taal, bijvoorbeeld door de richtlijnen van RuleSpeak toe te passen.
  • Een validatieregel heeft een eigenschap ernst met de waarde 'Blokkerend' of 'Waarschuwing'. Blokkerende validatieregels leiden tot afkeuring van het document in de keten. Documenten met Waarschuwing worden wel toegelaten in de keten, maar resulteren in een melding aan de indiener. Waarschuwing worden bijvoorbeeld gebruikt om te melden dat een bepaalde constructie in de huidige versie van de standaard nog wel is toegestaan, maar in de toekomst niet meer. Uit de formulering van de validatieregel moet blijken waarom de waarschuwing gegeven wordt.
  • Waarschuwingen hoeven niet altijd herleidbaar tot een regel uit de standaard maar mogen ook gebruikt om te waarschuwen voor constructies in een aanlevering die mogen van de standaard maar waarschijnlijk niet zo bedoeld waren. Een voorbeeld hiervan is een Locatie die buiten het ambtsgebied van een bevoegd gezag ligt. Er zijn gevallen waarin dit kan gebeuren maar vaak zal het toch niet de bedoeling zijn geweest.
  • Eigenaarschap van regels: voor het regelen van verantwoordelijkheden binnen de validatiematrix is het wenselijk om per regel een eigenaar aan te wijzen. Een begin hiervan is te vinden in de identificatie van de regels waar de letters aan het begin een indicatie zijn van de eigenaar. Dit wordt verder uitgewerkt in volgende versies van dit document.
  • Waar mogelijk is de formulering van de regel in de standaard gelijk aan die in de validatiematrix.