Probleem
Bij de review van het Zaak- en Regieservices koppelvlak liep ik er tegenaan dat de best practices op het gebied van naamgevingsconventies voor de XML-schema en wsdl bestanden niet klopte en incompleet was. Dat controlerend zag ik vervolgens dat in eigenlijk alle sectormodellen bestanden aanwezig waren die niet correct waren.
In het bijgaande bestand ‘Controle op naamgevingsconventie bestanden.xlsx’ (zie C:\Data\KING\Kern-taken\StUF\StUFmaster\0301\Controle op naamgevingsconventie bestanden.xlsx) heb ik de conventie proberen aan te scherpen (hoewel er op enkele punten nog wel wat vragen zijn) en een aantal sectormodellen daarop gecontroleerd. In het bestand zie je waar dan de fouten in de diverse sectormodellen zitten.
Oplossing
Er moeten nu 3 dingen gebeuren, ten eerste moet de conventie daar waar nog vragen zijn vervolledigd worden, ten tweede moet de best practices gecorrigeerd en aangevuld worden en ten derde moeten de betreffende bestandsnamen in de sectormodellen gecorrigeerd worden.
Dit onderhoudsverzoek is opgevoerd in de onderhoudsverzoeken als ONV0402.
De lijst met onderhoudsverzoeken vind je op:
gemmaonline.nl/index.php/StUF-Expertgroep#Documenten
Bij deze een voorstel voor het wijzigen van de best practices op het vlak van de naamgevingsconventie.
Daarnaast zijn er ook enkele kleine andere wijzigingen in aangebracht.
Bijlage
Tijdens de StUF Expertgroep van 16-9-2015 is de in deze discussie voorgestelde oplossing goedgekeurd op enkele kleine correcties na. Het corrigeren van de betreffende bestandsnamen in de sectormodellen en koppelvlakken kan achterwege blijven. Nieuwe (versies van) sectormodellen en koppelvlakken zullen wel moeten gaan voldoen aan de conventie. Het onderhoudsverzoek is omgezet naar erratum ERR0402.
Biu het uitwerken van een en ander voor het sectormodel woz0313 met zeven koppelvlakken kon ik toch niet helemaal uit de voeten met de tekst in het onderhoudsverzoek voor de best practice. Gelieve als bijlage een beschrijving aan te treffen van hoe ik het nu heb gedaan.
Bijlage
Maarten,
Ik heb je document doorgenomen, zie mijn opmerkingen in het bijgaande PDF document.
Ik ga niet alle opmerkingen hier herhalen maar enkele zaken wil ik wel alvast noemen.
Op sommige punten ben ik het helemaal met je eens, enkele zaken heb ik dan ook alweer overgenomen in de best practices.
De folderstructuur die je nu hanteert in StUF-WOZ 3.13 is naar mijn mening echter niet gewenst.
Het belemmert nl. het onafhankelijk van elkaar beheren van de koppelvlakken en sectormodel.
Voor StUF-WOZ is dat wellicht geen probleem maar voor andere sectormodellen en koppelvlakken wel.
Aangezien ik vind dat we over alle koppelvlakken en sectormodellen een consistente methodiek moeten hanteren zou ik liever een andere structuur gehanteerd zien voor StUF-WOZ.
Bijlage
Hallo Robert,
De tekst kan inderdaad op een aantal punten nog wel wat verduidelijking en verbetering gebruiken.
Je opmerking over de andere structuur intrigeert me wel. Zou je nader kunnen uitwerken hoe jij een en ander ziet?
NB: klopt het dat het bovenstaande document twee pagina's telt?
Hoi Maarten,
Ik zal een dummy structuur maken zoals ik de complete structuur van de StUF sectormodellen (incl. StUF-WOZ 3.13) en de diverse koppelvlakken (incl. die van de woz) zie.
Het document bevat inderdaad net als jouw origineel maar 2 pagina's. Ik heb aan jouw document alleen de notities toegevoegd.
Maarten,
Zie de bijgaande folderstructuur. Hierbij ga ik natuurlijk uit van het ideale plaatje waarbij de bag, prs en zsdms berichtencatalogi al in een eigen namespace zijn geplaatst en waarbij er hier en daar al correcties zijn aangebracht in de folderstructuur.
Voor een aantal koppelvlakken die KING heeft ontwikkeld geldt deze situatie al (dcr0310, fin0310, jz0100 en wbg0310) deze vormen voor mij de basis voor de structuur die ik voor ogen heb. Alle sectormodel en koppelvlak folders bevatten nu ook minstens 1 berichtencatalogus. Zo heb ik geoberichten toegevoegd aan de folder geo0100. Dat kan natuurlijk ook een andere naam zijn in fin0310 en wbg0310 komen tenslotte ook geen folders voor met de naam finberichten en wbgberichten. Wellicht kunnen we voor de naamgeving van de berichtencatalogi anders dan mutatie en vraagAntwoord ook nog een conventie afspreken. De namen voor de berichtencatalogi zouden natuurlijk terug moeten komen in de namen van de diverse schema's. Dat is nu helaas nog niet altijd het geval.
De inhoud van de diverse hoofdfolders kan met deze structuur en het in een eigen namespace plaatsen in ieder geval onafhankelijk van elkaar gepubliceerd en beheerd worden.
Op dit moment moeten we de schema's in bijv. de zsdms berichtencatalogus (in de nieuwe opzet zds0100) tegelijkertijd met die van zkn0310 aanpassen en publiceren. Later publiceren zou alleen maar leiden tot een hoop verwarring.
Zoals je kunt zien hebben we bij het bepalen van de namen van de hoofdfolders van de KING koppelvlakken de lijn die we hebben uitgezet met StUF-BG, StUF-ZKN en StUF-ZTC doorgetrokken. We gebruiken gewoon de prefix die we hebben gekozen voor de namespace ook in de naam van de folder en plaatsen daarachter het versienummer. Datzelfde heb ik dus ook gedaan voor de koppelvlakfolders behorende bij woz0313. Die foldernaam komt overigens ook weer terug in de namespace uri.
Ik hoop dat hiermee een beetje duidelijk is hoe ik het e.e.a. zie.
Bijlage
Robert,
Ik zie een verschil tussen de reeds bestaande dcr0310 map en de voorgestelde zds0100 map."dcr0310" is Documentcreatieservices gebaseerd op StUF BG 03.10 en niet versie 0310 van de Documentcreatieservices. Elke nieuwe versie van de Documentcreatieservices gebaseerd op StUF BG 03.10 komt in de map dcr0310.
Zodra RSGB 3.0 verStUFt is en StUF BG 03.20 af is komt er een map dcr0320 met daarin de versie van Documentcreatieservices op basis van van StUF BG 03.20.
Ik zou dus de map zds0100 vervangen door zds0310.
edit: de mappen voor bag, prs etc. worden nog heringedeeld natuurlijk.
Robert,
De structuur die jij voorstelt is hetzelfde als de structuur die ik heb gebruikt voor woz0313. Ik heb alleen op het parentniveau er nog een strik omheen gedaan in de vorm van een folder woz0313, omdat je zo eenvoudig in één zip alle relevante bestanden kwijt kunt.
Michiel,
Het is niet gezegd dat een koppelvlak slechts gebruik maakt van één sectormodel en je kunt je daarom afvragen of het verstandig is om een structuur te introduceren die feitelijk vereist dat dit wel zo is. Er lijkt me weinig om koppelvlakken gewoon een eigen nummering te geven met major en minor versie. Het lijkt me zinnig om over te gaan naar een nieuwe major versie als een onderliggend sectormodel van versie wijzigt.
Maarten,
Ik vermoed dat je niet gezien hebt dat ik in mijn versie van het document 'OpbouwSectormodelWoz0313.pdf' (zie de zip bij reactie #9) 8 notities heb staan. Wellicht goed om die nog even te lezen.
Naar aanleiding van jouw document maar ook naar aanleiding van voortschrijdend inzicht hebt ik wederom een aangepaste versie van de best practices gemaakt. Daarin zijn alle wijzigingen (n.a.v. zowel ERR0386 als ERR0402) die in de StUF Expertgroep van 16 september 2015 waren goedgekeurd geaccepteerd.
Wellicht goed om het in de komende StUF Expertgroep vergadering even te hebben over de folderstructuur zoals jij deze voor woz313 hebt uitgewerkt. Naar aanleiding daarvan kunnen er later nog wijzigingen worden doorgevoerd.
Bijlage
Tijdens de StUF Expertgroep van 21-10-2015 zijn we helaas niet aan de behandeling van het bovenstaande voorstel toegekomen. Er is daarom toen afgesproken dat de aanwezige leden eventuele bezwaren binnen 2 weken na de betreffende bijeenkomst kenbaar zouden maken. Aangezien geen bezwaren zijn geplaatst is het voorstel aangenomen en het zal dan ook meegenomen worden in pre-patch 23.
Tijdens de StUf Expertgroep van 18 november 2015 is besloten de voorgestelde oplossing niet op te nemen in patch 23. Dat wat nu in de best practices staat beschreven voldoet namelijk niet helemaal voor StUF-WOZ. Er zal een aangepast voorstel worden gemaakt.
Bijgaand de laatste versie van de StUF best practices n.a.v. ERR0402 en ONV0386.
De structuur van de laatste versie van StUF-WOZ (3.13) en de beschrijving in deze versie van de best practices zijn hierin op elkaar afgestemd.
Indien de StUF Expertgroep deze versie goedkeurt dan kan deze indien gewenst nog worden meegenomen met patch 24.
Bijlage
Tijdens de StUF Expertgroep van 16 maart 2016 is het voorstel goedgekeurd. Dit voorstel gaat mee in patch 24.