1. Präambel
Dieses Dokument ist das offizielle Handbuch zur Benutzung der Software xPlanBox. Die in diesem Dokument genannten Soft- und Hardwarebezeichnungen sind in den meisten Fällen auch eingetragene Warenzeichen und unterliegen als solche den gesetzlichen Bestimmungen.
Die in diesem Werk enthaltenen Angaben, Daten, Ergebnisse usw. wurden von den Autoren nach bestem Wissen erstellt und mit Sorgfalt überprüft. Dennoch sind inhaltliche Fehler nicht völlig auszuschließen. Daher erfolgen alle Angaben ohne jegliche Verpflichtung oder Garantie. Die Autoren übernehmen aus diesem Grund auch keinerlei Verantwortung oder Haftung für Fehler und deren Folgen. Hinweise auf eventuelle Irrtümer werden gerne entgegengenommen.
Dieses Dokument ist mit AsciiDoc gesetzt. Es ist als Quellcode erhältlich und kann als HTML und PDF angeschaut bzw. bereitgestellt werden. Für die Bereitstellung des AsciiDoc Quellcode wenden Sie sich bitte an lat/lon - per E-mail an info@lat-lon.de.
1.1. Autoren
Danilo Bretschneider, Jens Fitzke, Torsten Friebe, Sebastian Goerke, Lyn Elisa Goltz, Lena Rippolz, Sabine Schmitz, Dirk Stenger, Carmen Tawalika, Jeronimo Wanhoff.
Copyright © 2010 - 2025, lat/lon GmbH, Wachtberg.
1.2. Lizenz des Dokuments
Es wird die Erlaubnis gewährt, dieses Dokument zu kopieren, zu verteilen und/oder zu modifizieren, unter den Bestimmungen der GNU Free Documentation License, Version 1.3 oder jeder späteren Version, veröffentlicht von der Free Software Foundation; mit den unveränderlichen Abschnitten Präambel und Autoren, ohne vordere Umschlagtexte und ohne hintere Umschlagtexte. Die Lizenz wird unter http://www.gnu.org/licenses/fdl-1.3 bereitgestellt.
2. Überblick
Die xPlanBox dient der Abbildung der Bauleit- und der Landschaftsplanung. Die xPlanBox basiert auf den Standards des Open Geospatial Consortium, der INSPIRE Richtlinie und insbesondere dem Standard XPlanung zur Abbildung des deutschen Planungsrechts durch ein GML-Anwendungsschema.
Zur Implementierung der Komponenten der xPlanBox wurde die Open Source Software deegree eingesetzt, das ein Projekt der OSGeo Foundation ist. Die xPlanBox besteht aus den folgenden Komponenten:
-
XPlanValidator: Komponente zur Validierung von Daten des Standards XPlanung
-
XPlanManager: Komponente zur Verwaltung von Daten des Standards XPlanung
-
XPlanWMS: Standard-Kartendienst (WMS) für die Auskunft
-
XPlanWFS: Standard-Datendienst (WFS) für die Auskunft (XPlanGML-konforme Datenstruktur)
-
XPlanSynWFS: Standard-Datendienst (WFS) für die Auskunft (vereinfachte Datenstruktur)
-
XPlanDokumenteAPI: Optionale Komponente für den Zugriff auf Dokumente aus einem XPlanArchiv
-
XPlanInspirePluWMS: Optionale Komponente mit INSPIRE View Service für die Auskunft im INSPIRE Datenthema Planned Land Use (PLU)
-
XPlanInspirePluWFS: Optionale Komponente mit INSPIRE Download Service für die Auskunft im INSPIRE Datenthema Planned Land Use (PLU)
Aktuell werden für Bebauungspläne, Flächennutzungspläne, Landschaftspläne und Raumordnungspläne die XPlanGML-Versionen 4.0, 4.1, 5.0, 5.1, 5.2, 5.3, 5.4 und 6.0 durch die xPlanBox unterstützt. Für sonstige raumbezogene Planwerke werden die XPlanGML-Versionen 5.0, 5.1, 5.2, 5.3, 5.4 und 6.0 unterstützt.
Die Komponenten der xPlanBox werden in diesem Benutzerhandbuch im Einzelnen erläutert.
3. XPlanValidator
3.1. XPlanValidator Grundlagen
Der XPlanValidator ist ein Tool zur technischen Validierung von
-
Bebauungsplänen (B-Pläne),
-
Flächennutzungsplänen (F-Pläne),
-
Raumordnungsplänen (R-Pläne),
-
Landschaftsplänen (L-Pläne) und
-
Sonstigen Plänen (SO-Pläne)
in den XPlanGML-Versionen 4.0, 4.1, 5.0, 5.1, 5.2, 5.3, 5.4 und 6.0.
|
Die Konformitätsregeln sind für die Version 5.0 und höher optimiert! |
XPlanung ist der Standard für die Struktur, den Inhalt und die Form von Daten und Informationen zur Bereitstellung von räumlichen Planwerken der Raumordnung, Landes- und Regionalplanung, Bauleitplanung und Landschaftsplanung. Durch die Anwendung des Standards kann ein verlustfreier Datenaustausch zwischen unterschiedlichen IT-Systemen und Anwendungen gewährleistet werden.
Um die Einhaltung des Standards zu gewährleisten und damit einen Austausch zu ermöglichen, muss eine Validierung der Daten erfolgen.
|
Der XPlanValidator kann prüfen, ob Daten der XPlanung technisch fehlerfrei sind. Dies ersetzt aber keine inhaltliche und fachliche Prüfung. |
3.2. XPlanValidatorWeb
3.2.1. In 3 Schritten zum Validierungsbericht
Schritt 1 – Plan hochladen
Laden Sie Ihren Plan bzw. Planarchiv hoch, indem Sie auf „Datei auswählen“ klicken.
| Bitte beachten Sie, dass abhängig von Ihrem Browser, "Datei auswählen" auch "Durchsuchen" o.a. heißen kann. |
Vom XPlanValidator werden folgende Dateiformate akzeptiert:
-
ZIP-Dateien (Dateiendung
.zip) mit folgendem Aufbau: Im Basisverzeichnis muss die XPlanGML-Datei mit dem Dateinamen xplan.gml vorhanden sein. Rasterdaten sowie alle im xplan.gml referenzierten Anhänge liegen ebenfalls im Basisverzeichnis der ZIP-Datei. Eine solche ZIP-Datei wird XPlanArchiv genannt. -
GML-Dateien (Dateiendung
.gml) -
XML-Dateien (Dateiendung
.xml)
|
Bitte beachten Sie die Anforderungen an den Dateinamen. Der Dateiname darf nur folgende Zeichen enthalten:
Sonderzeichen wie z. B. Umlaute, Zeilenumbrüche und Leerzeichen sind nicht erlaubt. |
| Die Größe eines Plans hat unmittelbare Auswirkungen auf die Dauer der Validierung. Das UI des XPlanValidatorWeb ist nur für die Validierung von kleinen Plänen ausgelegt. Nutzen Sie die REST-API des XPlanValidatorAPI für die Validierung von größeren Plänen! |
Schritt 2 – Bezeichnung des Validierungsberichts und Validierungstyp wählen
Wenn Sie einen Plan hochgeladen haben, steht im Feld „Bezeichnung für den Report“ der Name der Datei ohne Endung.
Sie können der aktuellen Validierung, falls notwendig, eine beliebige Bezeichnung geben. Diese erscheint ausschließlich auf dem Validierungsbericht.
| Vermeiden Sie auch hier Umlaute, Sonderzeichen und/oder Leerzeichen. Es gelten die gleichen Anforderungen wie an den Dateinamen. |
In Ihrem Validierungsbericht wird die Bezeichnung wie folgt dargestellt:
Wählen Sie nun unter folgenden Validierungstypen:
Standardmäßig sind alle Validierungstypen selektiert.
1) Semantische Validierung (optional)
Die semantische Validierung überprüft die fachlich-inhaltliche Kohärenz der XPlanGML-Datei. Genauer gesagt wird geprüft, ob die Validierungsregeln der Konformitätsbedingungen in der jeweiligen Version eingehalten wurden.
-
4.0 (194 Regeln)
-
4.1 (235 Regeln)
-
5.0 (178 Regeln)
-
5.1 (184 Regeln)
-
5.2 (191 Regeln)
-
5.3 (195 Regeln)
-
5.4 (198 Regeln)
-
6.0 (181 Regeln)
|
Die Konformitätsregeln sind für die Version 5.0 und höher optimiert! |
Eine XPlanGML-Datei ist dann zu der jeweiligen XPlanGML-Version konform, wenn das XML-Dokument gegen das jeweilige XPlanGML Schema validiert und alle in den Konformitätsbedingungen spezifizierten Regeln erfüllt werden.
|
Folgende Validierungsregeln werden derzeit nicht durch die semantische Validierung geprüft:
Der Ausschluss von gemischter Geometrie ist bereits durch das GML-Profil abgedeckt. Verstöße fallen somit bereits bei der syntaktischen Validierung auf. Die Regel "8.1.7.1 Die Einschränkung auf Punktgeometrie" bezieht sich auf LP_Punktobjekt. Dabei handelt es sich um eine abstrakte Klasse, für die es keine abgeleiteten Klassen gibt. |
2) Geometrische Validierung (optional)
Bei der geometrischen Validierung wird die Korrektheit der Geometrien überprüft. XPlanung bezieht sich auf das Simple Feature Model des OGC. Räumliche Objekte werden hier als Punkte, Linien oder Flächen mit speziellen geometrischen Eigenschaften modellhaft abgebildet. Als Fehler werden z. B. sich überschneidende Polygone identifiziert.
Folgende Prüfungen werden in Abhängigkeit vom Geometrietyp durchgeführt, es handelt sich um die basisgeometrischen Prüfungen:
-
Punkte: Prüfung auf 2D-Koordinaten
-
Linien: Segment-Kontinuität
-
Polygone:
-
Geschlossenheit (äußere und innere Ringe)
-
äußerer Ring: Orientierung im Gegenuhrzeigersinn
-
innere Ringe: Orientierung im Uhrzeigersinn
-
kein Schnitt äußerer Ring / innere Ringe
-
Innere Ringe liegen innerhalb der vom äußeren Ring umschlossenen Fläche
-
Schnittmenge der von zwei inneren Ringen gebildeten Flächen ist leer
-
keine doppelten Stützpunkte (äußere und innere Ringe)
-
Patches sind frei von Überlappungen
-
Patches sind zusammenhängend
-
-
MultiPolygone:
-
kein Schnitt zwischen einzelnen Polygonen
-
alle für Polygone geltenden Prüfungen für jedes einzelne Polygon
-
Für alle Geometrietypen wird außerdem überprüft, ob die Koordinaten innerhalb des Geltungsbereichs des Koordinatenreferenzsystems liegen.
Nutzung der Optionen
-
„Geometrische Prüfung der Flächenschlussbedingung (2.2.1.1) überspringen“:
Mit der Option "Prüfung der Flächenschlussbedingung (2.2.1.1) überspringen" kann die Prüfung der Flächenschlussbedingung in Ausnahmefällen deaktiviert werden. Grundsätzlich sollten alle Fehler, die den Flächenschluss betreffen, behoben werden.
|
Wenn sich zwei aneinandergrenzende Flächenschlussobjekte an einer Geraden berühren und nur eines der Flächenschlussobjekte einen zusätzlichen Stützpunkt innerhalb dieser Geraden aufweist, wird der fehlende Stützpunkt des anderen Flächenschlussobjekt durch den XPlanValidator nicht gefunden. |
-
„Geometrische Prüfung des Geltungsbereichs (2.2.3.1) überspringen“:
Wenn Fehler im Geltungsbereich, z. B. in Kreisbögen, nicht korrigiert werden können, selektieren Sie in Ausnahmefällen die Option „Geometrische Prüfung des Geltungsbereichs (2.2.3.1) überspringen“. Bei Überlappungen des Geltungsbereiches gilt eine Toleranz von 1 mm. Grundsätzlich sollten alle Fehler, die den Geltungsbereich betreffen, behoben werden.
|
Wenn die Geometrie eines Fachobjekts ein Loch im Geltungsbereich vollständig überdeckt, wird dieser Fehler nur angezeigt, wenn für dieses Fachobjekt keine weiteren Fehler bei der Überprüfung des Geltungsbereichs auftreten. |
-
„Prüfung der Laufrichtung (2.2.2.1) überspringen“:
Bei der Prüfung der Laufrichtung werden Fehler bei der Orientierung von Polygonen ausgegeben. Sollen die Fehler bei der Laufrichtung ignoriert werden, können Sie die Option "Prüfung der Laufrichtung (2.2.2.1) überspringen" aktivieren.
3) Syntaktische Validierung (obligatorisch)
Die syntaktische Validierung ist die Voraussetzung für die semantische und geometrische Validierung und ist daher nicht abwählbar.
Bei der syntaktischen Validierung wird die Struktur der XPlanGML-Datei geprüft. Eine syntaktisch valide XPlanGML-Datei muss sowohl den Anforderungen der Wohlgeformtheit von XML entsprechen als auch die vom XPlanGML-Schema definierten Regeln erfüllen.
Die Validierung kann über den Button
gestartet werden.
Zusätzliche Profile mit Validierungsregeln (optional)
Zusätzlich können noch Profile ausgewählt werden, die zusätzliche Validierungsregeln enthalten können. Sind Profile für den XPlanValidator konfiguriert, dann werden diese unterhalb der Validierungstypen angezeigt.
Schritt 3 – Validierungsbericht und -ergebnis
Der Validierungsbericht
1) Allgemeine Informationen
Der Kopf des Validierungsberichts gibt Ihnen einen Überblick über die Informationen aus der XPlanGML-Datei sowie das Validierungsergebnis.
Neben dem Namen des XPlanArchivs bzw. der XPlanGML-Datei, des Datums der Validierung sowie der Version des XPlanGML-Dokuments werden auch die in dem XPlanGML-Dokument enthaltenen Instanzen mit deren Namen aufgelistet.
Wenn Rasterdaten z. B. als PNG- mit PGW-Dateien im XPlanGML-Dokument referenziert werden, so werden diese aufgelistet und zu jeder Datei angezeigt, ob diese im XPlanArchiv vorhanden ist oder nicht. Für Dateien, die über eine URL referenziert werden, wird keine Prüfung durchgeführt und als Status immer "nicht geprüft" angezeigt.
Das angezeigte Ergebnis wird für alle in dem XPlanGML-Dokument enthaltenen Instanzen angezeigt. Es müssen alle ausgewählten Validierungstypen für alle Instanzen fehlerfrei sein, damit das Gesamtergebnis valide ist. Die zu den jeweiligen Validierungstypen detaillierten Validierungsergebnisse werden in den folgenden Abschnitten ausgegeben.
2) Semantische Validierung – valide
Eine valide semantische Prüfung wird Ihnen wie folgt angezeigt.
Die Anzahl der ausgeführten Validierungsregeln variiert in Abhängigkeit der Version der GML-Datei.
3) Semantische Validierung – nicht valide
Am Beispiel der nachfolgenden Abbildung sehen Sie welche Konformitätsbedingung (bzw. Validierungsregel) nicht erfüllt ist.
Die ausgegebene GML ID gibt Ihnen einen Hinweis, welches Element in der XPlanGML-Datei davon betroffen ist.
4) Geometrische Validierung – valide
Eine valide geometrische Prüfung wird wie folgt angezeigt.
Eine geometrische Validierung kann valide sein, aber dennoch Warnungen enthalten. Warnungen werden angezeigt, wenn z. B. Lücken bei Prüfung der Flächenschlussbedingung gefunden werden.
5) Geometrische Validierung – nicht valide
Fehler werden angezeigt, wenn die geometrischen Validierungsregeln nicht erfüllt sind.
Am Beispiel der nachfolgenden Abbildung sehen Sie, welche Validierungsregeln nicht erfüllt sind.
Die ausgegebene GML ID gibt Ihnen einen Hinweis, welches Element in der XPlanGML-Datei davon betroffen ist.
6) Syntaktische Validierung – valide
Eine valide syntaktische Prüfung wird wie folgt angezeigt.
7) Syntaktische Validierung – nicht valide
| Die Angaben der Zeilennummer können abweichen. Gute Ergebnisse lassen sich erzielen, wenn das XML-Dokument ohne Formatierung der Attribute erfolgt, insbesondere der Deklaration der Namensräume (siehe auch Bekannte Probleme). |
Wenn die syntaktische Validierung nicht valide ist, werden die semantische und die geometrische Validierung nicht durchgeführt und es ist auch keine Kartenvorschau vorhanden.
Validierungsergebnis für Profile
Sind Profile für den XPlanValidator konfiguriert und wurden diese bei der Validierung durch den Benutzer ausgewählt, so wird das Ergebnis unterhalb der Ergebnisse der syntaktischen Validierung ausgegeben
Download des Validierungsberichts
Der Validierungsbericht kann in den Formaten:
-
HTML
-
PDF
exportiert werden.
Die selektierten Reports werden in einer ZIP-Datei gespeichert. Der Dateiname entspricht der Bezeichnung des Validierungsdurchlaufs.
Kartenvorschau
Über den Button
wechseln Sie zur Kartenansicht des Plans. Hier kann eine visuelle Überprüfung des Plans vorgenommen werden.
Der Plan wird zentriert in der Kartenvorschau angezeigt.
|
Der Plan steht in der Kartenansicht nur für eine begrenzte Zeitspanne (ca. 5 Minuten) zur Verfügung, anschließend ist nur noch die Hintergrundkarte zu sehen. Die Kartenvorschau visualisiert ausschließlich die Geometrien aus der XPlanGML-Datei. Angehängte Rasterpläne werden nicht dargestellt. Bei Plänen, die geometrisch nicht valide sind, kann es zu Problemen bei der Darstellung in der Kartenvorschau kommen. |
Navigation:
Mit
können Sie die Validierungsoptionen verändern.
Mit
kehren Sie zur Startseite zurück und können einen neuen oder geänderten Plan hochladen.
3.3. XPlanValidatorAPI
Die REST-API des XPlanValidator ermöglicht es, die Funktionen des XPlanValidator über eine Web-API aufzurufen. Die REST-API des XPlanValidator stellt folgende Ressourcen bereit:
| Ressource | HTTP Methode | Beschreibung | Verarbeitung |
|---|---|---|---|
|
|
Beschreibung der Schnittstelle als OpenAPI 3.0 Dokument |
synchron |
|
|
Informationen zur Software und Konfiguration |
synchron |
|
|
Validieren eines XPlanGML-Dokuments oder XPlanArchivs |
asynchron |
|
|
Abruf des Fortschritts für eine Validierungsanfrage |
synchron |
|
|
Abruf eines Validierungsberichts |
synchron |
|
|
Abruf von geometrischen Fehlern zu einem Validierungsbericht im Format GeoJSON |
synchron |
Eine vollständige Beschreibung der HTTP Status-Codes und der unterstützten Formate (Encodings) für die jeweiligen Ressourcen sind in der OpenAPI-Schnittstellenbeschreibung enthalten.
| Die URL für die REST-API des XPlanValidator setzt sich wie folgt zusammen http://<host>:<port>/xplan-validator-api/api/v2/. |
Mit der Version 8.1 wird im Validierungsbericht für crsStatus der Wert UNSUPPORTED nicht mehr verwendet. Wenn das Koordinatenreferenzsystem für die Rasterdaten von dem der Geometrien im XPlanGML abweicht, dann wird für den crsStatus der Wert INVALID ausgegeben.
|
| Die REST-API v1 ist veraltet und wird in zukünftigen Versionen der xPlanBox entfernt! Stellen Sie Clients auf die neue REST-API v2 um! |
4. XPlanManager
4.1. XPlanManager Grundlagen
Der XPlanManager dient zur Verwaltung von Planwerken innerhalb der xPlanBox. Mit dem XPlanManager können XPlanGML-Dateien und XPlanArchive importiert, editiert oder gelöscht werden. Nachdem ein Planwerk erfolgreich über den XPlanManager importiert wurde, können die Daten über die Dienste XPlanWFS, XPlanSynWFS und XPlanWMS abgerufen werden. In den folgenden Abschnitten werden die Anforderungen an ein XPlanGML-Dokument und XPlanArchiv beschrieben.
4.1.1. Das XPlanGML-Dokument
Das XPlanGML-Dokument muss folgende Eigenschaften aufweisen:
-
Das XPlanGML-Dokument ist wohlgeformt und hat die Dateiendung
.gmloder.xml(Dateiformatapplication/xml). -
Das Wurzelelement ist ein
xplan:XPlanAuszug(aus dem Namensraum der jeweiligen XPlanGML-Version) oder einewfs:FeatureCollection(aus dem Namensraumhttp://www.opengis.net/wfs/2.0aus dem OGC-Standard WFS 2.0) -
Das XPlanGML-Dokument beinhaltet nur ein oder mehrere Elemente vom Typ
xplan:XP_Plan. Beinhaltet eine Datei mehrere dieser Elemente, so dürfen keine nicht-referenzierten Features im XPlanGML-Dokument vorkommen, wie z. B. ein freies Präsentationsobjekt ohne Bezug zum Fachobjekt. -
Wenn das XPlanGML-Dokument mehrere
BP_Bereich-Elemente beinhaltet, muss das Elementxplan:nummerfür jedenxplan:BP_Bereicheindeutig sein. -
Das XPlanGML-Dokument beinhaltet keine internen Referenzen auf andere Planobjekte über eines der folgenden Elemente
aendert/XP_VerbundenerPlan/verbundenerPlanoderwurdeGeaendertVon/XP_VerbundenerPlan/verbundenerPlanbzw. in XPlanGML 6.0 überaendertPlan/XP_VerbundenerPlan/verbundenerPlan,wurdeGeaendertVonPlan/XP_VerbundenerPlan/verbundenerPlan,aendertPlanBereich/XP_VerbundenerPlanBereich/verbundenerPlanBereichoderwurdeGeaendertVonPlanBereich/XP_VerbundenerPlanBereich/verbundenerPlanBereich. Wird eines der Elemente in einem XPlanGML-Dokument verwendet, dann kann der Plan nicht importiert werden!
Vermeiden Sie Sonderzeichen im Plannamen xplan:name wie z. B. :, &, # , /, \, ?, @, ", ' oder Zeilenumbrüche.
|
4.1.2. Das XPlanArchiv
Das XPlanArchiv ist eine ZIP-Datei (Dateiformat application/zip) mit folgendem Aufbau:
-
Im Basisverzeichnis muss die XPlanGML-Datei mit dem Dateinamen xplan.gml vorhanden sein. Die Datei muss die Eigenschaften eines XPlanGML-Dokuments erfüllen.
-
Alle in der XPlanGML-Datei referenzierten Anhänge wie Rasterdaten und Begleitdokumente müssen entweder im Basisverzeichnis der ZIP-Datei liegen oder werden über einen Link auf eine externe Datei (URL) referenziert.
-
Referenzen auf Rasterdaten müssen entsprechend der XPlanGML-Version korrekt gesetzt sein, siehe Kapitel Referenzierung von Rasterdaten im XPlanGML.
-
Das XPlanArchiv kann Dateien in folgenden Dateiformaten enthalten:
-
application/xml -
image/tiff -
image/png -
text/plain -
application/pdf
-
Dateinamen dürfen keine Sonderzeichen wie z. B. :, &, # , /, \, ?, @, ", ' (doppeltes oder einfaches Anführungszeichen), Leerzeichen oder auch Umlaute beinhalten. Groß- und Kleinschreibung in den Dateinamen und auch der Dateiendung werden berücksichtigt
und müssen vollständig mit den Referenzen im Dokument übereinstimmen!
|
4.1.3. Referenzierung von Rasterdaten im XPlanGML
Die Rasterdaten müssen mit in dem XPlanArchiv enthalten sein und im Basisverzeichnis neben der Datei xplan.gml liegen.
Innerhalb des XPlanGML müssen die Rasterdateien wie folgt referenziert sein:
Referenzierung von Rasterdaten im XPlanGML 4.x
Rasterdateien werden im Feature Type XP_RasterplanBasis, XP_RasterplanAenderung, BP_RasterplanAenderung, FP_RasterplanAenderung, LP_RasterplanAenderung oder RP_RasterplanAenderung referenziert:
gml:featureMember
xplan:XP_RasterplanBasis
(oder) xplan:XP_RasterplanAenderung
(oder) xplan:BP_RasterplanAenderung
(oder) xplan:FP_RasterplanAenderung
(oder) xplan:LP_RasterplanAenderung
(oder) xplan:RP_RasterplanAenderung
xplan:refScan (kann auch mehrfach vorkommen)
xplan:XP_ExterneReferenz
xplan:georefURL
xplan:art
xplan:referenzName
xplan:referenzURL
Das Element <refScan/> kann beliebig häufig vorkommen. Das Element
<referenzURL/> beinhaltet die relative Referenz auf die Rasterdatei.
<gml:featureMember>
<xplan:XP_RasterplanBasis gml:id="FEATURE_1234567890">
<xplan:refScan>
<xplan:XP_ExterneReferenz>
<xplan:georefURL>rasterdatei.tfw</xplan:georefURL>
<xplan:art>PlanMitGeoreferenz</xplan:art>
<xplan:referenzName>rasterdatei</xplan:referenzName>
<xplan:referenzURL>rasterdatei.tif</xplan:referenzURL>
</xplan:XP_ExterneReferenz>
</xplan:refScan>
</xplan:XP_RasterplanBasis>
</gml:featureMember>
Referenzierung von Rasterdaten im XPlanGML 5.x
Rasterdateien werden im Feature Type XP_Rasterdarstellung referenziert:
gml:featureMember
xplan:XP_Rasterdarstellung
xplan:refScan (kann auch mehrfach vorkommen)
xplan:XP_ExterneReferenz
xplan:georefURL
xplan:art
xplan:referenzName
xplan:referenzURL
Das Element <refScan/> kann beliebig häufig vorkommen. Das Element
<referenzURL/> beinhaltet die relative Referenz auf die Rasterdatei.
<gml:featureMember>
<xplan:XP_Rasterdarstellung gml:id="FEATURE_1234567890">
<xplan:refScan>
<xplan:XP_ExterneReferenz>
<xplan:georefURL>rasterdatei.tfw</xplan:georefURL>
<xplan:art>PlanMitGeoreferenz</xplan:art>
<xplan:referenzName>rasterdatei</xplan:referenzName>
<xplan:referenzURL>rasterdatei.tif</xplan:referenzURL>
</xplan:XP_ExterneReferenz>
</xplan:refScan>
</xplan:XP_Rasterdarstellung>
</gml:featureMember>
Ab XPlanGML 5.1 ist diese Referenzierung als veraltet notiert. Mit Version XPlanGML 6.0 wird diese nicht mehr unterstützt.
Referenzierung von Rasterdaten im XPlanGML 6.0
Mit XPlanGML 6.0 werden Rasterdateien über die von XP_Bereich abgeleiteten Feature Types und dort über das Element <refScan/> referenziert (im folgendem Beispiel BP_Bereich):
gml:featureMember
xplan:BP_Bereich
xplan:refScan (kann auch mehrfach vorkommen)
xplan:XP_ExterneReferenz
xplan:georefURL
xplan:art
xplan:referenzName
xplan:referenzURL
Das Element <refScan/> kann beliebig häufig vorkommen. Das Element
<referenzURL/> beinhaltet die relative Referenz auf die Rasterdatei.
<gml:featureMember>
<xplan:BP_Bereich gml:id="FEATURE_1234567890">
...
<xplan:refScan>
<xplan:XP_ExterneReferenz>
<xplan:georefURL>rasterdatei.tfw</xplan:georefURL>
<xplan:art>PlanMitGeoreferenz</xplan:art>
<xplan:referenzName>rasterdatei</xplan:referenzName>
<xplan:referenzURL>rasterdatei.tif</xplan:referenzURL>
</xplan:XP_ExterneReferenz>
</xplan:refScan>
...
</xplan:BP_Bereich>
</gml:featureMember>
Ab Version 6.0 wird nur noch die Variante über das Element <refScan/> unterstützt.
Über die Editor-Funktion des XPlanManager können Rasterdaten über XP_RasterplanBasis oder über das Element <refScan/> innerhalb eines von XP_Bereich abgeleiteten Feature Type angezeigt werden. Weitere Informationen dazu auch im Kapitel Editieren.
|
4.1.4. Voraussetzungen für die Rasterdaten
Beim Import eines XPlanArchivs mit Rasterdaten werden diese durch den XPlanManager geprüft. Die Rasterdaten müssen folgende Voraussetzungen erfüllen, damit diese im Kartendienst XPlanWMS dargestellt werden können. Die Voraussetzungen an die Rasterdaten sind von dem Dateiformat abhängig, so sind Dateiformate ohne oder mit World-File zu unterscheiden.
GeoTIFF
-
Rasterdaten liegen im Format GeoTIFF vor.
-
GeoTIFF-Dateien enthalten ihre räumliche Ausdehnung als Metatags innerhalb der Datei.
-
GeoTIFF-Dateien enthalten das Koordinatensystem als Metatags innerhalb der Datei.
-
GeoTIFF-Dateien liegen im selben Koordinatenreferenzsystem vor, wie die Vektordaten (Geometrien) im XPlanGML.
-
Empfohlene Optimierungen:
-
Rasterdaten liegen im TIFF als gekachelte (tiled) Datenstrukturen vor.
-
Große Rasterdaten werden in unterschiedlichen Zoomstufen vorberechnet und in Pyramiden bzw. Overviews abgelegt.
-
TIFF mit World-File
-
TIFF-Dateien enthalten ihre räumliche Ausdehnung in dem ausgelagerten World-File (tfw-Datei).
-
TIFF-Dateien liegen im selben Koordinatenreferenzsystem vor, wie die Vektordaten (Geometrien) im XPlanGML.
-
Empfohlenen Optimierungen wie bei GeoTIFF
PNG mit World-File
-
PNG-Dateien enthalten ihre räumliche Ausdehnung in dem ausgelagerten World-File (pgw-Datei).
-
PNG-Dateien liegen im selben Koordinatenreferenzsystem vor, wie die Vektordaten (Geometrien) im XPlanGML.
-
Farbmodell (RGB) mit ein, drei oder vier Bändern.
-
Farbtiefe ist 8bit, 16bit oder 256 indizierten Farben im Farbpalettenmodus.
-
Transparenz ist als Alphakanal je Band (RGBA) oder als "NoData Value" angegeben.
- NOTE
-
Wenn das Kommandozeilentool XPlanCLI verwendet wird, muss für TIFF und PNG mit World-File zusätzlich die Datei aux.xml mit Angabe des Koordinatenreferenzsystems vorhanden sein. Für den XPlanManagerWeb ist dies keine Voraussetzung, da der Fachadministrator beim Import der Daten das Koordinatenreferenzsystem Rasterdaten über einen Dialog bestätigen kann.
4.1.5. Sortierung von Textabschnitten
Textabschnitte können über das Element XP_TextAbschnitt je Planart im XPlanGML hinterlegt werden. Da eine Sortierung auf Basis der Reihenfolge im XPlanGML-Dokument bei der Ausgabe technisch nicht gewährleistet werden kann, werden Textabschnitte in der xPlanBox über den Textschlüssel im Element XP_TextAbschnitt/schluessel sortiert ausgegeben. Die Sortierung erfolgt in der GetFeatureInfo-Ausgabe des XPlanWMS und bei der Anzeige von Textabschnitten in der Editieroberfläche des XPlanManagerWeb.
Um die gewünschte Sortierung zu erreichen, müssen die Textschlüssel einem bestimmten Aufbau folgen. Für die Sortierung werden alle Ziffern und Buchstaben bis zum ersten Leerzeichen im Textschlüssel berücksichtigt. Dabei unterstützt die xPlanBox folgende Sortierungen nach Ordnungszahlen und -buchstaben:
-
Sortierung nach Ziffern
1.1 text 1.2 text 2.1 text 2.2 text
-
Sortierung nach Kleinbuchstaben
a) text b) text c) text
-
Sortierung nach Ziffern mit Kleinbuchstaben
1.a) text 1.b) text 2.a) text 2.b) text
-
Sortierung mit einer Mischform aus Ziffern und Kleinbuchstaben mit Priorität auf Ziffern
1.1 text 1.2 text 2.1 text a) text b) text
-
Sortierung mit einer Mischform aus Großbuchstaben mit Ziffern
A text A.1.1 text A.1.2 text B text B.1.1 text B.1.2 text
-
Abweichend sortiert werden Textschlüssel, die mit einem Paragrafenzeichen (
§) beginnen. Hier werden nur die Zahlen bei der Sortierung berücksichtigt:
§1 Nr.1 §1 Nr.2 §2 Nr.1.1 §2 Nr.1.2
4.1.6. Planstatus eines Planwerks
Die xPlanBox unterscheidet zwischen drei verschiedenen Planstatus:
-
In Aufstellung
-
Festgesetzt
-
Archiviert
Der Planstatus eines Planwerks leitet sich, abhängig von der Planart und der Version des XPlanGML, aus dem Rechtsstand des Planwerks ab. Dafür werden die folgenden Enumerationen ausgewertet:
| Planart | Element in XPlanGML | Enumeration |
|---|---|---|
Bebauungsplan |
BP_Plan/rechtsstand |
BP_Rechtsstand |
Flächennutzungsplan |
FP_Plan/rechtsstand |
FP_Rechtsstand |
Landschaftsplan |
LP_Plan/rechtsstand |
LP_Rechtsstand |
Raumordnungsplan |
RP_Plan/rechtsstand |
RP_Rechtsstand |
Abhängig vom Enumerationswert wird der Planstatus ermittelt, beispielsweise aus dem Rechtsstand 2000 (Im Verfahren) eines Bebauungsplans in XPlanGML 6.0 wird der Planstatus In Aufstellung für die xPlanBox abgeleitet. Die folgenden Tabellen enthalten die Zuordnung eines Rechtsstands zum Planstatus für die jeweilige Planart:
Bebauungsplan (BP_Plan)
| Code | Text | XPlanGMLVersionen | Planstatus |
|---|---|---|---|
1000 |
Aufstellungsbeschluss |
alle |
In Aufstellung |
2000 |
Entwurf/Im Verfahren |
alle |
In Aufstellung |
2100 |
Frühzeitige Behördenbeteiligung |
alle |
In Aufstellung |
2200 |
Frühzeitige Öffentlichkeitsbeteiligung |
alle |
In Aufstellung |
2250 |
Entwurfsbeschluss |
6.0 |
In Aufstellung |
2300 |
Behördenbeteiligung |
alle |
In Aufstellung |
2400 |
Öffentliche Auslegung |
alle |
In Aufstellung |
3000 |
Satzung |
alle |
Festgestellt |
4000 |
In Kraft getreten |
alle |
Festgestellt |
4500 |
Teilweise untergegangen |
alle |
Festgestellt |
45001 |
Teilweise aufgehoben |
6.0 |
Festgestellt |
45002 |
Teilweise außer Kraft |
6.0 |
Festgestellt |
5000 |
Untergegangen |
alle |
Archiviert |
50000 |
Aufgehoben |
5.3, 5.4, 6.0 |
Archiviert |
50001 |
Außer Kraft |
5.3, 5.4, 6.0 |
Archiviert |
Flächennutzungsplan (FP_Plan)
| Code | Text | XPlanGMLVersionen | Planstatus |
|---|---|---|---|
1000 |
Aufstellungsbeschluss |
alle |
In Aufstellung |
2000 |
Entwurf/Im Verfahren |
alle |
In Aufstellung |
2100 |
Frühzeitige Behördenbeteiligung |
alle |
In Aufstellung |
2200 |
Frühzeitige Öffentlichkeitsbeteiligung |
alle |
In Aufstellung |
2250 |
Entwurfsbeschluss |
alle |
In Aufstellung |
2300 |
Behördenbeteiligung |
alle |
In Aufstellung |
2400 |
Öffentliche Auslegung |
alle |
In Aufstellung |
3000 |
Plan |
alle |
Festgestellt |
4000 |
Wirksamkeit |
alle |
Festgestellt |
5000 |
Untergegangen |
alle |
Archiviert |
50000 |
Aufgehoben |
5.3, 5.4, 6.0 |
Archiviert |
50001 |
Außer Kraft |
5.3, 5.4, 6.0 |
Archiviert |
Landschaftsplan (LP_Plan)
| Code | Text | XPlanGMLVersionen | Planstatus |
|---|---|---|---|
1000 |
Aufstellungsbeschluss |
alle |
In Aufstellung |
2000 |
Entwurf |
alle |
In Aufstellung |
3000 |
Plan |
alle |
In Aufstellung |
4000 |
Wirksamkeit |
alle |
Festgestellt |
5000 |
Untergegangen |
alle |
Archiviert |
6000 |
In Fortschreibung |
6.0 |
Festgestellt |
Raumordnungsplan (RP_Plan)
| Code | Text | XPlanGMLVersionen | Planstatus |
|---|---|---|---|
1000 |
Aufstellungsbeschluss |
alle |
In Aufstellung |
2000 |
Entwurf |
alle |
In Aufstellung |
2001 |
Entwurf genehmigt |
5.0, 5.1, 5.2, 5.3, 5.4, 6.0 |
In Aufstellung |
2002 |
Entwurf geändert |
5.0, 5.1, 5.2, 5.3, 5.4, 6.0 |
In Aufstellung |
2003 |
Entwurf aufgegeben |
5.0, 5.1, 5.2, 5.3, 5.4, 6.0 |
In Aufstellung |
2004 |
Entwurf ruht |
5.0, 5.1, 5.2, 5.3, 5.4, 6.0 |
In Aufstellung |
3000 |
Plan |
alle |
In Aufstellung |
4000 |
In Kraft getreten |
alle |
Festgestellt |
5000 |
Untergegangen |
4.0, 4.1 |
Archiviert |
5000 |
Allgemeine Planungsabsicht |
5.0, 5.1, 5.2, 5.3, 5.4, 6.0 |
In Aufstellung |
5500 |
Teilweise außer Kraft |
6.0 |
Festgestellt |
6000 |
Außer Kraft |
5.0, 5.1, 5.2, 5.3, 5.4, 6.0 |
Archiviert |
7000 |
Plan ungültig |
5.0, 5.1, 5.2, 5.3, 5.4, 6.0 |
Archiviert |
| Ist für einen Plan der Rechtsstand nicht gesetzt oder handelt es sich um einen SO_Plan, der keine Angabe zum Rechtsstand besitzt, wird der Planstatus Festgestellt angenommen. |
4.2. XPlanManagerWeb
Die Komponente XPlanManagerWeb ist eine Web-Oberfläche, die dem Fachadministrator der xPlanBox ermöglicht, die Datenhaltung zu kontrollieren und zu verwalten.
4.2.1. Einstiegsseite
Die Webanwendung XPlanManagerWeb kann mit einem Browser aufgerufen werden. Die Adresse der Webanwendung lautet:
http://<host>:<port>/xplan-manager-web/
4.2.2. Funktionen des XPlanManagerWeb
Mit dem XPlanManagerWeb kann der Benutzer XPlanArchive und XPlanGML-Dateien in die Datenhaltung laden, diese editieren und löschen sowie bereits importiere Planwerke wieder exportieren.
| Die Größe eines Plans hat unmittelbare Auswirkungen auf die Dauer des Uploads, die Validierung und den Import. Das UI des XPlanManagerWeb ist nur für die Verarbeitung von kleinen Plänen ausgelegt. Nutzen Sie die REST-API des XPlanManagerAPI für die Verarbeitung von größeren Plänen! |
Hinzufügen
Vor dem Importieren eines XPlanArchives oder XPlanGML-Dokuments in die Datenhaltung, muss die Datei über die Web-Oberfläche hochgeladen und validiert werden. Dazu muss die Datei ausgewählt und über den Browser hochgeladen werden. Hierfür kann die Datei über den Button Durchsuchen ausgewählt und durch einen Klick auf Hinzufügen hochgeladen werden. Der Benutzer wird über den Abschluss des Vorgangs über einen Hinweis in einem PopUp-Fenster informiert.
Validieren
Nachdem die Datei hochgeladen wurde, kann diese validiert werden. Hier stehen die Auswahlmöglichkeiten des XPlanValidatorWeb zur Verfügung.
| Bei der Validierung werden die syntaktische und basisgeometrische Prüfung (s. Abschnitt geometrische Validierung) immer mit ausgeführt. Diese Prüfungen stellen sicher, dass ein Plan keine schwerwiegenden Fehler enthält, die einen Import verhindern. Um die automatische Korrektur der Laufrichtung von Polygonen beim Import zu erzwingen, muss die Option "Prüfung der Laufrichtung (2.2.2.1) überspringen" aktiviert sein. |
Import
Wenn die Datei erfolgreich validiert wurde, kann der Plan in die Datenhaltung durch Klick auf den Button Import in die Datenhaltung übernommen werden. Ist der Plan nicht valide, dann ist der Button Import deaktiviert. Der Benutzer wird über den erfolgreichen bzw. fehlerhaften Import des Plans in Form eines PopUp-Fensters informiert.
Ist ein Import nicht möglich und soll ein anderer Plan importiert werden, dann kann der Plan über den Button Entfernen aus der laufenden Sitzung entfernt werden.
Auflistung
Standardmäßig werden alle importierten Pläne in einer Liste angezeigt. Die Liste kann nach den angezeigten Spaltennamen auf- oder absteigend sortiert werden. Sind mehr als 15 Pläne in der Auswahl, so wird unterhalb der Liste eine Navigation angezeigt, die ein seitenweises Vor- und Zurückblättern innerhalb der Ergebnismenge erlaubt.
Filter
Die Liste kann auch nach verschiedenen Kriterien gefiltert werden. Neben den beiden Filtern "Gemeindeauswahl" und "Planstatus" kann der Benutzer auch einen freien Filer auswählen und mit Klick auf den Button Suche die Anzeige der Pläne reduzieren. Mit dem Button "Alle Pläne anzeigen" können alle Filter aufgehoben werden und es werden wieder alle Pläne angezeigt.
Kartenvorschau
Durch den Klick auf den Button Kartenvorschau öffnet sich ein neues Fenster, indem der XPlan visualisiert wird. Im Hintergrund befindet sich eine Hintergrundkarte. Durch den Klick auf Schließen wird die Kartenvorschau wieder geschlossen.
| Der Browser verwendet bei der Kartenvorschau die Dateien aus dem Cache des Browsers. Wenn in der Kartenvorschau nicht der aktuelle Stand des Plans angezeigt wird, muss der Cache des Browsers gelöscht werden. |
Herunterladen
Die importierten Pläne können vom Benutzer durch den Klick auf den Button Herunterladen als XPlanArchiv heruntergeladen werden.
Löschen
Je nach Benutzerrechten können importierten Pläne durch den Klick auf den Button Löschen aus der Datenhaltung gelöscht werden. Hat ein Benutzer keine entsprechende Rechte, so wird der Button grau dargestellt.
Editieren
Abhängig von den Benutzerrechten können Pläne editiert werden. Fehlen dem Benutzer die entsprechenden Rechte ist die Funktion deaktiviert und der Button Editieren wird grau dargestellt. Die Editieransicht öffnet sich durch Klick auf den Button Editieren. Die Ansicht ist in verschiedene Bereiche aufgeteilt, die die Bearbeitung einzelner Elemente im XPlanGML über die Oberfläche zulässt. Je nach Planart kann die Liste der änderbaren Elemente variieren. Unterstützt werden Bebauungspläne ab der Version 4.1, Flächennutzungspläne, Regionalpläne und Sonstige Pläne ab der Version 5.0 sowie Landschaftspläne ab der Version 6.0.
Basisdaten
Folgende Basisdaten eines Plans können abhängig von der Planart geändert werden:
| BP_Plan | FP_Plan | LP_Plan | RP_Plan | SO_Plan |
|---|---|---|---|---|
xplan:name, xplan:beschreibung, xplan:technHerstellDatum, xplan:untergangsDatum, xplan:planArt, xplan:sonstPlanArt, xplan:rechtsstand, xplan:rechtsverordnungsDatum |
xplan:name, xplan:beschreibung, xplan:technHerstellDatum, xplan:untergangsDatum, xplan:planArt, xplan:sonstPlanArt, xplan:rechtsstand |
xplan:name, xplan:beschreibung, xplan:technHerstellDatum, xplan:untergangsDatum, xplan:planArt, xplan:rechtsstand |
xplan:name, xplan:beschreibung, xplan:technHerstellDatum, xplan:untergangsDatum, xplan:planArt, xplan:sonstPlanArt, xplan:rechtsstand |
xplan:name, xplan:beschreibung, xplan:technHerstellDatum, xplan:untergangsDatum |
| Alle Texteingaben werden von der Anwendung geprüft. Dabei sind die zugelassenen Zeichen und Zeichenketten aus Sicherheitsgründen limitiert. |
| Das Ändern des Rechtsstands kann dazu führen, dass eine Änderung des Planstatus eintritt. Damit verbunden ist das Verschieben der Vektor- und Rasterdaten in die entsprechende Datenhaltung mit Planstatus 'Festgestellt', 'In Aufstellung' oder 'Archiviert', weitere Hinweise dazu im Abschnitt Planstatus eines Planwerks. |
| Beim Import kann der Nutzer den Planstatus (s. Planstatus eines Planwerks) des Plans über eine Auswahlliste mit den Optionen 'Festgestellt', 'In Aufstellung' und 'Archiviert' ändern. Der im XPlanGML gesetzte Rechtsstand führt zu der passenden Vorauswahl in der Auswahlliste. Der Nutzer kann den Planstatus ändern, ohne den Rechtsstand im XPlanGML zu ändern! Beim Öffnen der Editieransicht wird der Rechtsstand aus dem Plan angezeigt und nicht der vom Nutzer zum Zeitpunkt des Imports ausgewählte Planstatus. Somit entspricht die Anzeige des Rechtsstands im Editor nicht dem Planstatus des Plans. Beim Abspeichern von Änderungen ist somit Vorsicht geboten, da es so unbeabsichtigt zu einer Zustandsänderung des Plans kommen kann! |
Änderungen
Folgende Felder eines Plans können geändert werden. Bis XPlanGML 5.4:
-
aendert
-
wurdeGeaendertVon
Ab XPlanGML 6.0:
-
aendertPlan
-
wurdeGeaendertVonPlan
Texte
Folgende Felder eines Plans können geändert werden:
-
texte
Dokumente
Abhängig von der XPlanGML-Version können folgende Elemente editiert werden:
XPlanGML 4.1:
-
refBegruendung
-
refRechtsplan
-
refGruenordnungsplan
ab XPlanGML 5.0:
-
externeReferenz
Dabei kann der Benutzer wählen, ob er eine Datei über einen vollqualifizierten Link (URL) referenziert oder zum XPlanArchiv hinzugefügt und dann relativ verlinkt.
Rasterbasis
Folgende Felder eines Plans können geändert werden:
-
rasterBasis
Die Rasterbasis kann nur editiert werden, wenn ein Plan ein Objekt vom Typ BP|FP|LP|RP|SO_Bereich besitzt. Ist dies nicht der Fall, wird ein entsprechender Hinweis in der Oberfläche angegeben. Die Angabe einer Rasterbasis kann in diesem Fall nicht erfolgen.
Wie im Kapitel Referenzierung von Rasterdaten im XPlanGML beschrieben, sind in den Versionen 5.1, 5.2, 5.3 und 5.4 noch zwei Varianten zur Referenzierung von Rasterdaten möglich. Die Anzeige im XPlanManager unterstützt die alte und die neue Variante. Wird über den XPlanManager eine Referenz geändert, dann erfolgt die Referenzierung immer über das Element <refScan/> unabhängig von der im Plan ursprünglich verwendeten Referenzierung.
Klickt der Nutzer auf Speichern, wird zunächst eine Validierung der Rasterdaten vorgenommen. Bei invaliden Dateien bekommt der Nutzer eine Entscheidungsoption, wie mit diesen Daten umgegangen werden soll. Stimmt das CRS der Rasterdaten nicht mit dem CRS der Rasterdatenhaltung überein, so erhält der Nutzer die Option, den Plan ohne Erzeugung der Rasterkonfiguration zu importieren. Anschließend erfolgt die Aktualisierung der Daten.
| Werden Referenzen auf Rasterbasisdateien entfernt oder verändert, so werden die nicht mehr referenzierten Dateien aus der Datenhaltung entfernt. Änderungen führen zu einer Aktualisierung der Konfiguration des XPlanWMS. |
| Die ebenfalls editierbaren Referenzen auf Texte (refText) und Legenden (refLegende) müssen in den Versionen 5.1, 5.2, 5.3 und 5.4 über die Abschnitte Texte und Dokumente editiert werden. |
| Bei aktivierter XPlanDokumenteAPI werden die externen Referenzen verändert und durch Links auf Ressourcen der XPlanDokumenteAPI ersetzt. Beachten Sie die Hinweise dazu im Kapitel Bekannte Probleme. |
Bereitstellung als INSPIRE PLU Datensatz
Abhängig von den Benutzerrechten können Pläne im Datenthema INSPIRE Planned Land Use veröffentlicht werden. Fehlen dem Benutzer die entsprechenden Rechte ist die Funktion deaktiviert und der Button Bereitstellung als INSPIRE Datensatz wird nicht dargestellt.
Durch Klick auf den Button Bereitstellung als INSPIRE Datensatz wird der Plan in das INSPIRE PLU Datenschema transformiert. Anschließend kann der Plan über den INSPIRE Download Service (XPlanInspirePluWFS) und INSPIRE View Service (XPlanInspirePluWMS) abgerufen werden.
| Die Bereitstellung als INSPIRE PLU Datensatz steht nur für BPläne in den XPlanGML-Versionen 4.1, 5.0, 5.1, 5.2, 5.3, 5.4 und 6.0 zur Verfügung. |
Hilfe
Eine Hilfeseite mit einer Kurzbeschreibung der Funktionen des XPlanManagerWeb lässt sich durch Betätigen des Buttons Hilfe anzeigen.
4.3. XPlanManagerAPI
Die REST-API des XPlanManager ermöglicht es, die Funktionen des XPlanManager über eine Web-API aufzurufen. Bei der Festlegung der Ressourcen wurden Begriffe aus drei Domänen verwendet. Die REST-API Ressourcen wie z.B. /plan oder /info sind in Englisch und der Einstiegspunkt für eine Entität. Ressourcen unterhalb einer Entität wie z.B. /plan/{planId}/aenderung oder /plan/{planId}/gueltigkeit sind in Deutsch und aus der Oberfläche des XPlanManagerWeb abgeleitet. Die verwendeten Datentypen sind ebenfalls in Deutsch und aus den Bezeichnern des XPlanung-Datenmodells (XPlanGML-Applikationsschema) abgeleitet. Bezeichner wie z. B. {planId} in einer Ressource sind Variablen und müssen durch entsprechende Werte ausgetauscht werden. Folgende Variablen werden in der API verwendet:
-
{planId}- eindeutiger Schlüssel eines Plans (numerischer Wert, z.B. 10, wird von der xPlanBox vergeben) -
{internalId}- interner Schlüssel eines Plans (alphanumerischer Wert, z.B. 96753413A#001) -
{planName}- Name eines Plans (alphanumerischer Wert, z.B. HafenCity14) -
{planStatus}- Status eines Plans (alphanumerischer Wert aus ["FESTGESTELLT", "IN_AUFSTELLUNG", "ARCHIVIERT"], Zuordnung siehe Planstatus eines Planwerks) -
{name}- Name oder Suchtext (alphanumerischer Wert, z.B. Hafen ) -
{id}- eindeutiger Schlüssel einer Ressource (numerischer Wert, Beispiele siehe Abschnitt eindeutige Schlüssel) -
{uuid}- eindeutiger Schlüssel einer Anfrage (alphanumerischer Wert, z.B. 31cd5e15-60ac-4ccd-b3fb-3f27e8fae2e9)
Die REST-API des XPlanManager stellt folgende Ressourcen bereit:
| Ressource | HTTP Methode | Beschreibung | Verarbeitung |
|---|---|---|---|
|
|
Beschreibung der Schnittstelle als OpenAPI 3.0 Dokument |
synchron |
|
|
Informationen zur xPlanBox Version und aktiven Konfiguration |
synchron |
|
|
Importieren eines XPlanGML-Dokuments oder XPlanArchivs |
asynchron |
|
|
Abfrage der Daten zu einem Plan über die PlanId |
synchron |
|
|
Abfrage des XPlanArchiv über die PlanId |
synchron |
|
|
Abfrage des XPlanGML über die PlanId |
synchron |
|
|
Löschen eines Plans |
synchron |
|
|
Suche nach Plänen mit Filtern über {planId}, {planName}, {planStatus}, {internalId} |
synchron |
|
|
Abfrage von Basisdaten zu einem Plan |
synchron |
|
|
Hinzufügen/Ersetzen von Basisdaten zu einem Plan |
synchron |
|
|
Abfrage von Änderungen zu einem Plan |
synchron |
|
|
Hinzufügen von Änderungen zu einem Plan |
synchron |
|
|
Abfrage von Dokumenten zu einem Plan |
synchron |
|
|
Hinzufügen/Ersetzen von Dokumenten zu einem Plan |
synchron |
|
|
Abfrage eines Dokuments zu einem Plan |
synchron |
|
|
Hinzufügen/Ersetzen eines Dokuments zu einem Plan |
synchron |
|
|
Entfernen eines Dokuments zu einem Plan |
synchron |
|
|
Abfrage von Texten zu einem Plan |
synchron |
|
|
Hinzufügen von Texten zu einem Plan |
synchron |
|
|
Abfrage eines Texts zu einem Plan |
synchron |
|
|
Hinzufügen/Ersetzen eines Texts zu einem Plan |
synchron |
|
|
Abfrage von Rasterbasisdateien zu einem Plan |
synchron |
|
|
Hinzufügen von Rasterbasisdateien zu einem Plan |
synchron |
|
|
Abfrage einer Rasterbasisdatei zu einem Plan |
synchron |
|
|
Hinzufügen/Ersetzen einer Rasterbasisdatei zu einem Plan |
synchron |
|
|
Entfernen einer Rasterbasisdatei zu einem Plan |
synchron |
|
|
Abruf des Fortschritts für eine Validierungsanfrage |
synchron |
|
|
Abruf eines Validierungsberichts |
synchron |
|
|
Abruf von geometrischen Fehlern zu einem Validierungsbericht im Format GeoJSON |
synchron |
Neben dem Datenformat JSON unterstützt die REST-API auch andere Inhaltstypen, die das Datenformat JSON (Inhaltstyp application/json) genauer beschreiben. Im Rahmen der Inhaltsvereinbarung zwischen Client und Server über das HTTP-Header-Feld Accept können auch die Inhaltstypen (media types) application/vnd.xplanbox.api+json, application/vnd.xplanbox.api.v1+json und application/vnd.xplanbox.api.v2+json angefragt werden. Einzelne Ressourcen wie z.B. POST /plan unterstützen diese anwendungsspezifischen Datentypen.
Eine vollständige Beschreibung der HTTP Status-Codes und der unterstützten Inhaltstypen (media types) und Formate (Encodings) für die jeweiligen Ressourcen sind in der OpenAPI-Schnittstellenbeschreibung enthalten.
| Die URL für die REST-API des XPlanManager setzt sich wie folgt zusammen: http://<host>:<port>/xplan-manager-api/api/v2/. |
| Die REST-API v1 ist veraltet und wird in zukünftigen Versionen der xPlanBox entfernt! Stellen Sie Clients auf die neue REST-API v2 um! |
4.3.1. Eindeutige Schlüssel für den Zugriff auf REST-Ressourcen
Um den Zugriff auf Texte, Dokumente und Rasterdaten zu ermöglichen, die über Referenzen in dem XPlanGML-Dokument definiert sind, werden beim Import oder bei Aktualisierung eines Plans eindeutige Schlüssel durch die xPlanBox festgelegt. Über diesen generierten und eindeutigen Schlüssel {id} kann auf die jeweiligen Ressourcen zugegriffen werden. Dies betrifft die folgenden Ressourcen:
-
Text-Ressource:
/plan/{planId}/text/{id} -
Dokument-Ressource:
/plan/{planId}/dokument/{id} -
Rasterbasis-Ressource:
/plan/{planId}/rasterbasis/{id}
| Ab Version 8.1 ersetzt der generierte Schlüssel die zusammengesetzten Schlüssel der Vorgängerversionen. |
Für Pläne mit mehreren BP_Bereich-Elementen muss das Element nummer für jeden BP_Bereich eindeutig sein.
|
4.3.2. Abgesicherter Zugriff auf XPlanManagerAPI
Wenn der abgesicherte Zugriff auf die REST-API des XPlanManagerAPI aktiviert ist, die Konfiguration ist im Betriebshandbuch der xPlanBox beschrieben, dann ist für den Aufruf der Schnittstelle ein gültiges Zugriffstoken im HTTP-Header erforderlich. Als Autorisierungsprotokoll wird OAuth 2.0 unterstützt und für das Format des Zugriffstokens das "JSON Web Token (JWT)"-Format.
4.3.3. Authentifizierung
Ein Client muss dazu im HTTP-Header "Authorization" einen gültigen Bearer Token mitschicken.
curl -i -X GET \
-H "Accept:application/json" \
-H "Authorization:Bearer eyJhb...I0kGA" \
'http://localhost:8080/xplan-manager-api/api/v2/plans'
Die Abfrage des Bearer Tokens muss vorher gegen den OpenID Provider wie z.B. Keycloak erfolgt sein. Ist der Bearer Token nicht gültig, wird der Zugriff auf die XPlanManagerAPI verweigert (HTTP-Status 401).
4.3.4. Autorisierung
Der Aufruf der XPlanManagerAPI kann durch Berechtigungen eingeschränkt werden.
Für folgende HTTP-Methoden werden die Berechtigungen geprüft:
-
POST/PUT/DELETE- gilt für alle Ressourcen - nur erfolgreich (HTTP-Status 200), wenn der Client über die Berechtigungen für den Zugriff auf die angefragte Ressource verfügt, andernfalls wird der Zugriff verweigert (HTTP-Status 403). Der Abgleich erfolgt über das Element xplan:XP_Gemeinde/ags. -
GET- gilt für alle Ressourcen - Client mit gültigem Token hat die Berechtigung für den Zugriff.
4.4. XPlanDokumenteAPI
Die REST-API der Komponente XPlanDokumenteAPI ermöglicht es, die in einem Plan referenzierten Dokumente über eine Web-API abzurufen. Zur Vereinfachung des Zugriffs auf die Begleitdokumente eines Plans stellt die xPlanBox die XPlanDokumenteAPI bereit. Wenn die optionale Komponente XPlanDokumenteAPI installiert und konfiguriert ist, dann werden alle im XPlanGML referenzierten Begleitdokumente über die URL der XPlanDokumenteAPI bereitgestellt.
Die REST-API der Komponente XPlanDokumenteAPI stellt folgende Ressourcen bereit:
| Ressource | HTTP Methode | Beschreibung |
|---|---|---|
|
|
Beschreibung der Schnittstelle als OpenAPI 3.0 Dokument |
|
|
Informationen zur Schnittstelle und aktiven Konfiguration |
|
|
Status der Komponente |
|
|
Abfrage der Dateien zu einem Plan |
|
|
Abfrage eines Dokuments |
|
|
Abfrage der Metadaten zu einem Dokument |
Eine vollständige Beschreibung der HTTP Status-Codes und der unterstützten Inhaltstypen (media types) und Formate (Encodings) für die jeweiligen Ressourcen sind in der OpenAPI-Schnittstellenbeschreibung enthalten.
| Die URL für die REST-API der Komponente XPlanDokumenteAPI setzt sich wie folgt zusammen: http://<host>:<port>/xplan-api-dokumente/xdokumente/api/v1/. |
5. XPlanWMS, XPlanWerkWMS und XPlanArtWMS
Der XPlanWMS, XPlanWerkWMS und XPlanArtWMS basieren auf der Open Source Software deegree und sind zu dem Standard Web Map Service (Version 1.1.1 und 1.3.0) des Open Geospatial Consortium (OGC) konforme Kartendienste. Diese dienen der Visualisierung von Plandaten sowie der Sachinformationsabfrage zu Planwerken.
5.1. Inhalte der Kartendienste
Die Datenquelle aller Kartendienste basiert auf den in die XPlanDB importierten Planwerken. Für jede Objektart aus den unterstützten XPlanGML-Applikationsschema mit einem Geometrie-Attribut existiert eine entsprechende Ebene (WMS Layer) im Kartendienst. Die Inhalte der einzelnen Kartendienste unterscheiden sich wie folgt:
-
Der XPlanWMS dient der Darstellung aller importierten Planwerke und stellt diese planübergreifend dar. Der XPlanWMS stellt genau einen Endpunkt mit allen Planwerken bereit. Und der Dienst stellt Ebenen zur Darstellung von Rasterdaten bereit.
-
Der XPlanWerkWMS visualisiert einzelne Planwerke. Der XPlanWerkWMS stellt für jedes Planwerk einen Endpunkt bereit. Die URL des Endpunkts enthält einen eindeutigen Pfadparameter wie den Plannamen, die PlanID oder die internalId. Und der Dienst stellt Ebenen zur Darstellung von Rasterdaten bereit.
-
Der XPlanArtWMS stellt einen Endpunkt für jede Planart wie z. B. BPlan oder FPlan zur Verfügung. Der XPlanArtWMS stellt alle importierten Planwerke dar. Dieser Kartendienst stellt keine Ebenen zur Darstellung von Rasterdaten bereit.
Die Plandaten werden nach Planstatus getrennt in der Datenhaltung gespeichert und über separate Endpunkte bereitgestellt (s. Planstatus eines Planwerks). Die folgende Tabelle zeigt die Zuordnung der XPlanWMS Endpunkte zum jeweiligen Planstatus und der verwendeten Endung im Servicenamen. Gleiches gilt für den XPlanWerkWMS und den XPlanArtWMS.
| Endpunkt | Planstatus | Postfix für Schema und Endpunkt |
|---|---|---|
XPlanWMSInAufstellung |
In Aufstellung |
pre |
XPlanWMSFestgestellt |
Festgestellt |
- |
XPlanWMSArchiviert |
Archiviert |
archive |
5.2. Benutzung der Kartendienste
Über den XPlanWMS, XPlanWerkWMS und XPlanArtWMS kann ein Benutzer Ebenen (WMS Layer) mit einem Browser oder einem GIS anfragen. Die folgende Tabelle gibt einen Überblick über die zur Verfügung stehenden Operationen der WMS-Dienste, die in den weiteren Kapiteln näher erläutert werden.
| WMS Operation | Inhalt |
|---|---|
GetCapabilities |
Abfrage der Fähigkeiten des Dienstes |
GetMap |
Abfrage von Kartenbildern zu WMS Ebenen |
GetFeatureInfo |
Abfrage von Sachinformationen einzelner Objekte |
GetLegendGraphic |
Abfrage von Legendengrafiken einzelner Ebenen |
GetAttachment |
Abfrage von Anhängen aus dem XPlanArchiv (veraltet) |
5.2.1. Adresse des XPlanWMS
http://<host>:<port>/xplan-services-wms/services/wms?
5.2.2. Adresse des XPlanWerkWMS
Die Adresse des XPlanWerkWMS enthält einen eindeutigen Pfadparameter, der den Zugriff auf ein einzelnes Planwerk ermöglicht. Folgende Pfadparameter werden vom XPlanWerkWMS unterstützt:
-
<PLANNAME>: Der Planname wird aus dem XPlanGML-Element
xplan:nameabgeleitet. Dabei werden Sonderzeichen wie/entfernt und der Planname für die Erstellung der URL kodiert (weitere Informationen zu URL Syntax und Zeichenkodierung in RFC 3986 – Uniform Resource Identifier (URI)). Neben der kodierten URL kann auch der Planname ohne Sonderzeichen verwendet werden. Dafür müssen alle anderen Zeichen alsa-zA-Z0-9-_aus dem Plannamen entfernt werden. Die so erstellte URL liefert die identische Antwort wie die dazugehörige, kodierte Anfrage-URL. -
<PLANID>: Die PlanID wird als eindeutiger Schlüssel durch die XPlanDB vergeben und ist je Instanz der XPlanDB eindeutig.
-
<INTERNALID>: Die internalId wird aus dem XPlanGML-Element
xplan:internalIdabgeleitet.
http://<host>:<port>/xplan-services-wms/services/planwerkwms/planname/<PLANNAME>? http://<host>:<port>/xplan-services-wms/services/planwerkwms/planid/<PLANID>? http://<host>:<port>/xplan-services-wms/services/planwerkwms/internalid/<INTERNALID>?
| Die URL des XPlanWerkWMS kann im XPlanManagerWeb abgerufen werden. |
5.2.3. Adresse des XPlanArtWMS
Die Adresse des XPlanWerkWMS ist abhängig von der Planart, die angefragt werden soll. Neben der Planart ist auch der Planstatus bei der Nutzung des XPlanArtWMS entscheidend, so setzt sich der Name nach folgendem Schema zusammen XPlanArtWMS<PLANART><PLANSTATUS>, z.B. XPlanArtWMSBPlanArchive. Die URL des WMS ist wie folgt aufgebaut:
http://<host>:<port>/xplan-services-wms/services/<PLANART>wms<PLANSTATUS>?
Die folgende Tabelle listet die Endpunkte des XPlanArtWMS auf:
| XPlanArtWMS | Planart | Planstatus | URL |
|---|---|---|---|
XPlanArtWMSBPlan |
BPlan |
Festgestellt |
|
XPlanArtWMSBPlanPre |
BPlan |
In Aufstellung |
|
XPlanArtWMSBPlanArchive |
BPlan |
Archiviert |
http://<host>:<port>/xplan-services-wms/services/bpwmsarchive? |
XPlanArtWMSFPlan |
FPlan |
Festgestellt |
|
XPlanArtWMSFPlanPre |
FPlan |
In Aufstellung |
|
XPlanArtWMSFPlanArchive |
FPlan |
Archiviert |
http://<host>:<port>/xplan-services-wms/services/fpwmsarchive? |
XPlanArtWMSLPlan |
LPlan |
Festgestellt |
|
XPlanArtWMSLPlanPre |
LPlan |
In Aufstellung |
|
XPlanArtWMSLPlanArchive |
LPlan |
Archiviert |
http://<host>:<port>/xplan-services-wms/services/lpwmsarchive? |
XPlanArtWMSRPlan |
RPlan |
Festgestellt |
|
XPlanArtWMSRPlanPre |
RPlan |
In Aufstellung |
|
XPlanArtWMSRPlanArchive |
RPlan |
Archiviert |
http://<host>:<port>/xplan-services-wms/services/rpwmsarchive? |
XPlanArtWMSSOPlan |
SOPlan |
Festgestellt |
|
XPlanArtWMSSOPlanPre |
SOPlan |
In Aufstellung |
|
XPlanArtWMSSOPlanArchive |
SOPlan |
Archiviert |
http://<host>:<port>/xplan-services-wms/services/sowmsarchive? |
5.3. Operationen
Das folgende Kapitel beschreibt die Operationen, die mit dem XPlanWMS, XPlanWerkWMS und XPlanArtWMS durchführbar sind.
5.3.1. GetCapabilities
Die GetCapabilities Abfrage dient der Auskunft über die Fähigkeiten des WMS Dienstes. Dabei handelt es sich beispielsweise um Informationen zum Dienstbetreiber, zu den unterstützten Operationen sowie zu den durch den WMS angebotenen WMS Ebenen.
XPlanWMS
http://<host>:<port>/xplan-services-wms/services/wms?request=GetCapabilities&service=WMS&version=1.1.1 http://<host>:<port>/xplan-services-wms/services/wms?request=GetCapabilities&service=WMS&version=1.3.0
XPlanWerkWMS
http://<host>:<port>/xplan-services-wms/services/planwerkwms/planname/<PLANNAME>?request=GetCapabilities&service=WMS&version=1.1.1 http://<host>:<port>/xplan-services-wms/services/planwerkwms/planname/<PLANNAME>?request=GetCapabilities&service=WMS&version=1.3.0
XPlanArtWMS
http://<host>:<port>/xplan-services-wms/services/<PLANART>wms<PLANSTATUS>?request=GetCapabilities&service=WMS&version=1.1.1 http://<host>:<port>/xplan-services-wms/services/<PLANART>wms<PLANSTATUS>?request=GetCapabilities&service=WMS&version=1.3.0
5.3.2. GetMap
Die Operation GetMap stellt die Kernfunktionalität des XPlanWMS dar. Die Operation ermöglicht es, die angebotenen Ebenen zu den Planinhalten mit GIS Clients zu nutzen, die die Schnittstellen WMS 1.1.1 bzw. WMS 1.3.0 unterstützen.
XPlanWMS
http://<host>:<port>/xplan-services-wms/services/wms?request=GetMap&Service=WMS&Version=1.1.1&Layers=bp_objekte&Format=image/png&Transparent=true&Styles=&Srs=EPSG%3A25833&Bbox=377814.52931834,5697447.998419,381059.6791237,5698548.3070248&Width=1280&Height=434 http://<host>:<port>/xplan-services-wms/services/wms?request=GetMap&Service=WMS&Version=1.3.0&Layers=bp_objekte&Format=image/png&Transparent=true&Styles=&Crs=EPSG%3A25833&Bbox=377814.52931834,5697447.998419,381059.6791237,5698548.3070248&Width=1280&Height=434
Die WMS-Spezifikation weist keinen Filtermechanismus auf, mit dem Sie in einer GetMap-Anforderung eine Abfragezeichenfolge oder eine WHERE-Klausel definieren können. Der XPlanWMS bietet einen anbieterspezifischen Parameter namens CQL2_FILTER für die WMS-Operationen "GetMap" und "GetFeatureInfo". Dadurch erhält der Client eine Möglichkeit zum Filtern der Features von einzelnen Layern in der angefragten Karte, indem Queryparameter für die angefragten Layer mit angegeben werden können.
Zusätzlich zu den WMS-Queryparametern unterstützt der XPlanWMS folgende Filterparameter, die zu einem CQL2_FILTER Queryparameter zusammengefasst werden:
-
planId → xpMgrPlanId
-
xpversion → xpVersion
-
type → xpPlanType
-
planName → xpPlanName
-
ags → xpAgs
-
internalId → xpInternalId
-
rechtsstand → xpRechtsstand
Die Kartenanzeige wird entsprechend der Filterbedingungen reduziert. Werden mehrere Filterparameter angegeben, werden diese mit AND in dem CQL2_FILTER Queryparameter verknüpft.
XPlanWerkWMS
http://<host>:<port>/xplan-services-wms/services/planwerkwms/planname/<PLANNAME>?request=GetMap&Service=WMS&Version=1.1.1&Layers=bp_objekte&Format=image/png&Transparent=true&Styles=&Srs=EPSG%3A25833&Bbox=377814.52931834,5697447.998419,381059.6791237,5698548.3070248&Width=1280&Height=434 http://<host>:<port>/xplan-services-wms/services/planwerkwms/planname/<PLANNAME>?request=GetMap&Service=WMS&Version=1.3.0&Layers=bp_objekte&Format=image/png&Transparent=true&Styles=&Crs=EPSG%3A25833&Bbox=377814.52931834,5697447.998419,381059.6791237,5698548.3070248&Width=1280&Height=434
Styles
Bei der GetMap-Operation gibt es die Möglichkeit zwischen zwei verschieden Styles zu wechseln, die die Darstellung der Inhalte des Kartendienstes beeinflussen. Dabei liegen alle Zeichenvorschriften (Styles) für alle Ebenen des XPlanWMS in transparenter und in vollflächiger Form vor. Bei GetMap-Operationen kann mittels des Style-Parameters zwischen beiden Darstellungen gewechselt werden. Wenn der transparente Style ausgewählt wird, sind lediglich die Planumringe sichtbar.
| Endpunkt | Planstatus | Default-Style | Dargestellte Planzeichen | GFI |
|---|---|---|---|---|
XPlanWMSInAufstellung |
In Aufstellung |
|
alle Planzeichen |
GFI |
XPlanWMSFestgestellt |
Festgestellt |
|
alle Planzeichen |
GFI |
XPlanWMSArchiviert |
Archiviert |
|
alle Planzeichen |
GFI |
In der Version 7.2 der xPlanBox hat sich der Default-Style im XPlanWMSInAufstellung und im XPlanWMSArchiviert von transparent auf vollflaechig geändert! Es werden nun bei Verwendung des Default-Styles alle Planzeichen angezeigt.
|
5.3.3. GetFeatureInfo
Die Operation GetFeatureInfo ermöglicht die Ausgabe von Sachinformationen zu Planobjekten. In der HTML-Ausgabe dieser Sachinformationen besteht neben der Ausgabe der entsprechenden Eigenschaften der Planobjekte auch die Möglichkeit, referenzierte Dokumente und Grafiken über die Operation GetAttachment abzurufen.
XPlanWMS
http://<host>:<port>/xplan-services-wms/services/wms?request=GetFeatureInfo&Service=WMS&Version=1.3.0&Width=460&Height=348&Layers=fp_bebausfl&Transparent=TRUE&Format=image%2Fpng&BBox=381754.08781343646,5716831.670553746,382351.0673120646,5717283.298522273&Crs=EPSG:25833&Styles=&Query_layers=fp_bebausfl&I=217&J=94&Feature_count=10&Info_format=text/html http://<host>:<port>/xplan-services-wms/services/wms?request=GetFeatureInfo&Service=WMS&Version=1.3.0&Width=460&Height=348&Layers=fp_bebausfl&Transparent=TRUE&Format=image%2Fpng&BBox=381754.08781343646,5716831.670553746,382351.0673120646,5717283.298522273&Crs=EPSG:25833&Styles=&Query_layers=fp_bebausfl&I=217&J=94&Feature_count=10&info_format=application/vnd.ogc.gml
XPlanWerkWMS
http://<host>:<port>/xplan-services-wms/services/planwerkwms/planname/<PLANNAME>?request=GetFeatureInfo&Service=WMS&Version=1.3.0&Width=460&Height=348&Layers=fp_bebausfl&Transparent=TRUE&Format=image%2Fpng&BBox=381754.08781343646,5716831.670553746,382351.0673120646,5717283.298522273&Crs=EPSG:25833&Styles=&Query_layers=fp_bebausfl&I=217&J=94&Feature_count=10&Info_format=text/html http://<host>:<port>/xplan-services-wms/services/planwerkwms/planname/<PLANNAME>?request=GetFeatureInfo&Service=WMS&Version=1.3.0&Width=460&Height=348&Layers=fp_bebausfl&Transparent=TRUE&Format=image%2Fpng&BBox=381754.08781343646,5716831.670553746,382351.0673120646,5717283.298522273&Crs=EPSG:25833&Styles=&Query_layers=fp_bebausfl&I=217&J=94&Feature_count=10&info_format=application/vnd.ogc.gml
5.3.4. GetLegendGraphic
Mit der GetLegendGraphic Operation können Legendengrafiken zu allen Ebenen des XPlanWMS abgefragt werden. Dies ermöglicht das gezielte Abfragen von Legendengrafiken der Ebenen.
XPlanWMS
http://<host>:<port>/xplan-services-wms/services/wms?request=GetLegendGraphic&Service=WMS&Version=1.1.1&layer=bp_gruenfl&format=image/png http://<host>:<port>/xplan-services-wms/services/wms?request=GetLegendGraphic&Service=WMS&Version=1.3.0&layer=bp_gruenfl&format=image/png
XPlanWerkWMS
http://<host>:<port>/xplan-services-wms/services/planwerkwms/planname/<PLANNAME>?request=GetLegendGraphic&Service=WMS&Version=1.1.1&layer=bp_gruenfl&format=image/png http://<host>:<port>/xplan-services-wms/services/planwerkwms/planname/<PLANNAME>?request=GetLegendGraphic&Service=WMS&Version=1.3.0&layer=bp_gruenfl&format=image/png
5.3.5. GetAttachment
Die WMS-Dienste der xPlanBox unterstützen zusätzlich die Operation GetAttachment. Diese Erweiterung der WMS Schnittstelle erlaubt den Zugriff auf die im XPlanGML referenzierten Anhänge.
Die Operation unterstützt folgende Parameter:
-
featureID: Die GML ID eines Features im XPlanWMS (u.a. abrufbar über GetFeatureInfo), z.B. XPLAN_XP_RASTERPLANBASIS_7b36b0ee-5139-4a55-afc0-01fec18e9f0a -
filename: Der Dateiname der referenzierten Datei, z.B. Stellingen64.png
XPlanWMS
http://<host>:<port>/xplan-services-wms/getAttachment?featureID=XPLAN_XP_RASTERPLANBASIS_7b36b0ee-5139-4a55-afc0-01fec18e9f0a&filename=Stellingen64.png
| Der Abruf von im XPlanGML referenzierten Anhängen über die Operation GetAttachment ist veraltet und wird in zukünftigen Versionen der xPlanBox entfernt. Stattdessen sollte die REST-API der Komponente XPlanDokumenteAPI verwendet werden. |
5.4. Koordinatenreferenzsysteme
Der XPlanWMS und XPlanWerkWMS unterstützt die folgenden Koordinatenreferenzsysteme für Vektordaten:
-
EPSG:25832
-
EPSG:25833
-
EPSG:325833
-
EPSG:31466
-
EPSG:31467
-
EPSG:31468
-
EPSG:31469
-
EPSG:4258
-
EPSG:4326
-
EPSG:4839
-
CRS:84
6. XPlanWFS
Der XPlanWFS ist ein auf der Open Source Software deegree basierender Dienst zur Abfrage von Vektordaten und ist konform zum Standard Web Feature Service (Version 1.1.0 und 2.0.0) des Open Geospatial Consortium (OGC).
6.1. Inhalte des Datendienstes
Der XPlanWFS dient zur Abfrage von Vektordaten und stellt Endpunkte für jede XPlanGML-Version bereit. Zu jeder unterstützten XPlanGML-Version stellt der XPlanWFS einen Endpoint bereit, über den das zur jeweiligen Version konforme XPlanGML abgerufen werden kann.
Die Plandaten werden nach Planstatus getrennt in der Datenhaltung gespeichert und über separate Endpunkte bereitgestellt (s. Planstatus eines Planwerks). Die folgende Tabelle zeigt die Zuordnung der XPlanWFS Endpunkte zum jeweiligen Planstatus und der verwendeten Endung im Service Endpoint.
| Endpunkt | Planstatus | Postfix für Service Endpunkt |
|---|---|---|
XPlanWFSInAufstellung |
In Aufstellung |
pre |
XPlanWFSFestgestellt |
Festgestellt |
- |
XPlanWFSArchiviert |
Archiviert |
archive |
6.2. Benutzung des XPlanWFS
Der XPlanWFS unterstützt Anfragen per HTTP GET (KVP) und POST (XML). Die Einbindung in WFS Client Anwendungen ist möglich, die die o.g. Versionen für OGC WFS Dienste unterstützen.
Der XPlanWFS bietet verschiedene Dienste zur Abfrage von XPlanGML an:
| XPlanGML-Version | Service Endpoint | WFS Protokollversion |
|---|---|---|
4.0 |
wfs40 |
1.1.0 und 2.0.0 |
4.1 |
wfs41 |
1.1.0 und 2.0.0 |
5.0 |
wfs50 |
1.1.0 und 2.0.0 |
5.1 |
wfs51 |
1.1.0 und 2.0.0 |
5.2 |
wfs52 |
1.1.0 und 2.0.0 |
5.3 |
wfs53 |
1.1.0 und 2.0.0 |
5.4 |
wfs54 |
1.1.0 und 2.0.0 |
6.0 |
wfs60 |
1.1.0 und 2.0.0 |
Die folgende Tabelle fasst die vom XPlanWFS unterstützten Operationen zusammen.
| WFS Operation | Inhalt |
|---|---|
GetCapabilities |
Abfrage der Fähigkeiten des Dienstes |
DescribeFeatureType |
Abfrage der Struktur von Objektarten |
GetFeature |
Abfrage von Planobjekten |
ListStoredQueries |
Abfrage der verfügbaren StoredQueries |
DescribeStoredQueries |
Beschreibung einer StoredQuery |
6.2.1. Adresse des Dienstes
Planstatus In Aufstellung:
http://<host>:<port>/xplan-services-wfs/services/wfs40pre? http://<host>:<port>/xplan-services-wfs/services/wfs41pre? http://<host>:<port>/xplan-services-wfs/services/wfs50pre? http://<host>:<port>/xplan-services-wfs/services/wfs51pre? http://<host>:<port>/xplan-services-wfs/services/wfs52pre? http://<host>:<port>/xplan-services-wfs/services/wfs53pre? http://<host>:<port>/xplan-services-wfs/services/wfs54pre? http://<host>:<port>/xplan-services-wfs/services/wfs60pre?
Planstatus Festgestellt:
http://<host>:<port>/xplan-services-wfs/services/wfs40? http://<host>:<port>/xplan-services-wfs/services/wfs41? http://<host>:<port>/xplan-services-wfs/services/wfs50? http://<host>:<port>/xplan-services-wfs/services/wfs51? http://<host>:<port>/xplan-services-wfs/services/wfs52? http://<host>:<port>/xplan-services-wfs/services/wfs53? http://<host>:<port>/xplan-services-wfs/services/wfs54? http://<host>:<port>/xplan-services-wfs/services/wfs60?
Planstatus Archiviert:
http://<host>:<port>/xplan-services-wfs/services/wfs40archive? http://<host>:<port>/xplan-services-wfs/services/wfs41archive? http://<host>:<port>/xplan-services-wfs/services/wfs50archive? http://<host>:<port>/xplan-services-wfs/services/wfs51archive? http://<host>:<port>/xplan-services-wfs/services/wfs52archive? http://<host>:<port>/xplan-services-wfs/services/wfs53archive? http://<host>:<port>/xplan-services-wfs/services/wfs54archive? http://<host>:<port>/xplan-services-wfs/services/wfs60archive?
6.3. Operationen
Das folgende Kapitel beschreibt die Operationen, die mit dem XPlanWFS durchführbar sind.
6.3.1. GetCapabilities
Die GetCapabilities Abfrage dient der Auskunft über die Fähigkeiten des WFS Dienstes. Dabei handelt es sich beispielsweise um Informationen zum Dienstbetreiber, zu den unterstützten Operationen sowie zu den durch den WFS angebotenen WFS Objektarten.
http://<host>:<port>/xplan-services-wfs/services/wfs40?request=GetCapabilities&Service=WFS http://<host>:<port>/xplan-services-wfs/services/wfs41?request=GetCapabilities&Service=WFS http://<host>:<port>/xplan-services-wfs/services/wfs50?request=GetCapabilities&Service=WFS http://<host>:<port>/xplan-services-wfs/services/wfs51?request=GetCapabilities&Service=WFS http://<host>:<port>/xplan-services-wfs/services/wfs52?request=GetCapabilities&Service=WFS http://<host>:<port>/xplan-services-wfs/services/wfs53?request=GetCapabilities&Service=WFS http://<host>:<port>/xplan-services-wfs/services/wfs54?request=GetCapabilities&Service=WFS http://<host>:<port>/xplan-services-wfs/services/wfs60?request=GetCapabilities&Service=WFS
6.3.2. GetFeature
Die Operation GetFeature stellt die Kernfunktionalität des XPlanWFS dar. Die Operation ermöglicht es, die angebotenen Ebene zu den Planinhalten mit GIS Clients zu nutzen, die die Schnittstellen WFS 1.1.0 bzw. WFS 2.0.0 unterstützen.
http://<host>:<port>/xplan-services-wfs/services/wfs40?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich http://<host>:<port>/xplan-services-wfs/services/wfs41?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich http://<host>:<port>/xplan-services-wfs/services/wfs50?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich http://<host>:<port>/xplan-services-wfs/services/wfs51?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich http://<host>:<port>/xplan-services-wfs/services/wfs52?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich http://<host>:<port>/xplan-services-wfs/services/wfs53?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich http://<host>:<port>/xplan-services-wfs/services/wfs54?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich http://<host>:<port>/xplan-services-wfs/services/wfs60?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich
6.3.3. DescribeFeatureType
Die Operation DescribeFeatureType gibt Informationen zur Struktur der einzelnen Feature Types wieder.
http://<host>:<port>/xplan-services-wfs/services/wfs40?request=DescribeFeatureType&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-services-wfs/services/wfs41?request=DescribeFeatureType&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-services-wfs/services/wfs50?request=DescribeFeatureType&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-services-wfs/services/wfs51?request=DescribeFeatureType&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-services-wfs/services/wfs52?request=DescribeFeatureType&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-services-wfs/services/wfs53?request=DescribeFeatureType&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-services-wfs/services/wfs54?request=DescribeFeatureType&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-services-wfs/services/wfs60?request=DescribeFeatureType&Service=WFS&Version=2.0.0
6.3.4. ListStoredQueries
Die Operation ListStoredQueries gibt Informationen über die verfügbaren StoredQueries zurück. Diese Operation steht nur in der Protokollversion 2.0.0 über die Endpunkte wfs40, wfs41, wfs50, wfs51, wfs52, wfs53 und wfs54 zur Verfügung.
http://<host>:<port>/xplan-services-wfs/services/wfs40?request=ListStoredQueries&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-services-wfs/services/wfs41?request=ListStoredQueries&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-services-wfs/services/wfs50?request=ListStoredQueries&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-services-wfs/services/wfs51?request=ListStoredQueries&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-services-wfs/services/wfs52?request=ListStoredQueries&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-services-wfs/services/wfs53?request=ListStoredQueries&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-services-wfs/services/wfs54?request=ListStoredQueries&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-services-wfs/services/wfs60?request=ListStoredQueries&Service=WFS&Version=2.0.0
6.3.5. StoredQueries
Neben den üblichen StoredQueries urn:ogc:def:query:OGC-WFS::GetFeatureById und urn:ogc:def:query:OGC-WFS::GetFeatureByType bieten die Endpunkte wfs40, wfs41, wfs50, wfs51, wfs52, wfs53, wfs54 und wfs60 drei weitere StoredQueries an. Darüber lassen sich die Vektordaten eines einzelnen Plans anhand im XPlanGML gesetzten Eigenschaften anfragen:
-
urn:ogc:def:query:OGC-WFS::PlanName
-
Filter auf XP_Plan/name
-
-
urn:ogc:def:query:OGC-WFS::PlanId
-
Filter auf XP_Plan/nummer
-
-
urn:ogc:def:query:OGC-WFS::InternalId
-
Filter auf XP_Plan/internalId
-
Die internalId kann, bei entsprechender Aktivierung durch den Adminstrator, beim Import eines Plans aus einer Verfahrensdatenbank ausgelesen werden
-
Diese Eigenschaften sollten bei den importierten Plänen eindeutig sein, nur dann liefert die StoredQuery exakt ein Anfrageergebnis. Pläne ohne Rechtsstand werden generell nicht über die StoredQueries ausgegeben.
Die Nutzung der StoredQueries erfolgt über GetFeature-Anfragen. Beispielanfrage für den Plan mit dem Namen Musterdorf in der XPlanGML-Version 5.4:
http://<host>:<port>/xplan-services-wfs/services/wfs54?request=GetFeature&service=WFS&version=2.0.0&resolvedepth=*&StoredQuery_ID=urn:ogc:def:query:OGC-WFS::PlanName&planName=Musterdorf
Über den optionalen Parameter srsName lässt sich das Koordinatenreferenzsystem der zurückzugebenden Geometrien angeben. Wird der Parameter nicht verwendet, erfolgt die Ausgabe der Geometrien in dem default-Koordinatenreferenzsystem des Dienstes. Der Parameter wird von allen StoredQueries unterstützt. Beispielanfrage für den Plan mit dem Namen Musterdorf in der XPlanGML-Version 5.4 mit srsName=EPSG:4326:
http://<host>:<port>/xplan-services-wfs/services/wfs54?request=GetFeature&service=WFS&version=2.0.0&resolvedepth=*&StoredQuery_ID=urn:ogc:def:query:OGC-WFS::PlanName&planName=Musterdorf&srsName=EPSG:4326
6.4. Koordinatenreferenzsysteme
Der XPlanWFS unterstützt die folgenden Koordinatenreferenzsysteme:
-
EPSG:25832
-
EPSG:25833
-
EPSG:325833
-
EPSG:31466
-
EPSG:31467
-
EPSG:31468
-
EPSG:31469
-
EPSG:4258
-
EPSG:4326
-
EPSG:4839
-
CRS:84
7. XPlanSynWFS
Der XPlanSynWFS ist ein auf der Open Source Software deegree basierender Dienst zur Abfrage von Vektordaten und ist konform zum Standard Web Feature Service (Version 1.1.0 und 2.0.0) des Open Geospatial Consortium (OGC).
7.1. Inhalte des Datendienstes
Der XPlanSynWFS dient der Abbildung des synthetisierten XPlanGML-Anwendungsschemas (XPlanSynGML). Dieses stellt eine vereinfachte und zusammenfassende Form der von der xPlanBox unterstützten XPlanGML-Versionen dar. Die vom XPlanSynWFS bereitgestellten Geometrien basieren auf dem Simple Feature Model des OGC. Die Werte aus den Codelisten von XPlanGML werden durch die textlichen Äquivalente dargestellt.
Die Plandaten werden nach Planstatus getrennt in der Datenhaltung gespeichert und über separate Endpunkte bereitgestellt (s. Planstatus eines Planwerks). Die folgende Tabelle zeigt die Zuordnung der XPlanSynWFS Endpunkte zum jeweiligen Planstatus und der verwendeten Endung im Service Endpoint.
| Endpunkt | Planstatus | Postfix für Service Endpunkt |
|---|---|---|
XPlanSynWFSInAufstellung |
In Aufstellung |
pre |
XPlanSynWFSFestgestellt |
Festgestellt |
- |
XPlanSynWFSArchiviert |
Archiviert |
archive |
7.2. Benutzung des XPlanSynWFS
Die folgende Tabelle fasst die vom XPlanSynWFS unterstützten Operationen zusammen. Der XPlanSynWFS unterstützt Anfragen per HTTP GET (KVP) und POST (XML). Die Einbindung in WFS Client Anwendungen ist möglich, die die o.g. Versionen für OGC WFS Dienste unterstützen.
| WFS Operation | Inhalt |
|---|---|
GetCapabilities |
Abfrage der Fähigkeiten des Dienstes |
GetFeature |
Abfrage von Planobjekten |
DescribeFeatureType |
Abfrage der Struktur von Objektarten |
ListStoredQueries |
Abfrage der verfügbaren StoredQueries |
DescribeStoredQueries |
Beschreibung einer StoredQuery |
7.2.1. Adresse des Dienstes
Planstatus In Aufstelllung:
http://<host>:<port>/xplan-services-wfs-syn/services/xplansynwfspre?
Planstatus Festgestellt:
http://<host>:<port>/xplan-services-wfs-syn/services/xplansynwfs?
Planstatus Archiviert:
http://<host>:<port>/xplan-services-wfs-syn/services/xplansynwfsarchive?
7.3. Operationen
Das folgende Kapitel beschreibt die Operationen, die mit dem XPlanSynWFS durchführbar sind.
7.3.1. GetCapabilities
Die GetCapabilities Abfrage dient der Auskunft über die Fähigkeiten des WFS Dienstes. Dabei handelt es sich beispielsweise um Informationen zum Dienstbetreiber, zu den unterstützten Operationen sowie den durch den WFS angebotenen Objektarten.
http://<host>:<port>/xplan-services-wfs-syn/services/xplansynwfs?request=GetCapabilities&Service=WFS&Version=1.1.0
7.3.2. GetFeature
Die Operation GetFeature stellt die Kernfunktionalität des XPlanSynWFS dar. Die Operation ermöglicht es, die angebotenen Ebene zu den Planinhalten mit GIS Clients zu nutzen, die die Schnittstellen WFS 1.1.0 bzw. WFS 2.0.0 unterstützen.
http://<host>:<port>/xplan-services-wfs-syn/services/xplansynwfs?request=GetFeature&Service=WFS&Version=1.1.0&typename=xplan:BP_Bereich
7.3.3. DescribeFeatureType
Die Operation DescribeFeatureType gibt Informationen zur Struktur der einzelnen Feature Types wieder.
http://<host>:<port>/xplan-services-wfs-syn/services/xplansynwfs?request=DescribeFeatureType&Service=WFS&Version=1.1.0
7.3.4. ListStoredQueries
Die Operation ListStoredQueries gibt Informationen über die verfügbaren StoredQueries zurück. Diese Operation steht nur in der Protokollversion 2.0.0 zur Verfügung.
http://<host>:<port>/xplan-services-wfs-syn/services/xplansynwfs?request=ListStoredQueries&Service=WFS&Version=2.0.0
7.4. StoredQueries
Neben den üblichen StoredQueries urn:ogc:def:query:OGC-WFS::GetFeatureById und urn:ogc:def:query:OGC-WFS::GetFeatureByType bietet der Endpoint xplansynwfs drei weitere StoredQueries an:
-
urn:ogc:def:query:OGC-WFS::InternalId
-
urn:ogc:def:query:OGC-WFS::PlanId
-
urn:ogc:def:query:OGC-WFS::PlanName
-
urn:ogc:def:query:OGC-WFS::PlanNameAndType
Darüber lassen sich die Vektordaten eines einzelnen Plans über die vom XPlanManager vergebene interne Id, die im XPlanGML vergebene Nummer bzw. den im XPlanGML angegebenen Namen abrufen.
Aufgrund der Eigenschaften des XPlanSynWFS lassen sich aktuell nur für die StoredQuery PlanName alle zu einem Plan gehörigen Vektordaten abrufen. Die StoredQueries InternalId und PlanId geben nur die Vektordaten des Feature Types BP_Plan (bzw. FP_Plan, LP_Plan, RP_Plan und SO_Plan) zurück, nicht ggf. referenzierte Vektordaten. Die StoredQuery PlanNameAndType gibt dagegen die Vektordaten des mit dem Parameter typeNames angefragten Feature Types zurück. Es kann an dieser Stelle nur ein Feature Type angegeben werden.
Um die Eindeutigkeit der StoredQueries PlanId, PlanName und PlanNameAndType zu gewährleisten, muss sichergestellt werden, dass bei den importierten Plänen die Nummer und der Name des Plans eindeutig sind.
Die Nutzung der StoredQueries erfolgt über GetFeature-Anfragen. Beispielanfrage für den Plan mit dem Namen Musterdorf:
http://<host>:<port>/xplan-services-wfs-syn/services/xplansynwfs?request=GetFeature&service=WFS&version=2.0.0&StoredQuery_ID=urn:ogc:def:query:OGC-WFS::PlanName&planName=Musterdorf
Über den optionalen Parameter srsName lässt sich das Koordinatenreferenzsystem der zurückzugebenden Geometrien angeben. Wird der Parameter nicht verwendet, erfolgt die Ausgabe der Geometrien in dem default-Koordinatenreferenzsystem des Dienstes. Der Parameter wird von allen StoredQueries unterstützt. Beispielanfrage für den Plan mit dem Namen Musterdorf mit srsName=EPSG:4326:
http://<host>:<port>/xplan-services-wfs-syn/services/xplansynwfs?request=GetFeature&service=WFS&version=2.0.0&StoredQuery_ID=urn:ogc:def:query:OGC-WFS::PlanName&planName=Musterdorf&srsName=EPSG:4326
7.5. Koordinatenreferenzsysteme
Der XPlanSynWFS unterstützt die folgenden Koordinatenreferenzsysteme:
-
EPSG:25832
-
EPSG:25833
-
EPSG:325833
-
EPSG:31466
-
EPSG:31467
-
EPSG:31468
-
EPSG:31469
-
EPSG:4258
-
EPSG:4326
-
EPSG:4839
-
CRS:84
8. XPlanInspirePluWMS
Der XPlanInspirePluWMS ist ein INSPIRE View Service zur Abfrage der Daten im INSPIRE Datenthema Planned Land Use (PLU). Der Dienst ermöglicht die Visualisierungen von Plandaten sowie Sachinformationsabfragen zu einzelnen Planinhalten.
8.1. Benutzung des XPlanInspirePluWMS
Der XPlanInspirePluWMS ist ein INSPIRE View Service basierend auf der Open Source Software deegree. Die folgende Tabelle gibt einen Überblick über die zur Verfügung stehenden Operationen des XPlanInspirePluWMS, die in den weiteren Kapiteln noch näher erläutert werden.
| WMS Operation | Inhalt |
|---|---|
GetCapabilities |
Abfrage der Fähigkeiten des Dienstes |
GetMap |
Abfrage von Kartenbildern zu WMS Ebenen |
8.1.1. Adresse des Dienstes
http://<host>:<port>/xplan-webservices-inspireplu/services/viewservice?
8.1.2. Beispielanfragen
GetCapabilities
http://<host>:<port>/xplan-webservices-inspireplu/services/viewservice?request=GetCapabilities&service=WMS&version=1.3.0
GetMap
http://<host>:<port>//xplan-webservices-inspireplu/services/viewservice?SERVICE=WMS&VERSION=1.3.0&REQUEST=GetMap&BBOX=49.0,9.0,50.0,9.5&CRS=EPSG:4326&WIDTH=1000&HEIGHT=1000&LAYERS=LU.SpatialPlan&STYLES=&FORMAT=image/png&DPI=96&MAP_RESOLUTION=96&FORMAT_OPTIONS=dpi:96&TRANSPARENT=TRUE
8.2. Operationen
Das folgende Kapitel beschreibt die Operationen, die mit dem XPlanInspirePluWMS durchführbar sind.
8.2.1. GetCapabilities
Die GetCapabilities Abfrage dient der Auskunft über die Fähigkeiten des WMS Dienstes. Dabei handelt es sich beispielsweise um Informationen zum Dienstbetreiber, zu den unterstützten Operationen sowie zu den durch den WMS angebotenen WMS Ebenen.
8.2.2. GetMap
Die Operation GetMap stellt die Kernfunktionalität des XPlanInspirePluWMS dar. Die Operation ermöglicht es, die angebotenen Ebene zu den Planinhalten mit GIS Clients zu nutzen, die die Schnittstellen WMS 1.3.0 unterstützen.
9. XPlanInspirePluWFS
Der XPlanInspirePluWFS ist ein INSPIRE Download Service zur Abfrage von Vektordaten im Datenformat des INSPIRE Datenthema Planned Land Use (PLU).
9.1. Benutzung des XPlanInspirePluWFS
Der XPlanInspirePluWFS ist ein INSPIRE Download Service (WFS 2.0) basierend auf der Open Source Software deegree. Die folgende Tabelle gibt einen Überblick über die zur Verfügung stehenden Operationen des XPlanInspirePluWFS, die in den weiteren Kapiteln noch näher erläutert werden.
| WFS Operation | Inhalt |
|---|---|
GetCapabilities |
Abfrage der Fähigkeiten des Dienstes |
GetFeature |
Abfrage von Planobjekten |
DescribeFeatureType |
Abfrage der Struktur von Objektarten |
9.1.1. Adresse des Dienstes
http://<host>:<port>/xplan-webservices-inspireplu/services/downloadservice?
9.1.2. Beispielanfragen
GetCapabilities
http://<host>:<port>/xplan-webservices-inspireplu/services/downloadservice?request=GetCapabilities&Service=WFS&Version=2.0.0
GetFeature
http://<host>:<port>/xplan-webservices-inspireplu/services/downloadservice?request=GetFeature&Service=WFS&Version=2.0.0&typename=plu:SpatialPlan
DescribeFeatureType
http://<host>:<port>/xplan-webservices-inspireplu/services/downloadservice?request=DescribeFeatureType&Service=WFS&Version=2.0.0
9.2. Operationen
Das folgende Kapitel beschreibt die Operationen, die mit dem XPlanInspirePluWFS durchführbar sind.
9.2.1. GetCapabilities
Die GetCapabilities Abfrage dient der Auskunft über die Fähigkeiten des WFS Dienstes. Dabei handelt es sich beispielsweise um Informationen zum Dienstbetreiber, zu den unterstützten Operationen sowie zu den durch den WFS angebotenen WFS Objektarten.
9.2.2. GetFeature
Die Operation GetFeature stellt die Kernfunktionalität des XPlanInspirePluWFS dar. Die Operation ermöglicht es, die angebotenen Vektordaten anzufragen.
9.2.3. DescribeFeatureType
Die Operation DescribeFeatureType gibt Informationen zur Struktur der einzelnen Feature Types wieder.
9.3. Response Paging
Der XPlanInspirePluWFs ist so konfiguriert, dass maximal 100 Instanzen des angefragten FeatureTypes zurückgegeben werden. Um alle Instanzen abzufragen muss daher das vom WFS unterstützte Response Paging verwendet werden: die Parameter COUNT und STARTINDEX ermöglichen das "Blättern" im Gesamtdatenbestand. Mit COUNT wird die Anzahl der maximal zurückgegeben Instanzen vorgegeben, mit STARTINDEX der Index der ersten Instanz (beginnend bei 1) die zurückgegeben werden soll. Beispiele (Beschreibung von <GET_FEATURE_REQUEST> s. oben):
"Seite 1":
<GET_FEATURE_REQUEST>&COUNT=10
"Seite 2":
<GET_FEATURE_REQUEST>&COUNT=10&STARTINDEX=11
Über die Attribute @next und @previous im GetFeatureResponse werden die URLs der nächsten bzw. vorherigen "Seite" bereits ausgegeben.
10. XPlanCLI Tools
Die Hilfe für das XPlanCLI kann mit xpb help aufgerufen werden. Das XPlanCLI unterstützt verschiedene Kommandos und die allgemeine Syntax ist: xpb <COMMAND> <SUBCOMMAND> [parameters].
Folgende Kommandos werden unterstützt: validate, manage, admin.
Globale Parameter sind:
-
--workspace: Pfad zum deegree WorkspaceDEEGREE_WORKSPACE_ROOTVerzeichnis -
--config: Pfad zumXPLAN_CONFIGVerzeichnis
10.1. XPlanCLI - Das validate Kommando
Mit den XPlanCLI validate Kommando können XPlanGML-Dateien und XPlanArchive validiert werden.
10.1.1. Benutzungsanleitung
Das Kommando wird mit xpb validate [SUBCOMMAND] aufgerufen.
Konfiguration über Datei
In dem Verzeichnis <validator-cli-directory>/etc/ befindet sich die Konfigurationsdatei validatorConfiguration.properties, welche genutzt werden kann, um generelle Konfigurationen an dem Kommandozeilenwerkzeug durchzuführen.
Über validationReportDirectory=<directory> kann konfiguriert werden, wo die Reports mit dem Validierungsergebnis, die während der Ausführung des Tools generiert werden, abgespeichert werden sollen.
Mit der Option validationRulesDirectory=<directory> kann konfiguriert werden, in welchem Verzeichnis die semantischen Validierungsregeln liegen, die für die Validierung verwendet werden sollen. Erfolgt keine Angabe werden die unter <validator-cli-directory>/etc/rules liegenden semantischen Validierungsregeln verwendet.
Hilfe
Die Hilfe mit den Angaben zu den möglichen Eingabeparametern lässt sich
mit dem Parameter help ausgeben.
Aufruf:
xpb validate help
Ausgabe:
Usage: xpb validate [COMMAND] Validate a plan or all plans in a database Commands: help Display help information about the specified command. file Validate a XPlanArchive or XPlanGML file. db Validate XPlanGML in xPlanBox database.
Auswahl XPlanArchiv
Über das Kommando validate und Angabe des Pfads zum XPlanArchiv
kann ausgewählt werden, welches Planwerk validiert werden soll. Die Angabe
des Parameters ist obligatorisch.
Aufruf:
xpb validate --file=planwerk.zip
Bezeichnung für den Report
Über den Parameter name <bezeichnung> kann eine Bezeichnung für den generierten
Report vergeben werden. Die Angabe des Parameters -name ist optional.
Fehlt dieser Parameter, wird der Name des XPlanArchivs verwendet.
Aufruf:
xpb validate --file=planwerk.zip --name=Report_Planwerk_1
Validierungsart
Die Kommandozeilenschnittstelle des XPlanValidator kann zur Auswahl der
Validierungsart parametrisiert aufgerufen werden. Die Angabe des
Parameters -vtype ist optional.
Aufruf:
xpb validate --file=planwerk.zip --type=[syntax|geometric|semantic]
Zuordnung der Werte:
-
syntax = Syntaktisch
-
geometric = Geometrisch
-
semantic = Semantisch
Wird kein type Parameter gewählt, werden alle Validierungsarten durchgeführt.
Beispiel für eine Ausgabe:
Configuration directory is /xplan-cli/etc Configuration is read from file /xplan-cli/etc/validatorConfiguration.properties ------------------------------------------- [main] Configuration of the XPlanValidator: ------------------------------------------- validation report directory - /tmp/validationReport17446416227420229747 validation rules directory - internal rules are used XPlanValidatorWMS Endpoint - null ------------------------------------------- Ergebnisse der syntaktischen Validierung: 0 Einlesen der Features (+ Geometrievalidierung)... Features with invalid flaechenschluss: - 2.2.1.1: Das Flaechenschlussobjekt mit der gml id Gml_068D3EBD-3701-42FC-9CED-C9DB9947B5CE erfuellt die Flaechenschlussbedingung an folgender Stelle nicht: (571672.134,5940838.1235) No features outside geltungsbereich - Ueberpruefung der XLink-Integritaet... Geometrie-Fehler: 1 - 2.2.1.1: Das Flaechenschlussobjekt mit der gml id Gml_068D3EBD-3701-42FC-9CED-C9DB9947B5CE erfuellt die Flaechenschlussbedingung an folgender Stelle nicht: (571672.134,5940838.1235) Fortsetzung trotz Geometrie-Fehlern (--force). Ergebnisse der geometrischen Validierung: Warnungen: 0 Fehler: 1 - 2.2.1.1: Das Flaechenschlussobjekt mit der gml id Gml_068D3EBD-3701-42FC-9CED-C9DB9947B5CE erfuellt die Flaechenschlussbedingung an folgender Stelle nicht: (571672.134,5940838.1235) ... Geometrische Validierung hat ergeben: Dokument ist nicht valide Semantische Validierung hat ergeben: Dokument ist valide Syntaktische Validierung hat ergeben: Dokument ist valide Archiv mit Validierungsergebnissen wird erstellt. Archiv mit Validierungsergebnissen wurde unter /tmp/validationReport17446416227420229747 abgelegt.
Validierungsoption
Die Kommandozeilenschnittstelle des XPlanValidator kann zur Auswahl von
zusätzlichen Validierungsoptionen parametrisiert aufgerufen werden. Die
Angabe des Parameters --option ist optional.
Aufruf:
xpb validate --file=planwerk.zip -option=skip-flaechenschluss,skip-geltungsbereich,skip-laufrichtung=true
Zuordnung der Werte:
-
skip-flaechenschluss: Geometrische Überprüfung der Flächenschlussbedingung (2.2.1.1) überspringen [ja] -
skip-geltungsbereich: Geometrische Überprüfung des Geltungsbereich (2.2.3.1) überspringen [ja] -
skip-laufrichtung: Geometrische Überprüfung Laufrichtung (2.2.2.1) überspringen
Validierungsergebnis
Am Ende des Validierungsdurchlaufs wird dem Benutzer der Pfad zu dem Validierungsergebnis ausgegeben. Das Validierungsergebnis wird als HTML, XML sowie PDF in einem Archiv gespeichert. Das Archiv ist nach dem Validierungsdurchlaufs benannt und kann somit leicht identifiziert werden.
10.2. XPlanCLI - Das manage Kommando
Mit den XPlanCLI manage Kommando können XPlanGML-Dateien und XPlanArchive in die XPlanDB verwaltet werden, sowie Service-Metadaten für den XPlanWerkWMS zu erzeugt werden.
10.2.1. Benutzungsanleitung
Das Kommando wird mit xpb manage [SUBCOMMAND] aufgerufen.
Konfiguration über Datei
In dem Verzeichnis <manager-cli-directory>/etc/ befindet sich die Konfigurationsdatei managerConfiguration.properties, welche genutzt werden kann, um generelle Konfigurationen an dem Kommandozeilentool durchzuführen.
Wird der Parameter managerconfiguration nicht angegeben, nutzt das Tool die unter
etc/ abgelegte Datei. Wenn der Parameter mitgegeben wird, muss sich die
Konfigurationsdatei in dem referenzierten Verzeichnis befinden.
Hilfe
Die Hilfe mit den Angaben zu den möglichen Eingabeparametern lässt sich
mit dem Kommando help ausgeben.
Aufruf:
xpb manage help
Ausgabe:
Usage: xpb manage [COMMAND]
Manage plans
Commands:
help Display help information about the specified command.
list List all plans that are available in the data storage.
import Import a single or multiple XPlanArchive(s) or XPlanGML file
(s).
export Export a single or multiple plan(s).
delete Delete a single or multiple plan(s).
create-metadata Create service metadata records.
Auflistung
Das Kommando list gibt die Liste der Pläne aus, die im XPlanManager importiert sind.
Aufruf:
xpb manage list
Beispiel Ausgabe:
Anzahl Plaene: 24 - Id: 1, Version: XPLAN_40, Typ: BP_Plan, Name: Alsterdorf2_SoapUI-XPlanManagerAPI, Nummer: -, GKZ: 02000000, Raster: nein, Veroeffentlichungsdatum: null, Importiert: 2023-09-12 16:27:13.563 - Id: 2, Version: XPLAN_41, Typ: BP_Plan, Name: Eidelstedt4_SoapUI-XPlanManagerAPI, Nummer: -, GKZ: 02000000, Raster: nein, Veroeffentlichungsdatum: 1973-10-16 00:00:00.0, Importiert: 2023-09-12 16:27:17.844 - Id: 3, Version: XPLAN_41, Typ: BP_Plan, Name: Eidelstedt4_SoapUI-XPlanManagerAPI, Nummer: -, GKZ: 02000000, Raster: nein, Veroeffentlichungsdatum: 1973-10-16 00:00:00.0, Importiert: 2023-09-12 16:27:19.601 - Id: 4, Version: XPLAN_50, Typ: BP_Plan, Name: Alsterdorf24_SoapUI-XPlanManagerAPI, Nummer: -, GKZ: 02000000, Raster: ja, Veroeffentlichungsdatum: null, Importiert: 2023-09-12 16:27:20.639 - Id: 5, Version: XPLAN_50, Typ: BP_Plan, Name: DemoPlanAenderung_1_SoapUI-XPlanManagerAPI, Nummer: -, GKZ: 1234567, Raster: nein, Veroeffentlichungsdatum: 2007-04-01 00:00:00.0, Importiert: 2023-09-12 16:27:22.903 - Id: 6, Version: XPLAN_50, Typ: BP_Plan, Name: BPlan Demo-Gemeinde_SoapUI-XPlanManagerAPI, Nummer: -, GKZ: 1234567, Raster: nein, Veroeffentlichungsdatum: 2006-09-01 00:00:00.0, Importiert: 2023-09-12 16:27:22.924 - Id: 7, Version: XPLAN_52, Typ: BP_Plan, Name: Bahrenfeld74_SoapUI-XPlanManagerAPI, Nummer: -, GKZ: 02000000, Raster: nein, Veroeffentlichungsdatum: 2022-03-02 00:00:00.0, Importiert: 2023-09-12 16:27:27.488 - Id: 8, Version: XPLAN_52, Typ: BP_Plan, Name: xplan52-Laufrichtungsfehler_SoapUI-XPlanManagerAPI, Nummer: -, GKZ: 02000000, Raster: nein, Veroeffentlichungsdatum: null, Importiert: 2023-09-12 16:27:29.51 ...
Import
Ein Import kann durch das Kommando import, gefolgt vom Pfad
zum XPlanArchiv, angestoßen werden. Bei dem Import können
XPlanGML-Vektordaten und XPlanGML-Rasterdaten ohne zusätzlichen
Parameter in die Datenhaltung geladen werden. Mehrere Pläne können durch Leerzeichen getrennt angegeben werden.
Beispiel Aufruf:
xpb manage import planwerk.zip
Während des Imports finden zahlreiche Konsistenz- und Korrektheitsüberprüfungen statt. Dies betrifft u.a. Schemavalidität, Geometrievalidität, Korrektheit von Links, Angabe von Koordinatenreferenzsystemen, u.v.m.
Folgende Parameter können mit angegeben werden, um z. B. fehlende Informationen anzugeben.
--force --crs=EPSG:25832
--force
Enthält das XPlanGML-Dokument Geometriefehler o.ä., ist es
dringend angeraten, diese vor einem Import zu bereinigen. Der Import eines Planes kann mit dem Parameter force erzwungen werden.
| Bitte beachten Sie, dass dabei vorliegenden Geometriefehler o.ä. übernommen werden und der importierte Plan dadurch fehlerhaft ist. Die Auswirkungen können von einer fehlerhaften Darstellung des Plans bis hin zu unerwarteten Verhalten der xPlanBox reichen. |
xpb import --force --files=planwerk.zip
-–crs
Fehlt die Angabe des Koordinatenreferenzsystems in den Daten, so kann
dieses mit dem Parameter crs übergeben werden.
Beispiel Aufruf:
xpb manage import --files=planwerk.zip --crs=EPSG:25832
Beispiel Ausgabe für erfolgreichen Import
Import des Plans /BPlan002_5-2.zip
...
- Analyse des XPlanArchivs ('/BPlan002_5-2.zip')... OK. [XPLAN_52, BP_Plan, EPSG:25832]
- Importiere Plan [XPLAN_52, BP_Plan, EPSG:25832]
- Ueberpruefung des raeumlichen Bezugssystems... OK, EPSG:25832
- Schema-Validierung (Hauptdokument)... OK [88 ms].
- Ueberpruefung der externen Referenzen... OK [0 ms]
- Insert XPlan
- Insert XPlan in XPlanDB
- Erzeugen der XPlan-Syn Features...
- Read rules from internal directory: /rules/xplan52.syn
- Read additional/overwriting rules from directory: /xplanbox/xplan-manager-config/synthesizer/xplan52.syn
- Configured codelist: codeList xplan_BP_SonstPlanArt.xml from directory /xplanbox/xplan-manager-config/synthesizer.
OK [2417 ms]
- Insert XPlan in XplanWFS/XPlanWMS
- Einfuegen von 3 Feature(s) in den FeatureStore (XPLAN_52)...
- Aktualisierung des Plans mit ID '25'
- Aktualisierung der XPlan-Features von Plan mit ID '25'
- Insert XPlan in XPlanSynWF
- Einfuegen von 3 Feature(s) in den FeatureStore (XPLAN_SYN)...
- Insert XPlan in XPlanDB
OK [2934 ms].
XPlanArchiv wurde erfolgreich importiert. Zugewiesene Id: 25
Rasterdatenanalyse
Die Rasterdaten werden beim Import auf Nutzbarkeit überprüft werden, damit sichergestellt ist, dass diese korrekt in den XPlanWMS eingebettet werden können. Die Prüfung beinhaltet das CRS des Rasterplans, sowie das Format.
Beispiel Aufruf:
xpb import --files=planwerk.zip
Beispiel Ausgabe:
Import des Plans /BPlan002_5-2.zip ... - Rasterdatei mit Namen BP_4_020_Bleiche_Hirzberg_u_Schwarzwaldstrasse.tif gefunden. - Koordinatensystem des Rasters: PROJCS[...["EPSG","25832"]] - Evaluationsergebnis der referenzierten Rasterdaten: - Name: BP_4_020_Bleiche_Hirzberg_u_Schwarzwaldstrasse.tif Unterstuetztes CRS: Ja Unterstuetztes Bildformat: Ja Die Rasterdaten des Plans sind valide ... - XPlanArchiv wurde erfolgreich importiert. Zugewiesene Id: 25 ... - Erzeugen/Einsortieren der Rasterkonfigurationen (nach Datum: unbekannt )... OK [0 ms] Rasterscans: - BP_4_020_Bleiche_Hirzberg_u_Schwarzwaldstrasse.tif
Passt das CRS der Rasterdaten nicht mit dem CRS der Rasterdatenhaltung überein, so erhält der Nutzer die Option, den Plan ohne Erzeugung der Rasterkonfiguration zu importieren:
Evaluationsergebniss von referenzierten Rasterdaten: - Name: Abrundungssatzung_Gruhno_ergb.tif Unterstuetztes CRS: Kein Unterstuetztes Bildformat: Ja Aufgrund invalider Rasterdaten wird der Import abgebrochen. Sie können den Import ohne die Erzeugung von Rasterkonfigurationen erzwingen, indem Sie die Option --force angeben.
Export
Der Export eines Planes erfolgt mit dem Kommando export,
gefolgt von der PlanID (diese kann zuvor mit dem Parameter list herausgefunden werden)
und dem Ausgabeverzeichnis. Mehrere PlanIDs können durch Leerzeichen getrennt angegeben werden.
Beispiel Aufruf:
xpb manage export --id=9 --target=../ausgabeverzeichnis
Beispiel Ausgabe für erfolgreichen Export:
- Schreibe Artefakt 'xplan.gml'...OK. Plan 9 wurde nach 'xplan-exported-9.zip' exportiert.
Löschen
Beim Löschen wird dem Kommando delete die PlanID (diese kann zuvor mit
list herausgefunden werden) übergeben. Mehrere PlanIDs können durch Leerzeichen getrennt angegeben werden.
Beispiel Aufruf:
xpb manage delete --id=21
Beispiel Ausgabe:
Delete XPlan 21 - Entferne XPlan 21 aus dem FeatureStore (XPLAN_SYN)... OK - Entferne XPlan 21 aus dem FeatureStore (XPLAN_60)... OK - Delete completed successfully. XPlanArchiv mit Id 21 wurde gelöscht.
Erzeugen von Service-Metadatensätzen
Mit dieser Option können Metadatensätze für den XPlanWerkWMS erstellt werden. Bei der Erstellung der Informationen für die Capabilities des XPlanWerkWMS werden dabei bereits vorhandene Informationen überschrieben. Generierte Service-Metadatensätze werden nicht überschrieben, sondern können anhand des Zeitstempels im Dateinamen dem Zeitpunkt der Erstellung zugeordnet werden. Es wird jedoch ein neuer FileIdentifier generiert.
Für einzelne Pläne können Metadatensätze durch Angabe der PlanID (diese kann zuvor mit list herausgefunden werden) erzeugt werden. Mehrere PlanIDs können durch Leerzeichen getrennt angegeben werden. Wird keine PlanID angegeben, werden die Metadatensätze für alle Pläne erzeugt.
Beispiel Aufruf:
xpb manage create-metadata --ids=1
Troubleshooting
Beim Import sehr großer Archive, kann es zu einem OutOfMemoryError
Laufzeitfehler kommen, da die Java Virtual Machine keinen weiteren
freien Speicher allokieren kann. Wenn der Server noch über freien
Arbeitsspeicher verfügt, dann kann dieser über die Umgebungsvariable
JAVA_OPTS unter Linux wie folgt erhöht werden:
export JAVA_OPTS='-Xmx4096m'
Weitere Informationen zur Konfiguration des Servers im Kapitel Bekannte Probleme - Kapazitätsbezogene Einschränkungen und im Betriebshandbuch.
11. Support und bekannte Probleme
11.1. Support
Für professionellen Support per Telefon oder E-Mail kontaktieren Sie bitte die lat/lon GmbH.
11.2. Fehler melden
Für den Fall, dass Sie einen Fehler in der xPlanBox finden, erstellen Sie bitte einen Fehlerbericht unter Open CoDE GitLab Issues.
11.3. Bekannte Probleme
11.3.1. XPlanValidator - Anzeige der Zeilennummern im Validierungsbericht
Die Ausgabe der Zeilennummer bei semantischen Validierungsfehlern kann je nach Formatierung des XML-Dokuments von der Zeile des verursachenden Elements abweichen. Gute und exakte Ergebnisse bei der Ausgabe der Zeilennummer des Elements lassen sich dann erzielen, wenn das XML-Dokument ohne Formatierung der Attribute erfolgt, insbesondere der Deklaration der Namensräume im Wurzelelement. Die Zeilen werden entsprechend der XML-Spezifikation gezählt und stellen nur eine Annäherung an die Zeilennummer der Dokumententität oder der externen geparsten Entität dar, in der das Element erscheint, das das Ereignis auslöst.
11.3.2. XPlanManagerWeb - Anzeige der Pläne auf der letzten Seite
Die Ansicht der Pläne im XPlanManagerWeb zeigt auf der letzten Seite immer die letzten 15 Pläne an. Dieses Verhalten tritt sowohl mit oder ohne Auswahl eines Filters auf (siehe dazu die Funktionsbeschreibung in Auflistung).
11.3.3. XPlanManagerWeb - Transformation in das INSPIRE Planned Land Use Datenschema
Bei der Transformation von XPlanGML in das INSPIRE Planned Land Use Datenschema können in der vorliegenden Version der xPlanBox die Daten nicht vollständig transformiert werden. So fehlen u.a. Transformationsregeln für Werte aus Codelisten als auch konfigurierbare Abbildungsregeln für Elemente wie z. B. der INSPIRE ID. Zugesichert werden kann, dass das über den XPlanInspirePluWFS abgegebene GML gegen das GML-Applikationsschema validiert. Nicht zugesichert werden kann, dass das GML die Vorgaben aus den Technical Guidelines für das INSPIRE Annex III Datenthema Land Use vollständig erfüllt, sowie dass die Daten aus XPlanGML vollständig in das Zielschema INSPIRE PLU transformiert werden.
11.3.4. XPlanManagerWeb - Änderungen der Rasterbasis über die Editorfunktion im XPlanManagerWeb werden nicht übernommen
Bei dem Hinzufügen einer Rasterbasis wird ohne Angabe des Typs ("Keine Auswahl" statt "Scan") der Eintrag nicht in das XPlanGML-Instanzdokument übernommen. Die Referenz auf die Rasterbasis wird beim Speichern nicht in das XPlanGML geschrieben, befindet sich aber in der ZIP-Datei.
11.3.5. XPlanManagerWeb - Hinzufügen von einer Datei xplan.gml über die Editorfunktion im XPlanManagerWeb resultiert in korrupten XPlanArchiv
Wird ein Text, Dokument oder eine Rasterbasis mit dem Namen xplan.gml über die Editorfunktion des XPlanManagerWeb hinzugefügt und gespeichert, kann dieses XPlanArchiv danach nicht mehr geöffnet werden. Beim nochmaligen Aufruf der Editorfunktion zeigt das System dann den HTTP-Statusfehler "500" an.
| Der Fehler kann nicht in der xPlanBox behoben werden! Das XPlanArchiv muss aus der Datenhaltung entfernt, korrigiert und dann erneut über den XPlanManager importiert werden. |
11.3.6. XPlanManagerWeb - Texteingaben über Editorfunktion im XPlanManagerWeb können nicht gespeichert werden
Bei der Verarbeitung von Texteingaben über die Editorfunktion werden die Zeichen und Zeichenketten aus Sicherheitsgründen von der Anwendung geprüft. Die zugelassenen Zeichen unterscheiden sich von denen, die im XML zugelassen sind und können dazu führen, dass eine Änderung an einem bereits erfolgreich validierten und importieren Plan nicht übernommen werden kann. In diesem Fall müssen allen Sonderzeichen aus der Texteingabe entfernt werden. Alternativ muss die Änderung direkt im XPlanGML vorgenommen werden und der Plan erneut importiert werden.
11.3.7. XPlanManagerWeb - Hinzufügen einer weiteren Datei mit gleichem Namen über die Editorfunktion führt zu Fehler beim Abspeichern
Wird ein XPlanArchiv mit Begleitdokumenten oder Rasterdaten importiert und über die Editorfunktion eine weitere Datei mit bereits verwendetem Dateinamen hinzugefügt, dann kommt es beim Abspeichern zu einer Fehlermeldung.
11.3.8. XPlanManagerWeb/XPlanManagerAPI - Fehler beim Editieren: Multiple representations of the same entity
Wird ein XPlanArchiv mit Anhängen z. B. Begleitdokumenten importiert und sind diese Dateien nicht oder durch eine absolute URL im XPlanGML referenziert, dann kommt es beim Hinzufügen einer Datei mit dem gleichen Namen über die Editierfunktion im XPlanManagerWeb oder entsprechende Funktion in der XPlanManagerAPI zu einem Fehler. Ein solches XPlanArchiv kann entstehen, wenn ein XPlanArchiv über den XPlanManagerWeb oder die XPlanManagerAPI exportiert wird und die XPlanDokumenteAPI aktiviert ist. Dann werden die externen Referenzen von der xPlanBox automatisch angepasst. Das exportierte XPlanArchiv beinhaltet alle Anhänge des Plans sowie die absoluten Referenzen auf die XPlanDokumenteAPI im XPlanGML.
11.3.9. XPlanDokumenteAPI - Abruf des World-Files bei GeoTIFF nicht möglich
Bei Import eines Plans mit einer im XPlanGML referenzierten GeoTIFF-Datei als Rasterbasis und zusätzlich auch noch einem referenzierten World-File (tfw-Datei), dann ist die tfw-Datei nicht über die XPlanDokumenteAPI abfragbar. Wird die im exportierten XPlanGML angegebene URL aufgerufen, kann die tfw-Datei nicht abgerufen werden und ein HTTP-Statusfehler "404 - Not Found" wird von der XPlanDokumenteAPI zurückgegeben.
11.3.10. XPlanDokumenteAPI/XPlanManagerAPI/XPlanManagerWeb - Re-Import von exportierten Plänen mit Rasterdaten bei aktivierter XPlanDokumenteAPI nicht möglich
Wenn die XPlanDokumenteAPI aktiviert ist und ein XPlanArchiv mit Rasterdaten importiert wurde, dann werden die Referenzen auf die Rasterdaten von der xPlanBox automatisch angepasst. Wird das XPlanGML-Instanzdokument über den XPlanManagerAPI oder -Web wieder exportiert, dann müssen vor einem erneuten Import in die xPlanBox die Referenzen manuell angepasst werden.
11.3.11. XPlanValidatorAPI - Verwendung von vollqualifizierten Pfaden im HTTP-Header "X-Filename"
Wird der HTTP-Header "X-Filename" mit einem vollqualifizierten Pfad angegeben, kommt es bei der Anfrage eines Reports im Format PDF zu einem HTTP-Statusfehler "500".
Der Fehler kann dadurch umgangen werden, dass im HTTP-Header nur der Dateiname angegeben wird. Der Fehler tritt nicht auf, wenn über den HTTP-Header "Accept" Json oder XML angefragt werden.
11.3.12. XPlanWMS - Darstellungsvorschriften für Raumordnungspläne
Die Darstellungsvorschriften für Raumordnungspläne sind zum Teil unvollständig. Durch den XPlanWMS werden die betroffenen Ebenen daher nur in der Standarddarstellung ausgegeben.
11.3.13. XPlanWMS - Umsetzung von Präsentationsobjekte
Im XPlanWMS ist der Umfang der Darstellung von Präsentationsobjekten nur eingeschränkt implementiert. Über die folgenden Layer werden diese angezeigt:
-
Für die Planart BP_Plan:
-
bp_xp_fpo
-
bp_xp_lpo
-
bp_xp_lto
-
bp_xp_ppo
-
bp_xp_pto
-
-
Für die Planart FP_Plan:
-
fp_xp_fpo
-
fp_xp_lpo
-
fp_xp_lto
-
fp_xp_ppo
-
fp_xp_pto
-
-
Für die Planart LP_Plan:
-
lp_xp_fpo
-
lp_xp_lpo
-
lp_xp_lto
-
lp_xp_ppo
-
lp_xp_pto
-
-
Für die Planart RP_Plan:
-
rp_xp_fpo
-
rp_xp_lpo
-
rp_xp_lto
-
rp_xp_ppo
-
rp_xp_pto
-
-
Für die Planart SO_Plan:
-
so_xp_fpo
-
so_xp_lpo
-
so_xp_lto
-
so_xp_ppo
-
so_xp_pto
-
Derzeit werden die folgenden Attribute bei der Visualisierung berücksichtigt:
-
XP_LTO
-
schriftinhalt
-
position
-
-
XP_PTO
-
schriftinhalt
-
skalierung
-
drehwinkel
-
horizontaleAusrichtung
-
vertikaleAusrichtung
-
position
-
-
XP_FPO
-
Polygon wird mit grauem Umring dargestellt
-
position
-
-
XP_LPO
-
Linie wird grau dargestellt
-
position
-
-
XP_PPO
-
Darstellung erfolgt als Kreis mit grauem Umring
-
position
-
12. Ausblick
12.1. Empfehlungen für die Bereitstellung von XPlanungsdaten
Die Leitstelle XPlanung/XBau hat einen Leitfaden XPlanung und eine Handreichung XPlanung herausgegeben, die sich an die Träger von Planverfahren, Planer in der öffentlichen Verwaltung als auch in Planungs- und Ingenieurbüros wendet, die mit der konkreten technischen Umsetzung von XPlanung bzw. der Erstellung von Planwerken gemäß dem Standard XPlanung beauftragt sind. Die beiden Dokumente bieten Unterstützung in der effektiven Umsetzung von XPlanung und der standardkonformen Erstellung und Bereitstellung von XPlanungsdaten von hoher Qualität.
12.2. Einbindung in andere Software
Zur Betrachtung der über den XPlanManager importierten Planwerke bietet sich die Einbindung des XPlanWMS oder XPlanWerkWMS in einen geeigneten Client an. Da es sich bei beiden Diensten jeweils um standardkonforme WMS handelt, kann jeder Client verwendet werden, der diese Schnittstelle in den Versionen 1.1.1 und 1.3.0 unterstützt. Der Zugriff auf die XPlanGML-Daten ist über den XPlanSynWFS oder die versionsspezifischen XPlanWFS-Dienste möglich.
| Als Desktop-Client wird QGIS empfohlen. Als WebGIS-Client wird das Masterportal empfohlen. Detaillierte Informationen zur Installation, Konfiguration und Benutzung finden sich in der Dokumentation der jeweiligen Software. |
Anhang A: Änderungshistorie der xPlanBox
A.1. Version 8.1
A.1.1. Erweiterungen
-
Funktionen zur syntaktischen und geometrischen Validierung innerhalb der XPlanDB im XPlanCLI hinzugefügt
-
Optimierung des ReSynthesizers für Performanz und Skalierbarkeit
-
Erweiterung des Synschemas der XPlanDB um Filterkriterien
-
Erweiterung des XPlanWMS, XPlanWerkWMS und XPlanMapServer um Filterkriterien für die Abfrage von Rasterdaten
-
Erweiterung des XPlanWerkWMS um Filter für internalId und planId
-
Erweiterung des XPlanWerkWMS um dynamische Capabilities
-
Erweiterung des XPlanWMS um Filterkriterien
-
Erweiterung der XPlanManagerAPI um weitere Queryparameter um internalId und planStatus für die Plansuche
-
Unterstützung von Paging in XPlanManagerAPI für plans Ressource implementiert
-
Erweiterung der XPlanManagerAPI um eine Ressource für den Abruf der Änderungshistorie
-
Verbesserung der Zuordnung des Planstatus bei Plänen ohne Angabe eines Rechtsstands
-
Erweiterung der geometrischen Validierung um Prüfung der Koordinaten eines Plans auf Lage innerhalb des Gültigkeitsbereichs des CRS
-
Erweiterung der XPlanManagerAPI um Ressource für den Download der XPlanGML-Datei
-
Ergänzung des HTTP Header Content-Disposition in XPlanDokumenteAPI für den Abruf von Dokumenten
-
XPlanWMS und XPlanMapServer können Rasterbilder mit unterschiedlichen SRS ausliefern
-
Umstellung von Classic Queues auf Quorum Queues für die Kommunikation über RabbitMQ
-
XPlanValidatorExecutor um Healthcheck zur Prüfung der RabbitMQ-Verbindung erweitert
-
Hintergrundkarte im XPlanManagerWeb ist konfigurierbar
-
Logging um Tracing Informationen erweitert
-
Zusammenfassung der Dokumentation und Überarbeitung der Einstiegsseite
-
Aktualisierung der Validierungsregeln auf v1.1.13
-
Aktualisierung auf MapProxy 3.1.3
-
Aktualisierung auf AWS SDK 2.x
A.1.2. Sicherheitsupdates
-
Bibliotheken mit Sicherheitslücken aktualisiert
-
Ausgabe der Anmeldedaten für die Datenbank in Log-Ausgabe des XPlanCLI wird unterdrückt
-
Ausgabe von Stacktraces und detaillierten Fehlermeldungen in Schnittstellen deaktiviert
A.1.3. Fehlerbehebungen
-
Korrektur der Ableitung des Planstatus bei Rechtsstand 5000 bei RPlänen
-
Konfiguration des CRS in XPlanMapServer korrigiert
-
Korrektur der Auswertung von XPath-Ausdrücken in Präsentationsobjekten
-
Korrektur des Validierungsberichts bei der Auswahl mehrerer Profile
-
Fehlerbehebung in den Änderungsfunktionen der XPlanManagerAPI
-
Fehlerbehebung im Editiermodus des XPlanManagerWeb
-
Fehlerbehebung bei der Verarbeitung von GeoTIFF-Dateien
-
Korrekturen in der Dokumentation vorgenommen
A.1.4. Entfernte Funktionen
-
Dialog im XPlanManager zum Überspringen des Imports von Rasterdaten entfernt
A.2. Version 8.0.3
A.2.1. Fehlerbehebungen
-
Regression beim Editieren von Texten, Dokumenten und Rasterbasis ohne Referenzdatei oder Georeferenzdatei in XPlanManagerAPI behoben
A.3. Version 8.0.2
A.3.1. Erweiterungen
-
Aktualisierung der Validierungsregeln auf v1.1.12
-
Integration des Validierungsprofils Bayern in XPlanValidator und XPlanManager
A.3.2. Sicherheitsupdates
-
Aktualisierung der Container Images mit Apache Tomcat 10.1 und der Spring Boot 3.4 Bibliotheken
A.3.3. Fehlerbehebungen
-
Korrekturen in der Dokumentation vorgenommen
A.4. Version 8.0.1
A.4.1. Erweiterungen
-
Konfigurationsoption für den Path-Style access für den Zugriff auf S3 hinzugefügt
-
Konfigurationsoption für die Angabe eines RabbitMQ Virtual Host hinzugefügt
A.4.2. Fehlerbehebungen
-
Doppelte Angabe der internalId im XPlanGML bei Import eines Plans über XPlanManagerAPI mit Query-Parameter internalId und internalId im XPlanGML behoben
-
Fehlende Ausgabe der internalId aus dem importierten XPlanGML durch XPlanManagerAPI behoben
-
Fehlerhaftes Datumsformat in Textreferenzen in XPlanManagerAPI v2 behoben
-
Fehlerhafter HTTP Statuscode bei Angabe eines invaliden Datumsformat in PUT/POST JSON-Model der XPlanManagerAPI behoben
-
Fehler in XPlanMapServer durch Zugriff auf die Georeferenzen in der Tabelle xplanmgr.plans behoben
-
Ausgabe des Elements rasterType in der Ressource /api/v2/info im XPlanManagerAPI entfernt
A.5. Version 8.0
Neben Fehlerbehebungen sowie Erweiterungen und Verbesserungen an den Komponenten der xPlanBox wird für den Betrieb der xPlanBox neben einem S3-Objektspeicher auch der Nachrichtenbroker RabbitMQ benötigt. Bitte beachten Sie dazu die Hinweise im Betriebshandbuch, Abschnitt Installation.
A.5.1. Erweiterungen
-
Ausgabe der GML ID bei geometrischen Fehlern wie z. B. Selbstüberschneidungen oder doppelten Stützpunkten im Validierungsbericht des XPlanValidator
-
Unterdrückung von Mehrfachnennungen von identischen Fehlern im Validierungsbericht des XPlanValidator
-
Ausgabe einer Warnung bei Uneindeutigkeit der Bereichsnummern in XPlanValidator
-
Ausgabe von Validierungsfehlern als GeoJSON im XPlanValidator
-
Aufteilung des Validierungsberichts je Planwerk in einer XPlanGML-Datei
-
Erweiterung von XPlanValidatorAPI und XPlanManagerAPI um Prüfungen von referenzierten Rasterdaten auf gültiges CRS und Bildformat
-
Aktualisierung der Validierungsregeln auf v1.1.10
-
Verbesserung der Initialisierung des XPlanManager
-
Einführung der REST-API Version 2 (v2) für XPlanManagerAPI und XPlanValidatorAPI mit asynchroner Verarbeitung über RabbitMQ
-
Verbesserter Validierungsbericht in REST-API v2
-
Unterstützung von Authentifizierung und Autorisierung für XPlanManagerAPI, XPlanValidatorAPI und XPlanDokumenteAPI über Keycloak
-
Umstellung aller Komponenten auf Java 17
-
Umstellung auf Spring Boot 3.3
-
PostgreSQL Update auf Version 15 mit PostGIS 3.5
A.5.2. Sicherheitsupdates
-
Aktualisierung von Bibliotheken mit bekannten Sicherheitsmängeln
A.5.3. Fehlerbehebungen
-
Fehlende Ausgabe des Gemeindenamens im XPlanModelData-Element der XPlanManagerAPI behoben
-
Fehler "Index 0 out of bounds for length 0" beim Editieren im XPlanManagerWeb behoben
-
Fehler in XPlanManagerAPI v1 für HTTP Statuscode 422 bei Import eines invaliden Plans behoben
A.5.4. Entfernte Funktionen
Die folgenden Funktionen wurden in dieser Version entfernt:
-
Unterstützung von XPlanWMS mit GeoTiffTileStore entfernt
-
Unterstützung von XPlanWMS mit MapServer und lokalen Dateisystem entfernt
-
Unterstützung von XPlanValidatorWMS mit In-Memory-FeatureStore entfernt
-
Workspace-Konfiguration für xplan-webservices-validator-wms-memory-workspace entfernt
-
Unterstützung von XPlanWMS mit GDAL entfernt
-
Ausgabe von Shape-Dateien als Teil des Validierungsberichts im XPlanValidator entfernt
-
Ausgabe von XML-Dateien als Teil des Validierungsberichts im XPlanValidator entfernt
-
SQL-Skripte zum Aufsetzen der XPlanDB entfernt
-
Konfigurationsoption zum Setzen eines Gültigkeitszeitraums beim Import eines Planwerks über den XPlanManagerWeb entfernt
-
Konfigurationsoptionen zum Setzen von defaultCRS und chooseCrs zur Auswahl eines Koordinatenreferenzsystems für die Vektordaten eines Planwerks beim Import eines Planwerks über den XPlanManagerWeb entfernt
-
XPlanTransformCLI zur Transformation von XPlanGML 4.1 nach XPlanGML 5.1 entfernt
-
Konfigurationsoption für Verfahrensdatenbank entfernt
-
LDAP-Schnittstelle zur Absicherung des XPlanManagerWeb entfernt
-
Konfigurationsoption für Filterkategorien im XPlanManagerWeb entfernt
A.5.5. Veraltete Funktionen
Die folgenden Funktionen sind veraltet und werden in einer zukünftigen Version der xPlanBox entfernt:
-
Die Erweiterung GetAttachmentHandler des XPlanWMS ist veraltet (deprecated)
-
Die REST-API v1 in XPlanValidatorAPI und XPlanManagerAPI ist veraltet (deprecated)
-
Der XPlanValidatorWMS in XPlanValidatorWeb und XPlanValidatorAPI ist veraltet (deprecated)
Die vollständige Änderungshistorie ist auf der OpenCoDE-Plattform zu finden.