Functioneel ontwerp Berichtenverkeer StUF-Geo IMGeo voor horizontaal en verticaal koppelvlak
Geonovum
datum 4 april 2013
versie v1.0 status definitief
1
Colofon Auteurs:
Arnoud de Boer
Beheer:
Geonovum
BGT-programma
Ministerie van Infrastructuur en Milieu Portefeuille Ruimte Directie Nationale Ruimtelijke Ordening Beleid GEO informatie/BGT Rijnstraat 8 Postbus 20951 2500 EZ Den Haag Interne postcode 350 E-mail:
[email protected]
2
Inhoudsopgave 1
2
3
4
Inleiding 1.1 Inleiding 1.1.1 Horizontaal en verticaal berichtenverkeer 1.1.2 Doel 1.2 Leeswijzer Uitgangspunten 2.1 Initiële levering en mutaties 2.2 Verwerking per transactie 2.3 Controle tegen richtlijnen IMBGT/IMGeo 2.4 Controle tegen versie in registratie 2.5 Bevestiging van ontvangst 2.6 Volgorde van verwerking in verticale keten 2.7 Logistieke en functionele identificaties 2.8 Geen berichtverkeer bronhouders onderling Scenario’s horizontaal 3.1 Actoren 3.1.1 Geo 3.1.2 BOR 3.2 Mutatie 3.3 Exploratieverzoek Scenario’s verticaal 4.1 Actoren 4.1.1 Bronhouder 4.1.2 Rakende bronhouder 4.1.3 Samenwerkingsverband van Bronhouders BGT (SVB-BGT) 4.1.4 Landelijke Voorziening BGT (LV-BGT) 4.1.5 Afnemer 4.2 Initiële levering 4.2.1 Aanleveren 4.2.2 Assembleren en goedkeuren 4.2.3 Registreren 4.3 Mutatie 4.3.1 optioneel: Vooraankondiging 4.3.2 Aanleveren 4.3.3 conditioneel: Goedkeuren 4.3.4 Registreren
5 5 5 6 6 7 7 7 8 8 8 9 9 9 10 10 10 10 10 13 15 15 15 15 15 15 15 17 17 19 22 24 24 27 29 30
3
5
Berichten 5.1 Berichtsoorten 5.1.1 Mutatiebericht(mtbDi01) 5.1.2 Mutatierespons (mtbDu01) 5.1.3 Mutatieverzoek(mtvDi01) 5.1.4 weigerbericht (mtvWeigerDu01) 5.1.5 mutatieOproep (mtoDi01) 5.1.6 mutatieOproepRespons (mtoDi01) 5.1.7 Exploratieverzoek (expDi01) 5.1.8 Exploratierespons (expDu01) 5.1.9 Vooraankondigingsverzoek (vavDi01) 5.1.10 VooraankondigingsRepons (vavDu01) 5.1.11 Ophaalverzoek (opvDi01) 5.1.12 Bevestiging van ontvangst (Bv03) 5.2 Gebruik 5.3 Berichteninhoud 5.4 StUF-Stuurgegevens 5.5 Entiteittypen 5.5.1 Mutatiebericht (MTB) 5.5.2 Mutatieverzoek (MTV) 5.5.3 MutatieOproep (MTO) 5.5.4 Weigerbericht (WGB) 5.5.5 Exploratieverzoek (EXP) 5.5.6 Vooraankondiging (VAV) 5.5.7 Ophaalverzoek (OPV) 5.6 Kennisgevingen 5.7 Extra elementen en domeinwaarden 5.7.1
5.7.2 <documentverwijzing> 5.7.3 5.7.4 5.7.5 5.7.6 5.7.7 5.7.8 5.7.9 5.7.10 <mutatieVerzoek> 5.7.11 <muterendeBronhouder> 5.7.12 5.7.13 <sleutelVerzendend> en <sleutelOntvangend> voor 5.7.14 <statusVerwerkingsActie> 5.7.15 5.7.16 Bijlage 1 Overzicht uitgangspunten en 3 ook gegevens van het object worden teruggestuurd. Er kunnen dus meerdere weigerberichten zijn op hetzelfde mutatieverzoek. in een mutatiebericht in het verticale koppelvlak. Een LV-publicatiedatum wordt uitgegeven door de LV en teruggegeven aan Bronhouder na succesvolle van een mutatiebericht. Met een LV-publicatiedatum kan Bronhouder bewijzen dat aan de wettelijk taak om BGT-gegevens in LV te registreren is voldaan; Bronhouder hoeft dit gegeven niet mee te leveren in een mutatiebericht aangeleverd aan SVB en LV. Deze controle wordt met name uitgevoerd omdat Bronhouder niet verplicht is tot het aanleveren van elke versie van een object uit zijn registratie aan de Centrale Registratie van de LV-BGT. Een Bronhouder kan mutaties opsparen en op een tijdstip overgaan tot aanleveren van de laatste versie van dit object aan de LV-BGT. Omdat in de Centrale Registratie van de LV-BGT geen versies van objecten mogen worden overgeslagen6, dient Bronhouder altijd de gegevens van de laatst aangeleverde versie (ORIGINEEL / WAS) van het object samen met de gewijzigde versie aan te leveren aan SVB-BGT en LV-BGT. Zo kan de LV-BGT controleren of Bronhouder de actuele stand aan het bewerken is. Bij een vooraankondiging7 van Bronhouder zal SVB-BGT -na goedkeuring- ter informatie een levering van de actuele stand op deze objecten uit de registratie van SVB-BGT aan Bronhouder doen. Bronhouder kan hierop zelf zijn registratie bijwerken, en op de actuele stand muteren. Geeft aan om wat voor soort bericht het gaat, bijv. “mtbLVDi01” voor een mutatiebericht van SVB aan LV. De verzender van het bericht. In ieder geval moet hier de organisatie, applicatie en gebruiker van de verzendende organisatie worden opgenomen. De ontvanger van het bericht; ook hier moet de applicatie worden opgenomen, nu van de ontvangende organisatie. Identificerend nummer van het bericht bij de verzender. In dit nummer is een volgnummer verwerkt; dit bepaalt de volgorde waarin berichten verwerkt worden en dient ter controle dat er geen berichten ontbreken c.q. niet ontvangen zijn (zie ook 2.7) Tijdstip waarop het bericht is aangemaakt. Alleen in het bgtDi01 en bgtBronDi01 bericht is dit stuurgegeven opgenomen. Omdat dit een vrij bericht is kan niet worden aangegeven over welk objecttype het bericht gaat (dit zullen er immers meestal verschillende zijn). Het stuurgegeven <entiteittype> is daarom niet opgenomen. In plaats daarvan wordt in Identificerend nummer van het bericht waarop een respons wordt gegeven. Versie StUF Welke StUF versie wordt gehanteerd, is te zien aan de StUF namespace declaratie in het bericht. Voor deze versie van het koppelvlak wordt “0301” ondersteund. <documentVerwijzing>22 <documentVerwijzing>2223 24 Tekstuele toelichting naar een op te halen bestand mag bevatten. Definitie attribuuttype: het organisatieonderdeel van de betreffende bronhouder dat het feitelijke beheer over het object voert. Toelichting: De bronhouder is verantwoordelijk voor de bijhouding van het BGT/IMGeo object in de BGT registratie. Het feitelijke beheer ervan kan bij een bepaald organisatieonderdeel liggen. In sommige gevallen is het – ook in het berichtenverkeer - zinvol om te weten wie het feitelijke beheer uitvoert. En sommige objecten hebben meerdere beheerders: bv een lantaarnpaal met verkeersbord. Het moet dus mogelijk zijn om per object meerdere beheerders via het koppelvlak uit te wisselen. Domeinwaarden: GE= Gemeentelijk eigendom GR= Groenbeheer KU= Kunstwerkbeheer RI= Rioolbeheer SP= Speelwerktuigenbeheer OP= Openbare Verlichting WE= Wegbeheer WA=Waterbeheer BA= BAG KL= K&L VE= Verkeersborden BO= Bomen PA=Particulier/Privaat O1= Overig 1 O2= Overig 2 O3= Overig 3 ON= Onbekend Punt, lijn of vlakgeometrie (GML-geometrie); voor vooraankondigingsverzoek: alleen GML:Surface. 5.7.4 Uniek referentienummer (identificatie) welke wordt toegekend aan een exploratieverzoek. 5.7.5 Identificerend nummer van mutatiebericht. 5.7.6 Identificerend nummer van mutatieverzoek. 5.7.7 Identificerend nummer van een vooraankondigingsverzoek 5.7.8 De laatste verwerkingsActie die in de functionele controle van een mutatiebericht, mutatieverzoek, vooraankondiging of exploratieverzoek is doorlopen. De domeinwaarden zijn niet als enumeratie in de berichtenstandaard opgenomen, maar worden als externe codelist gepubliceerd. Datum en tijdstip waarop objecten in Centrale Registratie LV zijn geregistreerd. 5.7.10 <mutatieVerzoek> Entiteittype t.b.v. (respons op) mutatieverzoek 5.7.11 <muterendeBronhouder> Identificatie van de Bronhouder die een vooraankondiging indient. 5.7.12 Resultaat na beoordeling van een mutatieverzoek of vooraankondigingsverzoek. 5.7.13 <sleutelVerzendend> en <sleutelOntvangend> voor Deze gegevens worden als optioneel attribuut aan toegevoegd, conform StUF. 5.7.14 <statusVerwerkingsActie> Status van de laatste verwerkingsActie. Begeleidende vrije tekst. Domein: text(500). 5.7.16 Locatie (URL) vanaf waar een verwerkingsverslag gedownload kan worden. Domein: varchar(300). en van het bericht. In de stuurgegevens kunnen voor de volgende adresgegevens worden opgenomen: , , en . Minimaal moeten dan de volgende gegevens worden opgenomen: , en . Elementen in berichten die geen waarde hebben zijn wel aanwezig en krijgen waarde “WaardeOnbekend”. Alle was/wordt attributen van een object in een StUF bericht worden ingevuld meegestuurd. Dus niet alleen die attributen die gemuteerd zijn. Alle mutaties die in één transactie bij GEO zijn verwerkt worden in één bericht naar BOR verstuurd. Specifiek horizontaal: Procedureel De (beheerder van de ) Geo-applicatie is bronhouder van IMGeo-objecten en als zodanig verantwoordelijk voor het bijhouden van de geometrie en attributen van IMGeo-objecten en het leveren van BGT/IMGeo-gegevens aan het SVB-BGT. De (beheerder van de ) BOR-applicatie is afnemer van IMGeo-gegevens en alszodanig verplicht tot het doen van terugmeldingen op de BGT / IMGeo-gegevens. De (beheerder van de ) BOR-applicatie is verplicht tot het overnemen van de gegevens uit een mutatiebericht afkomstig van de Geo-applicatie. De (beheerder van de ) BOR-applicatie mag geen IMGeo-objecten toevoegen aan of verwijderen uit de BOR-registratie en mag geen aan IMGEO gerelateerde attributen wijzigen, waaronder de geometrie . Het toevoegen, wijzigen of verwijderen van een IMGeo-object uit de BOR-registratie gaat middels een mutatieverzoek aan de Geo-applicatie. De (beheerder van de ) GEO-applicatie is niet verplicht tot het doorvoeren van een mutatieverzoek. Indien het mutatieverzoek niet wordt gevolgd, stuurt de Geo-applicatie een terugmelding d.m.v. een specifiek procesbericht naar de BOR-applicatie. Een mutatiebericht ontstaat op het initiatief vanuit de Geo-applicatie of in reactie op een mutatieverzoek of exploratieverzoek van de BOR-applicatie... Als reactie op het niet doorvoeren van wijzigingen of toevoegingen van één, meerdere of alle objecten uit een mutatieverzoek wordt per object een weigerbericht verstuurd. Dit weigerbericht bevat in vrije tekstveld de reden van weigering (mogelijk in een 2e versie van het koppelvlak een landelijke domeinwaardenlijst hiervoor opstellen), het referentienummer en IMGEO-id (specifiek horizontaal: bij nieuw object het BOR-id). Specifiek horizontaal: Mutatieverzoek Een mutatieverzoek bevat de gegevens van een potentieel IMGEO-object, aangevuld met stuurgegevens waaronder BOR-ID. Algemeen: Exploratieverzoek Een exploratieverzoek betreft een verzoek tot het inwinnen of aanpassen van objecten in een bepaald gebied. Een exploratieverzoek bevat dus wel geometrie, maar geen IMGEO-objecten. Het resultaat van verwerking op een exploratieverzoek geeft aan dat alle mutatieberichten die een gevolg zijn van het redlineverzoek zijn verstuurd en daarmee dat het redlineverzoek is afgehandeld. Mee terugsturen: het referentienummer. Een exploratieverzoek heeft altijd waarde “AanmaakExploratieverzoek” voor het element . Algemeen: Mutatiebericht Een mutatiebericht heeft . bij een niet doorgevoerd wijzigingsbericht (W) en waarde “NietDoorgevoerdeToevoeging” bij een niet doorgevoerd toevoegingsbericht (T). Specifiek horizontaal: Technische specificaties Het FO Koppeling Geo-BOR stelt dat qua geometrie gelden de volgende uitgangspunten voor Geo en BOR: een 2D IMGeo geometrie en optioneel een Lod0 (waar de Z-Coördinaat in zit). Validatie volgens Oracle regels met tolerantie van 0.0005m. Algemeen: Systeemsleutels en het IMGeo-ID Nieuwe IMGeo-identificaties (een GUID) ontstaan alleen bij Geo / Bronhouder. Bronhouder bepaalt of er nieuwe IMGeo objecten ontstaan of nieuwe versies van bestaande objecten (zoals de BGT/IMGeo catalogus voorschrijft). De IMGeo sleutel wordt – indien bekend - altijd meegestuurd. Het staat de verzendende systeem vrij om de overige sleutels – indien die bekend zijn - mee te sturen. De systeemsleutels worden in het StUF bericht middels “sleutelVerzender” / ”sleutelOntvanger” verstuurd, het IMGeo-id middels namespace (NL.IMGEO) en lokaalID. De characterstring van deze StUFsleutels moet alfanumerieke tekens kunnen bevatten en een zodanig lengte hebben dat deze het aantal characters van de BOR en IMGEO-ID’s kunnen bevatten. De unieke identificatie van een (versie van) een object wordt gedaan op basis van lokaal-id (IMGEO GUID) in combinatie met tijdstipRegistratie. wordt niet uitgewisseld tussen Geo- en BOR-applicatie. De wijziging van attribuut van een IMGeo-object in de Geo-applicatie leidt niet tot een mutatiebericht naar de BOR-applicatie. In het GEO-BOR berichtenverkeer kan voor veel verplichte IMGeo attributen niet voldaan worden aan de huidige tabel met kardinaliteiten uit GeoStUF. Verplichte IMGEO-attributen mogen in een mutatieverzoek en weigerbericht leeg zijn. De elementen zijn wel aanwezig in het bericht maar krijgen als waarde “WaardeOnbekend” . en
