Verfahren hinzufügen (XPlanverfahren)

> Zurück zur Hauptseite DiPlan Cockpit Basis für Mandanten-Administratoren (M-A)

Diese Funktion ermöglicht einen Import von Verfahren im XML-Format und nach dem XöV Standard XPlanverfahren. Der Import kann ein einzelnes Verfahren oder auch mehrere umfassen und je nach Größe des Imports längere Zeit in Anspruch nehmen. Während dieser Zeit arbeitet das System unter Volllast und ist unter Umständen eingeschränkt verfügbar. Aus technischen Gründen ist die Anzahl der simultan importierbaren Verfahren in einem XPlanverfahren Importdokument limitiert. Das Importdokument wird XöV schemavalidiert. Zusätzlich führt das Cockpit weitere Validierungen durch, beispielsweise müssen der Verfahrensstand und die Angaben für das Beschluss- und Bekanntmachungsdatum zusammenpassen.

Im Fehlerfall wird der Prozess abgebrochen und das gesamte Importdokument abgewiesen.

ACHTUNG! 
Das Schema XPlanverfahren für die Validierung wird kontinuierlich weiterentwickelt. Für die Aufbereitung von Importdateien muss IMMER die aktuelle Version genutzt werden. Ein Klick auf den Button "XPlanverfahren Schema [V.1.4] herunterladen" lädt das im Cockpit hinterlegte Schema herunter. Eine Aufbereitung der Import-Dateien sollte möglichst kurz vor dem Import ins DiPlanCockpit erfolgen. Liegen mehrere Wochen oder Monate dazwischen, kann es sein, dass das Schema bereits in neuer Version vorliegt und die Dateien nicht mehr valide sind. 
Es ist zudem sinnvoll, mit einer kleinen Anzahl an XPlanverfahren zu starten und den Import zu testen. Wenn das erfolgreich ist, kann der Massen-Import starten.

Es wird empfohlen einen Import nur in Randzeiten anzustoßen.

Die maximale Anzahl der simultan importierbaren Verfahren wird über den Wert des Systemparameters XPLANVERFAHREN_IMPORT_VERFAHRENSANZAHL gesteuert. Es wird empfohlen den Defaultwert nicht zu überschreiten, um die Systemstabilität nicht zu gefährden (Default: 500 Verfahren). 

Der Import von Verfahren zur Raumordnung / Raumordnungsplan-Verfahren ins DiPlanCockpit ist nicht vorgesehen. Stattdessen sind die (wenigen) Bestandsdaten manuell im DiPlanCockpit anzulegen.

Verfahren importieren

Um ein oder mehrere Planverfahren zu importieren benötigen Sie ein lokal abgelegtes valides XPlanverfahren Importdokument. In einem Importdokument können mehrere Verfahren definiert sein. Laden Sie das XML über die entsprechende Schaltfläche hoch, um den Importprozess starten.

• Klicken Sie auf das Lupen-Symbol, um das lokale XPlanverfahren Importdokument auszuwählen. Die Dateiendung muss dem XML-Format entsprechen.
• Nach Bestätigung wird der Dateiname zur Bestätigung angezeigt.
• Starten Sie den Importprozess durch Klick auf Hochladen

Prüfung der Eingabedaten

Der Importprozess startet mit einer Überprüfung der Eingabedaten. Neben einer allgemeinen XML-Schemaprüfung werden im Importdokument referenzierte Codelistenwerte gegen aktuell in der Anwendung hinterlegte Codelisten abgeglichen. Zusätzlich werden Plannamen auf Eindeutigkeit und die Existenz von Pflichtattributen geprüft.

Der Import bricht im Fehlerfall umgehend mit einer Fehlermeldung ab. Die Fehlermeldung beschreibt die Ursache des Abbruchs. Da die Herangehensweise zur Fehlerbehebung situationsabhängig und uneindeutig ist, verzichtet die Anwendung auf konkrete Handlungsanweisungen. Um Wartezeiten zu minimieren werden Fehlermeldungen jeweils einzeln ausgegeben und nicht gesammelt.

Im Fehlerfall bricht die Anwendung den Import direkt und vollständig ab, sodass keine Inhalte - auch keine Teilmengen - übernommen werden. 

Definition XPlanverfahren

XPlanverfahren ist im XRepository unter folgender URL veröffentlicht: https://www.xrepository.de/details/urn:xoev-de:xleitstelle:standard:xplanverfahren. Hier finden Sie ebenso eine XSD zur XML-Schemavalidierung wie auch die Spezifikation mit allen Inhalten als PDF Datei. Bitte beachten Sie, dass XPlanverfahren einer Versionierung unterliegt und sich Inhalte zwischen Versionen semantisch und syntaktisch ändern bzw. neue Inhalte hinzugefügt oder auch alte Inhalte entfernt werden können.

In XPlanverfahren werden obligatorische und optionale Inhalte gelistet. Nur eine kleine Teilmenge der XPlanverfahren-Inhalte sind obligatorisch. Bitte achten Sie jeweils auf die Angabe zur Kardinalität.

Besonderheiten zum Import

Die Inhalte eines Imports sind in XPlanverfahren beschrieben und im XRepository veröffentlicht. Im Folgenden finden Sie über den Standard hinausgehende Beschreibungen und Hinweise.

<xplanverfahren:geobezug>

In Abhängigkeit des Verfahrensstandes mag Ihnen bereits ein XPlanGML vorliegen oder auch noch nicht. Evtl. liegt Ihnen auch ein XPlanGML vor, welches unmittelbar als Dienst im Internet veröffentlicht werden soll. Ein Import ins DiPlanCockpit setzt lediglich das Vorhandensein eines Geobezugs voraus. Unterhalb dieses Elements können Sie entweder als Geobezug ein <xplanverfahren:xPlan> oder ein <xplanverfahren:flaechenabgrenzung> definieren. Als Fächenabgrenzung genügt eine BoundingBox oder auch der Geltungsbereich als Polygon.

Das Standard-Koordinatensystem ist für ganz Deutschland EPSG:25832. Alle Dienste und Daten müssen in dieses Koordinatensystem transformiert werden können. Folgende Koordinatensysysteme sind konfiguriert:

• EPSG: 25831
• EPSG: 25832
• EPSG: 25833
• EPSG: 4326
• EPSG: 3857
• EPSG: 4258

Der Geltungsbereich (flaechenabgrenzung) wird als GeoJson in EPSG:4326 erwartet.

Möchten Sie ein XPlanGML in das DiPlanCockpit importieren, so können Sie unter <xplanverfahren:xPlan> eine xPlanURL definieren. Die Anwendung unterstützt sowohl Netzwerk- als auch Downloadressourcen, deren URL hier eingetragen werden kann. Die Ressource muss von der Anwendung frei erreichbar ohne vorgeschaltete Authentifizierung sein.

Eine Downloadressource gängiger Cloudanbieter kann verwendet werden, wenn der Anbieter einen Content-Disposition Header mit einen Wert für „filename“ übermittelt. Das ist bei hidrive, nextcloud und dropbox verprobt. Es kann aber weitere Cloud Anbieter geben, die diesen Wert nicht übermitteln. In diesem Fall würde ein Fehler geworfen werfen. 

Es können Netzwerkressourcen verwendet werden. Der Dateiname wird hinter dem "/" der URL erwartet.

Durch das Setzen eines optionalen veroeffentlichungsdatum können Sie zusätzlich zum Import ins DiPlanCockpit das XPlanGML als Dienst im Internet veröffentlichen. Wenn ein Planwerk als Geobezug importiert wird, dann muss das in der XPlanGML aufgeführte Veröffentlichungsdatum mit dem hier in der Import-XML angegebenen identisch sein. Ist ein Datumswert gesetzt, so wird das XPlanGML zunächst über Standardoptionen validiert und ggf. im Anschluss direkt im Internet veröffentlicht.

Die Validierung umfasst alle Standardprüfungen, wie bspw. der Plannamenabgleich.

<xplanverfahren:infoDokumente>

Unter "infoDokumente" können null bis beliebig viele Verfahrensdokumente einzeln als "dokument" ins DiPlanCockpit übernommen werden. Die Dokumente werden im Planverfahren in der Dokumentenansicht angeboten und können veröffentlicht, geteilt und bearbeitet werden. Unter "link" erfolgt der Verweis auf die zu importierende Datei. Die Anwendung unterstützt sowohl Netzwerk- als auch Downloadressourcen, deren URL hier eingetragen werden kann. Die Ressource muss von der Anwendung frei erreichbar ohne vorgeschaltete Authentifizierung sein.

Eine Downloadressource gängiger Cloudanbieter kann verwendet werden, wenn der Anbieter einen Content-Disposition Header mit einen Wert für „filename“ übermittelt. Das ist bei hidrive, nextcloud und dropbox verprobt. Es kann aber weitere Cloud Anbieter geben, die diesen Wert nicht übermitteln. In diesem Fall würde ein Fehler geworfen werfen.

Es können Netzwerkressourcen verwendet werden. Dabei werden die Schema http://, https://, s3:// sowie file:// unterstützt. Der Dateiname wird hinter dem "/" der URL erwartet.

Bitte beachten: Externe Routen für den Import müssen explizit freigegeben werden, standardmäßig wird sämtlicher Netzwerkverkehr in und aus dem Cluster blockiert.

Es wird zwischen Dokumenten aus öffentlichen URL und nicht öffentlichen URL unterschieden. Für den Import aus nicht öffentlichen URL werden S3-Storages genutzt, in die die Dokumente zuvor abgelegt werden müssen. Von Seiten des Cockpit gibt es nur Leserechte für den S3 Storage, die per HELM Chart verwaltet werden.

Um die Referenz auf einen S3-Storage korrekt aufzulösen und diese von einer öffentlichen URL zu unterscheiden, wird dem Dokument per Konvention der Präfix s3:// vorangestellt. Die vollständige Syntax ist damit festgelegt auf: s3://<Name des Dokuments>, die vollständige Zeile lautet somit beispielsweise `<xplan:link>s3://test-dokument-2.pdf</xplan:link>`. Es ist daraus zu achten, dass der Name des Dokuments entsprechend einer URL codiert ist. Wenn die Datei beispielsweise "test dokument 2.pdf" heißt, dann ist es notwendig das Leerzeichen als %20 zu kodieren. Die korrekte Angabe in der XML wäre demnach NICHT `<xplan:link>s3://test dokument 2.pdf</xplan:link>` sondern `<xplan:link>s3://test%20dokument%202.pdf</xplan:link>`.

Um Dokumente im S3-Storage zu pflegen, ist zunächst ein Zugang zu IONOS notwendig. Dieser wird über Dataport herausgegeben. Die Anmeldung erfolgt mit den erhaltenen Credentials auf der IONOS-Webseite.

Nach der Anmeldung navigiert man über das Hauptmenu zu "Storage & Backup" und wählt dort den Eintrag "IONOS Object Storage" aus. Es werden in einem neuen Menu die verschiedenen vorhandenen Buckets für DiPlanung angezeigt. Je nach freigeschalteter Berechtigung hat man Zugriff auf einen oder mehrere Buckets. Diese sind immer pro Umgebung und Mandant aufgeführt (z.B. Demo.Stage). Per Klick auf den entsprechenden (freigegebenen) Bucket wird er geöffnet und man kann dort weitere Unterordner anlegen oder direkt Dokumente hochladen. ACHTUNG: Dokumente, die in Ordnern bereitliegen, können momentan nicht im Cockpit referenziert werden.

Nachdem das Dokument hochgeladen wurde, muss dieses wie oben beschrieben in die XML aufgenommen werden: s3://<Name des Dokuments>, also beispielsweise s3://test-dokument-2.pdf. Das Kopieren der vollständigen URL aus dem Bucket funktioniert hingegen nicht.

Die Angaben zu "link", "dokumentart" und "status" sind notwendig. "dokumentart" und "status" verweisen jeweils auf Einträge aus der entsprechenden Codeliste. Wenn kein Verfahrensschritt angegeben ist, wird das Dokument unter "Übergreifende Dokumente" dargestellt. Ebenfalls optional können die "vormerkung" und ein "gueltigkeitszeitraum" angegeben werden.

Dokumente mit dem Status "2100" (veröffentlicht) werden beim Import automatisch im Veröffentlichungs-S3-Storage publiziert und sind damit über einen Veröffentlichungslink auch für externe Nutzer erreichbar.

Mandaten spezifische Stammdaten

Über die DiPlanung-Erweiterung ist der Import von Mandanten spezifischen Stammdaten, die in der Verfahrenskonfiguration definiert sind, möglich.

Der Screenshot zeigt beispielhaft, wie Stammdaten-Eigenschaften in der Import-XML aufgeführt werden.