DCAT-AP.PLU Export DiPlanCockpit Basis: Unterschied zwischen den Versionen
Aus DiPlanung
| (Eine dazwischenliegende Version desselben Benutzers wird nicht angezeigt) | |||
| Zeile 7: | Zeile 7: | ||
==== Erläuterung zu DCAT-AP.PLU ==== | ==== Erläuterung zu DCAT-AP.PLU ==== | ||
| − | Als Datenmodell für die Beschreibung von Planverfahren wird | + | 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 zum Art und Status eines Planverfahrens, der Planart oder den Prozessschritten zu dokumentieren. |
==== Aktualität der Metadaten ==== | ==== Aktualität der Metadaten ==== | ||
| − | Es steht die Vorstellung, dass Metadaten immer aktuell im DiPlanPortal recherchiert werden können | + | 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 Änderung bestimmter Eigenschaften am Planverfahren automatisiert ein aktualisierten Metadatensatz generiert wird. Ein vorheriger Datensatz wird dadurch ausgetauscht. Ggf. muss ein vorhandener Datensatz auch ersatzlos gelöscht werden. |
==== Datenkatalog ==== | ==== Datenkatalog ==== | ||
| − | Die Metadaten der Verfahren werden durch Kataloge gruppiert. Pro Mandant/Bundesland wird es einen Katalog geben. | + | 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: |
| − | |||
| − | |||
{| class="wikitable" | {| class="wikitable" | ||
!Katalog | !Katalog | ||
| Zeile 76: | Zeile 74: | ||
==== DCAT-AP.PLU Template ==== | ==== DCAT-AP.PLU Template ==== | ||
| − | Das verwendete Austauschformat auf Basis des entworfenen Datenmodells wird über das Template "dcat-ap-plu-template.xml" | + | 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! |
{| class="wikitable" | {| class="wikitable" | ||
!DCAT-AP.PLU Element/Attribut | !DCAT-AP.PLU Element/Attribut | ||
!Inhalt | !Inhalt | ||
| − | !Mandanten | + | !Mandanten spezifisch |
|- | |- | ||
|dct:title | |dct:title | ||
| Zeile 127: | Zeile 125: | ||
|- | |- | ||
|plu:procedurePeriod/dct:PeriodOfTime/dcat:startDate | |plu:procedurePeriod/dct:PeriodOfTime/dcat:startDate | ||
| − | | | + | |Datum, an dem das Verfahren gestartet wurde |
| | | | ||
|- | |- | ||
|plu:procedurePeriod/dct:PeriodOfTime/dcat:endDate | |plu:procedurePeriod/dct:PeriodOfTime/dcat:endDate | ||
| − | | | + | |Datum der Bekanntmachung, wenn sich das Verfahren im Verfahrensstand "inkraftgetreten" befindet. Untergangsdatum, wenn sich das Verfahren im Verfahrensstand "ganz aufgehoben" befindet. |
| | | | ||
|} | |} | ||
| Zeile 141: | Zeile 139: | ||
|- | |- | ||
|dcat:Distribution/@rdf:about | |dcat:Distribution/@rdf:about | ||
| − | |"<nowiki>https://bauleitplanung.hamburg.de/ | + | |für Hamburg: "<nowiki>https://bauleitplanung.hamburg.de/p</nowiki><span aria-hidden="true" role="presentation" class="fabric-icon ms-Icon--NavigateExternalInline font-size"></span>lanzeichnung " |
|ja | |ja | ||
|- | |- | ||
| Zeile 174: | Zeile 172: | ||
=== Automatischer Export === | === Automatischer Export === | ||
| − | In bestimmten Fällen übermittelt | + | 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. | Dieser Export kann beim Bearbeiten eines Verfahrens über das Cockpit bzw. beim Import ausgelöst werden. | ||
| Zeile 205: | Zeile 203: | ||
* MessageTyp CREATE_OR_UPDATE_RECORD (Anlegen/Aktualisieren), DELETE_RECORD (Löschen) | * MessageTyp CREATE_OR_UPDATE_RECORD (Anlegen/Aktualisieren), DELETE_RECORD (Löschen) | ||
| − | Ein periodisch laufender Hintergrundjob startet die eigentliche Übermittlung in Abhängigkeit folgender Parameter | + | Ein periodisch laufender Hintergrundjob startet die eigentliche Übermittlung in Abhängigkeit folgender Parameter: |
{| class="wikitable" | {| class="wikitable" | ||
!Art | !Art | ||
| Zeile 238: | Zeile 236: | ||
==== Schnittstelle PLU API ==== | ==== Schnittstelle PLU API ==== | ||
| − | Die REST-Schnittstelle wurde aus einer von wemove bereitgestellten Konfigurationsdatei "api-plu.yml" generiert und | + | 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: |
{| class="wikitable" | {| class="wikitable" | ||
!Art | !Art | ||
| Zeile 248: | Zeile 246: | ||
|- | |- | ||
|Parameter | |Parameter | ||
| − | | | + | |lokaler Identifikator eines mandanten spezifischen Datenkatalogs |
|OGC_API_COLLECTION_ID | |OGC_API_COLLECTION_ID | ||
|DCATAP_PLU | |DCATAP_PLU | ||
| Zeile 284: | Zeile 282: | ||
=== Manueller Export === | === Manueller Export === | ||
| − | 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 | + | 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. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Aktuelle Version vom 3. Dezember 2024, 09:50 Uhr
> Zurück zur Hauptseite DiPlan Cockpit Basis 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 zum 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 Änderung bestimmter Eigenschaften am Planverfahren automatisiert ein aktualisierten 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!
| 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:planName | Planname | |
| dcat:bbox | Bounding Box als Polygon (((MINX, MINY), (MINX, MAXY), (MAXX, MAXY), (MAXX, MINY), (MINX, MINY))) im GeoJSON Format | |
| locn:geometry | Flächenabgrenzung im GeoJSON Format | |
| locn:geographicName | Regionalschlüssel (Mandanten-spezifisch), Hamburg: 020000000000 | ja |
| dcterms:modified | Veröffentlichungsdatum des XPlanGML im ISO-Format | |
| plu:planState | Codelistenwert verfahrensstand.pluPlanstate | |
| plu:procedureType | Codelistenwert verfahrensart.pluProcedureType | |
| plu:procedureState | Codelistenwert verfahrensstand.pluProcedureState | |
| plu:planType | Codelistenwert planart.pluPlanType | |
| plu:procedurePeriod/dct:PeriodOfTime/dcat:startDate | Datum, an dem das Verfahren gestartet wurde | |
| plu:procedurePeriod/dct:PeriodOfTime/dcat:endDate | Datum der Bekanntmachung, wenn sich das Verfahren im Verfahrensstand "inkraftgetreten" befindet. Untergangsdatum, wenn sich das Verfahren im Verfahrensstand "ganz aufgehoben" befindet. |
Die Planzeichnung wird als "dcat:distribution" übermittelt, wenn ein XPlanGML zuvor veröffentlicht wurde.
| DCAT-AP.PLU Element/Attribut | Inhalt | Mandanten-spezifisch |
|---|---|---|
| dcat:Distribution/@rdf:about | für Hamburg: "https://bauleitplanung.hamburg.de/planzeichnung " | ja |
| dct:title | "Planzeichnung des Bebauungsplans " + Planname | |
| dct:description | der Planname | |
| <dcat:accessURL/@rdf:resource | die Planwerk-WMS-URL (mit maskierten XML-Sonderzeichen) | |
| plu:mapLayerNames | 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</plu:mapLayerNames" | |
| dct:format | "WMS" | |
| dcat:downloadURL/@rdf:resource | die Planwerk-WMS-URL (mit maskierten XML-Sonderzeichen) | |
| plu:docType/@rdf:resource | "https://specs.diplanung.de/resource/docType#planDrawing " |
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.
