DCAT-AP.PLU Export DiPlanCockpit Pro
> Zurück zur Hauptseite DiPlanCockpit Pro für Mandanten-Administratoren (M-A)
Metadatenübermittlung an die OGC API for Features[Bearbeiten | Quelltext bearbeiten]
Metadaten von Planverfahren werden in Abhängigkeit des jeweiligen Verfahrensstandes per DCAT-AP.PLU an die OGC API for Features des Metadatenservers übermittelt, um verfahrensspezifische Berichtspflichten und die OZG Leistung "Veröffentlichen von Planwerksinformationen" zu erfüllen.
Austauschformat DCAT-AP.PLU[Bearbeiten | Quelltext bearbeiten]
Erläuterung zu DCAT-AP.PLU[Bearbeiten | Quelltext bearbeiten]
Als Datenmodell für die Beschreibung von Planverfahren wird eine Erweiterung des Datenmodells DCAT-AP von der Firma wemove unter dem Namen DCAT-AP.PLU (PLU = Planned Land Use) entwickelt. Die Erweiterung des DCAT-AP Datenmodells ermöglicht es u.a. Informationen zu Art und Status eines Planverfahrens, der Planart oder den Prozessschritten zu dokumentieren.
Aktualität der Metadaten[Bearbeiten | Quelltext bearbeiten]
Es steht die Vorstellung, dass Metadaten immer aktuell im DiPlanPortal recherchiert werden können. Der generierte Metadatensatz soll in den zentralen Suchindex (Elastic Search Index) der OZG Lösung importiert werden. Dies hat zur Folge, dass bei der Änderung bestimmter Eigenschaften am Planverfahren automatisiert ein aktualisierter Metadatensatz generiert wird. Ein vorheriger Datensatz wird dadurch ausgetauscht. Ggf. muss ein vorhandener Datensatz auch ersatzlos gelöscht werden.
Datenkatalog[Bearbeiten | Quelltext bearbeiten]
Die Metadaten der Verfahren werden durch Kataloge gruppiert. Pro Mandant/Bundesland wird es einen Katalog geben. Das OGC-Metadateninformationssystem stellt für jede Umgebung initial folgende Kataloge bereit:
| Katalog | Kürzel (CollectionId) |
|---|---|
| Übergreifender Katalog | harvester |
| Baden-Württemberg | bw |
| Bayern | by |
| Berlin | be |
| Brandenburg | bb |
| Bremen | hb |
| Hamburg | hh |
| Hessen | he |
| Mecklenburg-Vorpommern | mv |
| Niedersachsen | ni |
| Nordrhein-Westfalen | nw |
| Rheinland-Pfalz | rp |
| Saarland | sl |
| Sachsen | sn |
| Sachsen-Anhalt | st |
| Schleswig-Holstein | sh |
| Thüringen | th |
| Demo | demo |
DCAT-AP.PLU Template[Bearbeiten | Quelltext bearbeiten]
Das verwendete Austauschformat auf Basis des entworfenen Datenmodells wird über das Template "dcat-ap-plu-template.xml" gepflegt. Alle Mandanten spezifischen Eigenschaften müssen am Template administrativ gepflegt werden. Für die Anzeige und Überarbeitung der Templates sollte kein Browser sondern eine professionelle XML-Anwendung verwendet werden. Wenn eine solche nicht vorhanden ist, lässt sich behelfsweise ein Texteditor wie Notepad++ nutzen.
Das Herunterladen, und wieder Hochladen, des Templates ist im Admin-Bereich im Reiter Konfiguration im Abschnitt "DCATAP PLU Template aktualisieren" möglich. Das Template besteht nach der Definition der Namespaces aus den Abschnitten dcat:Catalog und dcat:Dataset. Viele der Angaben werden über Platzhalter befüllt, erkennbar an der Angabe in eckigen Klammern im Template, z.B. [planname].
Das Template kann an verschiedenen Stellen angepasst werden. Notwendig ist das für die in den Tabellen mit "Ja" in der Spalte Mandanten spezifisch gekennzeichneten Feldern. Dabei handelt es sich um Freitext-Felder in die die individuell passenden Texte einzutragen sind. Weitere Anpassungen sind möglich, es ist dabei auf die fachliche und technische Korrektheit zu achten. Beispielsweise könnte man im Titel statt des Platzhalters [planname] den Platzhalter [veroeffentlichungstitel] einsetzen.
dcat:Catalog[Bearbeiten | Quelltext bearbeiten]
Die folgende Tabelle beschreibt die Attribute im Template innerhalb des dcat:Catalog.
| DCAT-AP.PLU Element/Attribut | Inhalt | Mandanten spezifisch |
|---|---|---|
| dcat:dataset | ID des Planverfahrens | |
| dct:description | Freitextfeld zur Beschreibung | Ja |
| dct:title | Freitextfeld für den Titel | Ja |
| dct:publisher | Angabe des Verantwortlichen als foaf:name (Freitextfeld) und dct:type | Ja |
| dct:modified | Letztes Änderungsdatum | |
| dct:issued | Veröffentlichungsdatum | |
| foaf:homepage | URL der eigenen Webseite, z.B. für Hamburg: https://bauleitplanung.hamburg.de/ | Ja |
dcat:Dataset[Bearbeiten | Quelltext bearbeiten]
Die folgende Tabelle beschreibt die Attribute im Template innerhalb des dcat:Dataset.
| DCAT-AP.PLU Element/Attribut | Inhalt | Mandanten spezifisch |
|---|---|---|
| dct:title | für Hamburg: "Planverfahren " + Planname + " Hamburg"; für demo.cockpit: Veröffentlichungstitel | Ja |
| dct:description | Beschreibung Planungsanlass | |
| plu:procedureImportDate | Datum des Anlegens des Verfahrens | |
| dcatde:maintainer | Für das Verfahren zuständige Person (angegeben als foaf:Agent mit foaf:name und dct:type) | |
| dcat:contactPoint | Kontaktinformationen der für das Verfahren zuständigen Person (angegeben als vcard:Organization mit vcard:fn (z.B. Name der Behörde), vcard:hasPostalCode, vcard:hasStreetAddress, vcard:hasLocality, vcard:hasCountyName, vcard:hasEmail, vcard:hasTelephone; wird befüllt über kontakte.xml) | |
| dcat:distribution | Jeweils ein Abschnitt für Planwerk, Internetseite und Dokumente wenn vorhanden. Erläuterung in nachfolgenden separaten Tabellen. | |
| dct:identifier | Plan-ID | |
| adms:identifier | Kombination aus ID der datenhaltenden Stelle (z.B. hh für Hamburg) mit Plan-ID als URL | |
| plu:planName | Planname | |
| dct:spatial | Raumbezug des Datensatzes, Erläuterung in nachfolgender separater Tabelle. | |
| dct:publisher | Zuständige Organisation, angegeben als foaf:Agent mit foaf:name (Freitextfeld, z.B. Freie und Hansestadt Hamburg) und dct:type. | Ja |
| plu:planState | Codelistenwert verfahrensstand.pluPlanstate | |
| plu:procedureType | Verfahrensart gemäß Codelistenwert verfahrensart.pluProcedureType | |
| plu:procedureState | Codelistenwert verfahrensstand.pluProcedureState | |
| plu:planType | Planart gemäß Codelistenwert planart.pluPlanType | |
| plu:procedurePeriod (darin dct:PeriodOfTime und darin dcat:endDate) | Datum der Bekanntmachung, wenn sich das Verfahren im Verfahrensstand "inkraftgetreten" befindet. Untergangsdatum, wenn sich das Verfahren im Verfahrensstand "ganz aufgehoben" befindet. |
dcat:distribution (Planwerk)[Bearbeiten | Quelltext bearbeiten]
Die Planzeichnung wird als "dcat:distribution" übermittelt, wenn zuvor ein XPlanGML veröffentlicht wurde.
| DCAT-AP.PLU Element/Attribut | Inhalt | Mandanten-spezifisch |
|---|---|---|
| dcat:Distribution/@rdf:about | Für Hamburg: "https://bauleitplanung.hamburg.de/planzeichnung". Der hier angegebene Wert darf im Template nur einmal für @rdf:about verwendet werden. | Ja |
| dct:title | "Planzeichnung des Bebauungsplans " + Planname | |
| dct:description | Planname | |
| dcat:accessURL/@rdf:resource | Planwerk-WMS-URL (mit maskierten XML-Sonderzeichen) | |
| plu:mapLayerNames | WMS-Layer, in Abhängigkeit der Eigenschaft "xPlanFachmodell" an der Planart: wenn xPlanFachmodell=RP dann "RP_Planvektor,RP_Planraster,SO_Planvektor,SO_Planraster", wenn xPlanFachmodell=LP dann "LP_Planvektor,SO_Planvektor,LP_Planraster,SO_Planraster", wenn xPlanFachmodell=FP dann "FP_Planvektor,SO_Planvektor,FP_Planraster,SO_Planraster", wenn xPlanFachmodell=BP dann "BP_Planvektor,SO_Planvektor,BP_Planraster,SO_Planraster", sonst "SO_Planvektor,SO_Planraster" | |
| dct:format | Format der Distribution, hier "WMS" | |
| dcat:downloadURL/@rdf:resource | Planwerk-WMS-URL | |
| plu:docType/@rdf:resource | Art des Dokuments, hier "https://specs.diplanung.de/resource/docType#planDrawing " |
dcat:distribution (Internetseite)[Bearbeiten | Quelltext bearbeiten]
Wenn eine Internetseite zum Verfahren existiert, wird sie ebenfalls als "dcat:distribution" übermittelt.
| DCAT-AP.PLU Element/Attribut | Inhalt | Mandanten-spezifisch |
|---|---|---|
| dcat:Distribution/@rdf:about | Für Hamburg: "https://bauleitplanung.hamburg.de/internetseite", Der hier angegebene Wert darf im Template nur einmal für @rdf:about verwendet werden. | Ja |
| dct:title | Internetseite (Freitextfeld) | |
| dct:description | "Internetpräsenz des aufzustellenden Planverfahrens" (Freitextfeld für eine Beschreibung) | |
| dcat:accessURL/@rdf:resource | URL der Internetseite | |
| dct:format | Format der Distribution, hier "HTML" | |
| dcat:downloadURL/@rdf:resource | Planwerk-WMS-URL | |
| plu:docType/@rdf:resource | Art des Dokuments, hier "https://specs.diplanung.de/resource/docType#procedureURL" |
dcat:distribution (Dokumente)[Bearbeiten | Quelltext bearbeiten]
Wenn es Dokumente zum Verfahren gibt, dann werden auch diese per "dcat:distribution" übermittelt. Es ist nur ein Eintrag im Template erforderlich, egal wie viele Dokumente vorliegen.
| DCAT-AP.PLU Element/Attribut | Inhalt | Mandanten-spezifisch |
|---|---|---|
| dcat:Distribution/@rdf:about | Veröffentlichungs-URL des Dokuments. Der hier angegebene Wert darf im Template nur einmal für @rdf:about verwendet werden. | |
| dct:title | Dateiname | |
| dcat:accessURL/@rdf:resource | Veröffentlichungs-URL des Dokuments | |
| dct:format | Format des Dokuments | |
| dcat:downloadURL/@rdf:resource | Veröffentlichungs-URL des Dokuments | |
| dct:modified | Datum der letzten Änderung des Dokuments | |
| dct:issued | Veröffentlichungsdatum des Dokuments | |
| plu:docType/@rdf:resource | Verfahrensunterlagetyp des Dokuments gemappt auf den PLU-Doc-Type (gemäß der Codeliste des Verfahrensunterlagetyps) |
dct:spatial[Bearbeiten | Quelltext bearbeiten]
Hier wird der Raumbezug angegeben. dct:spatial enthält ein Element dct:Location und darin sind die Angaben davon abhängig, wie die Flächenabgrenzung vorliegt.
| DCAT-AP.PLU Element/Attribut | Inhalt | Mandanten-spezifisch |
|---|---|---|
| dcat:bbox | Wenn die Flächenabgrenzung als Bounding Box als Polygon (((MINX, MINY), (MINX, MAXY), (MAXX, MAXY), (MAXX, MINY), (MINX, MINY))) im GeoJSON-Format vorliegt. | |
| locn:geometry | Wenn die Flächenabgrenzung im GeoJSON Format vorliegt. | |
| dcat:centroid | Wenn die Flächenabgrenzung als Centroid im GeoJSON-Format vorliegt. | |
| locn:geographicName | Beschreibung des Geltungsbereichs |
Automatischer Export[Bearbeiten | Quelltext bearbeiten]
In bestimmten Fällen übermittelt das DiPlanCockpit aktiv ein Metadatendokument laufender Verfahren an die OGC API for Records, sodass sich sofort der ElasticSearch Index aktualisiert und das Verfahren im DiPlanPortal gefunden werden kann.
Dieser Export kann beim Bearbeiten eines Verfahrens über das Cockpit bzw. beim Import ausgelöst werden.
Bedingung für eine initiale Veröffentlichung im DiPlanPortal:
- Ein Verfahren wird gestartet (Planstatus wechselt dabei auf "aktiv")
- ODER ein bearbeitetes Verfahren wechselt in den Planstatus "aktiv"
- ODER ein neues aktives Verfahren wird importiert
- ODER ein vorhandenes Verfahren wird importiert und der Planstatus wechselt dadurch auf "aktiv"
Bedingungen für eine Aktualisierung im DiPlanPortal:
- Ein bearbeitetes Verfahren besitzt den Planstatus "aktiv" und der Verfahrensstand ändert sich
- ODER ein vorhandenes aktives Verfahren wird importiert und der Verfahrensstand ändert sich
- ODER ein Dokument mit Vormerkung Metadateninformationssystem wird im Internet veröffentlicht oder die Veröffentlichung wird zurückgezogen
- ODER ein Planwerk wird veröffentlicht oder die Veröffentlichung wird zurückgezogen.
- ODER der Planname eines gestarteten Verfahrens wird geändert.
Bedingung für das Löschen im DiPlanPortal:
- An einem bearbeiteten Verfahren ändert sich der Planstatus von "aktiv" auf einen beliebigen anderen Wert
- ODER ein vorhandenes vormals aktives Verfahren wird importiert und der Planstatus ändert sich dadurch auf einen beliebigen anderen Wert
- ODER ein aktives Verfahren wird als "gelöscht" markiert (Planstatus wechselt dabei auf "gelöscht")
- ODER ein aktives Verfahren wird gelöscht
Technisch wird in den genannten Fällen eine Transfer-Message in die Tabelle "transfer_message" geschrieben mit folgenden Eigenschaften:
- TransferSource: DCAT_AP_PLU
- MessageTyp CREATE_OR_UPDATE_RECORD (Anlegen/Aktualisieren), DELETE_RECORD (Löschen)
Ein periodisch laufender Hintergrundjob startet die eigentliche Übermittlung in Abhängigkeit folgender Parameter:
| Art | Beschreibung | Name | Topic | Typ | Beispielwert |
|---|---|---|---|---|---|
| Aktivator | Aktiviert die Jobs vom Cockpit. Jobs müssen aktiviert sein. | job.ScheduledJob.enabled | Zeitplanung | BOOLEAN | true |
| Aktivator | Aktives Übermitteln von DCAT-AP.PLU-Nachrichten an das OGC API for Features | job.DcatappluMessageSender.enabled | DCATAP_PLU | BOOLEAN | true |
| Zeitintervall | Zeitintervall für das Verarbeiten von DCAT-AP.PLU-Nachrichten die vom Nachrichtenbroker abgeholt werden | job.DcatappluMessageSender.intervall | DCATAP_PLU | INTEGER | 60 |
Eine Übermittlung über OGC API Features wird im Verfahrenslog (Protokoll) geloggt.
Schnittstelle PLU API[Bearbeiten | Quelltext bearbeiten]
Die REST-Schnittstelle wurde aus einer von wemove bereitgestellten Konfigurationsdatei "api-plu.yml" generiert und lässt sich über Systemparameter an das entsprechende Zielsystem anpassen:
| Art | Beschreibung | Name | Topic | Typ | Beispielwert |
|---|---|---|---|---|---|
| Parameter | lokaler Identifikator eines mandanten spezifischen Datenkatalogs | OGC_API_COLLECTION_ID | DCATAP_PLU | STRING | hh |
| URL | Basis-URL für OGC API for Records | OGC-API URL-BASE | DCATAP_PLU | STRING | https://ogcrecordsapi.develop.diplanung.de/v1/ |
| Zugangsdaten | Username für OGC API for Records | OGC-API USERNAME | DCATAP_PLU | STRING | admin |
| Zugangsdaten | Passwort für OGC API for Records | OGC-API PASSWORD | DCATAP_PLU | STRING | |
| Zeitintervall | Timeout für OGC API for Records in Sekunden | OGC-API TIMEOUT | DCATAP_PLU | INTEGER | 60 |
Manueller Export[Bearbeiten | Quelltext bearbeiten]
Der Endpunkt "verfahren/<planId>/metadaten?format=DCAT_AP_PLU" steht zur Verfügung, um für aktive Verfahren Metadaten nach dem Format DCAT-AP.PLU als XML zu exportieren.
Zudem lässt sich im Reiter Einstellungen jedes Verfahrens der Export manuell per Klick auslösen.
