kadaster / klic-win

https://kadaster.nl/zakelijk/registraties/landelijke-voorzieningen/klic
20 stars 16 forks source link

Aanpassing naamgeving statussen bij samenstellen beheerdersinformatie #90

Closed herman-vandenberg closed 8 months ago

herman-vandenberg commented 4 years ago

De invoering van IMKL/BMKL stond in najaar 2018 flink onder druk. Het was niet meer mogelijk om een logische naam te geven voor de eindstatus als de nieuwe processtap om beheerdersinformatielevering samen te stellen, was afgerond. Daardoor heeft de eindstatus nu een onlogische naam. In de nieuwe versie van de BMKL-API zou dit rechtgetrokken kunnen worden.

Zie het voorgestelde statusverloop in de bijlage: klc-STD Produceren beheerdersinformatie (codelist v2).pdf

Samengevat:

status huidige naam gewenste naam
beheerdersinformatie is gereed om deze te laten samenstellen ("bundelen") tot een gebiedsinformatie biGereedVoorLevering biGereedVoorSamenstellen
er is een levering van beheerdersinformatie (zipbestand) samengesteld voor de netbeheerder biGereedVoorSamenstellenProduct biLeveringSamengesteld
herman-vandenberg commented 4 years ago

In bovengenoemd statusdiagram (STD) worden ook enkele attribuutnamen genoemd van datumtijdstippen bij een bepaalde status. Bij de nieuwe status biGereedVoorSamenstellen staat als datumtijdstip datumBeheerdersinformatieOntvangen. Het moment datumBeheerdersinformatieOntvangen is echter het moment van ontvangst van beheerdersinformatie. Dit moment wordt vastgelegd in deze variabele. Vervolgens worden nog enkele processtappen doorlopen (waaronder valideren van aangeleverde informatie) voordat een gevalideerde en correcte aanlevering van beheerdersinformatie gereed is voor samenstellen (bundelen tot gebiedsinformatie). Het datumtijdstip dat een levering geschikt is voor samenstellen is dus niet het moment dat de beheerdersinformatie is ontvangen, maar wel de status dat de 'datumBeheerdersinformatieOntvangen' wordt teruggegeven in de betreffende BMKL-API (/gebiedsinformatieAanvragen/{giAanvraagId}/beheerdersinformatieAanvragen/{biAanvraagId}/beheerdersinformatieLevering). Het datumtijdstip 'datumBILeveringSamengesteld` is een moment dat in het productieproces van KLIC wordt bijgehouden, maar niet wordt teruggegeven in een API.

Om verwarring te voorkomen, laat ik hieronder een plaatje zien van statussen / datumtijdstippen die met de BMKL-API worden teruggegeven (ook het verbindingslijntje voor datumBeheerdersinformatieOntvangen is weggehaald): image

JustinRoodenburg commented 2 years ago

Toelichting op implementatie van het Kadaster: Er zijn aangepaste waarden in de waardelijst voor biProductieStatus. Deze is zichtbaar voor zowel Centrale als Decentrale netbeheerders. Tevens wordt er gebruik gemaakt van een gewijzigde URI. (zie issue #94 )

Voor een compleet overzicht van de toegestane waarden, zie de waardelijst op: https://api.klic.kadaster.nl/waardelijsten/v2/biProductieStatussen/

Voor een compleet overzicht en voorbeelden van de BMKL-API versie 2.1 zie onderstaande links: De nieuwe versie van het berichtenmodel (BMKL versie 2.1) vindt u op deze GitHub pagina van het Kadaster. Een toelichting op en en voorbeelden van de wijzigingen van de BMKL-standaarden vindt u op deze GitHub pagina van het Kadaster.