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 - 2023, lat/lon GmbH, Bonn.
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 (originale XPlanGML-Datenstruktur)
-
XPlanSynWFS: Standard-Datendienst (WFS) für die Auskunft (vereinfachte Datenstruktur)
-
XPlanDokumentenAPI: Optionale Komponente für den Zugriff auf Dokumente aus einem XPlanArchiv
-
XPlanTransformCLI: Kommandozeilenwerkzeug für die Transformation von Plänen
-
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
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.1. XPlanValidatorWeb
3.1.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. |
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 XMLDokument 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)
-
-
MultiPolygone:
-
kein Schnitt zwischen einzelnen Polygonen
-
alle für Polygone geltenden Prüfungen für jedes einzelne Polygon
-
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
-
XML
exportiert werden.
Geometriefehler können zusätzlich auch als Shape-Datei gespeichert werden.
Derzeit werden ausschließlich Schnittpunkte in der Shape-Datei ausgegeben, also die Punkte an denen sich die Umgrenzungslinie der betroffenen Geometrie und die des Geltungsbereichs schneiden. Linienförmige Schnittbereiche werden derzeit nicht ausgegeben. |
Alle Ergebnisdateien, selektierte Reports und Geometriefehler, 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.2. 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 |
---|---|---|
|
|
Beschreibung der Schnittstelle als OpenAPI 3.0 Dokument |
|
|
Validieren eines XPlanGML-Dokuments oder XPlanArchivs |
|
|
Informationen zur Software und Konfiguration |
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-api-validator/xvalidator/api/v1/. Die URL für die xPlanBox-Demo lautet https://xplanbox.lat-lon.de/xvalidator/api/v1/. |
3.3. XPlanValidatorCLI
Analog zum XPlanManagerWeb können XPlanGML-Dokumente mit der Komponente XPlanValidatorCLI über ein Kommandozeilenwerkzeug validiert werden.
3.3.1. Benutzungsanleitung
Beim XPlanValidatorCLI handelt es sich um ein Kommandozeilenwerkzeug, das parametrisiert aufgerufen wird. Da diese Anwendung bei der Installation in die PATH Variable aufgenommen wird, ist diese von einem beliebigen Ort aufrufbar.
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:
./XPlanValidator --help
Ausgabe:
Validates XPlanGML files. usage: XPlanValidator [-name <arg>] -validate <arg> [-vo <arg>] [-vtype <arg>] -name <arg> name of the validation -validate <arg> zip file path -vo <arg> validation options, possible values are: skip-flaechenschluss=true, skip-geltungsbereich=true, skip-laufrichtung=true. Each value must be passed as single options, e.g: -vo skip-geltungsbereich=true -vo skip-laufrichtung=true -vtype <arg> values: syntax, geometric, semantic. multiple types must be comma separated
Auswahl XPlanArchiv
Über den Parameter validate <planarchiv>
kann der Pfad zum XPlanArchiv
auswählt werden, welcher validiert werden soll. Die Angabe
des Parameters ist obligatorisch.
Aufruf:
./XPlanValidator -validate Plan.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:
./XPlanValidator -validate Plan.zip -name Validierung
Validierungsart
Die Kommandozeilenschnittstelle des XPlanValidator kann zur Auswahl der
Validierungsart parametrisiert aufgerufen werden. Die Angabe des
Parameters -vtype
ist optional.
Aufruf:
./XPlanValidator -validate Plan.zip -vtype [syntax|geometric|semantic]
Zuordnung der Werte:
-
syntax = Syntaktisch
-
geometric = Geometrisch
-
semantic = Semantisch
Wird kein vtype
Parameter gewählt, werden alle Validierungsarten durchgeführt.
Beispiel für eine Ausgabe:
Configuration directory is /xplan-validator-cli-7.1-SNAPSHOT/etc Configuration is read from file /xplan-validator-cli-7.1-SNAPSHOT/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 -vo
ist optional.
Aufruf:
./XPlanValidator -validate Plan.zip -vo skip-flaechenschluss=true -vo skip-geltungsbereich=true -vo 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.
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
.gml
oder.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.0
aus 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:nummer
für jedenxplan:BP_Bereich
eindeutig sein. -
Das XPlanGML-Dokument beinhaltet keine internen Referenzen auf andere Planobjekte über eines der folgenden Elemente
aendert/XP_VerbundenerPlan/verbundenerPlan
oderwurdeGeaendertVon/XP_VerbundenerPlan/verbundenerPlan
bzw. in XPlanGML 6.0 überaendertPlan/XP_VerbundenerPlan/verbundenerPlan
,wurdeGeaendertVonPlan/XP_VerbundenerPlan/verbundenerPlan
,aendertPlanBereich/XP_VerbundenerPlanBereich/verbundenerPlanBereich
oderwurdeGeaendertVonPlanBereich/XP_VerbundenerPlanBereich/verbundenerPlanBereich
. Wird eines der Elemente in einem XPlanGML-Dokument verwendet, dann kann der Plan nicht importiert werden!
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 (auch der Dateiendung) werden berücksichtigt
und müssen vollständig mit den Referenzen im Dokument übereinstimmen!
|
Referenzierung von Rasterdaten im XPlanGML
Die Rasterdaten müssen mit in dem XPlanArchiv enthalten sein und neben der Datei xplan.gml liegen.
Innerhalb des XPlanGML müssen die Rasterdateien wie folgt referenziert sein:
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.
Beispiel:
<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>
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.
Beispiel:
<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 auch nicht mehr unterstützt. Stattdessen 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.
Beispiel:
<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.
|
Voraussetzungen für die Rasterdaten
Um Rasterdaten importieren und diese über die XPlanWMS-Ebene zur Verfügung stellen zu können, müssen die Daten folgende Anforderungen erfüllen.
Die Unterstützung verschiedener Rasterdatenformate ist vom gesetzten Raster-Konfigurationstyp abhängig.
Dies kann nur zentral für die xPlanBox konfiguriert und nicht durch den Nutzer geändert werden. Hinweise zur Konfiguration sind im Betriebshandbuch zu finden. |
Unterschieden wird dabei zwischen den Konfigurationstypen GeoTiff und GDAL:
GeoTiff - Konfigurationstyp:
-
Es werden ausschließlich Rasterdaten im GeoTiff Format unterstützt.
GDAL - Konfigurationstyp:
-
Grundsätzlich können alle durch GDAL unterstützten Rasterdatenformate auch durch deegree und somit dem XPlanManager verarbeitet werden.
-
Getestet wurden bisher nur die Formate GeoTiff und PNG.
Folgende Voraussetzung werden an die einzelnen Formate gestellt:
GeoTiff:
-
GeoTiff-Dateien liegen als gekachelte GeoTiff-Dateien vor.
-
GeoTiff-Dateien liegen in dem Koordinatenreferenzsystem vor, welches für den XPlanManager konfiguriert ist.
-
GeoTiff-Dateien enthalten ihre räumliche Ausdehnung als Metatags innerhalb der Datei.
-
Zur Optimierung der Antwortzeit beim Zugriff auf die GeoTiff-Dateien wird empfohlen, in den GeoTiff-Dateien Overlays mit niedriger Auflösung hinzuzufügen.
PNG:
-
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.
-
PNG-Dateien liegen in dem Koordinatenreferenzsystem vor, welches für den XPlanManager konfiguriert ist.
-
PNG-Dateien enthalten ihre räumliche Ausdehnung in einer ausgelagerten PGW-Datei (PNG World File).
-
Wenn das Kommandozeilentool XPlanManagerCLI verwendet wird, muss in der Datei aux.xml das Koordinatenreferenzsystem der PNG-Datei definiert sein. Für den XPlanManagerWeb ist dies keine Voraussetzung, da der Fachadministrator beim Import der Daten das Koordinatenreferenzsystem der PNG-Datei über einen Dialog bestätigen kann.
4.1.3. Anlegen von deegree Konfigurationsstrukturen für Rasterdaten
Beim Import von XPlanArchiven mit Rasterdaten werden Konfigurationsdateien für den XPlanWMS automatisch angelegt, die eine Darstellung im XPlanWMS ermöglichen.
Für jede importierte Rasterdatei werden folgende Konfigurationen angelegt:
-
eine Konfigurationsdatei für einen GeoTiffTileStore oder GDALTileStore,
-
eine Konfigurationsdatei für einen TileLayer und
-
in der Ebenenbaum-Konfiguration wird ein neuer Layer in die Kategorieebene eingefügt, die die Rasterpläne nach Datum sortiert beinhaltet.
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.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.
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 geändert werden:
-
name
-
beschreibung
-
technHerstellDatum
-
untergangsDatum
-
planArt
-
sonstPlanArt
-
rechtsstand
-
rechtsverordnungsDatum
Alle Texteingaben werden von der Anwendung sowohl client- als auch serverseitig geprüft. Dabei sind die zugelassenen Zeichen (und Zeichenketten) limitiert und dienen dem Schutz vor Angriffen wie z. B. Cross Site Scripting (XSS) und SQL-Injection.
Das Editieren des Rechtsstands kann dazu führen, dass eine Zustandsänderung des Plans eintritt. Damit verbunden ist das Verschieben der Vektor- und Rasterdaten in die entsprechende Datenhaltung. Übergänge zwischen den drei Zuständen 'Festgestellt', 'In Aufstellung' und 'Archiviert' sind möglich. Eine Zustandsänderung von 'Festgestellt' nach 'In Aufstellung' tritt beispielsweise beim Ändern des Rechtsstands von 'InkraftGetreten' nach 'Untergegangen' ein. |
Beim Import kann der Nutzer den Zustand eines Planes über eine Auswahlliste mit den Optionen 'Festgestellt', 'In Aufstellung' und 'Archiviert' ändern. Abhängig von dem im Plan gesetzten Rechtsstand wird eine Vorauswahl getroffen, die der Nutzer aber ändern kann. Beim Öffnen der Editieransicht wird der Rechtsstand aus dem Plan angezeigt und nicht der vom Nutzer zum Zeitpunkt des Imports ausgewählte Rechtsstand. Somit entspricht die Anzeige des Rechtsstands im Editor nicht dem Zustand des Plans, falls dieser beim Import geändert wurde. Beim Abspeichern von Änderungen ist somit Vorsicht geboten, da es so unbeabsichtigt zu einer Zustandsänderung des Plans kommen kann! |
Gültigkeitszeitraum
-
Der Zeitraum in dem ein Plan im XPlanWMSInAufstellung angezeigt wird. Für dieses Feld gibt es keine Entsprechung im XPlanGML. Die Angabe des Zeitraums, wie sie beim Import erfolgt ist, wird beim Ändern des Zeitraums überschrieben.
Änderungen
bis XPlanGML 5.4:
-
aendert
-
wurdeGeaendertVon
ab XPlanGML 6.0:
-
aendertPlan
-
wurdeGeaendertVonPlan
Texte
-
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
-
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 Abschnitt Referenzierung von Rasterdaten im XPlanGML beschrieben, sind in den Versionen 5.1, 5.2, 5.3 und 5.4 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.
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 XPlanWMS-Konfiguration. 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. |
Wie im Abschnitt 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.
Die ebenfalls in diesem Abschnitt 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.
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) -
{planName}
- eindeutiger Name eines Plans (alphanumerischer Wert, z.B. HafenCity14) -
{name}
- Name oder Suchtext (alphanumerischer Wert, z.B. Hafen ) -
{id}
- eindeutiger Schlüssel einer Ressource (alphanumerischer Wert, Beispiele siehe Abschnitt eindeutige Schlüssel)
Die REST-API des XPlanManager stellt folgende Ressourcen bereit:
Ressource | HTTP Methode | Beschreibung |
---|---|---|
|
|
Beschreibung der Schnittstelle als OpenAPI 3.0 Dokument |
|
|
Informationen zur xPlanBox Version und aktiven Konfiguration |
|
|
Importieren eines XPlanGML-Dokuments oder XPlanArchivs |
|
|
Abfrage der Daten zu einem XPlanArchiv über PlanID |
|
|
Löschen eines XPlanArchivs |
|
|
Abfrage der Daten zu einem XPlanArchiv über den Plannamen |
|
|
Suche nach XPlanArchiven über den Plannamen |
|
|
Abfrage von Basisdaten zu einem Plan |
|
|
Hinzufügen/ersetzen von Basisdaten zu einem Plan |
|
|
Abfrage des Gültigkeitzeitraums zu einem Plan |
|
|
Hinzufügen/ersetzen des Gültigkeitzeitraums zu einem Plan |
|
|
Abfrage von Änderungen zu einem Plan |
|
|
Hinzufügen von Änderungen zu einem Plan |
|
|
Abfrage von Dokumenten zu einem Plan |
|
|
Hinzufügen/ersetzen von Dokumenten zu einem Plan |
|
|
Abfrage eines Dokuments zu einem Plan |
|
|
Hinzufügen/ersetzen eines Dokuments zu einem Plan |
|
|
Entfernen eines Dokuments zu einem Plan |
|
|
Abfrage von Texten zu einem Plan |
|
|
Hinzufügen von Texten zu einem Plan |
|
|
Abfrage eines Texts zu einem Plan |
|
|
Hinzufügen/ersetzen eines Texts zu einem Plan |
|
|
Abfrage von Rasterbasisdateien zu einem Plan |
|
|
Hinzufügen von Rasterbasisdateien zu einem Plan |
|
|
Abfrage einer Rasterbasisdatei zu einem Plan |
|
|
Hinzufügen/ersetzen einer Rasterbasisdatei zu einem Plan |
|
|
Entfernen einer Rasterbasisdatei zu einem Plan |
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-api-manager/xmanager/api/v1/. Die URL für die xPlanBox-Demo lautet https://xplanbox.lat-lon.de/xmanager/api/v1/. |
Die alte REST-API mit den Ressourcen /xplanmgrweb/rest/manager/plans und /xplanmgrweb/rest/manager/plan/{planId} wird durch die neue
API komplett ersetzt und in einer zukünftigen Version der xPlanBox entfernt!
|
4.3.1. Eindeutige Schlüssel für den Zugriff auf REST-Ressourcen
Um den Zugriff auf externe Dokumente zu ermöglichen, die über Referenzen in dem XPlanGML-Dokument definiert sind, wurden folgende Konventionen für die Bestimmung eines eindeutigen Schlüssels festgelegt. Diese Konventionen müssen von einem XPlanArchiv erfüllt werden, wenn dieses über die REST-API bearbeitet werden soll. Im Folgenden sind die Konventionen am Beispiel der Planart "BPlan" und die jeweilige XPlanGML-Version aufgeführt.
Ressource: /plan/{planId}/text/{id}
XPlanGML-Version | Element | ID |
---|---|---|
4.1 |
BP_Plan/texte ⇒ BP_TextAbschnitt (FeatureType) |
GML ID |
5.0 |
BP_Plan/texte ⇒ BP_TextAbschnitt (FeatureType) |
GML ID |
5.1 |
BP_Plan/texte ⇒ BP_TextAbschnitt (FeatureType) |
GML ID |
5.2 |
BP_Plan/texte ⇒ BP_TextAbschnitt (FeatureType) |
GML ID |
5.3 |
BP_Plan/texte ⇒ BP_TextAbschnitt (FeatureType) |
GML ID |
5.4 |
BP_Plan/texte ⇒ BP_TextAbschnitt (FeatureType) |
GML ID |
6.0 |
BP_Plan/texte ⇒ BP_TextAbschnitt (FeatureType) |
GML ID |
Ressource: /plan/{planId}/dokument/{id}
Version | Element | Konformitätsregel | ID |
---|---|---|---|
4.1 |
BP_Plan/ref*/XP_ExterneReferenz |
referenzName-referenzURL[1] |
|
5.0 |
BP_Plan/externeRefenz/XP_ExterneReferenz |
referenzName-referenzURL[1] |
|
5.1 |
BP_Plan/externeRefenz/XP_ExterneReferenz |
referenzName-referenzURL[1] |
|
5.2 |
BP_Plan/externeRefenz/XP_ExterneReferenz |
referenzName-referenzURL[1] |
|
5.3 |
BP_Plan/externeRefenz/XP_ExterneReferenz |
3.2.4.2. Mindestens eines der Attribute referenzName und referenzURL muss belegt sein. |
referenzName-referenzURL[1] |
5.4 |
BP_Plan/externeRefenz/XP_ExterneReferenz |
3.2.4.2. Mindestens eines der Attribute referenzName und referenzURL muss belegt sein. |
referenzName-referenzURL[1] |
6.0 |
BP_Plan/externeRefenz/XP_ExterneReferenz |
3.2.4.2. Mindestens eines der Attribute referenzName und referenzURL muss belegt sein. |
referenzName-referenzURL[1] |
Ressource: /plan/{planId}/rasterbasis/{id}
Version | Element | Konformitätsregel | ID |
---|---|---|---|
4.1 |
BP_Bereich/rasterBasis ⇒ XP_RasterplanBasis/refScan |
referenzName-referenzURL[1] |
|
5.0 |
BP_Bereich/rasterBasis ⇒ XP_RasterplanBasis/refScan, BP_Bereich/refScan/XP_ExterneReferenz |
referenzName-referenzURL[1] |
|
5.1 |
BP_Bereich/rasterBasis ⇒ XP_RasterplanBasis/refScan, BP_Bereich/refScan/XP_ExterneReferenz |
referenzName-referenzURL[1] |
|
5.2 |
BP_Bereich/rasterBasis ⇒ XP_RasterplanBasis/refScan, BP_Bereich/refScan/XP_ExterneReferenz |
referenzName-referenzURL[1] |
|
5.3 |
BP_Bereich/rasterBasis ⇒ XP_RasterplanBasis/refScan, BP_Bereich/refScan/XP_ExterneReferenz |
3.2.4.2. Mindestens eines der Attribute referenzName und referenzURL muss belegt sein. |
referenzName-referenzURL[1] |
5.4 |
BP_Bereich/rasterBasis ⇒ XP_RasterplanBasis/refScan, BP_Bereich/refScan/XP_ExterneReferenz |
3.2.4.2. Mindestens eines der Attribute referenzName und referenzURL muss belegt sein. |
referenzName-referenzURL[1] |
6.0 |
BP_Bereich/refScan/XP_ExterneReferenz |
3.2.4.2. Mindestens eines der Attribute referenzName und referenzURL muss belegt sein. |
referenzName-referenzURL[1] |
Zusätzliche Anforderungen an die im XPlanGML-Dokument verlinkten Referenzen:
-
Für alle Dokumente und Rasterbasis in der Version 4.1 bis 5.2 gilt, dass referenzName oder referenzURL belegt sein muss.
-
Für Pläne mit mehreren
BP_Bereich
-Elementen muss das Elementnummer
für jedenBP_Bereich
eindeutig sein. -
Und zusätzlich gilt für alle Dokumente und Rasterbasis, dass die Kombination aus referenzName-referenzURL innerhalb eines XPlanGML-Dokuments eindeutig sein muss.
4.4. XPlanManagerCLI
Die Komponente XPlanManagerCLI ist ein Kommandozeilenwerkzeug, welches dem Fachadministrator der xPlanBox ermöglicht, die Datenhaltung zu kontrollieren. Dabei ist das Kommandozeilenwerkzeug in der Lage, XPlanGML-Dokumente in die Datenhaltung zu Laden, zu Löschen, Listenausgaben zu erzeugen sowie Service-Metadaten für den XPlanWerkWMS zu erzeugen.
4.4.1. Benutzungsanleitung
Beim XPlanManagerCLI handelt es sich um ein Kommandozeilenwerkzeug, das parametrisiert aufgerufen wird. Da diese Anwendung bei der Installation in die PATH Variable aufgenommen wird, ist diese von einem beliebigen Ort aufrufbar.
Das Basisverzeichnis mit dem Workspace xplan-manager-workspace
muss über
die Umgebungsvariable DEEGREE_WORKSPACE_ROOT gesetzt werden.
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 Parameter help
ausgeben.
Aufruf:
./XPlanManager --help
Ausgabe:
Usage: XPlanManager <options> --help --list --import <xplanarchiv> [<xplanarchiv>..] [--force] [--crs=<CRS>] <xplanarchiv> Die absolute oder relative Referenz auf den Plan, der importiert werden soll (verpflichtend). Mehrere Plaene koennen durch ein Leerzeichen getrennt angegeben werden. --force Erzwingen des Imports eines Plans mit Geomtriefehlern oder Validierungsfehlern (optional). EMPFOHLEN ist die Behebung der Fehler! --crs Angabe des Koordinatenreferenzsystems in dem die Daten vorliegen (optional). --export <planid> [<planid>..] [--target=<verzeichnis>] <planid> Die ID des Plans der exportiert werden soll (verpflichtend). Mehrere IDs koennen durch ein Leerzeichen getrennt angegeben werden. --target Angabe des Verzeichnis in dem die exportierten XPlanArchive abgelegt werden sollen (optional). --delete <planid> [<planid>..] <planid> Die ID des Plans der geloescht werden soll (verpflichtend). Mehrere IDs koennen durch ein Leerzeichen getrennt angegeben werden. --createMetadata <planid> [<planid>..] <planid> Die ID des Plans zu dem der Service-Metadatensatz generiert werden soll (optional). Mehrere IDs koennen durch ein Leerzeichen getrennt angegeben werden. Wenn keine ID angegeben ist, werden fuer alle Plaene Metadatensaetze erstellt. Allgemeine Parameter: --v Ausgabe der Systemeigenschaften Allgemeine Hinweise: Das Verzeichnis in dem die Konfigurationsdatei managerConfiguration.properties liegt, muss durch Angabe des Verzeichnis in der Datei etc/application.properties oder durch Setzen der Umgebungsvariablen _XPLANBOX_CONFIG_ erfolgen. Andernfalls wird die Konfiguration aus etc/managerConfiguration.properties verwendet. Der Workspace `xplan-manager-workspace` muss im Verzeichnis _.deegree/_ des Home-Verzeichnis des Nutzers liegen, der das XPlanManagerCLI aufruft. Alternativ kann das Verzeichnis, in dem der Workspace liegt, durch Angabe der Umgebungsvariablen _DEEGREE_WORKSPACE_ROOT_ gesetzt werden.
Auflistung
Der Parameter list
gibt die Liste der Pläne aus, die im XPlanManager importiert sind.
Aufruf:
./XPlanManager --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 Angabe des Parameters 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:
./XPlanManager --import ../Input-Planverzeichnis/Infrastruktur.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. |
./XPlanManager --import --force ../Input-Planverzeichnis/Infrastruktur.zip
-–crs
Fehlt die Angabe des Koordinatenreferenzsystems in den Daten, so kann
dieses mit dem Parameter crs
übergeben werden.
Beispiel Aufruf:
./XPlanManager --import ../Input-Planverzeichnis/Infrastruktur.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:
./XPlanManager --import ~/test-data/BPlan002_5-2.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 unter Angabe des Parameters 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:
./XPlanManager --export 9 --target=outputverzeichnis
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 Parameter delete
die PlanID (diese kann zuvor mit
list
herausgefunden werden) übergeben. Mehrere PlanIDs können durch Leerzeichen getrennt angegeben werden.
Beispiel Aufruf:
./XPlanManager --delete 21
Beispiel Ausgabe:
Delete XPlan 21 - Entferne XPlan 21 aus dem FeatureStore (XPLAN_SYN)... OK - Entferne XPlan 21 aus dem FeatureStore (XPLAN_60)... OK - Workspace reloader configuration is valid. - Attempting to delete XPlanWerkWMS configuration with URL http://xplan-services:8080//xplan-wms/planwerkwmsapi/21 - 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:
./XPlanManager --createMetadata 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.
4.5. XPlanDokumentenAPI
Die REST-API der Komponente XPlanDokumentenAPI 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 XPlanDokumentenAPI bereit. Wenn die optionale Komponente XPlanDokumentenAPI installiert und konfiguriert ist, dann werden alle im XPlanGML referenzierten Begleitdokumente über die URL der XPlanDokumentenAPI bereitgestellt.
Die REST-API der Komponente XPlanDokumentenAPI 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 XPlanDokumentenAPI setzt sich wie folgt zusammen: http://<host>:<port>/xplan-api-dokumente/xdokumente/api/v1/. Die URL für die xPlanBox-Demo lautet https://xplanbox.lat-lon.de/xdokumente/api/v1/. |
5. XPlanTransformCLI
Die Komponente XPlanTransformCLI ist ein Kommandozeilenwerkzeug, welches dem Fachadministrator der xPlanBox ermöglicht, bereits über den XPlanManagerWeb, XPlanManagerAPI oder das XPlanManagerCLI importierte Pläne in eine aktuellere XPlanGML-Version zu transformieren.
Die transformierten Pläne können entweder syntaktisch validiert und das Validierungsergebnis in eine CSV-Datei geschrieben werden oder die transformierten Pläne werden in die entsprechende Datenhaltung eingespielt.
Unterstützt wird derzeit die Transformation von XPlanGML 4.1 nach XPlanGML 5.1 |
5.1. Installation
Für die Nutzung des Tools muss die Installation der Software HALE CLI erfolgreich abgeschlossen sein. Weitere Informationen zur Installation finden Sie im Betriebshandbuch der xPlanBox.
Weiterhin sind zusätzliche SQL-Skripte auszuführen, die sich im Verzeichnis scripts/ befinden. Die Ausführung muss in der festgelegten Reihenfolge erfolgen:
-
01_create_tables.sql
-
02_create_trigger-functions.sql
-
03_create_trigger.sql
-
04_grant_user.sql (zuvor ist die Variable $DB_USER im Skript durch den Namen des Datenbanknutzers auszutauschen, mit dem der XPlanManager und die XPlanDienste auf die XPlaNDB zugreifen, s. Abschnitt "Konfiguration der Datenbank" im Betriebshandbuch)
5.2. Benutzungshinweise
Beim XPlanTransformCLI handelt es sich um ein Kommandozeilenwerkzeug, das parametrisiert aufgerufen wird. Weitere Informationen über die verschiedenen Parameter gibt das Kommandozeilenwerkzeug aus, wenn der Parameter --help
angehängt wird:
./XPlanTransformCLI --help
Beispiel für eine Ausgabe:
Reads all Plans from XPlanWFS 4.1 datastore, transforms them to XPlanGML 5.1 and inserts them in XPlanWFS 5.1 datastore. Usage: XPlanTransformCLI <options> Options: --type one of 'VALIDATE' (default if missing), 'ALL', 'SYNC': * 'VALIDATE': validates all available XPlanGML 4.1 plans and writes the results * 'ALL' transforms all available XPlanGML 4.1 plans and inserts the valid plans in XPlanWFS 5.1 datastore, plans already available in 5.1 will be removed first * 'SYNC' transforms the XPlanGML 4.1 plans logged in the table xplanmgr.transformToolPlanTableLog and inserts the valid plans in XPlanWFS 5.1 datastore --output directory to write the validation results into, directory will be created if it not exists (if missing a new tmp directory is created Allgemeine Hinweise: Das Verzeichnis in dem die Konfigurationsdatei managerConfiguration.properties liegt, muss durch Angabe des Verzeichnis in der Datei etc/application.properties oder durch Setzen der Umgebungsvariablen _XPLANBOX_CONFIG_ erfolgen. Andernfalls wird die Konfiguration aus etc/managerConfiguration.properties verwendet. Der Workspace `xplan-manager-workspace` muss im Verzeichnis _.deegree/_ des Home-Verzeichnis des Nutzers liegen, der das Tool aufruft. Alternativ kann das Verzeichnis, in dem der Workspace liegt, durch Angabe der Umgebungsvariablen _DEEGREE_WORKSPACE_ROOT_ gesetzt werden.
Das XPlanTransformCLI unterscheidet drei Modi:
-
Option VALIDATE zur Transformation und Validierung der transformierten Pläne. Das Ergebnis wird in einer CSV-Datei zusammengefasst und die transformierten Pläne können eingesehen werden. Es erfolgt keine Übertragung der transformierten Pläne in die Datenhaltung.
-
Option ALL zur Transformation aller Pläne und Übertragung in die Datenhaltung. Die Option kann ebenfalls genutzt werden, wenn bereits Pläne über das Werkzeug eingespielt wurden. In diesem Fall werden die bereits eingespielten Pläne zunächst aus der Ziel-Datenhaltung entfernt.
-
Option SYNC um die Synchronisation der seit der letzten Ausführung des Werkzeuges geänderten Pläne zu transformieren und in die Ziel-Datenhaltung des XPlanWFS einzuspielen.
Durch die Ausführung von ALL oder SYNC werden die transformierten Pläne, wenn sie syntaktisch valide sind, in die Ziel-Datenhaltung des XPlanWFS eingespielt. Es erfolgt keinerlei Anpassung an anderen Datenhaltungen (z. B. XPlanSyn-Datenhaltung). Die transformierten Pläne sind weiterhin in der alten Version über den XPlanWFS für XPlanGML 4.1 anfragbar und zusätzlich in der neuen Version über den XPlanWFS für 5.1. Syntaktisch invalide Pläne werden nicht eingespielt.
Beispiel für das initiale Einspielen der in XPlanGML 4.1 vorliegenden Pläne in die XPlan 5.1 Datenhaltung des XPlanWFS:
./XPlanTransformCLI --type ALL
Empfohlen ist zunächst einmalig die Ausführung der Option ALL und anschließend regelmäßig (z. B. nachts mit Hilfe eines Cron-Jobs) die Option SYNC um einen tagesaktuellen Stand der über den XPlanWFS 5.1 anfragbaren Pläne zu erreichen.
6. XPlanWMS, XPlanArtWMS und XPlanWerkWMS
Der XPlanWMS, XPlanArtWMS und XPlanWerkWMS 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 bieten die Möglichkeit Visualisierungen von Plandaten sowie Sachinformationsabfragen zu einzelnen Planinhalten abzufragen.
Während der XPlanWMS die Inhalte planübergreifend dargestellt, visualisiert der XPlanWerkWMS genau ein einzelnes Planwerk. Der XPlanWMS stellt genau einen Endpunkt mit allen Planwerken bereit, der XPlanWerkWMS je einen Endpunkt pro importiertem Plan. Der XPlanArtWMS stellt je einen Endpunkt für jede Planart wie z. B. BPlan oder FPlan zur Verfügung.
6.1. Benutzung des XPlanWMS und XPlanWerkWMS
Mit dem XPlanWMS und XPlanWerkWMS ist ein Benutzer in der Lage, WMS-Ebenen (Layer) mit einem Browser oder einem GIS anzufragen. Die folgende Tabelle gibt einen Überblick über die zur Verfügung stehenden Operationen des WMS, 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 |
6.1.1. Adresse des XPlanWMS
http://<host>:<port>/xplan-wms/services/wms?
6.1.2. Adresse des XPlanWerkWMS
Die Adresse des XPlanWerkWMS ist abhängig von dem Planwerk das angefragt werden soll. Der Name des Plans wird im XPlanManager (s. XPlanManagerWeb) in der Auflistung der Pläne angezeigt und in der URL für den Platzhalter <PLANNAME> angegeben. Der Planname wird aus dem XPlanGML-Element xplan:name
abgeleitet. Dabei werden Sonderzeichen wie /
entfernt und der Planname für die Erstellung der URL des XPlanWerkWMS kodiert (weitere Informationen zu URL Syntax und Zeichenkodierung in RFC 3986 – Uniform Resource Identifier (URI)).
Die vollständige XPlanWerkWMS URL kann über die Kartenvorschau im XPlanManagerWeb abgerufen werden.
Vermeiden Sie Sonderzeichen im Plannamen wie z. B. : , & , # , / , \ , ? , @ , ' , " oder Zeilenumbrüche.
|
http://<host>:<port>/xplan-wms/services/planwerkwms/planname/<PLANNAME>
Alternativ kann die URL auch ohne Sonderzeichen verwendet werden. Dafür müssen alle anderen Zeichen als a-zA-Z0-9-_ aus <PLANNAME> entfernt werden. Die so erstellte URL liefert eine identische Response wie die dazugehörige, kodierte URL.
|
6.1.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-wms/services/<PLANART>wms<PLANSTATUS>?
Die folgende Tabelle liested die Endpunkte des XPlanArtWMS auf:
XPlanArtWMS | Planart | Planstatus | URL |
---|---|---|---|
XPlanArtWMSBPlan |
BPlan |
Festgestellt |
|
XPlanArtWMSBPlanPre |
BPlan |
In Aufstellung |
|
XPlanArtWMSBPlanArchive |
BPlan |
Archiviert |
|
XPlanArtWMSFPlan |
FPlan |
Festgestellt |
|
XPlanArtWMSFPlanPre |
FPlan |
In Aufstellung |
|
XPlanArtWMSFPlanArchive |
FPlan |
Archiviert |
|
XPlanArtWMSLPlan |
LPlan |
Festgestellt |
|
XPlanArtWMSLPlanPre |
LPlan |
In Aufstellung |
|
XPlanArtWMSLPlanArchive |
LPlan |
Archiviert |
|
XPlanArtWMSRPlan |
RPlan |
Festgestellt |
|
XPlanArtWMSRPlanPre |
RPlan |
In Aufstellung |
|
XPlanArtWMSRPlanArchive |
RPlan |
Archiviert |
|
XPlanArtWMSSOPlan |
SOPlan |
Festgestellt |
|
XPlanArtWMSSOPlanPre |
SOPlan |
In Aufstellung |
|
XPlanArtWMSSOPlanArchive |
SOPlan |
Archiviert |
6.2. Inhalte des Kartendienstes
Der XPlanWMS dient der Darstellung aller importierten XPlanArchive, während der XPlanWerkWMS einzelne Planwerke visualisiert. Die Datenquelle beider Dienste basiert auf den über den XPlanManager importierten XPlanArchiven. Für jede Objektart aus den unterstützten XPlanGML-Applikationsschema, das Geometrie-Attribute enthält, existiert eine entsprechende Ebene im XPlanWMS und XPlanWerkWMS. Zusätzlich zu den aus dem XPlanGML abgeleiteten Ebenen stellen beide Dienste Ebenen zur Darstellung von gescannten Rasterplan-Dateien bereit.
6.3. Operationen
Das folgende Kapitel beschreibt die Operationen, die mit dem XPlanWMS und XPlanWerkWMS durchführbar sind.
6.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-wms/services/wms?request=GetCapabilities&service=WMS&version=1.1.1 http://<host>:<port>/xplan-wms/services/wms?request=GetCapabilities&service=WMS&version=1.3.0
XPlanWerkWMS
http://<host>:<port>/xplan-wms/services/planwerkwms/planname/<PLANNAME>?request=GetCapabilities&service=WMS&version=1.1.1 http://<host>:<port>/xplan-wms/services/planwerkwms/planname/<PLANNAME>?request=GetCapabilities&service=WMS&version=1.3.0
XPlanArtWMS
http://<host>:<port>/xplan-wms/services/<PLANART>wms<PLANSTATUS>?request=GetCapabilities&service=WMS&version=1.1.1 http://<host>:<port>/xplan-wms/services/<PLANART>wms<PLANSTATUS>?request=GetCapabilities&service=WMS&version=1.3.0
6.3.2. GetMap
Die Operation GetMap stellt die Kernfunktionalität des XPlanWMS dar. Die Operation ermöglicht es, die angebotenen Ebene 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-wms/services/wms?request=GetMap&Service=WMS&Version=1.1.1&Layers=bp_plan&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-wms/services/wms?request=GetMap&Service=WMS&Version=1.3.0&Layers=bp_plan&Format=image/png&Transparent=true&Styles=&Crs=EPSG%3A25833&Bbox=377814.52931834,5697447.998419,381059.6791237,5698548.3070248&Width=1280&Height=434
XPlanWerkWMS
http://<host>:<port>/xplan-wms/services/planwerkwms/planname/<PLANNAME>?request=GetMap&Service=WMS&Version=1.1.1&Layers=bp_plan&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-wms/services/planwerkwms/planname/<PLANNAME>?request=GetMap&Service=WMS&Version=1.3.0&Layers=bp_plan&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. Im XPlanWMS ist als Default-Style die vollflächige Darstellung eingestellt, im XPlanWMSInAufstellung und im XPlanWMSArchiviert hingegen die transparente. Wenn der transparente Style ausgewählt wird, sind lediglich die Planumringe sichtbar.
Endpoint | Planstatus | Default-Style | Dargestellte Planzeichen | GFI |
---|---|---|---|---|
XPlanWMSInAufstellung |
In Aufstellung |
|
nur Planumring |
GFI |
XPlanWMSFestgestellt |
Festgestellt |
|
alle Planzeichen |
GFI |
XPlanWMSArchiviert |
Archiviert |
|
nur Planumring |
GFI |
Gültigkeitszeitraum
Der Gültigkeitszeitraum bestimmt die Sichtbarkeit der Inhalte eines Plans bei Aufruf des XPlanWMSInAufstellung über die GetMap-Operation. Der Gültigkeitszeitraum eines Plans kann beim Import über den XPlanManagerWeb als Zeitspanne angegeben werden. Wird der XPlanWMSInAufstellung innerhalb des gewählten Zeitraums angefragt, so werden die Plandaten, sowohl Vektor- als auch Rasterdaten, angezeigt. Liegt der Zeitpunkt der GetMap-Anfrage an den XPlanWMSInAufstellung ausserhalb des Zeitraums, so werden keine Plandaten angezeigt.
Ausnahme: Die Sichtbarkeit der Layer, die den Geltungsbereich darstellen, werden nicht über den Gültigkeitszeitraum verändert und werden immer angezeigt. |
6.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-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-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-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-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
6.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-wms/services/wms?request=GetLegendGraphic&Service=WMS&Version=1.1.1&layer=bp_gruenfl&format=image/png http://<host>:<port>/xplan-wms/services/wms?request=GetLegendGraphic&Service=WMS&Version=1.3.0&layer=bp_gruenfl&format=image/png
XPlanWerkWMS
http://<host>:<port>/xplan-wms/services/planwerkwms/planname/<PLANNAME>?request=GetLegendGraphic&Service=WMS&Version=1.1.1&layer=bp_gruenfl&format=image/png http://<host>:<port>/xplan-wms/services/planwerkwms/planname/<PLANNAME>?request=GetLegendGraphic&Service=WMS&Version=1.3.0&layer=bp_gruenfl&format=image/png
6.3.5. GetAttachment
Die beiden WMS-Dienste der xPlanBox unterstützen zusätzlich die Operation GetAttachment. Diese spezielle Erweiterung der 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-wms/getAttachment?featureID=XPLAN_XP_RASTERPLANBASIS_7b36b0ee-5139-4a55-afc0-01fec18e9f0a&filename=Stellingen64.png
6.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
Für Rasterdaten wird dagegen nur eines dieser Koordinatenreferenzsysteme unterstützt. Der Vorgabewert ist EPSG:25832 und kann über die Konfiguration der xPlanBox geändert werden. Die Konfiguration ist im Betriebshandbuch der xPlanBox beschrieben. Weitere Informationen zu den Anforderungen an die Rasterdaten stehen im Kapitel Voraussetzungen für die Rasterdaten.
7. 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).
7.1. 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 |
7.1.1. Adresse des Dienstes
http://<host>:<port>/xplan-wfs/services/wfs40? http://<host>:<port>/xplan-wfs/services/wfs41? http://<host>:<port>/xplan-wfs/services/wfs50? http://<host>:<port>/xplan-wfs/services/wfs51? http://<host>:<port>/xplan-wfs/services/wfs52? http://<host>:<port>/xplan-wfs/services/wfs53? http://<host>:<port>/xplan-wfs/services/wfs54? http://<host>:<port>/xplan-wfs/services/wfs60?
7.2. Inhalte des Datendienstes
7.3. Operationen
Das folgende Kapitel beschreibt die Operationen, die mit dem XPlanWFS 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 zu den durch den WFS angebotenen WFS Objektarten.
http://<host>:<port>/xplan-wfs/services/wfs40?request=GetCapabilities&Service=WFS http://<host>:<port>/xplan-wfs/services/wfs41?request=GetCapabilities&Service=WFS http://<host>:<port>/xplan-wfs/services/wfs50?request=GetCapabilities&Service=WFS http://<host>:<port>/xplan-wfs/services/wfs51?request=GetCapabilities&Service=WFS http://<host>:<port>/xplan-wfs/services/wfs52?request=GetCapabilities&Service=WFS http://<host>:<port>/xplan-wfs/services/wfs53?request=GetCapabilities&Service=WFS http://<host>:<port>/xplan-wfs/services/wfs54?request=GetCapabilities&Service=WFS http://<host>:<port>/xplan-wfs/services/wfs60?request=GetCapabilities&Service=WFS
7.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-wfs/services/wfs40?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich http://<host>:<port>/xplan-wfs/services/wfs41?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich http://<host>:<port>/xplan-wfs/services/wfs50?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich http://<host>:<port>/xplan-wfs/services/wfs51?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich http://<host>:<port>/xplan-wfs/services/wfs52?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich http://<host>:<port>/xplan-wfs/services/wfs53?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich http://<host>:<port>/xplan-wfs/services/wfs54?request=GetFeature&Service=WFS&Version=2.0.0&typename=xplan:BP_Bereich http://<host>:<port>/xplan-wfs/services/wfs60?request=GetFeature&Service=WFS&Version=2.0.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-wfs/services/wfs40?request=DescribeFeatureType&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-wfs/services/wfs41?request=DescribeFeatureType&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-wfs/services/wfs50?request=DescribeFeatureType&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-wfs/services/wfs51?request=DescribeFeatureType&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-wfs/services/wfs52?request=DescribeFeatureType&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-wfs/services/wfs53?request=DescribeFeatureType&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-wfs/services/wfs54?request=DescribeFeatureType&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-wfs/services/wfs60?request=DescribeFeatureType&Service=WFS&Version=2.0.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 über die Endpunkte wfs40, wfs41, wfs50, wfs51, wfs52, wfs53 und wfs54 zur Verfügung.
http://<host>:<port>/xplan-wfs/services/wfs40?request=ListStoredQueries&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-wfs/services/wfs41?request=ListStoredQueries&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-wfs/services/wfs50?request=ListStoredQueries&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-wfs/services/wfs51?request=ListStoredQueries&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-wfs/services/wfs52?request=ListStoredQueries&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-wfs/services/wfs53?request=ListStoredQueries&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-wfs/services/wfs54?request=ListStoredQueries&Service=WFS&Version=2.0.0 http://<host>:<port>/xplan-wfs/services/wfs60?request=ListStoredQueries&Service=WFS&Version=2.0.0
7.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-wfs/services/wfs54?request=GetFeature&service=WFS&version=2.0.0&resolvedepth=*&StoredQuery_ID=urn:ogc:def:query:OGC-WFS::PlanName&planName=Musterdorf
7.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
8. 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).
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.
8.1. 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 |
8.1.1. Adresse des Dienstes
http://<host>:<port>/xplansyn-wfs/services/xplansynwfs?
8.2. Inhalte des Datendienstes
8.3. Operationen
Das folgende Kapitel beschreibt die Operationen, die mit dem XPlanSynWFS durchführbar sind.
8.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>/xplansyn-wfs/services/xplansynwfs?request=GetCapabilities&Service=WFS&Version=1.1.0
8.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>/xplansyn-wfs/services/xplansynwfs?request=GetFeature&Service=WFS&Version=1.1.0&typename=xplan:BP_Bereich
8.3.3. DescribeFeatureType
Die Operation DescribeFeatureType gibt Informationen zur Struktur der einzelnen Feature Types wieder.
http://<host>:<port>/xplansyn-wfs/services/xplansynwfs?request=DescribeFeatureType&Service=WFS&Version=1.1.0
8.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>/xplansyn-wfs/services/xplansynwfs?request=ListStoredQueries&Service=WFS&Version=2.0.0
8.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>/xplansyn-wfs/services/xplansynwfs?request=GetFeature&service=WFS&version=2.0.0&StoredQuery_ID=urn:ogc:def:query:OGC-WFS::PlanName&planName=Musterdorf
8.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
9. 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.
9.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 |
9.1.1. Adresse des Dienstes
http://<host>:<port>/xplan-inspireplu/services/viewservice?
9.1.2. Beispielanfragen
GetCapabilities
http://<host>:<port>/xplan-inspireplu/services/viewservice?request=GetCapabilities&service=WMS&version=1.3.0
GetMap
http://<host>:<port>//xplan-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
9.2. Operationen
Das folgende Kapitel beschreibt die Operationen, die mit dem XPlanInspirePluWMS durchführbar sind.
9.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.
9.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.
10. XPlanInspirePluWFS
Der XPlanInspirePluWFS ist ein INSPIRE Download Service zur Abfrage von Vektordaten im Datenformat des INSPIRE Datenthema Planned Land Use (PLU).
10.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 |
10.1.1. Adresse des Dienstes
http://<host>:<port>/xplan-inspireplu/services/downloadservice?
10.1.2. Beispielanfragen
GetCapabilities
http://<host>:<port>/xplan-inspireplu/services/downloadservice?request=GetCapabilities&Service=WFS&Version=2.0.0
GetFeature
http://<host>:<port>/xplan-inspireplu/services/downloadservice?request=GetFeature&Service=WFS&Version=2.0.0&typename=plu:SpatialPlan
DescribeFeatureType
http://<host>:<port>/xplan-inspireplu/services/downloadservice?request=DescribeFeatureType&Service=WFS&Version=2.0.0
10.2. Operationen
Das folgende Kapitel beschreibt die Operationen, die mit dem XPlanInspirePluWFS durchführbar sind.
10.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.
10.2.2. GetFeature
Die Operation GetFeature stellt die Kernfunktionalität des XPlanInspirePluWFS dar. Die Operation ermöglicht es, die angebotenen Vektordaten anzufragen.
10.2.3. DescribeFeatureType
Die Operation DescribeFeatureType gibt Informationen zur Struktur der einzelnen Feature Types wieder.
10.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.
11. Bekannte Probleme
11.1. Unterstützung von Internet Explorer
Die Unterstützung von Microsoft Internet Explorer 9/10/11 ist mit Version 4.2 der xPlanBox abgekündigt worden. Bitte nutzen Sie einen anderen Browser wie z. B. Microsoft Edge, Firefox oder Google Chrome. |
11.2. XPlanValidator - Darstellung von geometrischen Fehlern in einer Shape-Datei
Es werden derzeit nur einfache Geometrien (Punkte, Linien und Polygone) im Validierungsbericht des XPlanValidator ausgegeben, Multigeometrien werden nicht dargestellt. In die Shape-Datei können nur Geometrien geschrieben werden, wenn diese auch gerendert werden können.
11.3. 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.4. XPlanWMS - Mit Kartenvorschau im XPlanManagerWeb generierter GetMap-Request
Der durch den Button "Plan im neuen Fenster öffnen" unterhalb der Kartenvorschau im XPlanManagerWeb generierte WMS GetMap-Request gibt im Fall, dass noch kein Rasterplan in das System importiert wurde, folgende erwartete Meldung aus:
Style default is not defined for layer *P_Planraster
Dieses Verhalten resultiert daraus, dass der Raster-Layer wegen fehlender Rasterpläne noch nicht von dem WMS angeboten wird.
Wenn die URL dennoch genutzt werden soll, muss der Layer [*]P_Planraster manuell aus der Request URL entfernt werden (Wert des Parameters "LAYERS").
Dies gilt für jede einzelne Planart: Für die URL für BPläne muss z. B. mindestens ein BPlan mit Rasterdaten vorliegen, für FPläne mindestens ein FPlan mit Rasterdaten.
11.5. XPlanWMS - Darstellung von Plänen mit Gültigkeitszeitraum
Wenn beim Import eines Plans über den XPlanManager ein Gültigkeitszeitraum angegeben wird, werden derzeit keine Vektordaten bei GetMap-Anfragen an den XPlanWMS angezeigt. Dies gilt für alle XPlanWMS unabhängig vom Planststatus.
11.6. 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.7. 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.8. XPlanManagerWeb - Löschen von einzelnen Plänen aus dem InspirePLU Diensten
Aktuell kann über den XPlanManager ein XPlanArchiv nur aus der XPlanDB-Datenhaltung entfernt werden. Wird ein Plan von XPlanGML nach INSPIRE PLU transformiert und in die InspirePLUDB-Datenhaltung übertragen, kann der transformierte Datensatz nicht über den XPlanManager aus der InspirePLUDB-Datenhaltung entfernt werden.
Eine Umgehung ist das Löschen des Datensatzes aus der InspirePLUDB-Datenhaltung direkt in der Datenbank oder über die WFS-T Schnittstelle des InspirePLUWFS. Zum Löschen eines oder mehrerer Datensätze muss an den InspirePLUWFS eine WFS-T 2.0.0 DELETE Aktion geschickt werden.
11.9. 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.10. 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 wiederholten Aufruf der Editorfunktion zeigt das System dann den Fehler "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.11. XPlanManagerWeb und XPlanManagerAPI - Sortierung der Rasterdaten wird nach Änderungen nicht aktualisiert
Wird über den XPlanManager ein für die Sortierung der Pläne in der Darstellung im XPlanWMS verwendete Datumsfeld angepasst, erfolgt derzeit keine automatische Aktualisierung der Konfiguration des XPlanWMS. Für eine Aktualisierung der Konfiguration des XPlanWMS steht ein Kommandozeilenwerkzeug für den Administrator zur Verfügung, weitere Hinweise zur Verwendung finden sich im Betriebshandbuch.
11.12. 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.13. 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.14. 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:
-
BP_Plan
-
bp_xp_fpo
-
bp_xp_lpo
-
bp_xp_lto
-
bp_xp_ppo
-
bp_xp_pto
-
-
FP_Plan
-
fp_xp_fpo
-
fp_xp_lpo
-
fp_xp_lto
-
fp_xp_ppo
-
fp_xp_pto
-
-
LP_Plan
-
lp_xp_fpo
-
lp_xp_lpo
-
lp_xp_lto
-
lp_xp_ppo
-
lp_xp_pto
-
-
RP_Plan
-
rp_xp_fpo
-
rp_xp_lpo
-
rp_xp_lto
-
rp_xp_ppo
-
rp_xp_pto
-
-
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. Fehler melden
Für den Fall, dass Sie einen Fehler in der xPlanBox finden, erstellen Sie bitte einen Fehlerbericht unter Open CoDE GitLab Issues.
13. Support
Für professionellen Support per Telefon oder E-Mail kontaktieren Sie bitte die lat/lon GmbH.
14. Ausblick
14.1. Empfehlungen für die Bereitstellung von XPlanungsdaten
Die Leitstelle XPlanung/XBau hat einen Leitfaden XPlanung herausgegeben, der 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. Der Leitfaden bietet Unterstützung in der effektiven Umsetzung von XPlanung und der standardkonformen Erstellung und Bereitstellung von XPlanungsdaten von hoher Qualität.
14.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 einen standardkonformen 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 7.0.1
A.1.1. Erweiterungen
-
Aktualisierung der Validierungsregeln auf v1.1.5
-
Das Validierungsprofil Berlin ist in den Komponenten XPlanValidator und XPlanManager enthalten und kann aktiviert werden
-
Einführung der Datei xqueryregeln.txt für Validierungsregeln und Profile
-
Verbesserung der Konfigurierbarkeit des MapServer-Container-Images
-
OCI-Labels für alle Container-Images hinzugefügt
A.1.2. Fehlerbehebungen
-
Fehler bei der Ausführung des XPlanValidator unter Windows behoben
-
Fehler bei der Ausführung in Container-Images auf Basis von Bitnami/Tomcat behoben
-
Fehler im Editiermodus des XPlanManagerWeb für XPlanGML 6.0 behoben
-
Korrekturen in den Zeichenvorschriften für den XPlanWMS vorgenommen
-
Fehlermeldung im XPlanValidator bei der Validierung von XPlanArchiven (ZIP-Datei) verbessert
-
Fehler im XPlanManagerCLI, XPlanTransformCLI und XPlanUpdateDataCLI bei der Ermittlung des Konfigurationsverzeichnisses etc/ bei der Auswertung der Konfigurationsdatei managerConfiguration.properties behoben
-
Korrekturen im Betriebshandbuch für die Kommandozeilenprogramme (CLI) vorgenommen
A.2. Version 7.0
Neben der Aktualisierung auf die aktuelle deegree webservices Version 3.5.0 sind einige Erweiterungen und Verbesserungen an den Komponenten der xPlanBox vorgenommen worden. Ab Version 7.0 der xPlanBox kann der XPlanWMS als MapServer-Instanz konfiguriert und ein AWS S3-kompatibler Objektspeicher genutzt werden. Mit der Version 7.0 wurde die Ausgabe von Log-Meldungen in separate Log-Dateien je xPlanBox-Komponente aus den mitgelieferten Logging-Konfiguration entfernt. Bitte beachten Sie dazu die Hinweise im Betriebshandbuch, Kapitel Logging.
A.2.1. Erweiterungen
-
Unterstützung für MapServer 8.0 zur Bereitstellung von Rasterdaten für XPlanWMS hergestellt
-
Ablage von Rasterdaten in einem AWS S3-kompatiblen Objektspeicher wird unterstützt
-
Ablage von Begleitdokumenten in einem AWS S3-kompatiblen Objektspeicher wird unterstützt
-
Abruf von Dokumenten und Rasterdaten über die neue Schnittstelle XPlanDokumentenAPI hergestellt
-
Verbesserter Abruf von Dokumenten und Rasterdaten in der GetFeatureInfo-Abfrage des XPlanWMS und GetFeature-Abfrage des XPlanSynWFS und XPlanWFS
-
Verbesserung der Geltungsbereichsprüfung im XPlanValidator
-
Prüfung der externen Referenzen bei Validierung eines Plans und Ausgabe des Ergebnisses im Validierungsbericht
-
Der Import von XPlanGML-Dateien über den XPlanManagerWeb und XPlanManagerAPI wird unterstützt; eine ZIP-Datei ist nicht mehr erforderlich
-
Der XPlanValidator kann Daten für den XPlanValidatorWMS temporär in der XPlanDB speichern
-
Konfiguration der XPlanDB mit der Angabe des
srid
für alle Geometriespalten hinzugefügt -
Unterstützung einer neuer StoredQuery mit Filter auf planName und eingegrenzten FeatureType im XPlanSynWFS
-
Unterstützung der StoredQuery mit Filter auf planName im XPlanSynWFS für alle Datenhaltungen
-
Absicherung der deegree REST-API über ApiKeys
-
Unterstützung des vereinfachten Downloads eines XPlanArchiv über die XPlanManagerAPI
-
Erweiterung der Sortierung von Textabschnitten
-
Entfernen des XML-Namespace Präfixes aus dem FeatureType-Namen in den Capabilities des XPlanWFS
-
Verbesserung der Transaktionalität bei Auftreten unerwarteter Fehler beim Import im XPlanManager
-
Neuer Vorgabewert für Verzeichnisse mit Konfigurationsdateien der xPlanBox
A.2.2. Sicherheitsupdates
-
Schwachstelle im XML-Prozessor von XPlanValidator und XPlanManager behoben, sodass nur lokale statische DTD verwendet werden können; jede externe und jede deklarierte DTD wird nicht mehr zugelassen
-
Schwachstelle im XPlanValidator und XPlanManager gegen persistentes Cross-Site-Scripting (XSS) behoben
-
Schwachstelle im XPlanValidator und XPlanManager beim Upload schadhafter Dateien behoben
-
Aktualisierung von Bibliotheken mit bekannten Sicherheitsmängeln
A.2.3. Fehlerbehebungen
-
Fehler in XPlanManagerAPI bei Aufruf von HTTP DELETE für einen Plan behoben
-
Fehler in XPlanValidatorAPI bei der Validierung syntaktisch invalider Pläne behoben
-
Fehler in XPlanWMS bei Aufruf mit GetMap-Anfrage mit WMS 1.1.1 und EPSG:4326 behoben
-
Fehler in XPlanWFS bei Aufruf mit GetFeature-Anfrage mit WFS 1.1.0 behoben
-
Fehler im Encoding der Attributtabelle von Shapefiles aus dem Validierungsreport des XPlanValidators behoben
-
Fehler im XPlanWMS bei Aufruf mit GetMap-Anfrage mit WMS 1.1.1 und EPSG:4326 behoben
-
Fehlende Ausgabe der detaillierten Zweckbestimmung in komplexen Attributen im XPlanSynWFS ergänzt
A.2.4. Veraltete Funktionen
Die folgenden Funktionen sind veraltet und werden in einer zukünftigen Version der xPlanBox entfernt: - LDAP-Schnittstelle ist veraltet (deprecated) - Schnittstelle zur Verfahrensdatenbank ist veraltet (deprecated) - Filterkategorien im XPlanManagerWeb sind veraltet (deprecated)
A.3. Version 6.0.3
A.3.1. Fehlerbehebungen
-
Aktualisierung der Validierungsregeln auf v1.1.4 mit Korrektur der Regel 5.3.1.2 für Flächennutzungspläne in der Version XPlanGML 5.1
-
Externe Codes werden beim Import über den XPlanManagerWeb nicht übersetzt
A.4. Version 6.0.2
A.4.1. Fehlerbehebungen
-
Aktualisierung der Validierungsregeln auf v1.1.3 mit Korrekturen der Regeln 4.5.1.3 und 5.3.1.2
-
Fehlerkorrektur in der Geltungsbereichsprüfung
A.5. Version 6.0.1
A.5.1. Erweiterungen
-
Aktualisierung der XPlanGML-Schemadateien auf Version 6.0.2
A.5.2. Fehlerbehebungen
-
Aktualisierung der Validierungsregeln auf v1.1.2 für die XPlanGML-Version 6.0.2
-
Korrektur der Reihenfolge der Textabschnitte im XPlanSynWMS und GFI des XPlanWMS, wenn kein Schlüssel angegeben ist
-
Wiederherstellung der Bearbeitungsmöglichkeit des Gültigkeitszeitraums im Editiermodus des XPlanManagerWeb
-
Verbesserung der geometrischen Validierung bzgl. inkorrekten Meldungen von Selbstüberschneidungen
-
Hinzufügen fehlender Layer im XPlanWMS und FeatureTypes im XPlanSynWFS
-
Warnung XPlanWMS "Error while trying to repair an expression" im Log behoben
-
Fehlerkorrektur bei der parallelen Ausführung von Validierungen
A.6. Version 6.0
Mit der Version 6.0 der xPlanBox wird die Version XPlanGML 6.0 unterstützt. Neben der Aktualisierung auf deegree webservices Version 3.5 sind einige Erweiterungen und Verbesserungen an den Komponenten der xPlanBox vorgenommen worden. Ab Version 6.0 der xPlanBox ist mindestens PostgreSQL Version 12 mit der PostGIS-Erweiterung 3.1 erforderlich.
A.6.1. Erweiterungen
-
Unterstützung für XPlanGML 6.0 in allen Komponenten der xPlanBox
-
Unterstützung von Profilen mit zusätzlichen Validierungsregeln für den XPlanValidator
-
Neuer Dienst XPlanArtWMS eingeführt, für jede spezifische Planklasse ein eigener WMS
-
Verfahren kann nicht mehr über die Editierfunktion im XPlanManagerWeb für XPlanGML 6.0 geändert werden
-
Im XPlanManagerWeb können über die Editierfunktion nun auch Flächennutzungspläne, Regionalpläne, Landschaftspläne und Sonstigen Pläne geändert werden
-
Versionierung des Datenbankschemas mit Liquibase
-
Aktualisierung der XPlanGML-Schemadateien auf Version 6.0.1
-
Aktualisierung der Validierungsregeln auf v1.0 für XPlanGML Version 6.0.1
-
Datei VERSION.txt durch version.properties für Standard-Validierungsregeln ersetzt
-
Validierung eines XPlanGML mit
xsi:type
ermöglicht -
Verbesserungen am XPlanSyn-Schema
-
Langfassung für Übersetzung von Enumerationswerten im XPlanSynWFS und XPlanWMS
-
Vereinheitlichen der Layernamen im XPlanWMS und XPlanWerkWMS
-
Verbesserungen der Zeichenvorschriften für Layer aus dem Modellbereichen BP und FP im XPlanWMS
-
Verbesserungen der Behandlung von Präsentationsobjekten mit einer Auswahl an Zeichenvorschriften
-
Verbesserung der Fehlermeldung beim Import eines XPlanArchiv mit mehreren Instanzdokumenten mit uneindeutigen Bereichs-Nummern
-
Verbesserung der Fehlermeldung beim Import eines XPlanArchiv mit mehreren Instanzdokumenten und Referenzierung über verbundenerPlan@xlink:href
-
Verbessern der Fehlermeldung beim Editieren eines Plans ohne Bereich
-
Unterstützung von XPlanGML 3.0 aus allen Komponenten entfernt
-
Konfigurationsparameter
defaultBboxIn4326
entfernt -
Hinzufügen der Tabelle planslog in der XPlanDB
-
Aktualisierung auf deegree 3.5
-
Aktualisierung auf JTS 1.19.0
A.6.2. Fehlerbehebungen
-
Fehler bei der Veröffentlichung von Bebauungsplänen als INSPIRE PLU behoben
-
Fehler beim Editieren der Rasterbasis (XPlanGML 4.1) behoben
-
Fehler in der XPlanWFS ListStoredQueries Antwort behoben
-
Fehler beim wiederholten Import eines Plans mit mehreren Instanzen behoben
-
Fehlerbehandlung für Anfrage von nicht vorhandenen Ressource über XPlanManagerAPI verbessert
-
Fehlende Zeichenvorschriften ergänzt
-
Fehler in der Flächenschlussprüfung für Änderungspläne und bei vollständiger Überlappung behoben
Die vollständige Änderungshistorie ist auf der OpenCoDE-Plattform zu finden.