DiPlanung - Benutzerbeiträge [de]

Verfahren und Blaupausen verwalten - Bauleitplanung

2026-05-05T12:02:56Z

Diplanung: Quelltext übernommen aus vorhandenem Artikel: https://wiki.diplanung.de/index.php?title=Verfahren_%26_Blaupause_anlegen_und_verwalten_(Fachplanung-Administration)

== Verfahrensübersicht ==
Ausgangsposition: Verwalten / Verfahren Ihrer Organisation:

[[Datei:Verfahren_verwalten.13.png|alternativtext=|rahmenlos|400x400px]]

Die Fachplanenden erhalten eine Übersicht der bisher angelegten Verfahren ihrer Organisation. '''„Verfahren Ihrer Organisation“''' ist der zentrale Einstieg für die Einrichtung und Verwaltung der Verfahren einer Organisation. Die Liste wird nach dem Einloggen angezeigt oder über die Funktion „'''Verwalten'''“ im Loginkasten.

* '''Für Sachbearbeitung und Administration:''' Die Verfahrensübersicht enthält eine Liste mit verfügbaren Verfahren und jeweils folgenden Informationen.
** Name des Verfahrens
** Anzahl der Originalstellungnahmen des Verfahrens
** Datum zu dem das Verfahren angelegt wurde
** Anfangs- und Enddatum der Beteiligungsphase
** Anzeige der aktuellen Phase

* '''Für Fachplanung-Administration:''' Ein Button '''„Neues Verfahren anlegen“''' oberhalb der Liste, um neue Verfahren anzulegen. Bei der Erstellung des Verfahrens werden die Einstellungen aus der Blaupause (vorgegebenen Schablone) übernommen, sofern diese ausgewählt wurde.

* '''Für Fachplanung-Administration:''' Ein Button '''„Löschen“''' oberhalb der Liste, um bestehende (abgeschlossene) Verfahren zu löschen.

'''Hinweis:''' es sollten nur Verfahren gelöscht werden, die wirklich abgeschlossen sind. Diese sind im Nachhinein nicht wieder aufrufbar.
[[Datei:Verfahren verwalten 14.png|zentriert|rahmenlos|600x600px]]

Die Verfahren können anhand verschiedener Kritierien sortiert werden. Datum aufsteigend und absteigend sortiert nach dem Datum der Erstellung des Verfahrens. Z-A und A-Z Name des Verfahrens sortiert nach dem Verfahrensnamen.

'''Empfehlung:''' Legen Sie ein Namensschema für Verfahrensnamen fest, z.B. dass die Plan Nummer immer am Anfang des Verfahrensnamens steht in der gleichen Schreibweise, so können Sie nach den Plan Nummern sortieren. Für die Öffentlichkeit ist der Name des Gebietes oft erklärender als die Plan-Nummer. Hier können Sie in den Grundeinstellungen einen öffentlichen Verfahrensnamen anlegen, bei dem das Gebiet vorangestellt ist.

[[Datei:Verfahren anlegenS15.png|rahmenlos|600x600px|alternativtext=|zentriert]]

== Verfahren anlegen ==
Ausgangsposition: Verwalten / Verfahren Ihrer Organisation Nachfolgend wird erklärt, wie ein Verfahren neu angelegt wird, um es anschließend für die Beteiligung vorzubereiten.

'''Hinweis:''' Ausschließlich Nutzende in der Rolle Fachplanung-Administration können neue Verfahren anlegen.[[Datei:Verfahren speichern S16.png|rahmenlos|600x600px|alternativtext=|zentriert]]

Über den Klick auf „'''Neues Verfahren anlegen'''“ öffnet sich nachfolgendes Formular, das ausgefüllt und gespeichert werden muss:

* Verfahrensname
* Ggf. Blaupause, falls eine bestimmte Vorlage eingefügt werden soll
* Interne Notiz (nur für Kollegen/involviertes Planungsbüro sichtbar)
* Starttermin der Beteiligung/Auslegung (Kalender hinterlegt)
* Verfahrensende der Beteiligung/Auslegung (Kalender hinterlegt)
== Blaupausen – Informationen verfahrensübergreifend wiederverwenden ==
Ausgangsposition: Verwalten / Blaupause

Die Blaupause ist eine Vorlage für neue Verfahren. In der Blaupause können Einstellungen vorgenommen und Textteile vorformuliert werden, die in neue Verfahren übernommen werden. Typische Einstellungen sind:

* aktuelle Mitteilung zum Ansprechpartner
* Organisationen, die regelmäßig als Institution beteiligt werden
* Planzeichenerklärung
* Grundkarten
* Kartenausschnitte
* Auswahl von Planunterlagenkategorien

Die Blaupausenübersicht enthält eine Liste mit verfügbaren Blaupausen und jeweils folgenden Informationen:

* Name der Blaupause
* Datum zu dem die Blaupause angelegt wurde

=== Blaupause einrichten ===
Ausgangsposition: Verwalten / Blaupause

* Klicken Sie auf den Button „'''Neue Blaupause anlegen'''“ oberhalb der Liste, um neue Blaupausen anzulegen. Bei der Erstellung der Blaupause können die Einstellungen aus einer bereits vorhandenen Blaupause (vorgegebenen Schablone) übernommen werden oder eine Neue, über „'''leere Blaupause'''“, angelegt werden.
* Die Inhalte einer Blaupause, wie zum Beispiel aktuelle Mitteilungen oder Startkartenausschnitt, werden ebenso eingerichtet wie Verfahren.
* Um eine alte Blaupause zu löschen, markieren Sie die Blaupause per Häkchen und nutzen den Button „'''Löschen'''“ oberhalb der Liste.
[[Datei:Blaupausen.S17.png|zentriert|rahmenlos|600x600px]]

Im Formular zur Blaupause können schon beim Anlegen verschiedene Informationen wie z.B. die Absendeemailadresse des Verfahrensträgers, weitere CC-E-Mailadressen sowie der Kontakt für Bürger:innen hinterlegt werden.

'''Achtung:''' Dabei muss jedoch beachtet werden, dass diese Daten bei Änderungen auch in der Blaupause angepasst werden sollten.
[[Datei:Grundeinstellungen Blaupause.png|zentriert|rahmenlos|750x750px]]

'''Hinweise:'''

* Die Funktion „'''Blaupause'''“ existiert nur für die Rolle Fachplanung-Administration.
* Der Name der Blaupause sollte immer den Begriff „Blaupause“ beinhalten, um Blaupausen eindeutig erkennen und von Verfahren unterscheiden zu können.
* Im Navigationspfad über der Ansicht wird jeweils der Name der Blaupause angezeigt.
[[Datei:Grundeinstellungen Blau.png|zentriert|rahmenlos|750x750px]]

=== Blaupause verwalten ===
Ausgangsposition: Verwalten / Blaupause

In der Blaupause können Einstellungen vorgenommen und Dokumente hochgeladen werden, die ab sofort in neuen Verfahren übernommen werden, da die Blaupause eine Vorlage für alle zukünftige Verfahren darstellt.

* Einstellungen bieten sich in folgenden Bereichen an:
* Absendeemailadresse des Verfahrensträgers
* Kontaktdaten
* Immer benutzte Grundkarten unter „'''Planungsdokumente und Planzeichnung'''“
* Immer zu beteiligende Organisationen unter „'''Institution verwalten'''“
* Textbausteine (z.B. für Einladungsschreiben oder Abwägungstexte)
* Schlagwörter

== Für Verfahren autorisieren ==
Ausgangsposition: Verwalten / Verfahren Ihrer Organisation / Grundeinstellungen

=== Verfahren an Planungsbüros übertragen ===
Verfahrenstragende haben die Möglichkeit, ein Verfahren von einem Planungsbüro durchführen zu lassen. Sobald das Planungsbüro in DiPlanBeteiligung registriert ist und die „'''Daten der Organisation'''“ ausgefüllt und gespeichert hat, kann es von den Verfahrenstragenden einem Verfahren zugewiesen werden.

Verfahrenstragende wählen unter „'''Verfahren Ihrer Organisation'''“ aus der Liste das entsprechende Verfahren aus, öffnen es über den Titel und klickt rechts im Verwalten-Menü auf „'''Grundeinstellungen'''“. Im Formular wird unter Intern/Planungsbüro der gewünschte Name ausgewählt und gespeichert. Anschließend hat das Planungsbüro Zugriff auf dieses Verfahren und kann die Inhalte bearbeiten.
[[Datei:Intern Grundeinstellungen..png|zentriert|rahmenlos|750x750px]]

Die Interne Notiz kann von Mitarbeitenden der Verfahrensträger genutzt werden, um Anmerkungen zum Verfahren zu hinterlegen. Die interne Notiz ist nicht sichtbar für Institutionen und Öffentlichkeit.

'''Hinweis:''' Die Verfahrenstragenden müssen das Verfahren bzw. den Verfahrensnamen angelegt haben, bevor das Planungsbüro für das Verfahren berechtigt werden kann.

=== Ein Verfahren mehreren Planungsbüros zuweisen ===
Ein Verfahren kann gleichzeitig mehreren Planungsbüros zugewiesen werden. Dafür können Sie aus dem Pulldown der Planungsbüros nacheinander mehrere der angezeigten Planungsbüros anklicken. Die ausgewählten Planungsbüros erscheinen dann oben im Kasten. Zum Löschen von Planungsbüros klicken Sie einfach auf das Kreuzchen vor dem Namen.
[[Datei:Test.S20.png|zentriert|rahmenlos|293x293px]]

Verfahrenskonfiguration Pro

2026-05-05T11:27:03Z

Diplanung: /* Unterverfahrensteilschritt */

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

Die Verfahrenskonfiguration, kurz VK, ist das zentrale Element in der Konfiguration. Über Verfahrenskonfigurationen wird je nach Verfahrenssteuerungstyp (kurz V-Typ) der Ablauf des Verfahrens festgelegt. Das heißt, die VK bestimmt den Ablauf des Verfahrens und die vorgesehenen Aufgaben innerhalb eines Verfahrens. Außerdem enthält sie grundlegende Einstellungen zur Zeitplanung.

Es ist eine Default-Stellung für die kommunale Bauleitplanung verfügbar, die Mandanten spezifisch angepasst werden kann. Es lassen sich beliebig viele unterschiedliche VKs konfigurieren, die für jeden V-Typ eigene Abläufe definieren.

== Tab Verfahrenskonfiguration ==
Im Tab Verfahrenskonfiguration sind die verfügbaren Verfahrenskonfigurationen aufgelistet. Sie lassen sich nach Name, Status, Verwendung, Aktualisierungsdatum und bearbeitender Person filtern. Das Herunterladen erfolgt wahlweise einzeln als XML für eine Verfahrenskonfiguration oder für alle zusammen in Form einer ZIP-Datei.

Eine Verfahrenskonfiguration kann angepasst und bzw. neu erstellt und anschließend über das dafür vorgesehene Feld hochgeladen werden. Eine neu hochgeladene Verfahrenskonfiguration gilt für alle danach neu angelegten Verfahren, bereits vorhandene Verfahren werden nicht verändert.

Es ist ebenfalls möglich Verfahrenskonfigurationen zu löschen. Das erfolgt in zwei Schritten. Zuerst wird eine Verfahrenskonfiguration per Klick auf "Löschen" im Drei-Punkte-Menü als gelöscht markiert. Anschließend kann sie wiederhergestellt oder endgültig gelöscht werden. Für die endgültige Löschung ist Voraussetzung, dass die Verfahrenskonfiguration nicht mehr in Verwendung ist. Gegebenenfalls sind deswegen zuerst die Verfahren zu löschen, die die Verfahrenskonfiguration noch verwenden. Die betreffenden Verfahren werden per Klick auf die Werte in der Spalte "in Verwendung" angezeigt.

== Wichtige Hinweise ==
Jede VK bezieht sich auf Codelisten - sowohl feste als auch (vom Mandanten) änderbare Codelisten. Um Fehler zu vermeiden, muss sichergestellt werden, dass VK und änderbare Codelisten stets auf dem gleichen Stand sind. Das bedeutet:

* Anpassungen in einer VK können Konsequenzen auf änderbare Codelisten haben. = Anpassungen IMMER für VK und änderbare Codelisten umsetzen.
* Entfernung von Codes in änderbaren Codelisten müssen mit Umsicht vorgenommen und mögliche Auswirkungen auf VK(s) geprüft und bei Bedarf umgesetzt werden.
* Einfacher ist es, Einträge / Codes in änderbaren Codelisten ergänzend vorzunehmen, also den Bestand um neue Einträge zu ergänzen.
* Beim Hochladen ist die Reihenfolge wichtig: Angepasste, änderbare Codelisten müssen zuerst hochgeladen werden. Danach folgt die angepasste VK. Wird die Reihenfolge nicht eingehalten, kann es zur Fehlermeldung kommen.
* Für die Änderung von VK und Codelisten empfiehlt sich der Einsatz eines professionellen XLM-Tools, das Validierungs-Funktionen bietet. Diese laufen i.d.R. im Hintergrund ab und zeigen optisch Fehler an, wie falsche Einrückungen im XML-Baum oder fehlende Bestandteile wie der End-Tag eines Elements. Die Validierung erfolgt gegen die Datei diplanung.xsd.
* Bestimmte Zeichen in einer XML müssen encoded werden, damit sie nicht eine besondere Rolle im XML-Syntax erfüllen. Allgemein gibt es 5 Zeichen, die [https://stackoverflow.com/a/1091953 in XML escaped] werden müssen:
** " muss escaped werden als &quot;
** ' muss escaped werden als &apos;
** < muss escaped werden als &lt;
** > muss escaped werden als &gt;
** & muss escaped werden als &amp;

Mehr Details zur Mandanten spezifischen Anpassung von VK + änderbaren Codelisten siehe Abschnitt: [https://wiki.diplanung.de/index.php/Verfahrenskonfiguration_Pro#Mandanten_spezifische_Anpassung_und_Erstellung_von_VK Mandanten spezifische Anpassung und Erstellung von Verfahrenskonfigurationen.]

== Elemente der Verfahrenskonfiguration im Frontend ==
Der folgende Screenshot mit farblichen Beschriftungen und Markierungen zeigt den Reiter Aufgaben im DiPlanCockpit Pro. Darin sind die meisten Elemente der VK zu sehen, die in den folgenden Abschnitten erklärt werden.

Die gelbe Markierung zeigt jeweils exemplarisch ein Element an, der nächstliegende rote Kasten mit Text die Bezeichnung.
[[Datei:ImageVKFrontend.png|zentriert|719x719px|alternativtext=|rahmenlos]]

== Struktur der Verfahrenskonfiguration ==
In den folgenden Abschnitten wird eine beispielhafte VK anhand von Screenshots erläutert. Die Zahlen am linken Rand der Screenshots zeigen die Zeilennummern der XML-Datei. Insgesamt sind es im Beispiel 4836. Um eine kompakte Darstellung zu ermöglichen, sind die Bereiche, die für die jeweilige Erläuterung irrelevant sind, eingeklappt. Das ist an den kleinen blauen Pfeilen rechts von den Zeilennummern zu erkennen. Ein Pfeil nach unten bedeutet, dass der Abschnitt aufgeklappt ist. Ein Pfeil nach rechts hingegen heißt, dass an dieser Stelle noch weitere Zeilen sind, die lediglich nicht angezeigt werden. Die Anzahl der ausgeblendeten Zeilen ist in Klammern angegeben. Die Form der Darstellung ist dem verwendeten Programm geschuldet. Bei der Verwendung anderer Programme kann die visuelle Darstellung der XML abweichen.

== Screenshot mit Überblick der VK ==
'''Hinweis''': Neben dem Code der Verfahrenssteuerung (Zeile 3) ist die Fachdomäne anzugeben, hier "KommunaleBauleitplanung" (fehlt im Screenshot). Die Zeile muss lauten <code><verfahrenssteuerung code="6100" fachdomaene="KommunaleBauleitplanung"></code>[[Datei:ImageVKUeberblick1.png|zentriert|rahmenlos|619x619px]]

=== Erläuterung der Grundstruktur ===
[[Datei:VKRahmen2.png|alternativtext=|zentriert|rahmenlos|418x418px]]
Den äußeren Rahmen bildet die Angabe des Codes für die jeweilige VK. Im dargestellten Beispiel ist dies der Code 6100. Für jeden gewünschten V-Typ ist eine separate Datei mit einem eindeutigen Code erforderlich. Dieser Code MUSS in der Codeliste Code.Verfahrenssteuerung enthalten sein.

Daneben folgt die Angabe der Fachdomäne, hier ist es die "KommunaleBauleitplanung". Andere mögliche Fachdomänen sind "Planfeststellung" und "Raumordnung". Die Fachdomäne steuert unter anderem, [[Editieren der Stammdaten - DiPlanCockpit Pro#Verf.C3.BCgbare%20Stammdaten%20pro%20Fachdom.C3.A4ne|welche Stammdaten]] angezeigt werden.

Unterhalb der Verfahrenssteuerung und einmal eingerückt folgen die Angabe der Veranlasser für die Beteiligung sowie die gewünschten Planarten und Verfahrensarten für die VK. Die Beteiligung ist verpflichten mit einem "StandardVeranlasser" anzugeben. Optional können weitere Veranlasser mit einer Zuständigkeit angegeben werden. Zu beachten sind hierbei zwei Punkte:

# Der Code-Wert aus der Codeliste Zuständigkeit muss mit dem Wert des Attributs zuständigkeit im Element veranlasser in der VK übereinstimmen.
# Der Wert des Elements veranlasser muss mit der Organisations-ID der Organisation in der Beteiligung übereinstimmen. Der Wert lässt sich üblicherweise dem verwendeten ELSTER-Zertifikat entnehmen.

Beim Nachrichtenaustausch mit DiPlanBeteiligung wird geprüft, ob ein spezifisch zur Zuständigkeit passender Veranlasser vorhanden ist. Wenn ja, wird dieser übermittelt, andernfalls der Standard-Veranlasser ohne Zuständigkeit.[[Datei:ImageVKBeteiligungVeranlasser.png|zentriert|rahmenlos|455x455px]]
Die angegebenen Planarten sollten fachlich zum Verfahrenssteuerungstyp passen. Zulässige Kombinationen sind im XRepository in der [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planart Codeliste Planart] aufgeführt. Der Eintrag in der Spalte "Übergeordneter Wert" der Codeliste bezeichnet den passenden Verfahrenssteuerungstyp.
[[Datei:ImageVKZustaendigkeit1.png|zentriert|rahmenlos]]
Optional kann oberhalb der Beteiligung noch die Zuständigkeit angegeben sein. Wenn eine oder mehrere Zuständigkeiten in der VK aufgeführt sind, steht die VK nur für diese zur Verfügung. Andernfalls ist die Nutzung der VK für alle Zuständigkeiten möglich.

An die Verfahrensarten schließen sich allgemeine Angaben zur Zeitplanung an. Anschließend folgt der Hauptteil der VK mit der Auflistung aller Verfahrensschritte. Diese enthalten jeweils Verfahrensteilschritte, Unterverfahrensteilschritte, Aufgaben, Unteraufgaben und schließlich die ActionItems.

Sämtliche ActionItems sind im Detail auf einer eigenen Unterseite beschrieben. Auf dieser Seite folgt eine Erläuterung der übrigen Elemente der VK.

=== Erläuterung der einzelnen Abschnitte ===

==== Zeitplanung ====
[[Datei:ImageVKZeitplanung2.png|zentriert|rahmenlos|744x744px]]
Im Abschnitt zur Zeitplanung wird festgelegt, ob ein Monitoring vorgesehen ist. Im dargestellten Beispiel ist es vorgesehen. Zusätzlich ist angegeben, welche möglichen Arten der Monitoringrelevanz es geben soll und welche Nicht-Monitoring-Gründe.

Außerdem wird im Abschnitt zur Zeitplanung festgelegt, welcher Termin als Prognosestarttermin dienen soll. Von diesem geht die gesamte Zeitplanung aus. Im Beispiel ist es der Termin "Grobabstimmung". Angegeben ist der entsprechende Code "grobabstimmung" aus der Codeliste Code.Sitzungen, alternativ ist auch ein Code aus Code.SonstigeTermin möglich. Zu beachten ist, dass der gewählte Termin mit dem Attribut "prognoserelevant=ja" angelegt werden muss.
{| class="wikitable"
!Name
!Zweck
|-
|monitoring
|Angabe, ob ein Monitoring vorgesehen ist.
|-
|artDerMonitoringRelevanz
|Angabe möglicher Arten der Monitoringrelevanz mit Name und Beschreibung.
|-
|nichtMonitoringGrund
|Angabe von Codes aus der Codeliste Code.NichtMonitoringGrund, die für Verfahren mit dieser Verfahrenskonfiguration zur Verfügung stehen sollen.
|-
|prognosestarttermin
|Definiert den Prognosestarttermin, von dem die Zeitplanung ausgeht. Zu beachten ist, dass der gewählte Termin mit dem Attribut "prognoserelevant=ja" angelegt werden muss.
|}

==== Optional: Fachdomänenspezifische Ordnerstruktur ====
Eine konfigurierbare fachdomänenspezifische Ordnerstruktur zum Hochladen der Dokumente kann durch den Mandanten-Administrator über den Abschnitt <dokumentbibliothek> ergänzt werden. Zurzeit ist diese Ordnerstruktur nur für die Fachdomäne Planfeststellung konfiguriert.
[[Datei:ImageFachdomänenspezifischeOrdner.png|zentriert|rahmenlos|748x748px]]
Erklärung der Felder:
{| class="wikitable"
!Name
!Zweck
|-
|name
|Name bzw. Bezeichnung des Ordners (im Frontend für Nutzende sichtbar), darf nicht leer sein und darf pro Ebene nicht doppelt auftauchen.
|-
|upload
|Gibt an, ob ein Dokumentenupload über den Ordner möglich ist (true) oder nicht (false).
|-
|verfahrensunterlagentyp
|Der standardmäßig automatisch zugeordnete Verfahrensunterlagentyp für alle Dokumente / Dateien im Ordner.
|-
|pflicht
|"ja" bedeutet, dass sich mindestens eine Datei im Ordner befinden muss, was im Rahmen der Vollzähligkeitsprüfung für Vorhabens- und Antragsdokumente der Fachdomäne Planfeststellung überprüft wird. "nein" bedeutet, dass der Ordner leer sein darf und keine Auswirkung auf die Vollzähligkeitsprüfung hat.
|-
|beschreibung
|Textliche Beschreibung der fachlichen Inhalte der Dokumente im Ordner, die für die KI-Prüfung genutzt wird.
|}
Die folgenden Regeln und Einschränkungen müssen beachtet werden:

* Die Ordnerstruktur entspricht einer Baumstruktur (ähnlich wie Windows-Explorer) mit den Ebenen 0 (Wurzel) bis n.
* Die Codeliste der Verfahrensunterlagentypen muss um die für die Ordnerstruktur vorgesehenen Verfahrensunterlagentypen ergänzt und hochgeladen sein, anschließend kann die VK hochgeladen werden.
* Das Attribut verfahrensunterlagentyp darf nicht leer sein und nicht doppelt über die ganze Ordnerstruktur vorkommen.
* Wenn Dokumente innerhalb dieser Ordnerstruktur von einem DiPlan-System (z. B. Vorhaben-Cockpit - Antragsstellung) zu einem andern DiPlan-System (z. B. Behörden-Cockpit - Verfahrens-Verwaltung) übertragen werden, dann muss die Ordnerstruktur in beiden Systemen exakt identisch sein. Dabei muss beachtet werden, dass in den Codelisten die Codewerte für Verfahrensunterlagentypen in beiden Systemen eindeutig sind und keine Widersprüche vorhanden sind.

==== Optional: Mandanten spezifische Stammdaten ====
Optional können oberhalb der Verfahrensschritte zusätzliche Mandanten spezifische Stammdaten angegeben werden. Diese ermöglichen die Gestaltung individueller Eingabefelder für die Stammdatenseite. Sie erscheinen auf der Stammdatenseite oberhalb des Abschnitts zu Parallelverfahren in der Reihenfolge, mit der sie in der Verfahrenskonfiguration aufgeführt sind. Ihre Definition erfolgt beispielsweise in der Form <code><eigenschaft label="Beispiel eines Mandanten spezifischen Feldes zur Eingabe von Text" name="Beispiel6200Text" typ="TEXT" subtyp="SINGLE" pflicht="nein"/></code>.

Erklärung der Felder:
{| class="wikitable"
!Name
!Zweck
|-
|label
|Wird als Beschriftung des Feldes angezeigt, kann frei gewählt werden.
|-
|name
|Technischer Name, muss eindeutig sein, sprich darf nur einmal verwendet werden.
|-
|typ
|Gibt den Datentyp an. Zulässige Werte sind: TEXT (Freitextfeld mit max. 255 Zeichen), FLOAT (Zahlenfeld für Gleitkommazahlen), INTEGER (Zahlenfeld für ganze Zahlen), BOOLEAN (Checkbox), DATE (Datumsfeld), TIME (Zeitangabe), DATE_TIME (Datums- und Zeitangabe), DATE_TIME_RANGE (Zeitspanne), URL (Link), CODELIST (Dropdown-Auswahl, Inhalte kommen aus einer Codeliste), DROPDOWN (Dropdown-Auswahl, Optionen individuell festgelegt ohne Codeliste)
|-
|subtyp
|Muss für alle Typen außer CODELIST und DROPDOWN den Wert SINGLE haben. Bei CODELIST bzw. DROPDOWN ermöglicht SINGLE die Auswahl genau eines Wertes aus dem Dropdown, bei LIST können mehrere ausgewählt werden (Multiselect).
|-
|pflicht
|Gibt an, ob das Feld verpflichtend ist (ja oder nein).
|-
|codelistName
|Nur erforderlich bei Typ CODELIST. Der Wert muss dann lauten: "Code." + Name der Codeliste, z.B. "Code.Zustaendigkeit".
|-
|option
|Nur erforderlich bei Typ DROPDOWN. Einmal bis beliebig oft mit je einem Eintrag für das Dropdown einfügen.
|}

==== Verfahrensschritt ====
[[Datei:ImageVKVS.png|links|488x488px|alternativtext=|rahmenlos]]
Ein Verfahrensschritt ist die oberste Ebene in der Unterteilung eines Verfahrens in mehrere Abschnitte. Er wird durch die Angabe des Codes aus Code.Verfahrensschritte bestimmt. Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen. Aktuell werden Durchgänge auf Ebene der Verfahrensschritte durch das Cockpit nicht unterstützt, sodass die Angabe von "ja" keinen Effekt hat.

Jeder Verfahrensschritt enthält beliebig viele Verfahrensteilschritte. Es ist möglich keinen Verfahrensteilschritt anzugeben, dann wird der Verfahrensschritt jedoch nicht im Cockpit sichtbar.

Die Reihenfolge der Verschachtelung (Verfahrensschritt > Verfahrensteilschritt > Unterverfahrensteilschritt) muss eingehalten werden. In einen Verfahrensschritt direkt einen Unterverfahrensteilschritt einzufügen ist nicht zulässig. Ebenso wenig ist es zulässig, innerhalb eines Verfahrensteilschritts oder einer tieferen Ebene, Verfahrensschritte zu ergänzen.

Damit die Verfahrensschritte in der richtigen Reihenfolge dargestellt werden, ist es notwendig ihre Codes in alphabetischer/numerischer Reihenfolge zu vergeben, also beispielsweise "0001VerfahrensschrittEins", "0002Verfahrensschritt2" usw.
{| class="wikitable"
!Name
!Zweck
|-
|verfahrensteilschritt
|Angabe eines untergeordneten Verfahrensteilschritts.
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein". Im Cockpit werden Durchgänge für Verfahrensschritte nicht unterstützt.
|}
Eine Besonderheit ist der Verfahrensschritt 9998. Dieser ist obligatorisch mitsamt des Verfahrensteilschritts 9998. Darin können Termine aufgeführt sein, die Eingaben auf der Stammdatenseite referenzieren.

Die mit der Stammdatenseite verknüpften Termine sind für die kommunale Bauleitplanung 0100 (Beschlussdatum), 0200 (Vorweggenehmigung bzw. Planreife gemäß §33 BauGB) und 9300 (Aufhebungsdatum). Der Termin 9300 muss zudem die beiden Eigenschaften "linkPlanzeichnung" und "linkBegruendung" des Typs URL haben.

Für die Fachdomäne Raumordnung sind es die Termine pflicht_9400 (Tag des Inkrafttretens) und pflicht_9450 (Tag des Außerkrafttretens). Diese Termine müssen im VS 9998 angegeben werden, wenn sie nicht bereits in einem vorherigen Verfahrensschritt definiert sind.

Wichtig für die Stammdatenseite ist, dass diese Termine in der Verfahrenskonfiguration enthalten sind, aber nicht an welcher Stelle. Der VS 9998 dienst als Option, wenn nicht gewünscht ist, die Termine in den Verfahrensablauf einzubinden.
[[Datei:ImageVS9998 2.png|zentriert|rahmenlos|572x572px]]

==== Verfahrensteilschritt ====
[[Datei:ImageVKVTS.png|601x601px|alternativtext=|zentriert|rahmenlos]]
Verfahrensteilschritte bilden die zweite Ebene in der Strukturierung des Verfahrensablaufs. Sie werden durch die Angabe eines Codes aus Code.Verfahrensteilschritte bestimmt. Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen.

Zu jedem Verfahrensteilschritt können 0 bis beliebig viele Sitzungen und/oder sonstige Termine angegeben werden. Anschließend folgt die Auflistung aller Unterverfahrensteilschritte.
{| class="wikitable"
!Name
!Zweck
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein".
|-
|sitzung
|Sitzung innerhalb des Verfahrensteilschritts.
|-
|sonstigerTermin
|Sonstiger Termin innerhalb des Verfahrensteilschritts.
|-
|unterverfahrensteilschritt
|Angabe eines untergeordneten Unterverfahrensteilschritts.
|}

==== Sitzung ====
[[Datei:ImageVKSitzung.png|links|474x474px|alternativtext=|rahmenlos]]
Sitzungen werden über einen Code aus der Codeliste Code.Sitzungscodes bestimmt. Zu beachten ist, dass die Bezeichnung einer Sitzung maximal 255 Zeichen umfassen darf. Zusätzlich werden mögliche Ergebnisse über die Angabe eines Codes aus Code.Sitzungsergebnistyp festgelegt.

Jede Sitzung enthält die Information, ob sie zeitplanungsrelevant oder nicht zeitplanungsrelevant ist. Bei Relevanz für die Zeitplanung ist ebenfalls anzugeben ob Monitoring- und/oder Prognoserelevanz gewünscht ist. Zusätzlich ist die vorgesehene Wirkung in der Modellberechnung anzugeben. Dies erfolgt über die Verzögerung, Dauer und das Setzen auf Aktiv. Die möglichen Verzögerungsgründe werden hier nicht angegeben, sondern sind je nach V-Typ festgelegt und stammen aus der Codeliste Code.Verzoegerungsgrund.

Für nicht zeitplanungsrelevante Sitzungen ist nur anzugeben, welcher Datumstyp gewünscht ist. Dieser kann ein einzelner Tag (Angabe zeitpunkt), Zeitraum (Angabe zeitraum) oder flexibel (Angabe zeitpunkt_oder_zeitraum) sein.
{| class="wikitable"
!Name
!Zweck
|-
|ergebnistyp
|Codeliste der Ergebnistypen.
|-
|zeitplanungsrelevant oder nichtzeitplanungsrelevant
|Legt Zeitplanungsrelevanz fest.
|-
|monitoringrelevant
|Legt Monitoringrelevanz fest. Angabe "ja" oder "nein".
|-
|prognoserelevant
|Legt Prognoserelevanz fest. Angabe "ja" oder "nein".
|-
|modellberechnung
|Enthält Informationen zur Berechnung in der Zeitplanung.
|-
|verzoegerung
|Bestimmt die Verzögerung. Angabe als ganze Zahl.
|-
|dauer
|Bestimmt die Dauer. Angabe als ganze Zahl.
|-
|aktiv
|(De-)aktiviert den Einfluss auf die Modellberechnung. Angabe "ja" oder "nein".
|-
|datumstyp
|Beschreibt für nicht zeitplanungsrelevante Termine die Art der Datumsangabe. Angabe "zeitpunkt", "zeitraum" oder "zeitpunkt_oder_zeitraum".
|}

==== Sonstiger Termin ====
[[Datei:ImageSonstigeTermine.png|links|rahmenlos|507x507px]]
(Hinweis: Des Screenshot zeigt zwei verschiedene sonstige Termine, um möglichst viele Optionen der Konfiguration abzubilden.)

Sonstige Termine werden über einen Code aus der Codeliste Code.SonstigeTermin bestimmt. Zu beachten ist, dass die Bezeichnung eines sonstigen Termins maximal 255 Zeichen umfassen darf. Zusätzlich wird in der Beschreibung der anzuzeigende Text zu dem sonstigen Termin definiert.

Jeder sonstige Termin enthält die Information, ob er zeitplanungsrelevant oder nicht zeitplanungsrelevant ist. Bei Relevanz für die Zeitplanung ist ebenfalls anzugeben ob Monitoring- und/oder Prognoserelevanz gewünscht ist. Zusätzlich ist die vorgesehene Wirkung in der Modellberechnung anzugeben. Dies erfolgt über die Verzögerung, Dauer und das Setzen auf Aktiv. Die möglichen Verzögerungsgründe werden hier nicht angegeben, sondern sind je nach V-Typ fest vorgegeben.

Für nicht zeitplanungsrelevante sonstige Termine ist nur anzugeben, welcher Datumstyp gewünscht ist. Dieser kann ein einzelner Tag (Angabe zeitpunkt), Zeitraum (Angabe zeitraum) oder flexibel (Angabe zeitpunkt_oder_zeitraum) sein.

Sonstige Termine können außerdem über eine oder mehrere Angaben einer "eigenschaft" verfügen. Es stehen unterschiedliche Datentypen zur Verfügung (siehe Tabelle), mit denen weitere Informationen zu einem Termin angegeben werden können.
{| class="wikitable"
!Name
!Zweck
|-
|beschreibung
|Anzuzeigende Beschreibung des sonstigen Termins.
|-
|zeitplanungsrelevant oder nichtzeitplanungsrelevant
|Legt Zeitplanungsrelevanz fest.
|-
|monitoringrelevant
|Legt Monitoringrelevanz fest. Angabe "ja" oder "nein".
|-
|prognoserelevant
|Legt Prognoserelevanz fest. Angabe "ja" oder "nein".
|-
|modellberechnung
|Enthält Informationen zur Berechnung in der Zeitplanung.
|-
|verzoegerung
|Bestimmt die Verzögerung. Angabe als ganze Zahl.
|-
|dauer
|Bestimmt die Dauer. Angabe als ganze Zahl.
|-
|aktiv
|(De-)aktiviert den Einfluss auf die Modellberechnung. Angabe "ja" oder "nein".
|-
|datumstyp
|Beschreibt für nicht zeitplanungsrelevante Termine die Art der Datumsangabe. Angabe "zeitpunkt", "zeitraum" oder "zeitpunkt_oder_zeitraum".
|-
|eigenschaft
|Beschreibt zusätzliche Informationen zu dem Termin. Umfasst "name", "typ" und optional "codelistName".
|-
|name
|Benennt die "eigenschaft" des Termins. Angabe als String.
|-
|typ
|Beschreibt das Datenformat der "eigenschaft" des Termins. Optionen: "TEXT", "FLOAT", "INTEGER", "BOOLEAN", "DATE", "URL", "CODELIST"
|-
|codelistName
|Benennt die zu referenzierende Codeliste, wenn der "typ" der "eigenschaft" "CODELIST" ist.
|}

==== Unterverfahrensteilschritt ====
[[Datei:ImageVKUVTS.png|links|436x436px|alternativtext=|rahmenlos]]
Unterverfahrensteilschritte bilden die dritte Ebene in der Strukturierung des Verfahrensablaufs. Sie werden durch die Angabe des Codes aus Code.Unterverfahrensteilschritte bestimmt. Die Angabe bei "pflicht" legt fest, ob der Unterverfahrensteilschritt immer aktiviert sein soll (Angabe "ja"), oder ob er optional und manuell aktivierbar sein soll (Angabe "nein"). Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen. Aktuell werden Durchgänge auf Ebene der Unterverfahrensteilschritte durch das Cockpit nicht unterstützt, sodass die Angabe von "ja" keinen Effekt hat. Optional kann eine Bedingung angegeben werden, wann der UVTS angezeigt werden soll. Details zu Bedingungen finden sich im Abschnitt [https://wiki.diplanung.de/index.php?title=Verfahrenskonfiguration_Pro#Aufgabe Aufgaben].

In jedem Unterverfahrensteilschritt können 0 bis beliebig viele Aufgaben enthalten sein. Unterverfahrensteilschritte werden auch dann dargestellt, wenn sie keine Aufgaben enthalten.
{| class="wikitable"
!Name
!Zweck
|-
|pflicht
|Legt fest, ob der Unterverfahrensteilschritt verpflichten oder optional ist. Angabe "ja" oder "nein".
|-
|bedingung
|Bedingung in Platzhalter-Syntax, wann der UVTS angezeigt werden soll. Damit eine Bedingung gesetzt werden kann, muss pflicht="ja" sein.
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein". Im Cockpit werden Durchgänge für Unterverfahrensteilschritte nicht unterstützt.
|-
|aufgabe
|Angabe einer untergeordneten Aufgabe.
|}

==== Aufgabe ====
[[Datei:ImageVKAufgabe.png|zentriert|719x719px|alternativtext=|rahmenlos]]
Aufgaben sind in Unterverfahrensteilschritten enthalten. Pro Unterverfahrensteilschritt sind 0 bis beliebig viele Aufgaben möglich.

Jede Aufgabe benötigt eine eindeutige ID zur Identifikation und eine Beschreibung, die im Cockpit angezeigt wird. Optional kann eine Bedingung angegeben werden, wann die Aufgabe angezeigt werden soll. Im dargestellten Beispiel wird die Aufgabe nur angezeigt, wenn der sonstige Termin "InfoFoeb_Zeitraum" als Eigenschaft den Code 0200 erhalten hat.
{| class="wikitable"
!Name
!Zweck
|-
|id
|Eindeutige ID der Aufgabe.
|-
|bedingung
|Bedingung in Platzhalter-Syntax, wann die Aufgabe angezeigt werden soll.
|-
|beschreibung
|Anzuzeigende Beschreibung der Aufgabe.
|-
|unteraufgabe
|Unteraufgabe der Aufgabe, enthält die ActionItems.
|}
Es können auch Werte von ActionItems in Bedinungen genutzt werden. Dabei sind jedoch nur ActionItems möglich, die im selben Verfahrensteilschritt definiert sind, in dem auch die Aufgabe/Unteraufgabe mit der Bedingung enthalten ist. Zudem muss das ActionItem in der Verfahrenskonfiguration eine refID definiert haben, welche dann genutzt wird um das ActionItem in der Bedingung zu referenzieren.

Beispiele:
{| class="wikitable"
!Beispiel
!Erklärung
|-
|<code>actionItem('ref-checkbox').checked=true</code>
|Das ActionItem vom Typ Checkbox mit der refID <code>ref-checkbox</code> muss angehakt sein, damit die Bedingung zutrifft.
|-
|<code>actionItem('ref-string').value!=someValue</code>
|Das ActionItem vom Typ Text mit der refID <code>ref-string</code> darf nicht den Wert <code>someValue</code> haben, damit die Bedingung zutrifft.
|-
|<code>actionItem('ref-dropdown').valueSelected=someValue</code>
|Das ActionItem vom Typ Dropdown mit der refID <code>ref-dropdown</code> muss den Wert <code>someValue</code> ausgewählt haben, damit die Bedingung zutrifft.
|}

==== Unteraufgabe ====
[[Datei:ImageVKUnteraufgabe.png|zentriert|531x531px|alternativtext=|rahmenlos]]
Unteraufgaben sind in beliebiger Anzahl in Aufgaben enthalten und umfassen beliebig viele ActionItems. ActionItems sind auf einer eigenen Unterseite beschrieben. Um ein ActionItem einer Aufgabe hinzuzufügen, muss eine Unteraufgabe vorhanden und das ActionItem darin ergänzt werden. Direkt in eine Aufgabe ohne Unteraufgabe ActionItems hinzuzufügen ist nicht möglich.

Analog zu Aufgaben benötigt je Unteraufgabe eine eindeutige ID zur Identifikation und eine Beschreibung, die im Cockpit angezeigt wird. Optional kann auch für Unteraufgaben eine Bedingung angegeben werden, wann sie angezeigt werden soll. Im dargestellten Beispiel wird die Unteraufgabe nur angezeigt, wenn der Hauptbezirk Harburg ist.
{| class="wikitable"
!Name
!Zweck
|-
|id
|Eindeutige ID der Aufgabe.
|-
|bedingung
|Bedingung in Platzhalter-Syntax ob die Unteraufgabe angezeigt werden soll.
|-
|beschreibung
|Anzuzeigende Beschreibung der Aufgabe.
|-
|Auflistung der ActionItems
|Liste der ActionItems.
|}

Reporting: Auswertungen im DiPlan Cockpit

2026-05-04T09:03:54Z

Diplanung:

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

'''> Zurück zur Hauptseite [[DiPlanCockpit Basis als EfA-Lösung|DiPlanCockpit Basis für Fachplanung-Sachbearbeitung (FP-SB)]]'''

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

'''> Zurück zur Hauptseite [[DiPlanCockpit Pro für Fachplanung-Sachbearbeitung (FP-SB)]]'''

⚠️ '''Bitte beachten: Die Reporting-Funktionalität wird nach und nach Mandanten spezifisch freigeschaltet. Informationen zur Funktionsweise finden Sie hier vorab.'''

== Einleitung ==
Die Auswertungskomponente für das DiPlan Cockpit ermöglicht das Abrufen, Filtern und Downloaden von Reports und Auswertungen aus Planungs- und Genehmigungsverfahren. Die Auswertungsdiagramme zu individuellen Fragestellungen werden in dem externen BI-Tool Superset von berechtigten Personen auf Basis grundlegender SQL- und Datenmodell-Kenntnisse erstellt, verwaltet, auf Dashboards zusammengestellt und schließlich für die Darstellung im DiPlan Cockpit freigegeben.

== Aufruf der Auswertungen ==
Die Auswertungen sind in dem gleichnamigen Reiter im DiPlan Cockpit zu finden.

In der linken Bildschirmhälfte sind die Namen der jeweiligen zur Verfügung stehenden Dashboards zu finden. Ein Dashboard ist eine Zusammenstellung von einem oder mehreren Auswertungsdiagrammen auf einer Seite. Standardmäßig wird das Dashboard "Verfahrensstand aller Verfahren" für jeden Mandant initial mit ausgerollt. Alle weiteren Dashboards können je nach Bedarf individuell durch berechtigte Personen je Mandant erstellt werden. Mehr dazu findet sich im Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Auswertungen_erstellen.2C_ver.C3.B6ffentlichen_und_freigeben Auswertungen erstellen, veröffentlichen und freigeben].

'''Gut zu wissen:'''

* '''Datengrundlage:''' Grundsätzlich fließen gelöschte Verfahren nicht in die Auswertungen ein.
* '''Aktualität der Daten:''' Die Daten werden jede Nacht einmal mit der DiPlan Cockpit Datenbank synchronisiert.
* '''Darstellung:''' Das Reporting wird mit dem Tool Superset umgesetzt, welches in das DiPlan Cockpit eingebunden wird. Für eine optimale Darstellung nutzen Sie bitte den Browser Microsoft Edge.
[[Datei:ImageAuswertungenCockpit.png|zentriert|mini|717x717px|Ansicht des Reiters "Auswertungen" im DiPlan Cockpit mit dem Standarddashboard "Verfahrensstand aller Verfahren".]]

== Filtern der Dashboards bzw. Auswertungen ==
Je nach Art der dargestellten Auswertungen können Sie weitere Aktionen in den einzelnen Diagrammen vornehmen. Oftmals sind zum Beispiel verschiedene Filterungsmöglichkeiten hinterlegt. Zum Öffnen der Filter gehen Sie bitte folgendermaßen vor:

* Aufklappen der Filter durch Klick auf den kleinen blauen Pfeil links neben den Diagrammen. Alternativ können die Filter auch am oberen Rand des Dashboards eingebunden sein.
* Auswählen der gewünschten Filter.
* Klick auf "Filter anwenden".
* Bei Klick auf "Alles löschen" werden sämtliche gesetzte Filter wieder zurückgesetzt.
[[Datei:ImageAuswertungenCockpitFilter.png|zentriert|mini|742x742px|Falls eine Filterung im Dashboard integriert wurde, so lässt diese sich über den kleinen Pfeil ausklappen oder befindet sich am oberen Rand des Dashboards. Hier zu sehen eine Filterung auf dem Dashboard nach Zuständigkeit oder Verfahrenstyp.]]
[[Datei:ImageAuswertungenCockpitFilter2.png|zentriert|mini|742x742px|Das Reporting bietet die Möglichkeit auch mehrere verschiedene Diagrammtypen auf einem Dashboard darzustellen. Diese können von Mandanten-Administratoren konfiguriert und freigegeben werden. Hier ein Beispiel mit integrierten Filtern am oberen Rand des Dashboards.]]

== Download der Auswertungen ==
Neben jeder Auswertungsgrafik (jedem Diagramm) finden sich drei Punkte, welche bei Klick ein Drop-Down Menü öffnen. Durch '''Mouseover auf "Herunterladen"''' öffnet sich das Menü zum Download des Diagramms in verschiedenen auswählbaren Formaten. Hier sind folgende Punkte zu beachten:

* '''Der Download entspricht immer der Filterung:''' Wird eine Grafik durch eine Filterung angepasst und dann ein Download gestartet, so entsprechen die heruntergeladenen Daten immer genau der Filterung, das heißt es sind nicht alle Daten vorhanden. Je nach Grafik ist in den heruntergeladenen Dateien nicht selbsterklärend, dass eine Filterung angewendet wurde und es ist wichtig das Downloadergebnis bei der weiteren Verwendung in den richtigen Kontext zu setzen. Laden Sie sich alternativ die Daten ohne Filterung herunter und filtern Sie zum Beispiel bei Bedarf gesondert in MS Excel.
* '''Die Rollen der Sachbearbeitenden sehen nur die eigene Zuständigkeit:''' Je nach Rolle der Nutzenden werden unter Umständen nicht alle Daten auf den Dashboards dargestellt. Sachbearbeitende können nur Daten der eigenen Zuständigkeit sehen. Siehe dazu auch das nächste Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Rechte_und_Rollen Rechte und Rollen].
[[Datei:ImageAuswertungenHerunterladen.png|zentriert|mini|581x581px|Das vertikale Dreipunktemenü in den Diagrammen beinhaltet die Herunterladen-Funktion.]]

== Rechte und Rollen ==
Alle Rollen aus dem DiPlan Cockpit werden gemäß ihrer Berechtigungen mit einer entsprechenden Rolle in Superset versehen. Prinzipiell gibt es zwei relevante Rollen, denen die Nutzenden in Superset zugeordnet werden. Dies passiert automatisch und regelt ob die Nutzenden berechtigt sind Auswertungen selbst anzulegen, freizugeben und zu veröffentlichen oder ob sie ausschließlich die freigegebenen Auswertungen gemäß ihrer Zuständigkeit im DiPlan Cockpit sehen können. Nachfolgend sehen Sie eine Übersicht über die verschiedenen Berechtigungen:
<table border="1" cellspacing="0" cellpadding="8">
<tr>
<th>Rolle DiPlan Cockpit</th>
<th>Rolle Superset</th>
<th>Berechtigungen</th>
</tr>
<tr>
<td valign="top">
EfA Cockpit Pro
<ul>
<li>M‑A = Mandanten‑Administration</li>
<li>FP‑A = Fachplanung‑Administration</li> 
</ul>
EfA Cockpit Basis 
<ul>
<li>M-A-Basis = Mandanten-Administration-Basis</li>
<li>FP-A-Basis = Fachplanung-Administration Basis</li></ul>
</td>
<td valign="top">
Reporting-Administrator
</td>
<td valign="top">
<ul>
<li>Kann direkt aus dem DiPlan Cockpit zu Superset abspringen und ist dort automatisch eingeloggt (SSO).</li>
<li>Kann Datensätze (Superset-spezifische Zwischenschicht zwischen DB-Tabelle und Abfrage) erstellen.</li>
<li>Kann Auswertungen/Diagramme in Superset erstellen.</li>
<li>Kann Dashboards mit verschiedenen Auswertungen/Diagramme zusammenstellen.</li>
<li>Kann Dashboards freigeben für den ganzen Mandanten (z.B. ganz Hamburg).</li>
<li>Kann alle Daten im Dashboard eines Mandanten sehen.</li>
<li>Kann Abfragen filtern, also z.B. in Hamburg nach Belieben nach Bezirk (Zuständigkeit) z.B. Altona oder Senat.
<li>Kann Auswertungen in verschiedenen Formaten herunterladen.</li>
<li>Kann andere Reporting-Administratoren für die eigenen Dashboards/Diagramme als Besitzer eintragen, um diese für die Bearbeitung, Freischaltung und Veröffentlichung zu berechtigen.</li>
<ul/>
</td>
</tr>
<tr>
<td valign="top">
EfA Cockpit Pro 
<ul>
<li>FP-VM = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)</li>
<li>FP-SB = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)</li> 
</ul>
EfA Cockpit Basis 
<ul>
<li>FP-VM-Basis = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)</li>
<li>FP-SB-Basis = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)</li>
</ul>
</td>
<td valign="top">
Sachbearbeiter
</td>
<td valign="top">
<ul>
<li>Sieht ausschließlich die vorgefilterten Daten der eigenen Zuständigkeit (also z.B. Altona).</li>
<li>Kann Auswertungen herunterladen, aber nur mit den Daten der eigenen Zuständigkeit.</li>
<li>Kann freigegebene Dashboards betrachten. </li>
<li>Kann Auswertungen filtern, wenn Filter eingerichtet wurden.</li>
<li>Kann Auswertungen in verschiedenen Formaten herunterladen.</li>
</ul>
</td>
</tr>
</table>

== Superset als zentrales Tool für Reporting-Administratoren ==

=== Übergreifende Informationen zu Superset ===
Für die Erstellung und Darstellung des Reportings wurde das Open-Source-Tool Apache Superset in das DiPlan Cockpit implementiert. Superset ist eine Reporting- und Monitoring-Technologie, die es ermöglicht komplexe Daten auf Dashboards in leicht verständlichen Visualisierungen darzustellen. Die Erstellung der Dashboards erfolgt dabei direkt in der Superset-Anwendung. Dort wird auch gesteuert, welche Dashboards mit welchen Auswertungen im DiPlan Cockpit veröffentlicht werden sollen.

=== Absprung aus dem DiPlan Cockpit zu Superset ===
Sobald eine Rolle für die Erstellung von Auswertungen berechtigt ist (zum Beispiel M-A oder FP-A), findet sich im Reiter Auswertungen automatisch der Button '''"Auswertungen konfigurieren"'''. Bei Klick öffnet sich ein weiteres Browserfenster mit der Superset-Plattform. Eine gesonderte Anmeldung in Superset ist nicht erforderlich, da die Anmeldung durch das Cockpit erfolgt (auch Single Sign-On (SSO) genannt).

'''Bitte beachten:''' Nach 4 Stunden erfolgt aus Sicherheitsgründen ein automatischer Logout aus Superset - unabhängig davon ob Sie gerade in Superset arbeiten oder nicht aktiv waren. Sie erhalten keine Warnung vor dem Logout. Deshalb empfiehlt es sich, Änderungen regelmäßig zu speichern, um zu verhindern, dass ungesicherte Abfragen verloren gehen.
[[Datei:ImageButtonAuswertungenKonfigurieren.png|zentriert|mini|766x766px|Berechtigte Personen sehen über den Dashboards im DiPlan Cockpit einen Absprungbutton zu Superset mit der Bezeichnung "Auswertungen konfigurieren."]]
[[Datei:ImageStartbildschirmSuperset.png|zentriert|mini|777x777px|Startbildschirm in Superset mit einer Vorschau auf Dashboards und Diagrammen. Die Hauptmenüpunkte zur Navigation sind am oberen Bildschirmrand zu sehen.]]

=== Auswertungen erstellen, veröffentlichen und freigeben ===
Datenvisualisierungen von Abfragen werden in Superset als '''"Diagramme"''' bezeichnet. Sobald mindestens ein Diagramm erstellt ist, kann dieses auf einem Dashboard integriert werden und mit weiteren Filtermöglichkeiten versehen werden. Wie bereits erwähnt, können Sie als '''Reporting-Administrator''' selbst nach Belieben Diagramme erstellen. Nachfolgend wird beispielhaft die Erstellung und Freigabe des Dashboards mit dem Diagramm "Verfahrensstand aller Verfahren" beschrieben, um einige der Grundfunktionalitäten in Superset zu verdeutlichen (siehe dazu das Kapitel: "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]").

=== Datensätze erstellen ===
Um ein Diagramm zu erstellen wird zunächst ein Datensatz benötigt. Für einfache Abfragen reicht der '''Verfahrensdatensatz''' aus, der bereits standardmäßig enthalten ist. Dieser entspricht der '''Tabelle "Verfahren"''' mit den '''zugehörigen Datenfeldern (Stammdaten)'''.

Für Abfragen auf dem Verfahrensdatensatz können Sie direkt zum Abschnitt "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]" springen.

Für komplexere '''Abfragen über mehrere Tabellen hinweg, eigene Metriken oder eigene berechnete Spalten''' ist die Erstellung eines eigenen Datensatzes mithilfe von SQL-Abfragen notwendig.

Folgende Informationen sind in gesonderten Tabellen enthalten:

* Eigenschaften
* Gebietseinheiten
* Kontakte
* Nutzer
* Parallelverfahren
* Termine
* Veränderungssperren
* Vertragsarten
* Vorgesehene Nutzungen
* Zurückstellungen

'''Bitte beachten:''' Bei der Erstellung von eigenen Datensätzen, muss die Spalte "'''''zustaendigkeit_code"''''' aus der Tabelle "'''''verfahren"'' immer enthalten sein,''' da hierüber die Ansicht für Sachbearbeiter standardmäßig gefiltert wird.

'''Um eigene Datensätze zu erstellen gehen Sie bitte wie folgt vor:'''

* Klick im Hauptmenü auf den '''Reiter "SQL"''' und im zugehörigen Dropdown-Menü auf '''"SQL Lab".'''
[[Datei:ImageStartSQLLab.png|zentriert|mini|854x854px|Startansicht SQL Lab]]
* Erstellen Sie Ihre '''SQL-Abfrage''' und klicken Sie auf den '''Button "Ausführen"''', um eine Vorschau auf die Ergebnisse der Abfrage zu erhalten. Ein rotes Kreuzchen links vom SQL-Editor weist auf Fehler im SQL hin.
[[Datei:ImageAusfuehrenSQLLab.png|zentriert|mini|846x846px|Ausführen einer SQL Abfrage im SQL Lab]]
'''Typische Anwendungsfälle und die dazugehörigen SQL Abfragen könnten z.B. sein:'''

* Sie möchten, dass Ihre Abfragen z.B. nach "Gebietseinheiten" und "Vorgesehenen Nutzungen" gefiltert werden können:

{| class="wikitable"
|
SELECT v.*, g.gebietseinheit, vn.vorgesehene_nutzungen
FROM verfahren v
LEFT JOIN gebietseinheiten g ON g.verfahren_id = v.id
LEFT JOIN vorgesehene_nutzungen vn ON vn.verfahren_id = v.id;
|}

* Sie möchten, dass Ihr Datensatz bestimmte Termine enthält (z.B. Grobabstimmungsdatum, Vorweggenehmigungsreife):

{| class="wikitable"
|
WITH grobabstimmung_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Grobabstimmung'
),
vorweggenehmigungsreife_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Vorweggenehmigungsreife'
)
SELECT
v.*,
t1.beginn AS grobabstimmung,
t2.beginn AS vorweggenehmigungsreife
FROM verfahren v
LEFT JOIN grobabstimmung_termin t1 ON t1.verfahren_id = v.id
LEFT JOIN vorweggenehmigungsreife_termin t2 ON t2.verfahren_id = v.id;
|}

* Sie möchten, dass Ihr Datensatz bestimmte Mandanten spezifische Stammdaten enthält. Nachfolgend ein Beispiel für Stammdaten vom Typ Text, Ganzzahl und Zeitraum:

{| class="wikitable"
|
WITH kommentar_eigenschaft AS (
SELECT e.id, e.text, e.verfahren_id
FROM eigenschaft e
WHERE e.name = 'Kommentar'
),
kennzahl_eigenschaft AS (
SELECT e.id, e.ganzzahl, e.verfahren_id
FROM eigenschaft e
WHERE e.name = 'Kennzahl'
),
zeitraum_eigenschaft AS (
SELECT e.id, e.datum, e.enddatum, e.verfahren_id
FROM eigenschaft e
WHERE e.name = 'Zeitraum'
)
SELECT
v.*,
e1.text AS kommentar,
e2.ganzzahl AS kennzahl,
e3.datum AS zeitraum_beginn,
e3.enddatum AS zeitraum_ende
FROM verfahren v
LEFT JOIN kommentar_eigenschaft e1 ON e1.verfahren_id = v.id
LEFT JOIN kennzahl_eigenschaft e2 ON e2.verfahren_id = v.id
LEFT JOIN zeitraum_eigenschaft e3 ON e3.verfahren_id = v.id;
|}
* '''Speichern Sie Ihre Abfrage als Datensatz''' ab, indem Sie auf den '''Dropdown-Pfeil neben dem Button "Speichern"''' klicken und dann '''"Datensatz speichern"''' auswählen. Es öffnet sich ein Dialogfeld, in dem Sie einen Namen für Ihren Datensatz vergeben können.
** Hinweis: Wenn Sie statt auf "Datensatz speichern" auf "Speichern" klicken, finden Sie Ihre SQL Abfrage unter dem Reiter '''"Gespeicherte Abfragen"''' wieder.
[[Datei:ImageSpeichernDatensatzSuperset.png|zentriert|mini|891x891px|Speichern eines neuen Datensatzes]]
Nach der Erstellung eines Datensatzes können Sie diesen noch weiter bearbeiten und Labels, eigene Metriken oder berechnete Spalten hinzufügen. Gehen Sie dazu wie folgt vor:
* Klick im Hauptmenü auf den '''Reiter "Datensätze"'''. Hier sind die verfügbaren Datensätze aufgelistet.
* Klicken Sie ganz rechts neben dem Datensatz, den Sie bearbeiten wollen, auf das '''Stift-Symbol.''' Es öffnet sich eine Bearbeitungsmaske.
[[Datei:ImageBearbeitungDatensatzSuperset.png|zentriert|mini|890x890px|Öffnen Sie den Bearbeitungsmodus durch Klick auf das Stiftsymbol]]
*'''Reiter "Quelle":''' Hier kann die zugrundeliegende SQL Abfrage nachträglich angepasst werden. Klicken Sie hierfür auf das Schloss-Symbol.
[[Datei:ImageReiterQuelleSuperset.png|zentriert|mini|879x879px|Im Reiter "Quelle" kann das SQL nachträglich angepasst werden]]
*'''Reiter "Metriken":''' Hier können eigene Metriken angelegt werden.
[[Datei:ImageReiterMetrikenSuperset.png|zentriert|mini|878x878px|Eine neue Metrik "Anzahl Verfahren" wird hinzugefügt]]
*'''Reiter "Spalten":''' Hier sind alle im Datensatz enthaltenen Spalten aufgeführt. An den Werten in der Tabelle ("Datentyp", "Ist zeitlich" etc.) sollte in der Regel nichts geändert werden, dies wird von Superset automatisch richtig erkannt. Beim '''Klick auf das "Plus"''' neben jeder Spalte kann unter "Beschriftung" ein sprechendes Label hinzugefügt werden. Dieses wird später in den Diagrammen angezeigt.
[[Datei:ImageReiterSpaltenSuperset.png|zentriert|mini|877x877px|Im Reiter "Spalten" wird ein Label hinzugefügt]]
*'''Reiter "Berechnete Spalten":''' Hier können dem Datensatz weitere Spalten hinzugefügt werden, die Werte enthalten, die aus anderen Spalten errechnet werden. Verwenden Sie für die Berechnung SQL-Syntax.
[[Datei:ImageReiterBerechneteSpaltenSuperset.png|zentriert|mini|851x851px|Eine berechnete Spalte wird hinzugefügt]]
* Speichern Sie Ihre Änderungen am Datensatz durch das '''Klicken auf den "Speichern"-Button'''. Um die Änderungen zu prüfen, empfiehlt es sich ein Diagramm mit dem Datensatz anzulegen (z.B. eine Tabelle).

=== Beispiel-Diagramm erstellen ===
Nachfolgend soll beispielhaft ein Diagramm "Verfahrensstand aller Verfahren" erstellt werden. Dazu gehen Sie wie folgt vor:

# Klick auf den '''Menüpunkt "Diagramme":''' Auf dieser Seite findet sich eine Liste mit allen bereits erstellten Diagrammen. Innerhalb dieser Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Diagramm-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageUebersichtDiagrammeSuperset.png|zentriert|mini|860x860px|Im Menüpunkt "Diagramme" findet sich eine Übersicht über die bisher erstellten Diagramme (Abfragen) mit vielen Zusatzinformationen.]]
# Um ein neues Diagramm zu erstellen klicken Sie auf den '''Button "+Diagramm"''' rechts oben. Es öffnet sich der Dialog '''"Neues Diagramm erstellen".'''[[Datei:ImageNeuesDiagrammSuperset.png|zentriert|mini|860x860px|Dialog um ein neues Diagramm zu erstellen]]
# Zunächst muss der '''passende Datensatz für die Auswertung ausgewählt''' werden. Für dieses Beispiel wählen wir unter '''"1- Datensatz auswählen"''' den Datensatz '''"verfahren"''' im Dropdownmenü aus.
# Im nächsten Schritt wird der '''passende Diagrammtyp ausgewählt'''. Hier werden Ihnen viele verschiedene Visualisierungsmöglichkeiten geboten. Im genannten Beispiel passt ein "Kreisdiagramm" am besten zu der Visualisierung der Verfahrensstände aller Verfahren. Sie finden das Kreisdiagramm unter dem Hauptmenü "Teil des Ganzen". Klicken Sie '''auf das Kreisdiagramm''' und anschließend auf '''"Neues Diagramm erstellen"'''.
# Nun geht es um die '''Detailkonfiguration''' des Diagramms. Grundsätzlich ist der Arbeitsbereich wie folgt aufgebaut:
#* Die linke Spalte enthält einen '''Überblick''' über die '''zur Verfügung stehenden Daten'''.
#* Die mittlere Spalte enthält die '''Werkzeuge''', um das '''Diagramm zu konfigurieren.'''
#* Im rechten Bereich kann man sich jeweils eine '''Vorschau des Diagramms''' anzeigen lassen.
'''Wir gehen für unser Beispiel wie folgt vor:'''

* Im Feld '''"Name des Diagramms hinzufügen"''' das Diagramm mit einer passenden Bezeichnung versehen.
* Um die Dimensionen des Diagramms festzulegen im Tab '''"Daten"''' unter der Überschrift '''"Abfrage > Dimensionen"''' die Spalte '''"verfahrensstand"''' von links per Drag & Drop herüberziehen.
* Der dazustellende Wert soll hier die Anzahl sein, weshalb nun unter '''"Metrik"''' das Feld '''"Anzahl"''' Button "+Diagramm" per Drag & Drop von links herübergezogen wird. Je nach Fragestellung bzw. welche Daten auf dem Diagramm dargestellt werden sollen, können verschiedenste Kombinationen in der selben Art und Weise über Drag & Drop zusammengestellt werden.
* Unter dem '''Punkt "Filter"''' kann eine Vorabfilterung eingebaut werden, also beispielsweise könnten Sie simulierte Verfahren standardmäßig herausfiltern, so dass die Nutzenden diese gar nicht auswerten können. Anmerkung: "imported_at" kann nicht gelöscht werden. Dieser Wert wird von Superset standardmäßig gesetzt und hat keine Auswirkung auf Ihre Auswertungen.
* Das für die Berechnung zugrundeliegende Zeilenlimit kann bei Bedarf verändert werden.
* Ein Klick auf den '''blauen Button "Diagramm erstellen"''' zeigt eine '''Vorschau''' des erstellten Diagrammes auf der rechten Bildschirmhälfte. Das Diagramm kann nun jederzeit mit einem '''Klick auf "Speichern"''' rechts oben gesichert werden.[[Datei:ImageDiagrammErstellenSuperset.png|zentriert|mini|880x880px|Dialog zur Detaildefinition des neuen Diagramms. Hier beispielhaft zusammengestellt für die Darstellung "Verfahrenstand aller Verfahren".]]

* Unter dem '''Tab "Anpassen"''' finden sich zahlreiche Möglichkeiten, das Diagramm weiter zu verfeinern (zum Beispiel in Farbe und Layout). Hier kann ganz nach Belieben ausprobiert werden. Mit '''Klick auf''' '''"Diagramm aktualisieren"''' kann die Vorschau des Diagramms zur Überprüfung mit den neu gewählten Einstellungen geladen werden.[[Datei:ImageDiagrammAnpassenSuperset.png|zentriert|mini|900x900px|Diagramm kann nach Belieben im Tab "Anpassen" verändert und verfeinert werden.]]
* '''Speichern nicht vergessen:''' Das Diagramm wird erst gespeichert durch '''Klick auf "Speichern" rechts oben'''. Es öffnet sich ein Dialog zu weiteren Speicheroptionen, der mit '''einer weiteren Speicherbestätigung''' abgeschlossen werden kann.[[Datei:ImageDiagrammSpeichernSuperset.png|zentriert|mini|874x874px|Speichern-Dialog für das erstellte Diagramm]]

=== Beispiel-Dashboard erstellen ===

# '''Klick auf den Menüpunkt "Dashboards":''' Unter der Überschrift "Dashboards" findet sich eine Liste mit allen bereits erstellten Dashboards. Diese Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Dashboard-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageDashboardsSuperset.png|zentriert|mini|866x866px|Unter dem Menüpunkt "Dashboards" finden sich alle bereits angelegten Dashboards, sowie die Möglichkeit neue Dashboards zu erstellen.]]
# Mit Klick auf den Button '''"+Dashboard"''' rechts oben öffnet sich ein neuer, leerer Dashboard -Entwurf.
# Der Titel des Dashboards ist standardmäßig als "untitled dashboard" angeben und kann durch '''Klick auf den Namen''' geändert werden.
# Auf der Seitenleiste am rechten Bildschirmrand finden sich alle bereits erstellten Diagramme. Das gewünschte Diagramm kann einfach durch '''Drag & Drop mit der Maus auf das Dashboard gezogen''' werden. Auch die Größe kann leicht geändert werden indem sie die Ränder oder Ecken des Diagramms klicken, gedrückt halten und auf die gewünschte Größe ziehen. Sie können ein oder auch mehrere Diagramme auf einem Dashboard platzieren.
# Zu guter Letzt oben rechts auf den '''Button "Speichern"''' klicken um Ihre Arbeit zu sichern. Nach dem Speichern können Sie jederzeit am Dashboard weiter arbeiten indem Sie auf den nun erscheinenden Button '''"Dashboard bearbeiten"''' klicken.
# Sollten Sie ein Diagramm wieder vom Dashboard löschen wollen, können Sie einfach das '''Mülleimer-Symbol''' klicken, welches bei Mouseover über das jeweilige Diagramm erscheint.[[Datei:ImageDragDropDiagrammSuperset.png|zentriert|mini|804x804px|Das gewünschte Diagramm kann mit der Maus einfach auf das Dashboard gezogen und platziert werden.]]
[[Datei:ImageDiagrammGroesseSuperset.png|zentriert|mini|761x761px|Die Größe des Diagramms lässt sich einfach durch Ziehen der Maus an Ecken oder Rändern verändern.]]

=== Einen oder mehrere Filter zu einem Dashboard zufügen ===
Es ist möglich Ihre Auswertungsdiagramme mit Filtermöglichkeiten zu versehen. Im folgenden wird beispielhaft ein Filter nach der Zuständigkeit auf dem Dashboard "Verfahrensstand aller Verfahren" hinzugefügt:

# Öffnen Sie das Dashboard oder legen Sie sich ein entsprechendes neues Dashboard an und speichern dieses.
# An der linken Bildschirmkante den '''kleinen Pfeil klicken''', um das Filtermenü auszuklappen. '''Wichtig:''' Der Pfeil ist nur sichtbar, wenn das Dashboard bereits gespeichert ist und sich nicht gerade im offenen Bearbeitungsmodus befindet. Sprich: Klicken Sie '''nicht''' "Dashboard bearbeiten" bevor Sie den Filter hinzufügen.
# Klicken Sie auf das '''kleine Zahnrad''' um das Untermenü zu öffnen.
# Ein Klick auf '''"Hinzufügen und Bearbeiten von Filtern"''' öffnet das Menü um die Filter zu konfigurieren.[[Datei:ImageDashboardFilterMenueSuperset.png|zentriert|mini|800x800px|Durch Klick auf den kleinen Pfeil öffnet sich das Menü, mit dem Filter hinzugefügt und konfiguriert werden können.]]
# Um nach der Zuständigkeit zu filtern muss im '''Menü Filtertyp die Option "Wert"''' ausgewählt sein.
# Im Menüpunkt Tabellenname '''"Zuständigkeit"''' als '''Namen des Filters''' eintragen.
# Im '''Feld Datensatz''' wird in diesem Fall '''"verfahren"''' ausgewählt.
# Im '''Feld "Spalte"''' den Filter auswählen, nach dem gefiltert werden soll: in diesem Fall '''"zustaendigkeit".'''
# Das Menü '''"Filterwerte sortieren"''' durch einen Haken aktivieren und absteigend sortieren und mit der '''Sortiermetrik "Anzahl"''' versehen.
# Im '''Reiter "Auswahlverfahren"''' kann der Filter durch eine Auswahl außerdem auf '''einzelne Diagramme oder auf alles bezogen''' werden.
# Durch '''Klick auf "Speichern"''' rechts unten wird der Filter in das Dashboard integriert.[[Datei:ImageFilteroptionenDashboardSuperset.png|zentriert|mini|712x712px|Sie können einen oder mehrere Filteroptionen auf einem Dashboard integrieren und in diesem Menü konfigurieren.]]
'''Übergeordnete Filtereinstellungen:'''

Nach '''Klick auf das Zahnrad''', im geöffneten Filter-Untermenü, können Sie außerdem entscheiden, ob der Filter '''oben''' über dem Diagramm '''oder seitlich links einklappbar''' angezeigt werden soll.

Es gibt dort außerdem die Möglichkeit für ein oder mehrere Diagramme eine '''Kreuzfilterung zu aktivieren.''' Diese erlaubt es Ihnen, direkt '''in einem Diagramm auf ein Element zu klicken''', um damit automatisch eines oder alle Diagramme im Dashboard zu filtern. So können Daten intuitiv und interaktiv erkundet werden, ohne separate Filtersteuerungen zu verwenden.
[[Datei:ImageFilterUntermenueSuperset.png|zentriert|mini|767x767px|Im Filter-Untermenü können bestehende Filter bearbeitet oder weitere Filter hinzugefügt werden. Außerdem kann die Kreuzfilterung aktiviert und die Darstellung der Filterleiste verändert werden.]]

=== Dashboards veröffentlichen ===
Dashboards werden erst im DiPlan Cockpit sichtbar, nachdem diese veröffentlicht und für die Sachbearbeitenden und Reporting-Administratoren freigeschalten wurden. Dabei gilt es zu beachten, dass Sie nur Dashboards veröffentlichen und freischalten können, die Sie selbst erstellt haben oder für die Sie berechtigt worden sind. Siehe hierzu auch das Kapitel "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Diagramme_und_Dashboards_f.C3.BCr_andere_Reporting-Administratoren_zur_Bearbeitung_freigeben Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben]".

'''Zur Veröffentlichung und Freischaltung gehen Sie wie folgt vor:'''

# Öffnen Sie das Dashboard, welches veröffentlicht werden soll.
# Durch Klick auf das '''graue Feld "Entwurf"''' neben dem Dashboard Namen, ändert sich die Bezeichnung auf '''"Veröffentlicht".'''[[Datei:ImageStatusVeroeffentlichtSuperset.png|zentriert|mini|911x911px|Durch Klick ändert sich der Status von "Entwurf" auf "Veröffentlicht".]]
# Öffnen Sie rechts oben das '''Dreipunktemenü''' und wählen Sie dort den Unterpunkt '''"Dashboard einbetten"''' aus.[[Datei:ImageDashboardEinbettenSuperset.png|zentriert|mini|942x942px|Im Dreipunktemenü muss im nächsten Schritt der Punkt "Dashboard einbetten" geklickt werden.]]
# Im Einbetten-Dialog lassen Sie das Feld für "Zulässige Domänen" bitte einfach frei und klicken lediglich den '''Button "Einbettung aktivieren".''' Dann kann das Menü durch Klick auf das '''X-Symbol''' geschlossen werden.[[Datei:ImageEinbettungAktivierenSuperset.png|zentriert|mini|869x869px|Im Menü "Einbetten" klicken Sie auf "Einbettung aktivieren" und dann einfach auf das X um das Fenster zu schließen.]]
# Um das Dashboard nun für die '''Rolle der Sachbearbeitenden und Mandanten-Administratoren''' im DiPlan Cockpit '''freizugeben''' öffnen Sie bitte erneut den Reiter '''"Dashboards",''' um auf die Liste mit allen Dashboards zu gelangen.
# Klicken Sie auf das '''Stift-Symbol''' neben dem Dashboard, welches freigeschalten werden soll.[[Datei:ImageDashboardEigenschaftenOeffnenSuperset.png|zentriert|mini|843x843px|Durch Klick auf das Stiftsymbol neben dem Dashboard werden die Dashboardeigenschaften geöffnet. Dort können auch die einzelnen Rollen freigeschaltet werden.]]
# In den '''Dashboardeigenschaften''' können nun die Rollen eingetragen werden, für die das Dashboard freigeschalten werden soll. Die Rollenbezeichnungen in Superset fassen mehrere Rollen aus dem DiPlan Cockpit zusammen, was die Freigabe von Dashboards vereinfacht. Bitte tragen Sie im Feld "Rollen" deshalb '''"Reporting-Administrator"''' und '''"Sachbearbeiter" in der Liste ein.''' Dies ist durch Tippen in das Feld möglich, so wird die auszuwählende Rolle schneller sichtbar. Sie können jedoch auch manuell durch die Liste scrollen und die Rolle auswählen. Klicken Sie anschließend den '''"Speichern"-Button'''. Die Auswertungen sind nun im DiPlan Cockpit für alle berechtigten Rollen sichtbar.[[Datei:ImageDashboardEigenschaftenRollenSuperset.png|zentriert|mini|695x695px|In den Dashboardeigenschaften müssen die Rollen, für die das Dashboard freigegeben werden soll, ausgewählt werden.]]
'''Hinweis: Veröffentlichung zurücknehmen'''

Sollten Sie ein Dashboard im DiPlan Cockpit unsichtbar machen wollen, so klicken Sie wie im Punkt 2 beschrieben wieder auf die graue Schaltfläche und setzen Sie den Status von '''"Veröffentlicht"''' zurück auf '''"Entwurf".'''

=== Bestehendes Dashboard oder Diagramm bearbeiten oder löschen ===
'''Wie lösche ich ein eingebettetes Diagramm von einem bereits veröffentlichten und freigegebenen Dashboard?'''

* Öffnen Sie das Dashboard und '''klicken Sie "Dashboard bearbeiten"''' auf der rechten Bildschirmseite.
* Im geöffneten Bearbeitungsmodus können Sie nun die Maus über das nicht mehr erwünschte Diagramm bewegen und durch '''Klick auf das erscheinende Mülleimersymbol''' löschen. Das Diagramm bleibt in der Liste der Diagramme weiterhin erhalten und wird lediglich vom Dashboard genommen.
* Sie können ein '''weiteres/neues Diagramm''' jederzeit wieder aus der Liste rechts auf das Dashboard ziehen.
* Bestätigen Sie das veränderte Dashboard durch Klick auf den "'''Speichern"-Button''' rechts oben.
* '''Bitte beachten:''' Änderungen an bereits veröffentlichten und freigegebenen Dashboards werden nach dem '''Speichern direkt auf dem DiPlan Cockpit sichtbar'''.
[[Datei:ImageDashboardDiagrammLoeschenSuperset.png|zentriert|mini|736x736px|Per Mouseover und Klick auf das Mülleimer Symbol lassen sich Diagramme auf Dashboards einfach wieder löschen.]]
'''Wie bearbeite ich ein bestehendes Diagramm?'''

Ein Diagramm unabhängig vom Dashboard ändern:

* Öffnen Sie das zu bearbeitende Diagramm in der '''Liste der Diagramme''' durch einen '''Klick auf den Namen'''.
* Das Diagramm öffnet sich direkt im Bearbeitungsmodus und kann nach '''Belieben angepasst werden'''.
* Ist das Diagramm bereits auf einem veröffentlichten und freigegebenen Dashboard eingebettet, so werden alle Änderungen nach dem Speichern direkt übernommen und im '''DiPlan Cockpit sichtbar'''.

Ein Diagramm direkt auf einem Dashboard ändern:

* Öffnen Sie das Dashboard und klicken Sie '''"Dashboard bearbeiten"'''.
* Bewegen Sie die Maus über die entsprechende Grafik, öffnen Sie das Dreipunktemenü rechts und klicken '''"Diagramm bearbeiten".'''
* Nachdem Sie das Diagramm bearbeitet haben klicken Sie '''"Speichern"'''.

'''Bitte beachten:''' Im Speichern-Dialog können Sie entscheiden, ob sie das bestehende '''Diagramm überschreiben''' oder ein '''neues Diagramm speichern''' wollen. Dies kann hilfreich sein, wenn Sie das Diagramm nicht generell, sondern nur auf einem bereits bestehenden Dashboard ändern wollen.
[[Datei:ImageDiagrammSpeichernÜberschreibenSuperset.png|zentriert|mini|792x792px|Es ist möglich direkt beim Speichern ein neues Diagramm zu erstellen oder das bereits bestehende zu überschreiben.]]

'''Wie lösche ich ein Dashboard oder Diagramm dauerhaft?'''

Sie können ein Dashboard unabhängig vom Status (also veröffentlicht oder auch als Entwurf) in der Liste der Dashboards wie folgt löschen:

* Bewegen Sie die Maus über den entsprechenden '''Listeneintrag.'''
* Klicken Sie das in der Zeile rechts erscheinende '''Papierkorb-Symbol''' und folgen den Anweisungen im erscheinenden Löschdialog.
* Die Originaldiagramme auf dem Dashboard bleiben dabei weiterhin in der Liste "Diagramme" erhalten.
* Sollten Sie ein Diagramm dauerhaft löschen wollen, so gehen Sie genauso wie beim Dashboard vor, jedoch im '''Reiter "Diagramme"'''.

=== Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Bitte beachten:''' Solange Reporting-Administratoren nicht als Besitzer eingetragen sind, haben diese nur Zugriff auf die eigenen erstellten Daten.

'''Das bedeutet konkret für die erstellten Daten von anderen Reporting-Administratoren:'''

* Unveröffentlichte Dashboards sind nicht sichtbar.
* Veröffentlichte Dashboards sind sichtbar, aber nicht bearbeitbar.
* Alle Diagramme sind sichtbar, Änderungen können jedoch nur als neue Diagramme gespeichert werden.
* Datensätze sind sichtbar und können verwendet, aber nicht bearbeitet werden.
* Gespeicherte Abfragen sind nicht sichtbar (Berechtigungen können hier grundsätzlich nicht vergeben werden).

Sie haben grundsätzlich keine Rechte ein Dashboard zu bearbeiten oder ein Diagramm zu überschreiben, welches nicht von Ihnen erstellt wurde, außer Sie wurden als '''"Besitzende/r"''' dazu ermächtigt.

Das bedeutet beispielsweise, dass Sie ein Diagramm, welches jemand anders erstellt hat, zwar bearbeiten, dies aber nur als neues Diagramm abspeichern können. Das Originaldiagramm wird hier nicht verändert. Um jemanden für die '''Mitarbeit an Ihrem Diagramm oder Dashboard zu ermächtigen''' gehen Sie wie folgt vor:

* Klicken Sie in der Liste der Diagramme oder Dashboards auf das '''Stift-Symbol "Bearbeiten".''' Der Dialog '''"Diagrammeigenschaften bearbeiten"''' öffnet sich.
* Unter der '''Überschrift "Zugang"''' können weitere '''"Besitzende" eingetragen''' werden. Klicken Sie hierzu in das Eingabefeld und fangen Sie an den Namen zu tippen oder scrollen Sie durch die Liste bis zum gewünschten Namen.
* '''Wählen Sie einen oder mehrere Namen aus,''' um diese in das Feld zu übernehmen und klicken Sie dann auf '''"Speichern"'''. Die eingetragene Person hat nun die gleichen '''Rechte zur Bearbeitung wie der/die ursprüngliche Ersteller/in'''.[[Datei:ImageDiagrammZugangBesitzendeSuperset.png|zentriert|mini|677x677px|Unter "Zugang" können Sie andere Mandanten-Administratoren für die Bearbeitung Ihrer Dashboards oder Diagramme berechtigen.]]

=== Datensätze für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Um Datensätze für andere Reporting-Administratoren zur Bearbeitung freizugeben, gehen Sie wie folgt vor:'''

* Klick auf den '''Reiter "Datensätze"'''
* In der Übersicht-Liste klicken Sie bitte das '''Stift- Symbol''' neben dem gewünschten Datensatz.
* Klicken Sie den '''Reiter "Einstellungen"''' ganz rechts und scrollen Sie ganz nach unten.
* Dort können Sie im '''Feld "Besitzende"''' auch andere Reporting-Administratoren zur Bearbeitung berechtigen.
[[Datei:ImageDatensatzBesitzendeSuperset.png|zentriert|mini|810x810px|Auch Datensätze können zur Bearbeitung an andere Mandanten-Administratoren freigegeben werden.]]

== Weiterführende Informationen ==
Unter folgendem Link können Sie weitere Informationen zu Superset in englischer Sprache finden. Bitte beachten Sie, dass Ihre Datenbank bereits angebunden ist und der Punkt "Connecting to a new database" in der Dokumentation somit nicht beachtet werden sollte: '''[https://superset.apache.org/docs/6.0.0/using-superset/creating-your-first-dashboard#creating-your-first-dashboard Englische Dokumentation des Open-Source-Tools Superset]'''

Reporting: Auswertungen im DiPlan Cockpit

2026-05-04T07:49:55Z

Diplanung: /* Datensätze erstellen */

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

'''> Zurück zur Hauptseite [[DiPlanCockpit Basis als EfA-Lösung|DiPlanCockpit Basis für Fachplanung-Sachbearbeitung (FP-SB)]]'''

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

'''> Zurück zur Hauptseite [[DiPlanCockpit Pro für Fachplanung-Sachbearbeitung (FP-SB)]]'''

⚠️ '''Bitte beachten: Die Reporting-Funktionalität wird nach und nach Mandanten spezifisch freigeschaltet. Informationen zur Funktionsweise finden Sie hier vorab.'''

== Einleitung ==
Die Auswertungskomponente für das DiPlan Cockpit ermöglicht das Abrufen, Filtern und Downloaden von Reports und Auswertungen aus Planungs- und Genehmigungsverfahren. Die Auswertungsdiagramme zu individuellen Fragestellungen werden in dem externen BI-Tool Superset von berechtigten Personen auf Basis grundlegender SQL- und Datenmodell-Kenntnisse erstellt, verwaltet, auf Dashboards zusammengestellt und schließlich für die Darstellung im DiPlan Cockpit freigegeben.

== Aufruf der Auswertungen ==
Die Auswertungen sind in dem gleichnamigen Reiter im DiPlan Cockpit zu finden.

In der linken Bildschirmhälfte sind die Namen der jeweiligen zur Verfügung stehenden Dashboards zu finden. Ein Dashboard ist eine Zusammenstellung von einem oder mehreren Auswertungsdiagrammen auf einer Seite. Standardmäßig wird das Dashboard "Verfahrensstand aller Verfahren" für jeden Mandant initial mit ausgerollt. Alle weiteren Dashboards können je nach Bedarf individuell durch berechtigte Personen je Mandant erstellt werden. Mehr dazu findet sich im Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Auswertungen_erstellen.2C_ver.C3.B6ffentlichen_und_freigeben Auswertungen erstellen, veröffentlichen und freigeben].

'''Gut zu wissen:'''

* '''Datengrundlage:''' Grundsätzlich fließen gelöschte Verfahren nicht in die Auswertungen ein.
* '''Aktualität der Daten:''' Die Daten werden jede Nacht einmal mit der DiPlan Cockpit Datenbank synchronisiert.
* '''Darstellung:''' Das Reporting wird mit dem Tool Superset umgesetzt, welches in das DiPlan Cockpit eingebunden wird. Für eine optimale Darstellung nutzen Sie bitte den Browser Microsoft Edge.
[[Datei:ImageAuswertungenCockpit.png|zentriert|mini|717x717px|Ansicht des Reiters "Auswertungen" im DiPlan Cockpit mit dem Standarddashboard "Verfahrensstand aller Verfahren".]]

== Filtern der Dashboards bzw. Auswertungen ==
Je nach Art der dargestellten Auswertungen können Sie weitere Aktionen in den einzelnen Diagrammen vornehmen. Oftmals sind zum Beispiel verschiedene Filterungsmöglichkeiten hinterlegt. Zum Öffnen der Filter gehen Sie bitte folgendermaßen vor:

* Aufklappen der Filter durch Klick auf den kleinen blauen Pfeil links neben den Diagrammen. Alternativ können die Filter auch am oberen Rand des Dashboards eingebunden sein.
* Auswählen der gewünschten Filter.
* Klick auf "Filter anwenden".
* Bei Klick auf "Alles löschen" werden sämtliche gesetzte Filter wieder zurückgesetzt.
[[Datei:ImageAuswertungenCockpitFilter.png|zentriert|mini|742x742px|Falls eine Filterung im Dashboard integriert wurde, so lässt diese sich über den kleinen Pfeil ausklappen oder befindet sich am oberen Rand des Dashboards. Hier zu sehen eine Filterung auf dem Dashboard nach Zuständigkeit oder Verfahrenstyp.]]
[[Datei:ImageAuswertungenCockpitFilter2.png|zentriert|mini|742x742px|Das Reporting bietet die Möglichkeit auch mehrere verschiedene Diagrammtypen auf einem Dashboard darzustellen. Diese können von Mandanten-Administratoren konfiguriert und freigegeben werden. Hier ein Beispiel mit integrierten Filtern am oberen Rand des Dashboards.]]

== Download der Auswertungen ==
Neben jeder Auswertungsgrafik (jedem Diagramm) finden sich drei Punkte, welche bei Klick ein Drop-Down Menü öffnen. Durch '''Mouseover auf "Herunterladen"''' öffnet sich das Menü zum Download des Diagramms in verschiedenen auswählbaren Formaten. Hier sind folgende Punkte zu beachten:

* '''Der Download entspricht immer der Filterung:''' Wird eine Grafik durch eine Filterung angepasst und dann ein Download gestartet, so entsprechen die heruntergeladenen Daten immer genau der Filterung, das heißt es sind nicht alle Daten vorhanden. Je nach Grafik ist in den heruntergeladenen Dateien nicht selbsterklärend, dass eine Filterung angewendet wurde und es ist wichtig das Downloadergebnis bei der weiteren Verwendung in den richtigen Kontext zu setzen. Laden Sie sich alternativ die Daten ohne Filterung herunter und filtern Sie zum Beispiel bei Bedarf gesondert in MS Excel.
* '''Die Rollen der Sachbearbeitenden sehen nur die eigene Zuständigkeit:''' Je nach Rolle der Nutzenden werden unter Umständen nicht alle Daten auf den Dashboards dargestellt. Sachbearbeitende können nur Daten der eigenen Zuständigkeit sehen. Siehe dazu auch das nächste Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Rechte_und_Rollen Rechte und Rollen].
[[Datei:ImageAuswertungenHerunterladen.png|zentriert|mini|581x581px|Das vertikale Dreipunktemenü in den Diagrammen beinhaltet die Herunterladen-Funktion.]]

== Rechte und Rollen ==
Alle Rollen aus dem DiPlan Cockpit werden gemäß ihrer Berechtigungen mit einer entsprechenden Rolle in Superset versehen. Prinzipiell gibt es zwei relevante Rollen, denen die Nutzenden in Superset zugeordnet werden. Dies passiert automatisch und regelt ob die Nutzenden berechtigt sind Auswertungen selbst anzulegen, freizugeben und zu veröffentlichen oder ob sie ausschließlich die freigegebenen Auswertungen gemäß ihrer Zuständigkeit im DiPlan Cockpit sehen können. Nachfolgend sehen Sie eine Übersicht über die verschiedenen Berechtigungen:
<table border="1" cellspacing="0" cellpadding="8">
<tr>
<th>Rolle DiPlan Cockpit</th>
<th>Rolle Superset</th>
<th>Berechtigungen</th>
</tr>
<tr>
<td valign="top">
EfA Cockpit Pro
<ul>
<li>M‑A = Mandanten‑Administration</li>
<li>FP‑A = Fachplanung‑Administration</li> 
</ul>
EfA Cockpit Basis 
<ul>
<li>M-A-Basis = Mandanten-Administration-Basis</li>
<li>FP-A-Basis = Fachplanung-Administration Basis</li></ul>
</td>
<td valign="top">
Reporting-Administrator
</td>
<td valign="top">
<ul>
<li>Kann direkt aus dem DiPlan Cockpit zu Superset abspringen und ist dort automatisch eingeloggt (SSO).</li>
<li>Kann Datensätze (Superset-spezifische Zwischenschicht zwischen DB-Tabelle und Abfrage) erstellen.</li>
<li>Kann Auswertungen/Diagramme in Superset erstellen.</li>
<li>Kann Dashboards mit verschiedenen Auswertungen/Diagramme zusammenstellen.</li>
<li>Kann Dashboards freigeben für den ganzen Mandanten (z.B. ganz Hamburg).</li>
<li>Kann alle Daten im Dashboard eines Mandanten sehen.</li>
<li>Kann Abfragen filtern, also z.B. in Hamburg nach Belieben nach Bezirk (Zuständigkeit) z.B. Altona oder Senat.
<li>Kann Auswertungen in verschiedenen Formaten herunterladen.</li>
<li>Kann andere Reporting-Administratoren für die eigenen Dashboards/Diagramme als Besitzer eintragen, um diese für die Bearbeitung, Freischaltung und Veröffentlichung zu berechtigen.</li>
<ul/>
</td>
</tr>
<tr>
<td valign="top">
EfA Cockpit Pro 
<ul>
<li>FP-VM = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)</li>
<li>FP-SB = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)</li> 
</ul>
EfA Cockpit Basis 
<ul>
<li>FP-VM-Basis = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)</li>
<li>FP-SB-Basis = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)</li>
</ul>
</td>
<td valign="top">
Sachbearbeiter
</td>
<td valign="top">
<ul>
<li>Sieht ausschließlich die vorgefilterten Daten der eigenen Zuständigkeit (also z.B. Altona).</li>
<li>Kann Auswertungen herunterladen, aber nur mit den Daten der eigenen Zuständigkeit.</li>
<li>Kann freigegebene Dashboards betrachten. </li>
<li>Kann Auswertungen filtern, wenn Filter eingerichtet wurden.</li>
<li>Kann Auswertungen in verschiedenen Formaten herunterladen.</li>
</ul>
</td>
</tr>
</table>

== Superset als zentrales Tool für Reporting-Administratoren ==

=== Übergreifende Informationen zu Superset ===
Für die Erstellung und Darstellung des Reportings wurde das Open-Source-Tool Apache Superset in das DiPlan Cockpit implementiert. Superset ist eine Reporting- und Monitoring-Technologie, die es ermöglicht komplexe Daten auf Dashboards in leicht verständlichen Visualisierungen darzustellen. Die Erstellung der Dashboards erfolgt dabei direkt in der Superset-Anwendung. Dort wird auch gesteuert, welche Dashboards mit welchen Auswertungen im DiPlan Cockpit veröffentlicht werden sollen.

=== Absprung aus dem DiPlan Cockpit zu Superset ===
Sobald eine Rolle für die Erstellung von Auswertungen berechtigt ist (zum Beispiel M-A oder FP-A), findet sich im Reiter Auswertungen automatisch der Button '''"Auswertungen konfigurieren"'''. Bei Klick öffnet sich ein weiteres Browserfenster mit der Superset-Plattform. Eine gesonderte Anmeldung in Superset ist nicht erforderlich, da die Anmeldung durch das Cockpit erfolgt (auch Single Sign-On (SSO) genannt).

'''Bitte beachten:''' Nach 4 Stunden erfolgt aus Sicherheitsgründen ein automatischer Logout aus Superset - unabhängig davon ob Sie gerade in Superset arbeiten oder nicht aktiv waren. Sie erhalten keine Warnung vor dem Logout. Deshalb empfiehlt es sich, Änderungen regelmäßig zu speichern, um zu verhindern, dass ungesicherte Abfragen verloren gehen.
[[Datei:ImageButtonAuswertungenKonfigurieren.png|zentriert|mini|766x766px|Berechtigte Personen sehen über den Dashboards im DiPlan Cockpit einen Absprungbutton zu Superset mit der Bezeichnung "Auswertungen konfigurieren."]]
[[Datei:ImageStartbildschirmSuperset.png|zentriert|mini|777x777px|Startbildschirm in Superset mit einer Vorschau auf Dashboards und Diagrammen. Die Hauptmenüpunkte zur Navigation sind am oberen Bildschirmrand zu sehen.]]

=== Auswertungen erstellen, veröffentlichen und freigeben ===
Datenvisualisierungen von Abfragen werden in Superset als '''"Diagramme"''' bezeichnet. Sobald mindestens ein Diagramm erstellt ist, kann dieses auf einem Dashboard integriert werden und mit weiteren Filtermöglichkeiten versehen werden. Wie bereits erwähnt, können Sie als '''Reporting-Administrator''' selbst nach Belieben Diagramme erstellen. Nachfolgend wird beispielhaft die Erstellung und Freigabe des Dashboards mit dem Diagramm "Verfahrensstand aller Verfahren" beschrieben, um einige der Grundfunktionalitäten in Superset zu verdeutlichen (siehe dazu das Kapitel: "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]").

=== Datensätze erstellen ===
Um ein Diagramm zu erstellen wird zunächst ein Datensatz benötigt. Für einfache Abfragen reicht der '''Verfahrensdatensatz''' aus, der bereits standardmäßig enthalten ist. Dieser entspricht der '''Tabelle "Verfahren"''' mit den '''zugehörigen Datenfeldern (Stammdaten)'''.

Für Abfragen auf dem Verfahrensdatensatz können Sie direkt zum Abschnitt "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]" springen.

Für komplexere '''Abfragen über mehrere Tabellen hinweg, eigene Metriken oder eigene berechnete Spalten''' ist die Erstellung eines eigenen Datensatzes mithilfe von SQL-Abfragen notwendig.

Folgende Informationen sind in gesonderten Tabellen enthalten:

* Gebietseinheiten
* Eigenschaften
* Kontakte
* Nutzer
* Parallelverfahren
* Termine
* Veränderungssperren
* Vertragsarten
* Vorgesehene Nutzungen
* Zurückstellungen

'''Bitte beachten:''' Bei der Erstellung von eigenen Datensätzen, muss die Spalte "'''''zustaendigkeit_code"''''' aus der Tabelle "'''''verfahren"'' immer enthalten sein,''' da hierüber die Ansicht für Sachbearbeiter standardmäßig gefiltert wird.

'''Um eigene Datensätze zu erstellen gehen Sie bitte wie folgt vor:'''

* Klick im Hauptmenü auf den '''Reiter "SQL"''' und im zugehörigen Dropdown-Menü auf '''"SQL Lab".'''
[[Datei:ImageStartSQLLab.png|zentriert|mini|854x854px|Startansicht SQL Lab]]
* Erstellen Sie Ihre '''SQL-Abfrage''' und klicken Sie auf den '''Button "Ausführen"''', um eine Vorschau auf die Ergebnisse der Abfrage zu erhalten. Ein rotes Kreuzchen links vom SQL-Editor weist auf Fehler im SQL hin.
[[Datei:ImageAusfuehrenSQLLab.png|zentriert|mini|846x846px|Ausführen einer SQL Abfrage im SQL Lab]]
'''Typische Anwendungsfälle und die dazugehörigen SQL Abfragen könnten z.B. sein:'''

* Sie möchten, dass Ihre Abfragen z.B. nach "Gebietseinheiten" und "Vorgesehenen Nutzungen" gefiltert werden können:

{| class="wikitable"
|
SELECT v.*, g.gebietseinheit, vn.vorgesehene_nutzungen
FROM verfahren v
LEFT JOIN gebietseinheiten g ON g.verfahren_id = v.id
LEFT JOIN vorgesehene_nutzungen vn ON vn.verfahren_id = v.id;
|}

* Sie möchten, dass Ihr Datensatz bestimmte Termine enthält (z.B. Grobabstimmungsdatum, Vorweggenehmigungsreife):

{| class="wikitable"
|
WITH grobabstimmung_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Grobabstimmung'
),
vorweggenehmigungsreife_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Vorweggenehmigungsreife'
)
SELECT
v.*,
t1.beginn AS grobabstimmung,
t2.beginn AS vorweggenehmigungsreife
FROM verfahren v
LEFT JOIN grobabstimmung_termin t1 ON t1.verfahren_id = v.id
LEFT JOIN vorweggenehmigungsreife_termin t2 ON t2.verfahren_id = v.id;
|}

* Sie möchten, dass Ihr Datensatz bestimmte Mandanten spezifische Stammdaten enthält. Nachfolgend ein Beispiel für Stammdaten vom Typ Text, Ganzzahl und Zeitraum:

{| class="wikitable"
|
WITH kommentar_eigenschaft AS (
SELECT e.id, e.text, e.verfahren_id
FROM eigenschaft e
WHERE e.name = 'Kommentar'
),
kennzahl_eigenschaft AS (
SELECT e.id, e.ganzzahl, e.verfahren_id
FROM eigenschaft e
WHERE e.name = 'Kennzahl'
),
zeitraum_eigenschaft AS (
SELECT e.id, e.datum, e.enddatum, e.verfahren_id
FROM eigenschaft e
WHERE e.name = 'Zeitraum'
)
SELECT
v.*,
e1.text AS kommentar,
e2.ganzzahl AS kennzahl,
e3.datum AS zeitraum_beginn,
e3.enddatum AS zeitraum_ende
FROM verfahren v
LEFT JOIN kommentar_eigenschaft e1 ON e1.verfahren_id = v.id
LEFT JOIN kennzahl_eigenschaft e2 ON e2.verfahren_id = v.id
LEFT JOIN zeitraum_eigenschaft e3 ON e3.verfahren_id = v.id;
|}
* '''Speichern Sie Ihre Abfrage als Datensatz''' ab, indem Sie auf den '''Dropdown-Pfeil neben dem Button "Speichern"''' klicken und dann '''"Datensatz speichern"''' auswählen. Es öffnet sich ein Dialogfeld, in dem Sie einen Namen für Ihren Datensatz vergeben können.
** Hinweis: Wenn Sie statt auf "Datensatz speichern" auf "Speichern" klicken, finden Sie Ihre SQL Abfrage unter dem Reiter '''"Gespeicherte Abfragen"''' wieder.
[[Datei:ImageSpeichernDatensatzSuperset.png|zentriert|mini|891x891px|Speichern eines neuen Datensatzes]]
Nach der Erstellung eines Datensatzes können Sie diesen noch weiter bearbeiten und Labels, eigene Metriken oder berechnete Spalten hinzufügen. Gehen Sie dazu wie folgt vor:
* Klick im Hauptmenü auf den '''Reiter "Datensätze"'''. Hier sind die verfügbaren Datensätze aufgelistet.
* Klicken Sie ganz rechts neben dem Datensatz, den Sie bearbeiten wollen, auf das '''Stift-Symbol.''' Es öffnet sich eine Bearbeitungsmaske.
[[Datei:ImageBearbeitungDatensatzSuperset.png|zentriert|mini|890x890px|Öffnen Sie den Bearbeitungsmodus durch Klick auf das Stiftsymbol]]
*'''Reiter "Quelle":''' Hier kann die zugrundeliegende SQL Abfrage nachträglich angepasst werden. Klicken Sie hierfür auf das Schloss-Symbol.
[[Datei:ImageReiterQuelleSuperset.png|zentriert|mini|879x879px|Im Reiter "Quelle" kann das SQL nachträglich angepasst werden]]
*'''Reiter "Metriken":''' Hier können eigene Metriken angelegt werden.
[[Datei:ImageReiterMetrikenSuperset.png|zentriert|mini|878x878px|Eine neue Metrik "Anzahl Verfahren" wird hinzugefügt]]
*'''Reiter "Spalten":''' Hier sind alle im Datensatz enthaltenen Spalten aufgeführt. An den Werten in der Tabelle ("Datentyp", "Ist zeitlich" etc.) sollte in der Regel nichts geändert werden, dies wird von Superset automatisch richtig erkannt. Beim '''Klick auf das "Plus"''' neben jeder Spalte kann unter "Beschriftung" ein sprechendes Label hinzugefügt werden. Dieses wird später in den Diagrammen angezeigt.
[[Datei:ImageReiterSpaltenSuperset.png|zentriert|mini|877x877px|Im Reiter "Spalten" wird ein Label hinzugefügt]]
*'''Reiter "Berechnete Spalten":''' Hier können dem Datensatz weitere Spalten hinzugefügt werden, die Werte enthalten, die aus anderen Spalten errechnet werden. Verwenden Sie für die Berechnung SQL-Syntax.
[[Datei:ImageReiterBerechneteSpaltenSuperset.png|zentriert|mini|851x851px|Eine berechnete Spalte wird hinzugefügt]]
* Speichern Sie Ihre Änderungen am Datensatz durch das '''Klicken auf den "Speichern"-Button'''. Um die Änderungen zu prüfen, empfiehlt es sich ein Diagramm mit dem Datensatz anzulegen (z.B. eine Tabelle).

=== Beispiel-Diagramm erstellen ===
Nachfolgend soll beispielhaft ein Diagramm "Verfahrensstand aller Verfahren" erstellt werden. Dazu gehen Sie wie folgt vor:

# Klick auf den '''Menüpunkt "Diagramme":''' Auf dieser Seite findet sich eine Liste mit allen bereits erstellten Diagrammen. Innerhalb dieser Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Diagramm-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageUebersichtDiagrammeSuperset.png|zentriert|mini|860x860px|Im Menüpunkt "Diagramme" findet sich eine Übersicht über die bisher erstellten Diagramme (Abfragen) mit vielen Zusatzinformationen.]]
# Um ein neues Diagramm zu erstellen klicken Sie auf den '''Button "+Diagramm"''' rechts oben. Es öffnet sich der Dialog '''"Neues Diagramm erstellen".'''[[Datei:ImageNeuesDiagrammSuperset.png|zentriert|mini|860x860px|Dialog um ein neues Diagramm zu erstellen]]
# Zunächst muss der '''passende Datensatz für die Auswertung ausgewählt''' werden. Für dieses Beispiel wählen wir unter '''"1- Datensatz auswählen"''' den Datensatz '''"verfahren"''' im Dropdownmenü aus.
# Im nächsten Schritt wird der '''passende Diagrammtyp ausgewählt'''. Hier werden Ihnen viele verschiedene Visualisierungsmöglichkeiten geboten. Im genannten Beispiel passt ein "Kreisdiagramm" am besten zu der Visualisierung der Verfahrensstände aller Verfahren. Sie finden das Kreisdiagramm unter dem Hauptmenü "Teil des Ganzen". Klicken Sie '''auf das Kreisdiagramm''' und anschließend auf '''"Neues Diagramm erstellen"'''.
# Nun geht es um die '''Detailkonfiguration''' des Diagramms. Grundsätzlich ist der Arbeitsbereich wie folgt aufgebaut:
#* Die linke Spalte enthält einen '''Überblick''' über die '''zur Verfügung stehenden Daten'''.
#* Die mittlere Spalte enthält die '''Werkzeuge''', um das '''Diagramm zu konfigurieren.'''
#* Im rechten Bereich kann man sich jeweils eine '''Vorschau des Diagramms''' anzeigen lassen.
'''Wir gehen für unser Beispiel wie folgt vor:'''

* Im Feld '''"Name des Diagramms hinzufügen"''' das Diagramm mit einer passenden Bezeichnung versehen.
* Um die Dimensionen des Diagramms festzulegen im Tab '''"Daten"''' unter der Überschrift '''"Abfrage > Dimensionen"''' die Spalte '''"verfahrensstand"''' von links per Drag & Drop herüberziehen.
* Der dazustellende Wert soll hier die Anzahl sein, weshalb nun unter '''"Metrik"''' das Feld '''"Anzahl"''' Button "+Diagramm" per Drag & Drop von links herübergezogen wird. Je nach Fragestellung bzw. welche Daten auf dem Diagramm dargestellt werden sollen, können verschiedenste Kombinationen in der selben Art und Weise über Drag & Drop zusammengestellt werden.
* Unter dem '''Punkt "Filter"''' kann eine Vorabfilterung eingebaut werden, also beispielsweise könnten Sie simulierte Verfahren standardmäßig herausfiltern, so dass die Nutzenden diese gar nicht auswerten können. Anmerkung: "imported_at" kann nicht gelöscht werden. Dieser Wert wird von Superset standardmäßig gesetzt und hat keine Auswirkung auf Ihre Auswertungen.
* Das für die Berechnung zugrundeliegende Zeilenlimit kann bei Bedarf verändert werden.
* Ein Klick auf den '''blauen Button "Diagramm erstellen"''' zeigt eine '''Vorschau''' des erstellten Diagrammes auf der rechten Bildschirmhälfte. Das Diagramm kann nun jederzeit mit einem '''Klick auf "Speichern"''' rechts oben gesichert werden.[[Datei:ImageDiagrammErstellenSuperset.png|zentriert|mini|880x880px|Dialog zur Detaildefinition des neuen Diagramms. Hier beispielhaft zusammengestellt für die Darstellung "Verfahrenstand aller Verfahren".]]

* Unter dem '''Tab "Anpassen"''' finden sich zahlreiche Möglichkeiten, das Diagramm weiter zu verfeinern (zum Beispiel in Farbe und Layout). Hier kann ganz nach Belieben ausprobiert werden. Mit '''Klick auf''' '''"Diagramm aktualisieren"''' kann die Vorschau des Diagramms zur Überprüfung mit den neu gewählten Einstellungen geladen werden.[[Datei:ImageDiagrammAnpassenSuperset.png|zentriert|mini|900x900px|Diagramm kann nach Belieben im Tab "Anpassen" verändert und verfeinert werden.]]
* '''Speichern nicht vergessen:''' Das Diagramm wird erst gespeichert durch '''Klick auf "Speichern" rechts oben'''. Es öffnet sich ein Dialog zu weiteren Speicheroptionen, der mit '''einer weiteren Speicherbestätigung''' abgeschlossen werden kann.[[Datei:ImageDiagrammSpeichernSuperset.png|zentriert|mini|874x874px|Speichern-Dialog für das erstellte Diagramm]]

=== Beispiel-Dashboard erstellen ===

# '''Klick auf den Menüpunkt "Dashboards":''' Unter der Überschrift "Dashboards" findet sich eine Liste mit allen bereits erstellten Dashboards. Diese Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Dashboard-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageDashboardsSuperset.png|zentriert|mini|866x866px|Unter dem Menüpunkt "Dashboards" finden sich alle bereits angelegten Dashboards, sowie die Möglichkeit neue Dashboards zu erstellen.]]
# Mit Klick auf den Button '''"+Dashboard"''' rechts oben öffnet sich ein neuer, leerer Dashboard -Entwurf.
# Der Titel des Dashboards ist standardmäßig als "untitled dashboard" angeben und kann durch '''Klick auf den Namen''' geändert werden.
# Auf der Seitenleiste am rechten Bildschirmrand finden sich alle bereits erstellten Diagramme. Das gewünschte Diagramm kann einfach durch '''Drag & Drop mit der Maus auf das Dashboard gezogen''' werden. Auch die Größe kann leicht geändert werden indem sie die Ränder oder Ecken des Diagramms klicken, gedrückt halten und auf die gewünschte Größe ziehen. Sie können ein oder auch mehrere Diagramme auf einem Dashboard platzieren.
# Zu guter Letzt oben rechts auf den '''Button "Speichern"''' klicken um Ihre Arbeit zu sichern. Nach dem Speichern können Sie jederzeit am Dashboard weiter arbeiten indem Sie auf den nun erscheinenden Button '''"Dashboard bearbeiten"''' klicken.
# Sollten Sie ein Diagramm wieder vom Dashboard löschen wollen, können Sie einfach das '''Mülleimer-Symbol''' klicken, welches bei Mouseover über das jeweilige Diagramm erscheint.[[Datei:ImageDragDropDiagrammSuperset.png|zentriert|mini|804x804px|Das gewünschte Diagramm kann mit der Maus einfach auf das Dashboard gezogen und platziert werden.]]
[[Datei:ImageDiagrammGroesseSuperset.png|zentriert|mini|761x761px|Die Größe des Diagramms lässt sich einfach durch Ziehen der Maus an Ecken oder Rändern verändern.]]

=== Einen oder mehrere Filter zu einem Dashboard zufügen ===
Es ist möglich Ihre Auswertungsdiagramme mit Filtermöglichkeiten zu versehen. Im folgenden wird beispielhaft ein Filter nach der Zuständigkeit auf dem Dashboard "Verfahrensstand aller Verfahren" hinzugefügt:

# Öffnen Sie das Dashboard oder legen Sie sich ein entsprechendes neues Dashboard an und speichern dieses.
# An der linken Bildschirmkante den '''kleinen Pfeil klicken''', um das Filtermenü auszuklappen. '''Wichtig:''' Der Pfeil ist nur sichtbar, wenn das Dashboard bereits gespeichert ist und sich nicht gerade im offenen Bearbeitungsmodus befindet. Sprich: Klicken Sie '''nicht''' "Dashboard bearbeiten" bevor Sie den Filter hinzufügen.
# Klicken Sie auf das '''kleine Zahnrad''' um das Untermenü zu öffnen.
# Ein Klick auf '''"Hinzufügen und Bearbeiten von Filtern"''' öffnet das Menü um die Filter zu konfigurieren.[[Datei:ImageDashboardFilterMenueSuperset.png|zentriert|mini|800x800px|Durch Klick auf den kleinen Pfeil öffnet sich das Menü, mit dem Filter hinzugefügt und konfiguriert werden können.]]
# Um nach der Zuständigkeit zu filtern muss im '''Menü Filtertyp die Option "Wert"''' ausgewählt sein.
# Im Menüpunkt Tabellenname '''"Zuständigkeit"''' als '''Namen des Filters''' eintragen.
# Im '''Feld Datensatz''' wird in diesem Fall '''"verfahren"''' ausgewählt.
# Im '''Feld "Spalte"''' den Filter auswählen, nach dem gefiltert werden soll: in diesem Fall '''"zustaendigkeit".'''
# Das Menü '''"Filterwerte sortieren"''' durch einen Haken aktivieren und absteigend sortieren und mit der '''Sortiermetrik "Anzahl"''' versehen.
# Im '''Reiter "Auswahlverfahren"''' kann der Filter durch eine Auswahl außerdem auf '''einzelne Diagramme oder auf alles bezogen''' werden.
# Durch '''Klick auf "Speichern"''' rechts unten wird der Filter in das Dashboard integriert.[[Datei:ImageFilteroptionenDashboardSuperset.png|zentriert|mini|712x712px|Sie können einen oder mehrere Filteroptionen auf einem Dashboard integrieren und in diesem Menü konfigurieren.]]
'''Übergeordnete Filtereinstellungen:'''

Nach '''Klick auf das Zahnrad''', im geöffneten Filter-Untermenü, können Sie außerdem entscheiden, ob der Filter '''oben''' über dem Diagramm '''oder seitlich links einklappbar''' angezeigt werden soll.

Es gibt dort außerdem die Möglichkeit für ein oder mehrere Diagramme eine '''Kreuzfilterung zu aktivieren.''' Diese erlaubt es Ihnen, direkt '''in einem Diagramm auf ein Element zu klicken''', um damit automatisch eines oder alle Diagramme im Dashboard zu filtern. So können Daten intuitiv und interaktiv erkundet werden, ohne separate Filtersteuerungen zu verwenden.
[[Datei:ImageFilterUntermenueSuperset.png|zentriert|mini|767x767px|Im Filter-Untermenü können bestehende Filter bearbeitet oder weitere Filter hinzugefügt werden. Außerdem kann die Kreuzfilterung aktiviert und die Darstellung der Filterleiste verändert werden.]]

=== Dashboards veröffentlichen ===
Dashboards werden erst im DiPlan Cockpit sichtbar, nachdem diese veröffentlicht und für die Sachbearbeitenden und Reporting-Administratoren freigeschalten wurden. Dabei gilt es zu beachten, dass Sie nur Dashboards veröffentlichen und freischalten können, die Sie selbst erstellt haben oder für die Sie berechtigt worden sind. Siehe hierzu auch das Kapitel "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Diagramme_und_Dashboards_f.C3.BCr_andere_Reporting-Administratoren_zur_Bearbeitung_freigeben Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben]".

'''Zur Veröffentlichung und Freischaltung gehen Sie wie folgt vor:'''

# Öffnen Sie das Dashboard, welches veröffentlicht werden soll.
# Durch Klick auf das '''graue Feld "Entwurf"''' neben dem Dashboard Namen, ändert sich die Bezeichnung auf '''"Veröffentlicht".'''[[Datei:ImageStatusVeroeffentlichtSuperset.png|zentriert|mini|911x911px|Durch Klick ändert sich der Status von "Entwurf" auf "Veröffentlicht".]]
# Öffnen Sie rechts oben das '''Dreipunktemenü''' und wählen Sie dort den Unterpunkt '''"Dashboard einbetten"''' aus.[[Datei:ImageDashboardEinbettenSuperset.png|zentriert|mini|942x942px|Im Dreipunktemenü muss im nächsten Schritt der Punkt "Dashboard einbetten" geklickt werden.]]
# Im Einbetten-Dialog lassen Sie das Feld für "Zulässige Domänen" bitte einfach frei und klicken lediglich den '''Button "Einbettung aktivieren".''' Dann kann das Menü durch Klick auf das '''X-Symbol''' geschlossen werden.[[Datei:ImageEinbettungAktivierenSuperset.png|zentriert|mini|869x869px|Im Menü "Einbetten" klicken Sie auf "Einbettung aktivieren" und dann einfach auf das X um das Fenster zu schließen.]]
# Um das Dashboard nun für die '''Rolle der Sachbearbeitenden und Mandanten-Administratoren''' im DiPlan Cockpit '''freizugeben''' öffnen Sie bitte erneut den Reiter '''"Dashboards",''' um auf die Liste mit allen Dashboards zu gelangen.
# Klicken Sie auf das '''Stift-Symbol''' neben dem Dashboard, welches freigeschalten werden soll.[[Datei:ImageDashboardEigenschaftenOeffnenSuperset.png|zentriert|mini|843x843px|Durch Klick auf das Stiftsymbol neben dem Dashboard werden die Dashboardeigenschaften geöffnet. Dort können auch die einzelnen Rollen freigeschaltet werden.]]
# In den '''Dashboardeigenschaften''' können nun die Rollen eingetragen werden, für die das Dashboard freigeschalten werden soll. Die Rollenbezeichnungen in Superset fassen mehrere Rollen aus dem DiPlan Cockpit zusammen, was die Freigabe von Dashboards vereinfacht. Bitte tragen Sie im Feld "Rollen" deshalb '''"Reporting-Administrator"''' und '''"Sachbearbeiter" in der Liste ein.''' Dies ist durch Tippen in das Feld möglich, so wird die auszuwählende Rolle schneller sichtbar. Sie können jedoch auch manuell durch die Liste scrollen und die Rolle auswählen. Klicken Sie anschließend den '''"Speichern"-Button'''. Die Auswertungen sind nun im DiPlan Cockpit für alle berechtigten Rollen sichtbar.[[Datei:ImageDashboardEigenschaftenRollenSuperset.png|zentriert|mini|695x695px|In den Dashboardeigenschaften müssen die Rollen, für die das Dashboard freigegeben werden soll, ausgewählt werden.]]
'''Hinweis: Veröffentlichung zurücknehmen'''

Sollten Sie ein Dashboard im DiPlan Cockpit unsichtbar machen wollen, so klicken Sie wie im Punkt 2 beschrieben wieder auf die graue Schaltfläche und setzen Sie den Status von '''"Veröffentlicht"''' zurück auf '''"Entwurf".'''

=== Bestehendes Dashboard oder Diagramm bearbeiten oder löschen ===
'''Wie lösche ich ein eingebettetes Diagramm von einem bereits veröffentlichten und freigegebenen Dashboard?'''

* Öffnen Sie das Dashboard und '''klicken Sie "Dashboard bearbeiten"''' auf der rechten Bildschirmseite.
* Im geöffneten Bearbeitungsmodus können Sie nun die Maus über das nicht mehr erwünschte Diagramm bewegen und durch '''Klick auf das erscheinende Mülleimersymbol''' löschen. Das Diagramm bleibt in der Liste der Diagramme weiterhin erhalten und wird lediglich vom Dashboard genommen.
* Sie können ein '''weiteres/neues Diagramm''' jederzeit wieder aus der Liste rechts auf das Dashboard ziehen.
* Bestätigen Sie das veränderte Dashboard durch Klick auf den "'''Speichern"-Button''' rechts oben.
* '''Bitte beachten:''' Änderungen an bereits veröffentlichten und freigegebenen Dashboards werden nach dem '''Speichern direkt auf dem DiPlan Cockpit sichtbar'''.
[[Datei:ImageDashboardDiagrammLoeschenSuperset.png|zentriert|mini|736x736px|Per Mouseover und Klick auf das Mülleimer Symbol lassen sich Diagramme auf Dashboards einfach wieder löschen.]]
'''Wie bearbeite ich ein bestehendes Diagramm?'''

Ein Diagramm unabhängig vom Dashboard ändern:

* Öffnen Sie das zu bearbeitende Diagramm in der '''Liste der Diagramme''' durch einen '''Klick auf den Namen'''.
* Das Diagramm öffnet sich direkt im Bearbeitungsmodus und kann nach '''Belieben angepasst werden'''.
* Ist das Diagramm bereits auf einem veröffentlichten und freigegebenen Dashboard eingebettet, so werden alle Änderungen nach dem Speichern direkt übernommen und im '''DiPlan Cockpit sichtbar'''.

Ein Diagramm direkt auf einem Dashboard ändern:

* Öffnen Sie das Dashboard und klicken Sie '''"Dashboard bearbeiten"'''.
* Bewegen Sie die Maus über die entsprechende Grafik, öffnen Sie das Dreipunktemenü rechts und klicken '''"Diagramm bearbeiten".'''
* Nachdem Sie das Diagramm bearbeitet haben klicken Sie '''"Speichern"'''.

'''Bitte beachten:''' Im Speichern-Dialog können Sie entscheiden, ob sie das bestehende '''Diagramm überschreiben''' oder ein '''neues Diagramm speichern''' wollen. Dies kann hilfreich sein, wenn Sie das Diagramm nicht generell, sondern nur auf einem bereits bestehenden Dashboard ändern wollen.
[[Datei:ImageDiagrammSpeichernÜberschreibenSuperset.png|zentriert|mini|792x792px|Es ist möglich direkt beim Speichern ein neues Diagramm zu erstellen oder das bereits bestehende zu überschreiben.]]

'''Wie lösche ich ein Dashboard oder Diagramm dauerhaft?'''

Sie können ein Dashboard unabhängig vom Status (also veröffentlicht oder auch als Entwurf) in der Liste der Dashboards wie folgt löschen:

* Bewegen Sie die Maus über den entsprechenden '''Listeneintrag.'''
* Klicken Sie das in der Zeile rechts erscheinende '''Papierkorb-Symbol''' und folgen den Anweisungen im erscheinenden Löschdialog.
* Die Originaldiagramme auf dem Dashboard bleiben dabei weiterhin in der Liste "Diagramme" erhalten.
* Sollten Sie ein Diagramm dauerhaft löschen wollen, so gehen Sie genauso wie beim Dashboard vor, jedoch im '''Reiter "Diagramme"'''.

=== Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Bitte beachten:''' Solange Reporting-Administratoren nicht als Besitzer eingetragen sind, haben diese nur Zugriff auf die eigenen erstellten Daten.

'''Das bedeutet konkret für die erstellten Daten von anderen Reporting-Administratoren:'''

* Unveröffentlichte Dashboards sind nicht sichtbar.
* Veröffentlichte Dashboards sind sichtbar, aber nicht bearbeitbar.
* Alle Diagramme sind sichtbar, Änderungen können jedoch nur als neue Diagramme gespeichert werden.
* Datensätze sind sichtbar und können verwendet, aber nicht bearbeitet werden.
* Gespeicherte Abfragen sind nicht sichtbar (Berechtigungen können hier grundsätzlich nicht vergeben werden).

Sie haben grundsätzlich keine Rechte ein Dashboard zu bearbeiten oder ein Diagramm zu überschreiben, welches nicht von Ihnen erstellt wurde, außer Sie wurden als '''"Besitzende/r"''' dazu ermächtigt.

Das bedeutet beispielsweise, dass Sie ein Diagramm, welches jemand anders erstellt hat, zwar bearbeiten, dies aber nur als neues Diagramm abspeichern können. Das Originaldiagramm wird hier nicht verändert. Um jemanden für die '''Mitarbeit an Ihrem Diagramm oder Dashboard zu ermächtigen''' gehen Sie wie folgt vor:

* Klicken Sie in der Liste der Diagramme oder Dashboards auf das '''Stift-Symbol "Bearbeiten".''' Der Dialog '''"Diagrammeigenschaften bearbeiten"''' öffnet sich.
* Unter der '''Überschrift "Zugang"''' können weitere '''"Besitzende" eingetragen''' werden. Klicken Sie hierzu in das Eingabefeld und fangen Sie an den Namen zu tippen oder scrollen Sie durch die Liste bis zum gewünschten Namen.
* '''Wählen Sie einen oder mehrere Namen aus,''' um diese in das Feld zu übernehmen und klicken Sie dann auf '''"Speichern"'''. Die eingetragene Person hat nun die gleichen '''Rechte zur Bearbeitung wie der/die ursprüngliche Ersteller/in'''.[[Datei:ImageDiagrammZugangBesitzendeSuperset.png|zentriert|mini|677x677px|Unter "Zugang" können Sie andere Mandanten-Administratoren für die Bearbeitung Ihrer Dashboards oder Diagramme berechtigen.]]

=== Datensätze für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Um Datensätze für andere Reporting-Administratoren zur Bearbeitung freizugeben, gehen Sie wie folgt vor:'''

* Klick auf den '''Reiter "Datensätze"'''
* In der Übersicht-Liste klicken Sie bitte das '''Stift- Symbol''' neben dem gewünschten Datensatz.
* Klicken Sie den '''Reiter "Einstellungen"''' ganz rechts und scrollen Sie ganz nach unten.
* Dort können Sie im '''Feld "Besitzende"''' auch andere Reporting-Administratoren zur Bearbeitung berechtigen.
[[Datei:ImageDatensatzBesitzendeSuperset.png|zentriert|mini|810x810px|Auch Datensätze können zur Bearbeitung an andere Mandanten-Administratoren freigegeben werden.]]

== Weiterführende Informationen ==
Unter folgendem Link können Sie weitere Informationen zu Superset in englischer Sprache finden. Bitte beachten Sie, dass Ihre Datenbank bereits angebunden ist und der Punkt "Connecting to a new database" in der Dokumentation somit nicht beachtet werden sollte: '''[https://superset.apache.org/docs/6.0.0/using-superset/creating-your-first-dashboard#creating-your-first-dashboard Englische Dokumentation des Open-Source-Tools Superset]'''

Aufgabenverwaltung

2026-04-27T06:30:40Z

Diplanung: /* Neuen Durchgang hinzufügen */

Zu jedem Verfahrensteilschritt in der Zeitplanung gibt es Aufgaben, die durchlaufen werden sollen, damit der Verfahrensteilschritt abgeschlossen wird. Um die Aufgaben zu betrachten, klicken Sie am Verfahren auf den Reiter Zeitplanung. Sie befinden sich nun im ersten Verfahrensschritt des ausgewählten Verfahrens. Alternativ können Sie im oberen Zeitstrahl einen spezifischen Verfahrensschritt auswählen, um direkt zu den zugehörigen Aufgaben zu kommen.

=== Aufbau des Reiters Aufgaben ===
Die Seite ist nun in zwei Bereiche unterteilt. Auf der linken Seite sehen Sie die Termine des Verfahrensteilschritts. Unter den Terminen befinden sich die Unterverfahrensteilschritte. Je nach Verfahrenskonfiguration sind diese bereits vorhanden oder sie können sich aus einer Liste von Unterverfahrensteilschritten den für Sie relevanten Unterverfahrensteilschritt auswählen.

Im rechten Bereich der Seite sehen Sie die eigentlichen Aufgaben. Welche Aufgaben gerade angezeigt werden, ist abhängig vom aktuell ausgewählten Unterverfahrensteilschritte. Der Aufgabenbereich unterteilt sich in die Bereiche „Offen“, „Erledigt“ und „Alle“. Standardmäßig ist der Bereich „Alle“ ausgewählt, in dem sowohl offene als auch erledigte Aufgaben angezeigt werden.

=== Aufgaben bearbeiten ===
Um eine Aufgabe zu bearbeiten, klicken Sie auf diese in der Aufgabenliste. Es öffnen sich nun die einzelnen Unteraufgaben, die es für ein Aufgabe zu erledigen gilt.

Folgende Aufgabentypen können von Ihnen vorgenommen werden:

* '''Aufgaben zum Abhaken:''' Sie können für ein To-Do des Unterverfahrensteilschritts eine Checkbox abhaken, um die Aufgabe es erledigt zu markieren
* '''Aufgaben mit Textfeldern:''' In Textfeldern können Sie Informationen zur Aufgabe festhalten. Denkbare wäre ein Kommentarfeld beim Dokumentieren des Ergebnisses eines Unterverfahrensteilschrittes oder das Festhalten von relevanten Kontaktpersonen
* '''Dokument hochladen:''' Über einen Button können Sie ein Dokument direkt an das Verfahren hochladen
* '''Dokument generieren:''' Über einen Button wird ein Word-Dokument aus einer Vorlage generiert, welches beim Speichern direkt am Verfahren gespeichert wird, ohne dass ein Upload des Dokuments notwendig ist. Die Pflege der Vorlage erfolgt über die fachliche Leitstelle.
* '''E-Mail versenden:''' Es besteht auch die Möglichkeit, E-Mails mit Dokumenten am Verfahren zu generieren. In einem Dialog können Dokumente für den Anhang ausgewählt werden. Danach wird automatisch eine E-Mail heruntergeladen, die danach nur noch ausformuliert und an die entsprechenden Empfänger verschickt werden muss. Dadurch entfallen das manuelle Suchen, Herunterladen und Anhängen von wichtigen Dateien. Pro Verfahren wird für jede Aufgabe für den E-Mailversand die Dokumentenauswahl nutzerübergreifend gespeichert.
* '''Termine eintragen:''' Über ein Datumsfeld kann ein Termin ausgewählt werden. Dabei kann es sich um einen Termin aus der Zeitplanung handeln. Wenn beim Einstellen des Zeitpunktes sich dieser von dem in der Zeitplanung unterscheidet, so wird automatisch der Dialog ausgespielt, der fragt, ob durch die Änderung am Termin die Zeitplanung neu berechnet werden soll. Je nach Art der Aufgabe kann sich auch der Status des Termins des Verfahrensteilschritt im linken Bereich ändern. Lautetet also eine Aufgabe, einen Termin zu planen, ändert sich der Status dieses Termins nach Erledigung der Aufgabe in „geplant“. Wird in der nächsten Aufgabe dann das Datum für das Stattfinden des Termins festgehalten, so wechselt der Status des Termins in „stattgefunden“. So behalten Sie die Übersicht über alle relevanten Termin und deren Status.
* '''Fachliche Ordner:''' Fachliche Ordner sind eine Sammlung von Verfahrensdokumenten, die einer bestimmten Fachlichkeit (z.B. Umweltordner, Feststellungsordner) zugeordnet sind und dort gesammelt und dann aus dem Cockpit ausgeleitet werden, um sie an Drittsystem weiterzugeben. Voraussetzung ist dafür, dass die Dokumente mit der entsprechenden Vormerkung versehen wurden. Die Vormerkung kann entweder im Dokumentenbereich oder beim Hochladen bzw. Generieren eines Dokuments im Aufgabenbereich gesetzt werden. Wird die Aufgabe für den fachlichen Ordner manuell erstellt, so kann ausgewählt werden, welche Vormerkung als Filterung vor eingestellt und welche Verfahrensunterlagentyp als obligatorisch definiert werden soll:[[Datei:Aufgabe fachlicher Ordner erstellen.png|zentriert|mini|500x500px|Aufgabe fachlicher Ordner erstellen]]Alternativ wird die Aufgabe über die Verfahrenskonfiguration gesteuert und konfiguriert. Nun können die Dokumente ausgewählt werden, indem bei der Aufgabe auf den entsprechenden Button geklickt wird:[[Datei:Aufgabe fachlicher Ordner.png|zentriert|mini|500x500px|Aufgabe fachlicher Ordner]]Aus den Dokumentenordner können nun die gewünschten Dokumente ausgewählt werden. Bei vielen Dokumenten erleichtert eine Such- und Filterfunktion das Auffinden der benötigten Dokumente. Die Dokumente müssen dabei den Status '''final''' haben, um für einen fachlichen Ordner ausgewählt werden zu können:[[Datei:Dokumente für fachlichen Ordner auswählen.png|zentriert|mini|500x500px|Dokumente für fachlichen Ordner auswählen]]Sobald die Dokumente ausgewählt wurden, wird der fachliche Ordner erzeugt. Dieser Prozess findet im Hintergrund statt und kann je nach der Anzahl und Größe der Dokumente entsprechend mehr Zeit in Anspruch nehmen. Nach Abschluss steht der fachliche Ordner im Dokumentenbereich zur Verfügung:[[Datei:Fachlicher Ordner im Dokumentenbereich.png|zentriert|mini|500x500px|Fachlicher Ordner im Dokumentenbereich]]Der fachliche Ordner kann nun als .zip-Datei heruntergeladen werden. In der .zip-Datei werden die Dokumente entsprechend dem Verfahrensteilschritt in Unterordnern sortiert. Einen Sonderfall bildet die Ordner "Übergreifende Dokumente" und "Vorhabens- und Antragsdokumente", die jeweils einen eigenen Ordner unabhängig der Verfahrensteilschritte erhalten.[[Datei:Strukturierung des fachlichen Ordners als .zip-Datei.png|zentriert|mini|500x500px|Strukturierung des fachlichen Ordners als .zip-Datei]]Über die Aufgabe des fachlichen Ordners können jederzeit Dokumente hinzugefügt oder entfernt werden. Beim Ausführen der Aufgabe wird dann der fachliche Ordner entsprechend aktualisiert und die neue .zip-Datei kann heruntergeladen werden.
* '''Beteiligungsverfahren einrichten:'''
** Unter „Beteiligungsverfahren konfigurieren“ kann das Verfahren automatisch nach DiPlanBeteiligung übertragen werden: Voraussetzung ist ein veröffentlichtes Planwerk und ein finales Dokument im Dokumentenbereich als ergänzende Unterlage.
** Das Planwerk muss entweder vorab veröffentlicht oder direkt während der Aufgabe über den Reiter Planwerke hochgeladen und veröffentlicht werden.
** Planungsanlass und Geltungsbereich werden aus den Stammdaten befüllt, die Felder können aber hier noch vorher angepasst werden.
** Dokumente können über den ersten Button aus dem Dokumentenbereich ausgewählt werden. Das Dokument muss final sein, um auswählbar zu sein. Über den zweiten Button können Dokumente direkt hochgeladen werden. Hierbei kann der Unterlagentyp bestimmt werden.
** Erst wenn die Dokumente final gesetzt sind und das Planwerk veröffentlicht ist, kann das Beteiligungsverfahren eingerichtet werden.
** Wenn sich der Verfahrensstand des Verfahrens geändert hat oder die für die Beteiligung relevanten Dokumente aktualisiert wurden, kann über diesen Weg auch das Beteiligungsverfahren aktualisiert werden.

=== Aufgaben als erledigt markieren ===
Sie entscheiden aber jederzeit selbst, ob die Termine oder Aufgaben eines Unterverfahrensteilschritts relevant für Ihr Verfahren sind. Sie müssen nicht alle angezeigten Unteraufgaben erledigen. Wenn Sie der Auffassung sind, dass eine von drei erledigten Unteraufgaben genügt, können Sie die Aufgabe als erledigt markieren. Die Unteraufgaben dienen Ihnen als Hilfestellung und Erinnerungsstütze.

Je detaillierter Sie Aufgaben in der Anwendung dokumentieren, desto größer ist das weitere Nutzungspotenzial für Ihre Kolleginnen und Kollegen.

* Als „erledigt“ markieren Sie Aufgaben per Klick auf das links angezeigte Häkchen.
* Eine erfolgreich bearbeitete Aufgabe wird in der Folge mit einem grünen Häkchen angezeigt.
* Sie können die Markierung auch jederzeit über einen erneuten Klick auf das grüne Häkchen wieder entfernen.

Der Bearbeitungsstand lässt sich auch in der linken Ansicht (Unterverfahrensteilschritte) einsehen.

* Offene Unterverfahrensteilschritte, bei denen noch alle Aufgaben unbearbeitet sind, sind mit einem hellgrauen Punkt versehen.
* Begonnene Unterverfahrensteilschritte mit bereits in Teilen erledigten Aufgaben sind mit einem dunkelgrauen Punkt versehen.
* Erledigte Unterverfahrensteilschritte, bei denen alle Aufgaben abgeschlossen wurden, sind mit einem grünen Punkt versehen.
Sind alle Aufgaben in allen Unterverfahrensteilschritten des aktuellen Durchgangs erledigt, so wird in der Verfahrensübersicht der gesamte Verfahrensteilschritt grün markiert.

=== Aufgaben zu einem Unterverfahrensteilschritt hinzufügen ===
Für die Unterverfahrensteilschritte wird Ihnen eine modellhafte Struktur der Aufgaben und Unteraufgaben vorgeschlagen. Zugleich können Sie auch selbst relevante Termine und Aufgaben sowie Unteraufgaben hinzufügen. Klicken Sie dafür im vorgesehen Unterverfahrensteilschritt auf den Button „Aufgabe hinzufügen“. Dieser Button steht nur dann zur Verfügung, wenn am Verfahrensteilschritt mindestens einen Unterverfahrensteilschritt mit einer Aufgabe aus der Verfahrenskonfiguration existiert. Über das Plus-Symbol können Sie die Aufgabe an der richtigen Stelle platzieren. Es öffnet sich nun eine Dialogbox, in der Sie, wie in einer Art Baukasten, relevante Felder auswählen können. Die Aufgabe und alle Felder müssen einem entsprechenden Bezeichner versehen werden, bevor die Aufgabe dem Unterverfahrensteilschritt zugeordnet werden kann.

=== Neuen Durchgang hinzufügen ===
Ein Verfahrensteilschritt, der eine Beschlussfassung oder Zustimmung eines zuständigen Gremiums voraussetzt, gilt erst mit wirksamer positiver Entscheidung als abgeschlossen. Wird bspw. die Zustimmung nicht erteilt, die Vorlage abgelehnt oder kann aus sonstigen Gründen das Ziel nicht im ersten Schritt erreicht werden, kann der Verfahrensteilschritt erneut durchgeführt werden, um die erforderliche Entscheidung in einer weiteren Sitzung herbeizuführen. Dies gelingt über im DiPlanCockpit über Durchgänge.

Bei jeden Verfahrensschritt können beliebig viele Durchgänge angelegt werden. Klicken Sie dafür einfach auf „Durchgang hinzufügen“ und ein neuer Durchgang für diesen Verfahrensteilschritt wird angelegt. Wenn ein nachfolgender Termin "stattgefunden" hat, wird für den Verfahrensteilschritt des stattgefundenen Termins ebenfalls ein neuer Durchgang angelegt. In einem neuen Durchgang werden nur die Standardaufgaben angelegt. Aufgaben, welche Sie im 1. Durchgang manuell angelegt hatten, werden nicht übernommen.

Aufgabenverwaltung

2026-04-27T06:27:41Z

Diplanung: /* Aufgaben zu einem Unterverfahrensteilschritt hinzufügen */

Zu jedem Verfahrensteilschritt in der Zeitplanung gibt es Aufgaben, die durchlaufen werden sollen, damit der Verfahrensteilschritt abgeschlossen wird. Um die Aufgaben zu betrachten, klicken Sie am Verfahren auf den Reiter Zeitplanung. Sie befinden sich nun im ersten Verfahrensschritt des ausgewählten Verfahrens. Alternativ können Sie im oberen Zeitstrahl einen spezifischen Verfahrensschritt auswählen, um direkt zu den zugehörigen Aufgaben zu kommen.

=== Aufbau des Reiters Aufgaben ===
Die Seite ist nun in zwei Bereiche unterteilt. Auf der linken Seite sehen Sie die Termine des Verfahrensteilschritts. Unter den Terminen befinden sich die Unterverfahrensteilschritte. Je nach Verfahrenskonfiguration sind diese bereits vorhanden oder sie können sich aus einer Liste von Unterverfahrensteilschritten den für Sie relevanten Unterverfahrensteilschritt auswählen.

Im rechten Bereich der Seite sehen Sie die eigentlichen Aufgaben. Welche Aufgaben gerade angezeigt werden, ist abhängig vom aktuell ausgewählten Unterverfahrensteilschritte. Der Aufgabenbereich unterteilt sich in die Bereiche „Offen“, „Erledigt“ und „Alle“. Standardmäßig ist der Bereich „Alle“ ausgewählt, in dem sowohl offene als auch erledigte Aufgaben angezeigt werden.

=== Aufgaben bearbeiten ===
Um eine Aufgabe zu bearbeiten, klicken Sie auf diese in der Aufgabenliste. Es öffnen sich nun die einzelnen Unteraufgaben, die es für ein Aufgabe zu erledigen gilt.

Folgende Aufgabentypen können von Ihnen vorgenommen werden:

* '''Aufgaben zum Abhaken:''' Sie können für ein To-Do des Unterverfahrensteilschritts eine Checkbox abhaken, um die Aufgabe es erledigt zu markieren
* '''Aufgaben mit Textfeldern:''' In Textfeldern können Sie Informationen zur Aufgabe festhalten. Denkbare wäre ein Kommentarfeld beim Dokumentieren des Ergebnisses eines Unterverfahrensteilschrittes oder das Festhalten von relevanten Kontaktpersonen
* '''Dokument hochladen:''' Über einen Button können Sie ein Dokument direkt an das Verfahren hochladen
* '''Dokument generieren:''' Über einen Button wird ein Word-Dokument aus einer Vorlage generiert, welches beim Speichern direkt am Verfahren gespeichert wird, ohne dass ein Upload des Dokuments notwendig ist. Die Pflege der Vorlage erfolgt über die fachliche Leitstelle.
* '''E-Mail versenden:''' Es besteht auch die Möglichkeit, E-Mails mit Dokumenten am Verfahren zu generieren. In einem Dialog können Dokumente für den Anhang ausgewählt werden. Danach wird automatisch eine E-Mail heruntergeladen, die danach nur noch ausformuliert und an die entsprechenden Empfänger verschickt werden muss. Dadurch entfallen das manuelle Suchen, Herunterladen und Anhängen von wichtigen Dateien. Pro Verfahren wird für jede Aufgabe für den E-Mailversand die Dokumentenauswahl nutzerübergreifend gespeichert.
* '''Termine eintragen:''' Über ein Datumsfeld kann ein Termin ausgewählt werden. Dabei kann es sich um einen Termin aus der Zeitplanung handeln. Wenn beim Einstellen des Zeitpunktes sich dieser von dem in der Zeitplanung unterscheidet, so wird automatisch der Dialog ausgespielt, der fragt, ob durch die Änderung am Termin die Zeitplanung neu berechnet werden soll. Je nach Art der Aufgabe kann sich auch der Status des Termins des Verfahrensteilschritt im linken Bereich ändern. Lautetet also eine Aufgabe, einen Termin zu planen, ändert sich der Status dieses Termins nach Erledigung der Aufgabe in „geplant“. Wird in der nächsten Aufgabe dann das Datum für das Stattfinden des Termins festgehalten, so wechselt der Status des Termins in „stattgefunden“. So behalten Sie die Übersicht über alle relevanten Termin und deren Status.
* '''Fachliche Ordner:''' Fachliche Ordner sind eine Sammlung von Verfahrensdokumenten, die einer bestimmten Fachlichkeit (z.B. Umweltordner, Feststellungsordner) zugeordnet sind und dort gesammelt und dann aus dem Cockpit ausgeleitet werden, um sie an Drittsystem weiterzugeben. Voraussetzung ist dafür, dass die Dokumente mit der entsprechenden Vormerkung versehen wurden. Die Vormerkung kann entweder im Dokumentenbereich oder beim Hochladen bzw. Generieren eines Dokuments im Aufgabenbereich gesetzt werden. Wird die Aufgabe für den fachlichen Ordner manuell erstellt, so kann ausgewählt werden, welche Vormerkung als Filterung vor eingestellt und welche Verfahrensunterlagentyp als obligatorisch definiert werden soll:[[Datei:Aufgabe fachlicher Ordner erstellen.png|zentriert|mini|500x500px|Aufgabe fachlicher Ordner erstellen]]Alternativ wird die Aufgabe über die Verfahrenskonfiguration gesteuert und konfiguriert. Nun können die Dokumente ausgewählt werden, indem bei der Aufgabe auf den entsprechenden Button geklickt wird:[[Datei:Aufgabe fachlicher Ordner.png|zentriert|mini|500x500px|Aufgabe fachlicher Ordner]]Aus den Dokumentenordner können nun die gewünschten Dokumente ausgewählt werden. Bei vielen Dokumenten erleichtert eine Such- und Filterfunktion das Auffinden der benötigten Dokumente. Die Dokumente müssen dabei den Status '''final''' haben, um für einen fachlichen Ordner ausgewählt werden zu können:[[Datei:Dokumente für fachlichen Ordner auswählen.png|zentriert|mini|500x500px|Dokumente für fachlichen Ordner auswählen]]Sobald die Dokumente ausgewählt wurden, wird der fachliche Ordner erzeugt. Dieser Prozess findet im Hintergrund statt und kann je nach der Anzahl und Größe der Dokumente entsprechend mehr Zeit in Anspruch nehmen. Nach Abschluss steht der fachliche Ordner im Dokumentenbereich zur Verfügung:[[Datei:Fachlicher Ordner im Dokumentenbereich.png|zentriert|mini|500x500px|Fachlicher Ordner im Dokumentenbereich]]Der fachliche Ordner kann nun als .zip-Datei heruntergeladen werden. In der .zip-Datei werden die Dokumente entsprechend dem Verfahrensteilschritt in Unterordnern sortiert. Einen Sonderfall bildet die Ordner "Übergreifende Dokumente" und "Vorhabens- und Antragsdokumente", die jeweils einen eigenen Ordner unabhängig der Verfahrensteilschritte erhalten.[[Datei:Strukturierung des fachlichen Ordners als .zip-Datei.png|zentriert|mini|500x500px|Strukturierung des fachlichen Ordners als .zip-Datei]]Über die Aufgabe des fachlichen Ordners können jederzeit Dokumente hinzugefügt oder entfernt werden. Beim Ausführen der Aufgabe wird dann der fachliche Ordner entsprechend aktualisiert und die neue .zip-Datei kann heruntergeladen werden.
* '''Beteiligungsverfahren einrichten:'''
** Unter „Beteiligungsverfahren konfigurieren“ kann das Verfahren automatisch nach DiPlanBeteiligung übertragen werden: Voraussetzung ist ein veröffentlichtes Planwerk und ein finales Dokument im Dokumentenbereich als ergänzende Unterlage.
** Das Planwerk muss entweder vorab veröffentlicht oder direkt während der Aufgabe über den Reiter Planwerke hochgeladen und veröffentlicht werden.
** Planungsanlass und Geltungsbereich werden aus den Stammdaten befüllt, die Felder können aber hier noch vorher angepasst werden.
** Dokumente können über den ersten Button aus dem Dokumentenbereich ausgewählt werden. Das Dokument muss final sein, um auswählbar zu sein. Über den zweiten Button können Dokumente direkt hochgeladen werden. Hierbei kann der Unterlagentyp bestimmt werden.
** Erst wenn die Dokumente final gesetzt sind und das Planwerk veröffentlicht ist, kann das Beteiligungsverfahren eingerichtet werden.
** Wenn sich der Verfahrensstand des Verfahrens geändert hat oder die für die Beteiligung relevanten Dokumente aktualisiert wurden, kann über diesen Weg auch das Beteiligungsverfahren aktualisiert werden.

=== Aufgaben als erledigt markieren ===
Sie entscheiden aber jederzeit selbst, ob die Termine oder Aufgaben eines Unterverfahrensteilschritts relevant für Ihr Verfahren sind. Sie müssen nicht alle angezeigten Unteraufgaben erledigen. Wenn Sie der Auffassung sind, dass eine von drei erledigten Unteraufgaben genügt, können Sie die Aufgabe als erledigt markieren. Die Unteraufgaben dienen Ihnen als Hilfestellung und Erinnerungsstütze.

Je detaillierter Sie Aufgaben in der Anwendung dokumentieren, desto größer ist das weitere Nutzungspotenzial für Ihre Kolleginnen und Kollegen.

* Als „erledigt“ markieren Sie Aufgaben per Klick auf das links angezeigte Häkchen.
* Eine erfolgreich bearbeitete Aufgabe wird in der Folge mit einem grünen Häkchen angezeigt.
* Sie können die Markierung auch jederzeit über einen erneuten Klick auf das grüne Häkchen wieder entfernen.

Der Bearbeitungsstand lässt sich auch in der linken Ansicht (Unterverfahrensteilschritte) einsehen.

* Offene Unterverfahrensteilschritte, bei denen noch alle Aufgaben unbearbeitet sind, sind mit einem hellgrauen Punkt versehen.
* Begonnene Unterverfahrensteilschritte mit bereits in Teilen erledigten Aufgaben sind mit einem dunkelgrauen Punkt versehen.
* Erledigte Unterverfahrensteilschritte, bei denen alle Aufgaben abgeschlossen wurden, sind mit einem grünen Punkt versehen.
Sind alle Aufgaben in allen Unterverfahrensteilschritten des aktuellen Durchgangs erledigt, so wird in der Verfahrensübersicht der gesamte Verfahrensteilschritt grün markiert.

=== Aufgaben zu einem Unterverfahrensteilschritt hinzufügen ===
Für die Unterverfahrensteilschritte wird Ihnen eine modellhafte Struktur der Aufgaben und Unteraufgaben vorgeschlagen. Zugleich können Sie auch selbst relevante Termine und Aufgaben sowie Unteraufgaben hinzufügen. Klicken Sie dafür im vorgesehen Unterverfahrensteilschritt auf den Button „Aufgabe hinzufügen“. Dieser Button steht nur dann zur Verfügung, wenn am Verfahrensteilschritt mindestens einen Unterverfahrensteilschritt mit einer Aufgabe aus der Verfahrenskonfiguration existiert. Über das Plus-Symbol können Sie die Aufgabe an der richtigen Stelle platzieren. Es öffnet sich nun eine Dialogbox, in der Sie, wie in einer Art Baukasten, relevante Felder auswählen können. Die Aufgabe und alle Felder müssen einem entsprechenden Bezeichner versehen werden, bevor die Aufgabe dem Unterverfahrensteilschritt zugeordnet werden kann.

=== Neuen Durchgang hinzufügen ===
Bei jeden Verfahrensschritt können beliebig viele Durchgänge angelegt werden. Dies ist dann denkbar, wenn z.B. eine Öffentlichkeitsbeteiligung erneut durchgeführt werden muss, kann es sein, dass einige Aufgaben erneut durchgeführt werden müssen. Klicken Sie dafür einfach auf „Durchgang hinzufügen“ und ein neuer Durchgang für diesen Verfahrensteilschritt wird angelegt. Wenn ein nachfolgender Termin "stattgefunden" hat, wird für den Verfahrensteilschritt des stattgefundenen Termins ebenfalls ein neuer Durchgang angelegt. In einem neuen Durchgang werden nur die Standardaufgaben angelegt. Aufgaben, welche Sie im 1. Durchgang manuell angelegt hatten, werden nicht übernommen.

Codelisten für DiPlan Cockpit Pro

2026-04-22T09:35:56Z

Diplanung: /* Code.Vertragsart */

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''
== Reiter Codelisten==
Außerhalb dieses Wikis finden sich im [https://www.xrepository.de/ XRepository] Dokumentationen einiger Codelisten. Der Reiter Codelisten stellt alle im DiPlanCockpit vorhandenen, änderbaren Codelisten dar. Mittels anpassbaren Codelisten lässt sich das Cockpit individuell gestalten, indem beispielsweise eigene Verfahrenstypen (Verfahrenssteuerung) oder Verfahrensarten definiert werden. Für jede Codeliste wird ihr Name, ihre listURI (URN) und listVersionID (Version) angezeigt. Zusätzlich können die festen Codelisten heruntergeladen werden.
===Filter und Suche===
Die Suche nach einer Codeliste kann über die Eingabe ihres Namens oder listURI (URN) in das Suchfeld erfolgen. Gesetzte Filter und Suchbegriffe können einzeln wieder entfernt werden oder mit einem Klick gleichzeitig zurückgesetzt werden.
===Funktionen===
Alle festen Codelisten können zusammen über einen Button ("'''Stammcodeliste herunterladen'''") heruntergeladen werden. Der Download erfolgt in Form einer XML-Datei.

Die änderbaren Codelisten können einzeln heruntergeladen werden. Der Download erfolgt in Form einer XML-Datei per Klick auf den Namen der Codeliste.

Um eine '''Codeliste zu ändern''', lässt sie sich wie beschrieben einzeln als XML-Datei herunterladen. Anschließend können außerhalb des Cockpits Änderungen an der XML-Datei vorgenommen werden (bspw. Codes ergänzen). Was bei den Änderungen zu beachten ist, wird in einem separaten Kapitel beschrieben. Per Klick auf den Upload-Button neben der entsprechenden Codeliste lässt sich die angepasste Codeliste wieder hochladen.
==Beschreibung der Codelisten==
In den folgenden Abschnitten sind einige relevante Codelisten beschrieben. Die Beschreibung erfolgt strukturiert anhand eine Templates.

An die Beschreibung der Codelisten schließt sich eine Erläuterung des Aufbaus von Codelisten an. Darauf folgt eine kurze Schritt-Anleitung, wie anpassbare Codelisten angepasst werden können. Außerhalb dieses Wikis finden sich im [https://www.xrepository.de/ XRepository] Dokumentationen einiger Codelisten.
===Anpassen von Codelistenwerten===
In der Rolle M-A steht Ihnen im ''Fachliche Leitstelle Administration'' ein Reiter ''Codelisten'' zur Verfügung. Über diesen gelangen Sie zur Administrationsoberfläche aller festen und mandantenspezifisch veränderbaren Codelisten. Sie können hier die festen Codelistenwerte zu Ihrer Information auslesen und herunterladen. Ebenso können Sie alle veränderbaren Codelisten zu Ihrer Information herunterladen, lokal bearbeiten und in Ihr DiPlanCockpit übernehmen.

Bei der Bearbeitung sind Änderungen an den Codes, Beschreibungen und ggf. der metadaten-parent-id zulässig. Andere Inhalte der Dateien müssen unverändert bleiben.
==== Feste Codelisten auslesen====
Diese Art von Codelisten bilden bundesweit einheitliche XöV Standards ab und lassen sich nicht individuell anpassen.

Für die Mandanten spezifische Konfiguration kann es aber hilfreich sein zu wissen, welche feste Codelisten mit welchen Inhalten es gibt.

Eine Sammlung an festen Codelisten lässt sich im Reiter Codelisten über den Button "Stammcodeliste herunterladen" in Form einer XML-Datei herunterladen. Anschließend kann die Datei eingesehen werden. Sie enthält alle festen Codelisten, die für das Cockpit spezifisch sind. Weitere feste Codelisten sind über das [https://www.xrepository.de/ XRepository] einsehbar.

====Veränderbare Codelisten aktualisieren====
Im Tabellenbereich des Reiters ''Codelisten'' werden Ihnen alle Codelisten zum Down- und Upload angeboten.
# Finden Sie die jeweilige Codeliste über die Suchfunktion.
#Klicken Sie den Namen der Codeliste, um die jeweilige Codeliste lokal herunterzuladen.
# Editieren Sie die Codeliste in einem lokalen Dateieditor, indem Sie die jeweiligen Codeblöcke anpassen. Sie können Codeblöcke mit Codelistenwerten hinzufügen, editieren oder auch entfernen.
#Klicken Sie auf das ''Pfeil-nach-oben Symbol'', um die jeweilige Codeliste in Ihr DiPlanCockpit hochzuladen.
##Die hochgeladene Codeliste wird XML-Schema validiert. Ungültige Dateien werden mit einer Fehlermeldung abgelehnt.
## Entfernte Codelistenwerte werden ermittelt und gegen den aktuellen Datenbestand abgeglichen. Codelisten mit entfernten, jedoch im Datenbestand referenzierten Codelistenwerten werden mit einer Fehlermeldung abgelehnt.
Codelisten liegen immer in einer XML-Notation in UTF-8 Kodierung vor und geben immer die verwendeten und verwendbaren Wertebereiche wieder.

Sie können neue Codelistenwerte jederzeit hinzufügen.

Sie können Codelistenwerte nur entfernen, wenn der zu entfernende Wert nicht mehr in aktuellen Datenbestand referenziert wird und es sich um keinen systemseitig notwendigen Wert handelt. Eine Fehlermeldung gibt Aufschluss über das konkrete Problem.
Fehlt ein systemseitig notwendiger Code, hat die Fehlermeldung die Form ''Die Codeliste enthält nicht folgende erforderlichen Codes: [Angabe des fehlgeschlagenen Validator-Aufrufs mit Code]'' Um diesen Fehler zu beheben, muss der Code wieder in der Codeliste ergänzt werden. Anschließend lässt sie sich erfolgreich hochladen.
Fehlt ein Code, der aktuell in Verfahren in Verwendung ist, hat die Fehlermeldung die Form ''Die Codeliste enthält nicht folgende erforderlichen Codes: {Code 'LoremIpsum' (LoremIpsum) wird noch in Tabelle 'verfahren' benutzt und kann nicht gelöscht werden}''. Um den Fehler zu beheben, muss entweder der Code wieder in der Codeliste ergänzt werden, oder die Verfahren müssen so angepasst werden, dass sie den Code nicht mehr verwenden. Anschließend lässt sich die Codeliste erfolgreich hochladen. Gleiches gilt für eine Fehlermeldung mit der Formulierung ''Fehler in der Verfahrenskonfiguration xy: Kein Wert für Codeliste 'a' und Wert 'z' zu ermitteln.''
Wenn eine Fehlermeldung besagt (oder äquivalent auf deutsch) ''The content of element 'x' is not complete. One of 'a' is expected.'' Dann fehlt entweder der Eintrag x in der Verfahrenskonfiguration, oder er steht an der falschen Stelle. Entsprechend muss er hinzugefügt bzw. verschoben werden.
==Erläuterung des Templates==
#Cockpit Basis/Pro: Die Codeliste ist in der Cockpit Basis Version enthalten (demnach auch ich Pro) oder sie ist nur in Pro enthalten
#Fachliche Bedeutung: Beschreibung der Bedeutung der Codeliste im Cockpit
#Bezug zu anderen Komponenten: Angabe, wo in welcher Konfiguration die Codeliste referenziert wird
#Technische Details:
##Anpassbar: ja/nein
###Verpflichtende Codes: Aufzählung der Codes, die nicht gelöscht werden dürfen (nur wenn anpassbar)
##Codeformat: vierstellig, zweistellig, ID, ...
##URN: Angabe der URN
##Attribute/Spalten: zusätzliche Angaben neben Beschreibung und Code
#Weitere Hinweise zur mandantenspezifischen Anpassung: ggf. Besonderheiten
==Beschreibung der Codelisten==

=== Code.ArtDerNutzung ===

#Cockpit Basis/Pro: Basis + Pro
#Fachliche Bedeutung: Diese Codelisten führt diverse Nutzungsarten je nach Planart auf.
#Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration und dem Datentyp Verfahrensbeschreibung referenziert.
#Technische Details:
#*Anpassbar: nein
#*Verpflichtende Codes: alle
#*Codeformat: String, z.B. 1_1_10_1_Windenergie
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:artdernutzung</nowiki>
#*Attribute/Spalten: uebergeordneterWert
#Weitere Hinweise zur Mandanten spezifischen Anpassung: Wichtig ist, dass der "uebergeordneterWert" in der Codeliste Code.ArtDerNutzung und der "uebergeordneterWert" der Planart des Verfahrens in der Codeliste Code.Planart übereinstimmen. Andernfalls werden die Nutzungen aus einer XPlanGML, für die der übergeordnete Wert nicht übereinstimmt, im Cockpit nicht angezeigt.

=== Code.ArtDesKontaktes ===

#Cockpit Basis/Pro: Basis + Pro
#Fachliche Bedeutung: Kategorien an Kontakten, die auf der Stammdatenseite (Reiter Stammdaten) ausgegeben werden.
#Bezug zu anderen Komponenten: keine
#Technische Details:
#*Anpassbar: ja
#*Verpflichtende Codes: keine
#*Codeformat: String, vierstelliger Zahlencode mit Beschreibung, z.B. 1000 Stadtplanung
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:artdeskontaktes</nowiki>
#*Attribute/Spalten: keine
#Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

=== Code.Aufhebungsgrund ===

# Cockpit Basis/Pro: Basis + Pro
# Fachliche Bedeutung: Diese Codeliste enthält Optionen an Aufhebungsgründen für ein Planverfahren, die über eine Nachricht an andere Komponenten übermittelt werden.
# Bezug zu anderen Komponenten: Nachrichten-Inhalt an andere Komponenten wie DiPlanPortal
# Technische Details:
#* Anpassbar: ja
#* Verpflichtende Codes: keine
#* Codeformat: String, vierstelliger Zahlencode mit Beschreibung, z.B. 1000 Verstoß gegen Formvorschriften
#* URN: [[urn:xoev-de:xplanverfahren:codeliste:ufhebungsgrund]]
#* Attribute/Spalten: keine
# Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

=== Code.Foerderweg ===

# Cockpit Basis/Pro: Basis + Pro
# Fachliche Bedeutung: Diese Codelisten enthält Optionen für den Förderweg im Wohnungsbau, der auf der Stammdatenseite geführt und über eine Nachricht an andere Komponenten übermittelt wird.
# Bezug zu anderen Komponenten: Nachrichten-Inhalt an andere Komponenten
# Technische Details:
#* Anpassbar: ja
#* Verpflichtende Codes: keine
#* Codeformat: String, vierstelliger Zahlencode mit Beschreibung, z.B. 2000 2. Förderweg
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:foerderweg</nowiki>
#* Attribute/Spalten: keine
# Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

=== Code.Gebietseinheit ===

# Cockpit Basis/Pro: Basis + Pro
# Fachliche Bedeutung: Diese Codelisten führt alle Gebietseinheiten mit Amtlichem Gemeindeschlüssel (AGS) auf, die über eine Nachricht an andere Komponenten übermittelt werden.
# Bezug zu anderen Komponenten: Nachrichten-Inhalt an andere Komponenten
# Technische Details:
#* Anpassbar: ja
#* Verpflichtende Codes: alle
#* Codeformat: String, achtstelliger Zahlencode und Beschreibung, z.B. 01004000 Neumünster, Stadt
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:foerderweg</nowiki>
#* Attribute/Spalten: zustaendigkeit
# Weitere Hinweise zur Mandanten spezifischen Anpassung: Weitere Optionen ergänzen

=== Code.NichtMonitoringGrund ===

# Cockpit Basis/Pro: Pro
# Fachliche Bedeutung: Diese Codelisten führt Optionen für die Deaktivierung des Monitorings eines Planverfahrens.
# Bezug zu anderen Komponenten: Nachrichten-Inhalt an andere Komponenten
# Technische Details:
#* Anpassbar: ja
#* Verpflichtende Codes: "Keine Begründung angegeben"
#* Codeformat: String
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:nichtmonitoringgrund</nowiki>
#* Attribute/Spalten: verfahrenssteuerung
# Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

===Code.Planart===
#Cockpit Basis/Pro: Basis + Pro
#Fachliche Bedeutung: Diese Codeliste ist Teil der hierarchischen Sortierung beim Anlegen eines Verfahrens nach den drei Auswahl-Optionen:
#*Verfahrenstyp (auch Verfahrenssteuerung bzw. Verfahrenssteuerungstyp)
#*Planart
#*Verfahrensart
#Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration und dem Datentyp Verfahrensbeschreibung referenziert.
#Technische Details:
#*Anpassbar: nein
#*Codeformat: z.B. 2_1_LandesweiterRaumordnungsplan
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:planart</nowiki>
#*Attribute/Spalten: beschreibungLang, uebergeordneterWert, xPlanFachmodell, plu-planType
#Weitere Hinweise zur Mandanten spezifischen Anpassung: Wichtig ist, dass der "uebergeordneterWert" in der Codeliste Code.ArtDerNutzung und der "uebergeordneterWert" der Planart des Verfahrens in der Codeliste Code.Planart übereinstimmen. Andernfalls werden die Nutzungen aus einer XPlanGML, für die der übergeordnete Wert nicht übereinstimmt, im Cockpit nicht angezeigt.

=== Code.RelationPlanrecht ===

# Cockpit Basis/Pro: Basis + Pro
# Fachliche Bedeutung: Diese Codeliste kann ergänzendes Planrecht abbilden, wird auf der Stammdatenseite geführt und kann über eine Nachricht an andere Komponenten übermittelt werden.
# Bezug zu anderen Komponenten: Nachrichten-Inhalt an andere Komponenten
# Technische Details:
#* Anpassbar: ja
#* Verpflichtende Codes: 9000 Sonstiges
#* Codeformat: String
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:relationplanrecht</nowiki>
#* Attribute/Spalten: keine
# Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

=== Code.Rolle ===

# Cockpit Basis/Pro: Basis + Pro
# Fachliche Bedeutung: Diese Codeliste führt Rollen auf, die über eine Nachricht an andere Komponenten übermittelt werden.
# Bezug zu anderen Komponenten: Nachrichten-Inhalt an andere Komponenten
# Technische Details:
#* Anpassbar: ja
#* Verpflichtende Codes: keine
#* Codeformat: String, vierstelliger Zahlencode und Beschreibung, z.B. 1000 Sachbearbeitung
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:rolle</nowiki>
#* Attribute/Spalten: keine
# Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

=== Code.Sitzungscodes ===
#Cockpit Basis/Pro: Pro
#Fachliche Bedeutung: Bezeichnet die verschiedenen Sitzungen im Laufe eines Verfahrens.
#Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration referenziert, um die Sitzungen/Termine je VTS aufzuführen. Zu einer Sitzung werden in der Verfahrenskonfiguration außerdem die zeitplanungs- und prognoserelevanz , die Modellberechnung, sowie der Sitzungsergebnistyp angegeben.
#Technische Details:
#*Anpassbar: ja
#**Verpflichtende Codes:
#***senatssitzung
#***beschlussBuergschaft
#***beschlussBezirksversammlungFeststellungsverfahren
#***ak2
#*Codeformat: String
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:sitzungen</nowiki>
#*Attribute/Spalten: ergebnistyp (leer)
#Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

=== Code.Sitzungsergebnistyp ===
#Cockpit Basis/Pro: Pro
#Fachliche Bedeutung: Beschreibt die Art des Sitzungsergebnisses (ErgebnisPolitischeAbstimmung, ErgebnisVerwaltungsabstimmung, ErgebnisVerwaltungsvorgaenge, ohneErgebnis)
#Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration referenziert, um die Auswahl möglicher Sitzungsergebnisse vorzugeben. Diese werden dann entsprechend der angegebenen Codeliste, z.B. ist es bei ErgebnisPolitischeAbstimmung die Codeliste Code.politischesSitzungsergebnis, angezeigt.
#Technische Details:
#*Anpassbar: nein
#*Codeformat: z.B. UnterschriftBehoerdenleitungFeststellung
#*URN: <nowiki>Urn:xoev-de:xplanverfahren:codeliste:sitzungsergebnistyp</nowiki>
#*Attribute/Spalten: keine
#Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

=== Code.SonstigeTermin ===

# Cockpit Basis/Pro: Pro
# Fachliche Bedeutung: Sonstige Termine werden in der Zeitplanung für Termine verwendet, die keine Sitzungen sind.
# Bezug zu anderen Komponenten: Die Verfahrenskonfiguration referenziert auf die in der Codeliste definierten Einträge und ordnet sie den passenden Verfahrensteilschritten zu.
# Technische Details:
#* Anpassbar: ja
#** Verpflichtende Codes:
#*** Beschlussdatum 0100
#*** Vorweggenehmigungsreife 0200
#*** Bekanntmachung 9300
#*** Tag des Inkrafttretens 9400
#*** Tag des Außerkrafttretens 9450
#* Codeformat: beliebiger String
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:sonstigetermin</nowiki>
#* Attribute/Spalten: keine
# Weitere Hinweise zur mandantenspezifischen Anpassung: keine

=== Code.Unterverfahrensteilschritte ===
#Cockpit Basis/Pro: Pro
#Fachliche Bedeutung: Unterverfahrensteilschritte (UVTS) stellen die kleinste Unterteilung im Ablauf eines Verfahrens dar. Im Reiter Aufgaben sind einem UVTS unterschiedliche Aufgaben zugeordnet. UVTS lassen sich auch als optional wählbar bzw. manuell aktivierbar umsetzen.
#Bezug zu anderen Komponenten: Die Verfahrenskonfiguration zum passenden Verfahrenstyp referenziert auf die in der Codeliste definierten UVTS-Einträge und bindet sie in die Hierarchie ein:
#*Verfahrensschritt (VS)
#*Verfahrensteilschritt (VTS)
#*Unterverfahrensteilschritt (UVTS)
#Technische Details:
#*Anpassbar: ja
#**Verpflichtende Codes: 9998 - individueller Vorgang
#*Codeformat: vierstelliger Zahlencode
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:unterverfahrensteilschritt</nowiki>
#*Attribute/Spalten: keine
#Weitere Hinweise zur Mandanten spezifischen Anpassung: keine
===Code.Verfahrensart===
#Cockpit Basis/Pro: Basis
#Fachliche Bedeutung: Diese Codeliste ist Teil der hierarchischen Sortierung beim Anlegen eines Verfahrens nach den drei Auswahl-Optionen:
#*Verfahrenstyp (auch Verfahrenssteuerung bzw. Verfahrenssteuerungstyp)
#*Planart
#*Verfahrensart
#Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration zur Auflistung aller möglichen Verfahrensarten referenziert.
#Technische Details:
#*Anpassbar: ja
#**Verpflichtende Codes: keine
#*Codeformat: vierstelliger Zahlencode
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:verfahrensart</nowiki>
#*Attribute/Spalten: plu-ProcedureType
#Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

=== Code.Verfahrensschritte ===
#Cockpit Basis/Pro: Pro
#Fachliche Bedeutung: Jeder Verfahrenstyp kann eine individuelle Anzahl und Abfolge an Verfahrensschritten (VS) haben. Es gibt pro VS einen eigenen VS-Ordner im Reiter Dokumenten, in denen Dokumente abgelegt werden. Zudem fließen die VS in die Verfahrensschrittanzeige bzw. den Zeitstrahl ein, die in den Reitern Aufgaben und Zeitplanung (künftig auch im Reiter Stammdaten / auf der Stammdatenseite) dargestellt sind.
#Bezug zu anderen Komponenten: Die Verfahrenskonfiguration zum passenden Verfahrenstyp referenziert auf die in der Codeliste definierten VS-Einträge und bindet sie in die Hierarchie ein:
#*Verfahrensschritt (VS)
#*Verfahrensteilschritt (VTS)
#*Unterverfahrensteilschritt (UVTS)
#Technische Details:
#*Anpassbar: ja
#**Verpflichtende Codes: 9998 - kein VS
#*Codeformat: vierstellige Zahlencodes
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:verfahrensschritt</nowiki>
#*Attribute/Spalten: Attribut "plu-processStepType", Spalte "Mapping auf DCAT-PLU Procedure Type plu-processStepType" und leere Spalte "ia-processstepType"
#Weitere Hinweise zur Mandanten spezifischen Anpassung: keine
===Code.Verfahrensstand===
#Cockpit Basis/Pro: Basis + Pro
#Fachliche Bedeutung: Bezeichnet den aktuellen Reifegrad eines Verfahrens, z.B. "simuliert" oder "beschlossen" und dient der Statusüberwachung innerhalb des Cockpits.
#Bezug zu anderen Komponenten: Es sind verschiedene fachliche Anforderungen mit dem Verfahrensstand verbunden. Dazu gehören eine Unterstützung für Berichts-, Dokumentations- und Veröffentlichungspflichten. Im DiPlanCockpit Basis muss der Verfahrensstand manuell angepasst werden. In Pro greift die Verfahrenssteuerung, sodass sich der Verfahrensstand automatisch anpasst. Um ein Planwerk veröffentlichen zu können, müssen der Verfahrensstand im Cockpit und der Rechtsstand eines Planwerkes zusammenpassen ([[Matching Verfahrensstand und Rechtsstand|Tabelle mit passenden Werten]]).
#Technische Details:
#*Anpassbar: nein
#*Codeformat: vierstellige Zahlencodes
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:verfahrensstand</nowiki>
#*Attribute/Spalten: plu-procedureState, plu-planstate
#Weitere Hinweise zur Mandanten spezifischen Anpassung: keine
===Code.Verfahrenssteuerung===
#Cockpit Basis/Pro: Basis + Pro
#Fachliche Bedeutung: Diese Codeliste ist Teil der hierarchischen Sortierung beim Anlegen eines Verfahrens nach den drei Auswahl-Optionen:
#*Verfahrenstyp bzw. Verfahrenssteuerung bzw. Verfahrenssteuerungstyp
#*Planart
#*Verfahrensart
#Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration zur Auflistung aller möglichen Verfahrenstypen referenziert.
#Technische Details:
#*Anpassbar: ja
#**Verpflichtende Codes: keine
#*Codeformat: vierstellige Zahlencodes
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:verfahrenssteuerung</nowiki>
#*Attribute/Spalten: keine
#Weitere Hinweise zur Mandanten spezifischen Anpassung: Inhaltliche Synonyme zu "Verfahrenssteuerung" sind Verfahrenstyp, Verfahrenssteuerungstyp. Im Kontext der Codelisten ist dennoch nur der Begriff "Verfahrenssteuerung" gültig.

=== Code.Verfahrensteilschritte ===
#Cockpit Basis/Pro: Pro
#Fachliche Bedeutung: Verfahrensteilschritte (VTS) sind die nächst kleinere Unterteilung der VS. Sie fließen wie die VS in die Verfahrensschrittanzeige bzw. den Zeitstrahl ein, die in den Reitern Aufgaben und Zeitplanung (künftig auch im Reiter Stammdaten / auf der Stammdatenseite) dargestellt sind.
#Bezug zu anderen Komponenten: Die Verfahrenskonfiguration zum passenden Verfahrenstyp referenziert auf die in der Codeliste definierten VTS-Einträge und bindet sie in die Hierarchie ein:
#*Verfahrensschritt (VS)
#*Verfahrensteilschritt (VTS)
#*Unterverfahrensteilschritt (UVTS)
#Technische Details:
#*Anpassbar: ja
#**Verpflichtende Codes: 9998 - kein VTS
#*Codeformat: vierstellige Zahlencodes
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:verfahrensteilschritt</nowiki>
#*Attribute/Spalten: temporäre zweite Beschreibungsspalte (mappt den VTS auf den zugehörigen VS)
#Weitere Hinweise zur Mandanten spezifischen Anpassung: keine
===Code.Verfahrensunterlagetyp===
#Cockpit Basis/Pro: Basis + Pro
#Fachliche Bedeutung: Diese Codeliste gibt die möglichen Unterlagentypen an, das heißt z.B. Vertrag, Anschreiben oder ergänzende Unterlage.
#Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration zur Angabe des Unterlagentyps bei Dokumenten referenziert.
#Technische Details:
#*Anpassbar: ja
#**Verpflichtende Codes:
#*** Code 0300 mit Wert Planzeichnung
#*** Code 0350 mit Wert XPlanarchiv
#*** Code 1180 mit Wert Veröffentlichung
#*** Code 1112 mit Wert Anschreiben Beteiligungsverfahren
#*** Code 1170 mit Wert Stellungnahme
#*** Code 4000 mit Wert Xtrassearchiv
#*** Code 4010 mit Wert XTrasse-Zeichnung
#*** Code 4020 mit Wert XTrasse-GML
#*** Code 9900 mit Wert Sonstige Unterlage
#*Codeformat: vierstellige Zahlencodes
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:verfahrensunterlagentyp</nowiki>
#*Attribute/Spalten: plu-doctype
#Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

=== Code.Vertragsart ===

# Cockpit Basis/Pro: Basis + Pro
# Fachliche Bedeutung: Auflistung der unterschiedlichen Vertragsarten mit Zuordnung der jeweiligen Verfahrensunterlagentypen
# Bezug zu anderen Komponenten: Referenzierung zur Codeliste Code.Verfahrensunterlagetyp = Die verwendeten Codes müssen in beiden Codelisten enthalten sein.
# Technische Details:
#* Anpassbar: ja
#* Verpflichtende Codes: keine
#* Codeformat: String, z.B. vierstelliger Zahlencode
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:vertragsart</nowiki>
#* Attribute/Spalten: verfahrensunterlagetyp
# Weitere Hinweise zur mandantenspezifischen Anpassung: keine

=== Code.Verzoegerungsgrund ===
#Cockpit Basis/Pro: Pro
#Fachliche Bedeutung: Gibt die möglichen Gründe für die Verzögerung eines Termins an.
#Bezug zu anderen Komponenten: Wird automatisch je Verfahrenssteuerungstyp referenziert.
#Technische Details:
#*Anpassbar: ja
#**Verpflichtende Codes: keine
#*Codeformat: vierstellige Zahlencodes
#*URN: <nowiki>Urn:diplanung-de:cockpit:codeliste:verzoegerungsgrund</nowiki>
#*Attribute/Spalten: verfahrenssteuerung
#Weitere Hinweise zur Mandanten spezifischen Anpassung: keine
===Code.Vormerkungen===
#Cockpit Basis/Pro: Basis + Pro
#Fachliche Bedeutung: Ermöglicht Dokumente vorzumerken, um sie beispielsweise zu Beteiligung zu übermitteln oder in einen fachlichen Ordner zu packen (nur Pro)
#Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration zum Setzen von Vormerkungen per Default referenziert.
#Technische Details:
#*Anpassbar: ja
#**Verpflichtende Codes:
#***Code 0300 mit Wert Umweltordner
#***Code 0500 mit Wert Langzeitarchivierung
#***Code 0800 mit Wert Beteiligungsverfahren
#***Code 1000 mit Wert Metadateninformationssystem
#*Codeformat: vierstellige Zahlencodes
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:vormerkung</nowiki>
#*Attribute/Spalten: keine
#Weitere Hinweise zur Mandanten spezifischen Anpassung: keine
===Code.Zustaendigkeit===
#Cockpit Basis/Pro: Basis + Pro
#Fachliche Bedeutung: Benennt die Zuständigkeit eines Nutzers für das angelegte Verfahren. Je nach Rollen - und Rechte-Konzept werden Lese- und Schreibrechte zugewiesen. Es gibt bestimmte Rollen (wie M-A), die über mehrere Zuständigkeiten hinweg Schreibrechte haben.
#Bezug zu anderen Komponenten:
#Technische Details:
#*Anpassbar: ja
#**Verpflichtende Codes: keine
#*Codeformat: frei wählbar, z.B. Senat
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:zustaendigkeit</nowiki>
#*Attribute/Spalten: Metadaten Parent ID bzw. uuid
#Weitere Hinweise zur Mandanten spezifischen Anpassung: Die Einträge aus der Codeliste Zuständigkeit müssen alle in der Kontakteliste enthalten sein. Das heißt, wenn ein Eintrag in die Codeliste Zuständigkeit hinzugefügt wird, dann muss dieser auch in der Kontakteliste hinzugefügt werden. Andernfalls kommt es zu einer Fehlermeldung, die darauf hinweist, dass ein Kontakt nicht konfiguriert ist.
==Aufbau einer Codeliste==
Am Beispiel der Codeliste Zuständigkeit ist im folgenden der Aufbau einer Codeliste erläutert und anschließend wird ihre Anpassung erklärt.
===Gesamtansicht der Default-Version===
Heruntergeladen und in einem XML Tool geöffnet, hier IntelliJ.[[Datei:CodelisteGesamt.png|zentriert|mini|809x809px|verweis=https://wiki.diplanung.de/index.php/Datei:CodelisteGesamt.png]]
===Erläuterung der einzelnen Abschnitte===
Im Folgenden sind die einzelnen Abschnitte des Screenshots beschrieben. Die Zeilenangabe bezieht sich auf die im Screenshot sichtbare Zeilennummerierung auf der linken Seite.
====Zeilen 5-13====
Annotation: Abschnitt mit Metadaten zur Codeliste
====Zeilen 14-23====
Identification: Abschnitt mit Angabe des Autors/Verfassers der Codeliste
====Zeilen 24-49====
ColumnSet: Abschnitt mit der Struktur der Codeliste. In diesem Beispiel gibt es drei Werte, die jeweils angepasst werden können:
*code (Pflicht)
*beschreibung (Option; empfohlen)
*metadaten-parent-id (Option; empfohlen)
====Zeile 50-62====
SimpleCodeList: Abschnitt für die Mandanten spezifischen Einträge. Im Screenshot ist ein Beispiel zu sehen. Eventuell ist dieser Abschnitt auch leer und das Element geschlossen, also nur <code><SimpleCodeList/></code> angegeben.
===Mandanten spezifischen Anpassung als Schritt-Anleitung===
====1. Schritt (wenn kein Beispieleintrag in SimpleCodeList)====
Öffnen des leeren Elements SimpleCodeList. Nur dieser Bereich wird angepasst!

'''Hinweis''': Es ist sinnvoll, für die Anpassung ein IDE Tool zu verwenden wie Visual Studio Code oder IntelliJ, um den Code im Hintergrund laufend validieren zu lassen (IDE = Integrierte Entwicklungsumgebung). Die Prüfung der Formatierung lässt sich per „Shift + Alt + L“ anstoßen.
====2. Schritt (wenn kein Beispieleintrag in SimpleCodeList)====
Eintrag einer validen Kopiervorlage, zum Beispiel wie Zeile 50-62 im ersten Screenshot.

Jeder Code füllt eine Zeile in der Codeliste - in der XML repräsentiert als das Element „Row“. Darin sind jeweils Angaben zu den möglichen Werten („Value“). Im Beispiel sind das „code“, „beschreibung“ und „metadaten-parent-id“. Diese repräsentieren die Spalten der Codeliste und werden entsprechend als „ColumnRef“ angegeben. Der gewünschte Wert wird jeweils im Element „SimpleValue“ eingetragen.

Kopiervorlage als Text mit Reiheneinrückung:
<code><Row>
<Value ColumnRef="code">
<SimpleValue>09000000</SimpleValue>
</Value>
<Value ColumnRef="beschreibung">
<SimpleValue>Bayern(09000000)</SimpleValue>
</Value>
<Value ColumnRef="metadaten-parent-id">
<SimpleValue>61BB42F9-20FE-489A-8C13-4FBFAC009CEA</SimpleValue>
</Value>
</Row></code>
====Abkürzung für Schritt 1 und 2====
Ein Default-Eintrag ist bereits vorhanden, der als Kopiervorlage dient (wie im oberen Screenshot).
====3. Schritt Vervielfältigung und Anpassung====
Die Kopiervorlage bzw. der Muster-Eintrag lässt sich 1..n-fach bis zur gewünschten Anzahl kopieren und Mandanten spezifisch anpassen.

'''Hinweise''':
*Der Code muss unique sein. In der Regel werden vierstellige Zahlenfolgen verwendet, die in Tausender- oder Hunderter-Schritten variieren.
*Die Beschreibung ist variabel wählbar und sollte sprechend sein.
*Die metadaten-parent-id, auch uuid genannt, muss unique sein und kann über ein genutztes Metadatensystem bereits vergeben sein. Wenn nicht, kann sie über einen UUID-Generator erzeugt werden z.B. unter <nowiki>https://www.uuidgenerator.net/</nowiki> (einzelne IDs + ID Bulks)
====4. Schritt: Hochladen ins DiPlanCockpit====
Das Hochladen der angepassten Codeliste erfolgt im Admin-Bereich im Reiter Codelisten, den Nutzer mit den Rollen M-A aufrufen können.

Codelisten

2026-04-22T09:35:37Z

Diplanung: /* Code.Verfahrensunterlagetyp */

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

== Reiter Codelisten ==
Der Reiter Codelisten stellt alle im DiPlanCockpit vorhandenen, änderbaren Codelisten dar. Mittels anpassbaren Codelisten lässt sich das Cockpit individuell gestalten, indem beispielsweise eigene Verfahrenstypen (Verfahrenssteuerung) oder Verfahrensarten definiert werden. Für jede Codeliste wird ihr Name, ihre listURI (URN) und listVersionID (Version) angezeigt. Zusätzlich können die festen Codelisten heruntergeladen werden.
===Filter und Suche===
Die Suche nach einer Codeliste kann über die Eingabe ihres Namens oder listURI (URN) in das Suchfeld erfolgen. Gesetzte Filter und Suchbegriffe können einzeln wieder entfernt werden oder mit einem Klick gleichzeitig zurückgesetzt werden.
===Funktionen===
Alle festen Codelisten können zusammen über einen Button ("'''Stammcodeliste herunterladen'''") heruntergeladen werden. Der Download erfolgt in Form einer XML-Datei.

Die änderbaren Codelisten können einzeln heruntergeladen werden. Der Download erfolgt in Form einer XML-Datei per Klick auf den Namen der Codeliste.

Um eine '''Codeliste zu ändern''', lässt sie sich wie beschrieben einzeln als XML-Datei herunterladen. Anschließend können außerhalb des Cockpits Änderungen an der XML-Datei vorgenommen werden (bspw. Codes ergänzen). Was bei den Änderungen zu beachten ist, wird in einem separaten Kapitel beschrieben. Per Klick auf den Upload-Button neben der entsprechenden Codeliste lässt sich die angepasste Codeliste wieder hochladen.

== Beschreibung der Codelisten ==
In den folgenden Abschnitten sind einige relevante Codelisten beschrieben. Die Beschreibung erfolgt strukturiert anhand eine Templates.

An die Beschreibung der Codelisten schließt sich eine Erläuterung des Aufbaus von Codelisten an. Darauf folgt eine kurze Schritt-Anleitung, wie anpassbare Codelisten angepasst werden können. Außerhalb dieses Wikis finden sich im [https://www.xrepository.de/ XRepository] Dokumentationen einiger Codelisten.

=== Anpassen von Codelistenwerten ===
In der Rolle M-A steht Ihnen im ''Fachliche Leitstelle Administration'' ein Reiter ''Codelisten'' zur Verfügung. Über diesen gelangen Sie zur Administrationsoberfläche aller festen und mandantenspezifisch veränderbaren Codelisten. Sie können hier die festen Codelistenwerte zu Ihrer Information auslesen und herunterladen. Ebenso können Sie alle veränderbaren Codelisten zu Ihrer Information herunterladen, lokal bearbeiten und in Ihr DiPlanCockpit übernehmen.

Bei der Bearbeitung sind Änderungen an den Codes, Beschreibungen und ggf. der metadaten-parent-id zulässig. Andere Inhalte der Dateien müssen unverändert bleiben.

==== Feste Codelisten auslesen ====
Diese Art von Codelisten bilden bundesweit einheitliche XöV Standards ab und lassen sich nicht individuell anpassen.

Für die Mandanten spezifische Konfiguration kann es aber hilfreich sein zu wissen, welche feste Codelisten mit welchen Inhalten es gibt.

Eine Sammlung an festen Codelisten lässt sich im Reiter Codelisten über den Button "Stammcodeliste herunterladen" in Form einer XML-Datei herunterladen. Anschließend kann die Datei eingesehen werden. Sie enthält alle festen Codelisten, die für das Cockpit spezifisch sind. Weitere feste Codelisten sind über das [https://www.xrepository.de/ XRepository] einsehbar.

==== Veränderbare Codelisten aktualisieren ====
Im Tabellenbereich des Reiters ''Codelisten'' werden Ihnen alle Codelisten zum Down- und Upload angeboten.

# Finden Sie die jeweilige Codeliste über die Suchfunktion.
# Klicken Sie den Namen der Codeliste, um die jeweilige Codeliste lokal herunterzuladen.
# Editieren Sie die Codeliste in einem lokalen Dateieditor, indem Sie die jeweiligen Codeblöcke anpassen. Sie können Codeblöcke mit Codelistenwerten hinzufügen, editieren oder auch entfernen.
# Klicken Sie auf das ''Pfeil-nach-oben Symbol'', um die jeweilige Codeliste in Ihr DiPlanCockpit hochzuladen.
## Die hochgeladene Codeliste wird XML-Schema validiert. Ungültige Dateien werden mit einer Fehlermeldung abgelehnt.
## Entfernte Codelistenwerte werden ermittelt und gegen den aktuellen Datenbestand abgeglichen. Codelisten mit entfernten, jedoch im Datenbestand referenzierten Codelistenwerten werden mit einer Fehlermeldung abgelehnt.

Codelisten liegen immer in einer XML-Notation in UTF-8 Kodierung vor und geben immer die verwendeten und verwendbaren Wertebereiche wieder.

Sie können neue Codelistenwerte jederzeit hinzufügen.

WICHTIG
Sie können Codelistenwerte nur entfernen, wenn der zu entfernende Wert nicht mehr in aktuellen Datenbestand referenziert wird und es sich um keinen systemseitig notwendigen Wert handelt. Eine Fehlermeldung gibt Aufschluss über das konkrete Problem.
Fehlt ein systemseitig notwendiger Code, hat die Fehlermeldung die Form ''Die Codeliste enthält nicht folgende erforderlichen Codes: [Angabe des fehlgeschlagenen Validator-Aufrufs mit Code]'' Um diesen Fehler zu beheben, muss der Code wieder in der Codeliste ergänzt werden. Anschließend lässt sie sich erfolgreich hochladen.
Fehlt ein Code, der aktuell in Verfahren in Verwendung ist, hat die Fehlermeldung die Form ''Die Codeliste enthält nicht folgende erforderlichen Codes: {Code 'LoremIpsum' (LoremIpsum) wird noch in Tabelle 'verfahren' benutzt und kann nicht gelöscht werden}''. Um den Fehler zu beheben, muss entweder der Code wieder in der Codeliste ergänzt werden, oder die Verfahren müssen so angepasst werden, dass sie den Code nicht mehr verwenden. Anschließend lässt sich die Codeliste erfolgreich hochladen. Gleiches gilt für eine Fehlermeldung mit der Formulierung ''Fehler in der Verfahrenskonfiguration xy: Kein Wert für Codeliste 'a' und Wert 'z' zu ermitteln.''
Wenn eine Fehlermeldung besagt (oder äquivalent auf deutsch) ''The content of element 'x' is not complete. One of 'a' is expected.'' Dann fehlt entweder der Eintrag x in der Verfahrenskonfiguration, oder er steht an der falschen Stelle. Entsprechend muss er hinzugefügt bzw. verschoben werden.

== Erläuterung des Templates ==

# Cockpit Basis/Pro: Die Codeliste ist in der Cockpit Basis Version enthalten (demnach auch ich Pro) oder sie ist nur in Pro enthalten
# Fachliche Bedeutung: Beschreibung der Bedeutung der Codeliste im Cockpit
# Bezug zu anderen Komponenten: Angabe, wo in welcher Konfiguration die Codeliste referenziert wird
# Technische Details:
## Anpassbar: ja/nein
### Verpflichtende Codes: Aufzählung der Codes, die nicht gelöscht werden dürfen (nur wenn anpassbar)
## Codeformat: vierstellig, zweistellig, ID, ...
## URN: Angabe der URN
## Attribute/Spalten: zusätzliche Angaben neben Beschreibung und Code
# Weitere Hinweise zur mandantenspezifischen Anpassung: ggf. Besonderheiten

== Beschreibung der Codelisten ==
Hier sind die für das DiPlan Cockpit Basis relevanten Codelisten beschrieben. Die weiteren Codelisten sind [[Codelisten für DiPlan Cockpit Pro]].
===Code.ArtDerNutzung===
#Cockpit Basis/Pro: Basis + Pro
#Fachliche Bedeutung: Diese Codelisten führt diverse Nutzungsarten je nach Planart auf.
#Bezug zu anderen Komponenten: Kann beim Import in der XML angegeben werden.
#Technische Details:
#*Anpassbar: ja
#*Verpflichtende Codes: alle
#*Codeformat: String, z.B. 1_1_10_1_Windenergie
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:artdernutzung</nowiki>
#*Attribute/Spalten: uebergeordneterWert
#Weitere Hinweise zur Mandanten spezifischen Anpassung: Wichtig ist, dass der "uebergeordneterWert" in der Codeliste Code.ArtDerNutzung und der "uebergeordneterWert" der Planart des Verfahrens in der Codeliste Code.Planart übereinstimmen. Andernfalls werden die Nutzungen aus einer XPlanGML, für die der übergeordnete Wert nicht übereinstimmt, im Cockpit nicht angezeigt. Es sollten die Einträge entsprechend der INSPIRE-Liste genutzt werden (https://registry.gdi-de.org/codelist/de.xleitstelle.inspire_plu/LandUse).
===Code.ArtDesKontaktes===
#Cockpit Basis/Pro: Basis + Pro
#Fachliche Bedeutung: Kategorien an Kontakten, die auf der Stammdatenseite (Reiter Stammdaten) ausgegeben werden.
# Bezug zu anderen Komponenten: keine
#Technische Details:
#*Anpassbar: ja
#* Verpflichtende Codes: keine
#*Codeformat: String, vierstelliger Zahlencode mit Beschreibung, z.B. 1000 Stadtplanung
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:artdeskontaktes</nowiki>
#*Attribute/Spalten: keine
#Weitere Hinweise zur Mandanten spezifischen Anpassung: keine
===Code.Aufhebungsgrund ===
#Cockpit Basis/Pro: Basis + Pro
#Fachliche Bedeutung: Diese Codeliste enthält Optionen an Aufhebungsgründen für ein Planverfahren, die über eine Nachricht an andere Komponenten übermittelt werden.
#Bezug zu anderen Komponenten: Nachrichten-Inhalt an andere Komponenten wie DiPlanPortal
#Technische Details:
#*Anpassbar: ja
#*Verpflichtende Codes: keine
#*Codeformat: String, vierstelliger Zahlencode mit Beschreibung, z.B. 1000 Verstoß gegen Formvorschriften
#*URN: [[null]]
#*Attribute/Spalten: keine
#Weitere Hinweise zur Mandanten spezifischen Anpassung: keine
=== Code.Foerderweg===
#Cockpit Basis/Pro: Basis + Pro
#Fachliche Bedeutung: Diese Codelisten enthält Optionen für den Förderweg im Wohnungsbau, der auf der Stammdatenseite geführt und über eine Nachricht an andere Komponenten übermittelt wird.
#Bezug zu anderen Komponenten: Nachrichten-Inhalt an andere Komponenten
# Technische Details:
#*Anpassbar: ja
#*Verpflichtende Codes: keine
#*Codeformat: String, vierstelliger Zahlencode mit Beschreibung, z.B. 2000 2. Förderweg
#*URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:foerderweg</nowiki>
#*Attribute/Spalten: keine
#Weitere Hinweise zur Mandanten spezifischen Anpassung: keine
===Code.Gebietseinheit===
#Cockpit Basis/Pro: Basis + Pro
#Fachliche Bedeutung: Diese Codelisten führt alle Gebietseinheiten mit Amtlichem Gemeindeschlüssel (AGS) auf, die über eine Nachricht an andere Komponenten übermittelt werden.
#Bezug zu anderen Komponenten: Nachrichten-Inhalt an andere Komponenten
#Technische Details:
#*Anpassbar: ja
#*Verpflichtende Codes: alle
#*Codeformat: String, achtstelliger Zahlencode und Beschreibung, z.B. 01004000 Neumünster, Stadt
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:foerderweg</nowiki>
#*Attribute/Spalten: zustaendigkeit
#Weitere Hinweise zur Mandanten spezifischen Anpassung: Weitere Optionen ergänzen
=== Code.Planart ===

# Cockpit Basis/Pro: Basis + Pro
# Fachliche Bedeutung: Diese Codeliste ist Teil der hierarchischen Sortierung beim Anlegen eines Verfahrens nach den drei Auswahl-Optionen:
#* Verfahrenstyp (auch Verfahrenssteuerung bzw. Verfahrenssteuerungstyp)
#* Planart
#* Verfahrensart
# Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration und dem Datentyp Verfahrensbeschreibung referenziert.
# Technische Details:
#* Anpassbar: nein
#* Codeformat: z.B. 2_1_LandesweiterRaumordnungsplan
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:planart</nowiki>
#* Attribute/Spalten: beschreibungLang, uebergeordneterWert, xPlanFachmodell, plu-planType
# Weitere Hinweise zur Mandanten spezifischen Anpassung: Wichtig ist, dass der "uebergeordneterWert" in der Codeliste Code.ArtDerNutzung und der "uebergeordneterWert" der Planart des Verfahrens in der Codeliste Code.Planart übereinstimmen. Andernfalls werden die Nutzungen aus einer XPlanGML, für die der übergeordnete Wert nicht übereinstimmt, im Cockpit nicht angezeigt.

=== Code.Verfahrensart ===

# Cockpit Basis/Pro: Basis
# Fachliche Bedeutung: Diese Codeliste ist Teil der hierarchischen Sortierung beim Anlegen eines Verfahrens nach den drei Auswahl-Optionen:
#* Verfahrenstyp (auch Verfahrenssteuerung bzw. Verfahrenssteuerungstyp)
#* Planart
#* Verfahrensart
# Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration zur Auflistung aller möglichen Verfahrensarten referenziert.
# Technische Details:
#* Anpassbar: ja
#** Verpflichtende Codes: keine
#* Codeformat: vierstelliger Zahlencode
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:verfahrensart</nowiki>
#* Attribute/Spalten: plu-ProcedureType
# Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

=== Code.Verfahrensstand ===
# Cockpit Basis/Pro: Basis + Pro
# Fachliche Bedeutung: Bezeichnet den aktuellen Reifegrad eines Verfahrens, z.B. "simuliert" oder "beschlossen" und dient der Statusüberwachung innerhalb des Cockpits.
# Bezug zu anderen Komponenten: Es sind verschiedene fachliche Anforderungen mit dem Verfahrensstand verbunden. Dazu gehören eine Unterstützung für Berichts-, Dokumentations- und Veröffentlichungspflichten. Im DiPlanCockpit Basis muss der Verfahrensstand manuell angepasst werden. In Pro greift die Verfahrenssteuerung, sodass sich der Verfahrensstand automatisch anpasst. Um ein Planwerk veröffentlichen zu können, müssen der Verfahrensstand im Cockpit und der Rechtsstand eines Planwerkes zusammenpassen ([[Matching Verfahrensstand und Rechtsstand|Tabelle mit passenden Werten]]).
# Technische Details:
#* Anpassbar: nein
#* Codeformat: vierstellige Zahlencodes
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:verfahrensstand</nowiki>
#* Attribute/Spalten: plu-procedureState, plu-planstate
# Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

=== Code.Verfahrenssteuerung ===

# Cockpit Basis/Pro: Basis + Pro
# Fachliche Bedeutung: Diese Codeliste ist Teil der hierarchischen Sortierung beim Anlegen eines Verfahrens nach den drei Auswahl-Optionen:
#* Verfahrenstyp bzw. Verfahrenssteuerung bzw. Verfahrenssteuerungstyp
#* Planart
#* Verfahrensart
# Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration zur Auflistung aller möglichen Verfahrenstypen referenziert.
# Technische Details:
#* Anpassbar: ja
#** Verpflichtende Codes: keine
#* Codeformat: vierstellige Zahlencodes
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:verfahrenssteuerung</nowiki>
#* Attribute/Spalten: keine
# Weitere Hinweise zur Mandanten spezifischen Anpassung: Inhaltliche Synonyme zu "Verfahrenssteuerung" sind Verfahrenstyp, Verfahrenssteuerungstyp. Im Kontext der Codelisten ist dennoch nur der Begriff "Verfahrenssteuerung" gültig.

=== Code.Verfahrensunterlagetyp ===
# Cockpit Basis/Pro: Basis + Pro
# Fachliche Bedeutung: Diese Codeliste gibt die möglichen Unterlagentypen an, das heißt z.B. Vertrag, Anschreiben oder ergänzende Unterlage.
# Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration zur Angabe des Unterlagentyps bei Dokumenten referenziert.
# Technische Details:
#* Anpassbar: ja
#** Verpflichtende Codes:
#*** Code 0300 mit Wert Planzeichnung
#*** Code 0350 mit Wert XPlanarchiv
#*** Code 1180 mit Wert Veröffentlichung
#*** Code 1112 mit Wert Anschreiben Beteiligungsverfahren
#*** Code 1170 mit Wert Stellungnahme
#*** Code 4000 mit Wert Xtrassearchiv
#*** Code 4010 mit Wert XTrasse-Zeichnung
#*** Code 4020 mit Wert XTrasse-GML
#*** Code 9900 mit Wert Sonstige Unterlage
#* Codeformat: vierstellige Zahlencodes
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:verfahrensunterlagentyp</nowiki>
#* Attribute/Spalten: plu-doctype
# Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

=== Code.Vertragsart ===

# Cockpit Basis/Pro: Basis + Pro
# Fachliche Bedeutung: Auflistung der unterschiedlichen Vertragsarten mit Zuordnung der jeweiligen Verfahrensunterlagentypen
# Bezug zu anderen Komponenten: Referenzierung zur Codeliste Code.Verfahrensunterlagetyp = Die verwendeten Codes müssen in beiden Codelisten enthalten sein.
# Technische Details:
#* Anpassbar: ja
#* Verpflichtende Codes: keine
#* Codeformat: String, z.B. vierstelliger Zahlencode
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:vertragsart</nowiki>
#* Attribute/Spalten: verfahrensunterlagetyp
# Weitere Hinweise zur mandantenspezifischen Anpassung: keine

=== Code.Vormerkungen ===
# Cockpit Basis/Pro: Basis + Pro
# Fachliche Bedeutung: Ermöglicht Dokumente vorzumerken, um sie beispielsweise zu Beteiligung zu übermitteln oder in einen fachlichen Ordner zu packen (nur Pro)
# Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration zum Setzen von Vormerkungen per Default referenziert.
# Technische Details:
#* Anpassbar: ja
#** Verpflichtende Codes:
#*** Code 0300 mit Wert Umweltordner
#*** Code 0500 mit Wert Langzeitarchivierung
#*** Code 0800 mit Wert Beteiligungsverfahren
#*** Code 1000 mit Wert Metadateninformationssystem
#* Codeformat: vierstellige Zahlencodes
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:vormerkung</nowiki>
#* Attribute/Spalten: keine
# Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

=== Code.Zustaendigkeit ===

# Cockpit Basis/Pro: Basis + Pro
# Fachliche Bedeutung: Benennt die Zuständigkeit eines Nutzers für das angelegte Verfahren. Je nach Rollen - und Rechte-Konzept werden Lese- und Schreibrechte zugewiesen. Es gibt bestimmte Rollen (wie M-A), die über mehrere Zuständigkeiten hinweg Schreibrechte haben.
# Bezug zu anderen Komponenten:
# Technische Details:
#* Anpassbar: ja
#** Verpflichtende Codes: keine
#* Codeformat: frei wählbar, z.B. Senat
#* URN: <nowiki>urn:xoev-de:xplanverfahren:codeliste:zustaendigkeit</nowiki>
#* Attribute/Spalten: Metadaten Parent ID bzw. uuid
# Weitere Hinweise zur Mandanten spezifischen Anpassung: Die Einträge aus der Codeliste Zuständigkeit müssen alle in der Kontakteliste enthalten sein. Das heißt, wenn ein Eintrag in die Codeliste Zuständigkeit hinzugefügt wird, dann muss dieser auch in der Kontakteliste hinzugefügt werden. Andernfalls kommt es zu einer Fehlermeldung, die darauf hinweist, dass ein Kontakt nicht konfiguriert ist.

== Aufbau einer Codeliste ==
Am Beispiel der Codeliste Zuständigkeit ist im folgenden der Aufbau einer Codeliste erläutert und anschließend wird ihre Anpassung erklärt.

=== Gesamtansicht der Default-Version ===
Heruntergeladen und in einem XML Tool geöffnet, hier IntelliJ.
[[Datei:CodelisteGesamt.png|zentriert|mini|809x809px]]

=== Erläuterung der einzelnen Abschnitte ===
Im Folgenden sind die einzelnen Abschnitte des Screenshots beschrieben. Die Zeilenangabe bezieht sich auf die im Screenshot sichtbare Zeilennummerierung auf der linken Seite.

==== Zeilen 5-13 ====
Annotation: Abschnitt mit Metadaten zur Codeliste

==== Zeilen 14-23 ====
Identification: Abschnitt mit Angabe des Autors/Verfassers der Codeliste

==== Zeilen 24-49 ====
ColumnSet: Abschnitt mit der Struktur der Codeliste. In diesem Beispiel gibt es drei Werte, die jeweils angepasst werden können:

* code (Pflicht)
* beschreibung (Option; empfohlen)
* metadaten-parent-id (Option; empfohlen)

==== Zeile 50-62 ====
SimpleCodeList: Abschnitt für die Mandanten spezifischen Einträge. Im Screenshot ist ein Beispiel zu sehen. Eventuell ist dieser Abschnitt auch leer und das Element geschlossen, also nur <code><SimpleCodeList/></code> angegeben.

=== Mandanten spezifischen Anpassung als Schritt-Anleitung ===

==== 1. Schritt (wenn kein Beispieleintrag in SimpleCodeList) ====
Öffnen des leeren Elements SimpleCodeList. Nur dieser Bereich wird angepasst!

'''Hinweis''': Es ist sinnvoll, für die Anpassung ein IDE Tool zu verwenden wie Visual Studio Code oder IntelliJ, um den Code im Hintergrund laufend validieren zu lassen (IDE = Integrierte Entwicklungsumgebung). Die Prüfung der Formatierung lässt sich per „Shift + Alt + L“ anstoßen.

==== 2. Schritt (wenn kein Beispieleintrag in SimpleCodeList) ====
Eintrag einer validen Kopiervorlage, zum Beispiel wie Zeile 50-62 im ersten Screenshot.

Jeder Code füllt eine Zeile in der Codeliste - in der XML repräsentiert als das Element „Row“. Darin sind jeweils Angaben zu den möglichen Werten („Value“). Im Beispiel sind das „code“, „beschreibung“ und „metadaten-parent-id“. Diese repräsentieren die Spalten der Codeliste und werden entsprechend als „ColumnRef“ angegeben. Der gewünschte Wert wird jeweils im Element „SimpleValue“ eingetragen.

Kopiervorlage als Text mit Reiheneinrückung:
<code><Row>
<Value ColumnRef="code">
<SimpleValue>09000000</SimpleValue>
</Value>
<Value ColumnRef="beschreibung">
<SimpleValue>Bayern(09000000)</SimpleValue>
</Value>
<Value ColumnRef="metadaten-parent-id">
<SimpleValue>61BB42F9-20FE-489A-8C13-4FBFAC009CEA</SimpleValue>
</Value>
</Row></code>

==== Abkürzung für Schritt 1 und 2 ====
Ein Default-Eintrag ist bereits vorhanden, der als Kopiervorlage dient (wie im oberen Screenshot).

==== 3. Schritt Vervielfältigung und Anpassung ====
Die Kopiervorlage bzw. der Muster-Eintrag lässt sich 1..n-fach bis zur gewünschten Anzahl kopieren und Mandanten spezifisch anpassen.

'''Hinweise''':

* Der Code muss unique sein. In der Regel werden vierstellige Zahlenfolgen verwendet, die in Tausender- oder Hunderter-Schritten variieren.
* Die Beschreibung ist variabel wählbar und sollte sprechend sein.
* Die metadaten-parent-id, auch uuid genannt, muss unique sein und kann über ein genutztes Metadatensystem bereits vergeben sein. Wenn nicht, kann sie über einen UUID-Generator erzeugt werden z.B. unter <nowiki>https://www.uuidgenerator.net/</nowiki> (einzelne IDs + ID Bulks)

==== 4. Schritt: Hochladen ins DiPlanCockpit ====
Das Hochladen der angepassten Codeliste erfolgt im Admin-Bereich im Reiter Codelisten, den Nutzer mit den Rollen M-A-Basis aufrufen können.

Plannamenvalidierungsregeln aktualisieren

2026-04-20T05:50:04Z

Diplanung:

Per Default sind im DiPlanCockpit keine Validierungsregeln für Plannamen hinterlegt, so dass keine Überprüfung während des Uploads und Downloads von Planwerken stattfindet. Der Plannamenvalidator ist jedoch per XML konfigurierbar.

Der folgende Screenshot zeigt einen Auszug aus einer beispielhaften XML-Datei zur Konfiguration:
[[Datei:ImagePlannamenvalidierungXML2.png|zentriert|mini|742x742px]]
Die Validierungsregeln werden jeweils pro Kombination aus Planart und Verfahrensart definiert und als Regex formuliert.

Bei Regex gilt, dass in eckigen Klammern steht, um welche Zeichen es geht, und in geschweiften Klammern, wie viele dieser Zeichen genutzt werden dürfen.

Die erste Regex aus dem Beispiel sieht folgendermaßen aus: [B]{1}[S]{1}[A-Z]{1}<nowiki>[a-z&amp;&amp;[^öüäß ]</nowiki>]

Das bedeutet: Der Planname muss aus einem "B" bestehen, gefolgt von einem "S", anschließen ein weiterer Großbuchstabe zwischen A und Z und anschließend beliebig viele Kleinbuchstaben, die keine Umlaute, "ß" oder Leerzeichen sein dürfen.

==Zur Vertiefung==
===Generelles===
Folgende Zeichen sind unkritisch und im Plannamen verwendbar:
*Groß- und Kleinbuchstaben
*Zahlen
Zusätzlich Sonderzeichen, die im EfA DiPlanCockpit möglich sind:
*Umlaute als Groß- und Kleinbuchstaben wie "Öäß"
*Weitere Zeichen: ",:§" und Römische Ziffern
Zeichen mit besonderer Bedeutung in Regex:
*.()^*/
*Diese Zeichen müssen mit einen vorangestellten \ maskiert werden, um sie von ihrer Sonderrolle zu entbinden.
===Details zur Konfiguration des Plannamenvalidators===
Die Default-Konfiguration beinhaltet keine Validatorregeln, d.h. der Planname wird nicht validiert.
<code><nowiki><?xml version="1.0" encoding="UTF-8"?>
<plannamenValidatorKonfiguration>

</plannamenValidatorKonfiguration></nowiki></code>
Enthält die XML-Konfigurationsdatei Validatorregeln, muss das zu prüfende Verfahren mindestens einer Validatorregel entsprechen, andernfalls wird der Planname als ungültig abgelehnt.

Innerhalb der XML-Datei können mehrere Validatoren konfiguriert werden. Ein Validator wird durch eine Planname-Syntax-Regel beschrieben. Dieses Element besteht aus 1-n Bedingungen und 1-n regulären Ausdrücken (Regex). Die Bedingungen beziehen sich auf Verfahrenseigenschaften und dienen dazu, den gültigen Validator für den Plannamen eines Verfahrens zu ermitteln. Folgende Verfahrenseigenschaften lassen sich in den Bedingungen abbilden:
* planart
** Planart des Verfahrens
** Datentyp: string
* verfahrensart
** Verfahrensart des Verfahrens
** Datentyp: string
* hatBeschlussBuergerschaftSenatssitzungFnp
** optionale Zusatzprüfung für FNP-Verfahren:
*** Sitzung "senatssitzung" hat stattgefunden UND politisches Sitzungsergebnis ist zugestimmt
*** Sitzung "beschlussBuergerschaft" hat stattgefunden UND politisches Sitzungsergebnis ist zugestimmt
** Datentyp: boolean
* hatBeschlussBuergerschaftLapro
** optionale Zusatzprüfung für LaPro-Verfahren:
*** Sitzung "beschlussBuergerschaft" hat stattgefunden UND politisches Sitzungsergebnis ist zugestimmt
** Datentyp: boolean
Die einzelnen Bedingungen einer Planname-Syntax-Regel sind ODER-verknüpft, d.h. bezogen auf das Verfahren muss mindestens eine Bedingung erfüllt sein, um den entsprechenden Validator anzuwenden. Der Planname wird dann anhand der regulären Ausdrücke geprüft. Diese regulären Ausdrücke sind ebenfalls ODER-verknüpft, d.h. der Planname ist valide, wenn seine Syntax mindestens einem regulären Ausdruck entspricht.

Beispiel:
<plannameSyntaxRegel>
<bedingung>
<planart>6_3_EinfacherBPlan</planart>
<verfahrensart>Baustufenplan_NormalesVerfahren</verfahrensart>
</bedingung>
<bedingung>
<planart>6_3_EinfacherBPlan</planart>
<verfahrensart>Baustufenplan_VereinfachtesVerfahren</verfahrensart>
</bedingung>

<regex>[B]{1}[S]{1}[A-Z]{1}<nowiki>[a-z&amp;&amp;[^öüäß ]</nowiki>]+</regex>

<regex>[B]{1}[S]{1}[A-Z]{1}<nowiki>[a-z&amp;&amp;[^öüäß ]</nowiki>]+[-]{1}[A-Z]{1}<nowiki>[a-z&amp;&amp;[^öüäß ]</nowiki>]+</regex>
</plannameSyntaxRegel>

Datei:ImagePlannamenvalidierungXML2.png

2026-04-20T05:09:41Z

Diplanung:

ImagePlannamenvalidierungXML2

Verfahrenskonfiguration Pro

2026-04-10T04:52:04Z

Diplanung: /* Unterverfahrensteilschritt */

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

Die Verfahrenskonfiguration, kurz VK, ist das zentrale Element in der Konfiguration. Über Verfahrenskonfigurationen wird je nach Verfahrenssteuerungstyp (kurz V-Typ) der Ablauf des Verfahrens festgelegt. Das heißt, die VK bestimmt den Ablauf des Verfahrens und die vorgesehenen Aufgaben innerhalb eines Verfahrens. Außerdem enthält sie grundlegende Einstellungen zur Zeitplanung.

Es ist eine Default-Stellung für die kommunale Bauleitplanung verfügbar, die Mandanten spezifisch angepasst werden kann. Es lassen sich beliebig viele unterschiedliche VKs konfigurieren, die für jeden V-Typ eigene Abläufe definieren.

== Tab Verfahrenskonfiguration ==
Im Tab Verfahrenskonfiguration sind die verfügbaren Verfahrenskonfigurationen aufgelistet. Sie lassen sich nach Name, Status, Verwendung, Aktualisierungsdatum und bearbeitender Person filtern. Das Herunterladen erfolgt wahlweise einzeln als XML für eine Verfahrenskonfiguration oder für alle zusammen in Form einer ZIP-Datei.

Eine Verfahrenskonfiguration kann angepasst und bzw. neu erstellt und anschließend über das dafür vorgesehene Feld hochgeladen werden. Eine neu hochgeladene Verfahrenskonfiguration gilt für alle danach neu angelegten Verfahren, bereits vorhandene Verfahren werden nicht verändert.

Es ist ebenfalls möglich Verfahrenskonfigurationen zu löschen. Das erfolgt in zwei Schritten. Zuerst wird eine Verfahrenskonfiguration per Klick auf "Löschen" im Drei-Punkte-Menü als gelöscht markiert. Anschließend kann sie wiederhergestellt oder endgültig gelöscht werden. Für die endgültige Löschung ist Voraussetzung, dass die Verfahrenskonfiguration nicht mehr in Verwendung ist. Gegebenenfalls sind deswegen zuerst die Verfahren zu löschen, die die Verfahrenskonfiguration noch verwenden. Die betreffenden Verfahren werden per Klick auf die Werte in der Spalte "in Verwendung" angezeigt.

== Wichtige Hinweise ==
Jede VK bezieht sich auf Codelisten - sowohl feste als auch (vom Mandanten) änderbare Codelisten. Um Fehler zu vermeiden, muss sichergestellt werden, dass VK und änderbare Codelisten stets auf dem gleichen Stand sind. Das bedeutet:

* Anpassungen in einer VK können Konsequenzen auf änderbare Codelisten haben. = Anpassungen IMMER für VK und änderbare Codelisten umsetzen.
* Entfernung von Codes in änderbaren Codelisten müssen mit Umsicht vorgenommen und mögliche Auswirkungen auf VK(s) geprüft und bei Bedarf umgesetzt werden.
* Einfacher ist es, Einträge / Codes in änderbaren Codelisten ergänzend vorzunehmen, also den Bestand um neue Einträge zu ergänzen.
* Beim Hochladen ist die Reihenfolge wichtig: Angepasste, änderbare Codelisten müssen zuerst hochgeladen werden. Danach folgt die angepasste VK. Wird die Reihenfolge nicht eingehalten, kann es zur Fehlermeldung kommen.
* Für die Änderung von VK und Codelisten empfiehlt sich der Einsatz eines professionellen XLM-Tools, das Validierungs-Funktionen bietet. Diese laufen i.d.R. im Hintergrund ab und zeigen optisch Fehler an, wie falsche Einrückungen im XML-Baum oder fehlende Bestandteile wie der End-Tag eines Elements. Die Validierung erfolgt gegen die Datei diplanung.xsd.
* Bestimmte Zeichen in einer XML müssen encoded werden, damit sie nicht eine besondere Rolle im XML-Syntax erfüllen. Allgemein gibt es 5 Zeichen, die [https://stackoverflow.com/a/1091953 in XML escaped] werden müssen:
** " muss escaped werden als &quot;
** ' muss escaped werden als &apos;
** < muss escaped werden als &lt;
** > muss escaped werden als &gt;
** & muss escaped werden als &amp;

Mehr Details zur Mandanten spezifischen Anpassung von VK + änderbaren Codelisten siehe Abschnitt: [https://wiki.diplanung.de/index.php/Verfahrenskonfiguration_Pro#Mandanten_spezifische_Anpassung_und_Erstellung_von_VK Mandanten spezifische Anpassung und Erstellung von Verfahrenskonfigurationen.]

== Elemente der Verfahrenskonfiguration im Frontend ==
Der folgende Screenshot mit farblichen Beschriftungen und Markierungen zeigt den Reiter Aufgaben im DiPlanCockpit Pro. Darin sind die meisten Elemente der VK zu sehen, die in den folgenden Abschnitten erklärt werden.

Die gelbe Markierung zeigt jeweils exemplarisch ein Element an, der nächstliegende rote Kasten mit Text die Bezeichnung.
[[Datei:ImageVKFrontend.png|zentriert|719x719px|alternativtext=|rahmenlos]]

== Struktur der Verfahrenskonfiguration ==
In den folgenden Abschnitten wird eine beispielhafte VK anhand von Screenshots erläutert. Die Zahlen am linken Rand der Screenshots zeigen die Zeilennummern der XML-Datei. Insgesamt sind es im Beispiel 4836. Um eine kompakte Darstellung zu ermöglichen, sind die Bereiche, die für die jeweilige Erläuterung irrelevant sind, eingeklappt. Das ist an den kleinen blauen Pfeilen rechts von den Zeilennummern zu erkennen. Ein Pfeil nach unten bedeutet, dass der Abschnitt aufgeklappt ist. Ein Pfeil nach rechts hingegen heißt, dass an dieser Stelle noch weitere Zeilen sind, die lediglich nicht angezeigt werden. Die Anzahl der ausgeblendeten Zeilen ist in Klammern angegeben. Die Form der Darstellung ist dem verwendeten Programm geschuldet. Bei der Verwendung anderer Programme kann die visuelle Darstellung der XML abweichen.

== Screenshot mit Überblick der VK ==
'''Hinweis''': Neben dem Code der Verfahrenssteuerung (Zeile 3) ist die Fachdomäne anzugeben, hier "KommunaleBauleitplanung" (fehlt im Screenshot). Die Zeile muss lauten <code><verfahrenssteuerung code="6100" fachdomaene="KommunaleBauleitplanung"></code>[[Datei:ImageVKUeberblick1.png|zentriert|rahmenlos|619x619px]]

=== Erläuterung der Grundstruktur ===
[[Datei:VKRahmen2.png|alternativtext=|zentriert|rahmenlos|418x418px]]
Den äußeren Rahmen bildet die Angabe des Codes für die jeweilige VK. Im dargestellten Beispiel ist dies der Code 6100. Für jeden gewünschten V-Typ ist eine separate Datei mit einem eindeutigen Code erforderlich. Dieser Code MUSS in der Codeliste Code.Verfahrenssteuerung enthalten sein.

Daneben folgt die Angabe der Fachdomäne, hier ist es die "KommunaleBauleitplanung". Andere mögliche Fachdomänen sind "Planfeststellung" und "Raumordnung". Die Fachdomäne steuert unter anderem, [[Editieren der Stammdaten - DiPlanCockpit Pro#Verf.C3.BCgbare%20Stammdaten%20pro%20Fachdom.C3.A4ne|welche Stammdaten]] angezeigt werden.

Unterhalb der Verfahrenssteuerung und einmal eingerückt folgen die Angabe der Veranlasser für die Beteiligung sowie die gewünschten Planarten und Verfahrensarten für die VK. Die Beteiligung ist verpflichten mit einem "StandardVeranlasser" anzugeben. Optional können weitere Veranlasser mit einer Zuständigkeit angegeben werden. Zu beachten sind hierbei zwei Punkte:

# Der Code-Wert aus der Codeliste Zuständigkeit muss mit dem Wert des Attributs zuständigkeit im Element veranlasser in der VK übereinstimmen.
# Der Wert des Elements veranlasser muss mit der Organisations-ID der Organisation in der Beteiligung übereinstimmen. Der Wert lässt sich üblicherweise dem verwendeten ELSTER-Zertifikat entnehmen.

Beim Nachrichtenaustausch mit DiPlanBeteiligung wird geprüft, ob ein spezifisch zur Zuständigkeit passender Veranlasser vorhanden ist. Wenn ja, wird dieser übermittelt, andernfalls der Standard-Veranlasser ohne Zuständigkeit.[[Datei:ImageVKBeteiligungVeranlasser.png|zentriert|rahmenlos|455x455px]]
Die angegebenen Planarten sollten fachlich zum Verfahrenssteuerungstyp passen. Zulässige Kombinationen sind im XRepository in der [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planart Codeliste Planart] aufgeführt. Der Eintrag in der Spalte "Übergeordneter Wert" der Codeliste bezeichnet den passenden Verfahrenssteuerungstyp.
[[Datei:ImageVKZustaendigkeit1.png|zentriert|rahmenlos]]
Optional kann oberhalb der Beteiligung noch die Zuständigkeit angegeben sein. Wenn eine oder mehrere Zuständigkeiten in der VK aufgeführt sind, steht die VK nur für diese zur Verfügung. Andernfalls ist die Nutzung der VK für alle Zuständigkeiten möglich.

An die Verfahrensarten schließen sich allgemeine Angaben zur Zeitplanung an. Anschließend folgt der Hauptteil der VK mit der Auflistung aller Verfahrensschritte. Diese enthalten jeweils Verfahrensteilschritte, Unterverfahrensteilschritte, Aufgaben, Unteraufgaben und schließlich die ActionItems.

Sämtliche ActionItems sind im Detail auf einer eigenen Unterseite beschrieben. Auf dieser Seite folgt eine Erläuterung der übrigen Elemente der VK.

=== Erläuterung der einzelnen Abschnitte ===

==== Zeitplanung ====
[[Datei:ImageVKZeitplanung2.png|zentriert|rahmenlos|744x744px]]
Im Abschnitt zur Zeitplanung wird festgelegt, ob ein Monitoring vorgesehen ist. Im dargestellten Beispiel ist es vorgesehen. Zusätzlich ist angegeben, welche möglichen Arten der Monitoringrelevanz es geben soll und welche Nicht-Monitoring-Gründe.

Außerdem wird im Abschnitt zur Zeitplanung festgelegt, welcher Termin als Prognosestarttermin dienen soll. Von diesem geht die gesamte Zeitplanung aus. Im Beispiel ist es der Termin "Grobabstimmung". Angegeben ist der entsprechende Code "grobabstimmung" aus der Codeliste Code.Sitzungen, alternativ ist auch ein Code aus Code.SonstigeTermin möglich. Zu beachten ist, dass der gewählte Termin mit dem Attribut "prognoserelevant=ja" angelegt werden muss.
{| class="wikitable"
!Name
!Zweck
|-
|monitoring
|Angabe, ob ein Monitoring vorgesehen ist.
|-
|artDerMonitoringRelevanz
|Angabe möglicher Arten der Monitoringrelevanz mit Name und Beschreibung.
|-
|nichtMonitoringGrund
|Angabe von Codes aus der Codeliste Code.NichtMonitoringGrund, die für Verfahren mit dieser Verfahrenskonfiguration zur Verfügung stehen sollen.
|-
|prognosestarttermin
|Definiert den Prognosestarttermin, von dem die Zeitplanung ausgeht. Zu beachten ist, dass der gewählte Termin mit dem Attribut "prognoserelevant=ja" angelegt werden muss.
|}

==== Optional: Fachdomänenspezifische Ordnerstruktur ====
Eine konfigurierbare fachdomänenspezifische Ordnerstruktur zum Hochladen der Dokumente kann durch den Mandanten-Administrator über den Abschnitt <dokumentbibliothek> ergänzt werden. Zurzeit ist diese Ordnerstruktur nur für die Fachdomäne Planfeststellung konfiguriert.
[[Datei:ImageFachdomänenspezifischeOrdner.png|zentriert|rahmenlos|748x748px]]
Erklärung der Felder:
{| class="wikitable"
!Name
!Zweck
|-
|name
|Name bzw. Bezeichnung des Ordners (im Frontend für Nutzende sichtbar), darf nicht leer sein und darf pro Ebene nicht doppelt auftauchen.
|-
|upload
|Gibt an, ob ein Dokumentenupload über den Ordner möglich ist (true) oder nicht (false).
|-
|verfahrensunterlagentyp
|Der standardmäßig automatisch zugeordnete Verfahrensunterlagentyp für alle Dokumente / Dateien im Ordner.
|-
|pflicht
|"ja" bedeutet, dass sich mindestens eine Datei im Ordner befinden muss, was im Rahmen der Vollzähligkeitsprüfung für Vorhabens- und Antragsdokumente der Fachdomäne Planfeststellung überprüft wird. "nein" bedeutet, dass der Ordner leer sein darf und keine Auswirkung auf die Vollzähligkeitsprüfung hat.
|-
|beschreibung
|Textliche Beschreibung der fachlichen Inhalte der Dokumente im Ordner, die für die KI-Prüfung genutzt wird.
|}
Die folgenden Regeln und Einschränkungen müssen beachtet werden:

* Die Ordnerstruktur entspricht einer Baumstruktur (ähnlich wie Windows-Explorer) mit den Ebenen 0 (Wurzel) bis n.
* Die Codeliste der Verfahrensunterlagentypen muss um die für die Ordnerstruktur vorgesehenen Verfahrensunterlagentypen ergänzt und hochgeladen sein, anschließend kann die VK hochgeladen werden.
* Das Attribut verfahrensunterlagentyp darf nicht leer sein und nicht doppelt über die ganze Ordnerstruktur vorkommen.
* Wenn Dokumente innerhalb dieser Ordnerstruktur von einem DiPlan-System (z. B. Vorhaben-Cockpit - Antragsstellung) zu einem andern DiPlan-System (z. B. Behörden-Cockpit - Verfahrens-Verwaltung) übertragen werden, dann muss die Ordnerstruktur in beiden Systemen exakt identisch sein. Dabei muss beachtet werden, dass in den Codelisten die Codewerte für Verfahrensunterlagentypen in beiden Systemen eindeutig sind und keine Widersprüche vorhanden sind.

==== Optional: Mandanten spezifische Stammdaten ====
Optional können oberhalb der Verfahrensschritte zusätzliche Mandanten spezifische Stammdaten angegeben werden. Diese ermöglichen die Gestaltung individueller Eingabefelder für die Stammdatenseite. Sie erscheinen auf der Stammdatenseite oberhalb des Abschnitts zu Parallelverfahren in der Reihenfolge, mit der sie in der Verfahrenskonfiguration aufgeführt sind. Ihre Definition erfolgt beispielsweise in der Form <code><eigenschaft label="Beispiel eines Mandanten spezifischen Feldes zur Eingabe von Text" name="Beispiel6200Text" typ="TEXT" subtyp="SINGLE" pflicht="nein"/></code>.

Erklärung der Felder:
{| class="wikitable"
!Name
!Zweck
|-
|label
|Wird als Beschriftung des Feldes angezeigt, kann frei gewählt werden.
|-
|name
|Technischer Name, muss eindeutig sein, sprich darf nur einmal verwendet werden.
|-
|typ
|Gibt den Datentyp an. Zulässige Werte sind: TEXT (Freitextfeld mit max. 255 Zeichen), FLOAT (Zahlenfeld für Gleitkommazahlen), INTEGER (Zahlenfeld für ganze Zahlen), BOOLEAN (Checkbox), DATE (Datumsfeld), TIME (Zeitangabe), DATE_TIME (Datums- und Zeitangabe), DATE_TIME_RANGE (Zeitspanne), URL (Link), CODELIST (Dropdown-Auswahl, Inhalte kommen aus einer Codeliste), DROPDOWN (Dropdown-Auswahl, Optionen individuell festgelegt ohne Codeliste)
|-
|subtyp
|Muss für alle Typen außer CODELIST und DROPDOWN den Wert SINGLE haben. Bei CODELIST bzw. DROPDOWN ermöglicht SINGLE die Auswahl genau eines Wertes aus dem Dropdown, bei LIST können mehrere ausgewählt werden (Multiselect).
|-
|pflicht
|Gibt an, ob das Feld verpflichtend ist (ja oder nein).
|-
|codelistName
|Nur erforderlich bei Typ CODELIST. Der Wert muss dann lauten: "Code." + Name der Codeliste, z.B. "Code.Zustaendigkeit".
|-
|option
|Nur erforderlich bei Typ DROPDOWN. Einmal bis beliebig oft mit je einem Eintrag für das Dropdown einfügen.
|}

==== Verfahrensschritt ====
[[Datei:ImageVKVS.png|links|488x488px|alternativtext=|rahmenlos]]
Ein Verfahrensschritt ist die oberste Ebene in der Unterteilung eines Verfahrens in mehrere Abschnitte. Er wird durch die Angabe des Codes aus Code.Verfahrensschritte bestimmt. Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen. Aktuell werden Durchgänge auf Ebene der Verfahrensschritte durch das Cockpit nicht unterstützt, sodass die Angabe von "ja" keinen Effekt hat.

Jeder Verfahrensschritt enthält beliebig viele Verfahrensteilschritte. Es ist möglich keinen Verfahrensteilschritt anzugeben, dann wird der Verfahrensschritt jedoch nicht im Cockpit sichtbar.

Die Reihenfolge der Verschachtelung (Verfahrensschritt > Verfahrensteilschritt > Unterverfahrensteilschritt) muss eingehalten werden. In einen Verfahrensschritt direkt einen Unterverfahrensteilschritt einzufügen ist nicht zulässig. Ebenso wenig ist es zulässig, innerhalb eines Verfahrensteilschritts oder einer tieferen Ebene, Verfahrensschritte zu ergänzen.

Damit die Verfahrensschritte in der richtigen Reihenfolge dargestellt werden, ist es notwendig ihre Codes in alphabetischer/numerischer Reihenfolge zu vergeben, also beispielsweise "0001VerfahrensschrittEins", "0002Verfahrensschritt2" usw.
{| class="wikitable"
!Name
!Zweck
|-
|verfahrensteilschritt
|Angabe eines untergeordneten Verfahrensteilschritts.
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein". Im Cockpit werden Durchgänge für Verfahrensschritte nicht unterstützt.
|}
Eine Besonderheit ist der Verfahrensschritt 9998. Dieser ist obligatorisch mitsamt des Verfahrensteilschritts 9998. Darin können Termine aufgeführt sein, die Eingaben auf der Stammdatenseite referenzieren.

Die mit der Stammdatenseite verknüpften Termine sind für die kommunale Bauleitplanung 0100 (Beschlussdatum), 0200 (Vorweggenehmigung bzw. Planreife gemäß §33 BauGB) und 9300 (Aufhebungsdatum). Der Termin 9300 muss zudem die beiden Eigenschaften "linkPlanzeichnung" und "linkBegruendung" des Typs URL haben.

Für die Fachdomäne Raumordnung sind es die Termine pflicht_9400 (Tag des Inkrafttretens) und pflicht_9450 (Tag des Außerkrafttretens). Diese Termine müssen im VS 9998 angegeben werden, wenn sie nicht bereits in einem vorherigen Verfahrensschritt definiert sind.

Wichtig für die Stammdatenseite ist, dass diese Termine in der Verfahrenskonfiguration enthalten sind, aber nicht an welcher Stelle. Der VS 9998 dienst als Option, wenn nicht gewünscht ist, die Termine in den Verfahrensablauf einzubinden.
[[Datei:ImageVS9998 2.png|zentriert|rahmenlos|572x572px]]

==== Verfahrensteilschritt ====
[[Datei:ImageVKVTS.png|601x601px|alternativtext=|zentriert|rahmenlos]]
Verfahrensteilschritte bilden die zweite Ebene in der Strukturierung des Verfahrensablaufs. Sie werden durch die Angabe eines Codes aus Code.Verfahrensteilschritte bestimmt. Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen.

Zu jedem Verfahrensteilschritt können 0 bis beliebig viele Sitzungen und/oder sonstige Termine angegeben werden. Anschließend folgt die Auflistung aller Unterverfahrensteilschritte.
{| class="wikitable"
!Name
!Zweck
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein".
|-
|sitzung
|Sitzung innerhalb des Verfahrensteilschritts.
|-
|sonstigerTermin
|Sonstiger Termin innerhalb des Verfahrensteilschritts.
|-
|unterverfahrensteilschritt
|Angabe eines untergeordneten Unterverfahrensteilschritts.
|}

==== Sitzung ====
[[Datei:ImageVKSitzung.png|links|474x474px|alternativtext=|rahmenlos]]
Sitzungen werden über einen Code aus der Codeliste Code.Sitzungscodes bestimmt. Zu beachten ist, dass die Bezeichnung einer Sitzung maximal 255 Zeichen umfassen darf. Zusätzlich werden mögliche Ergebnisse über die Angabe eines Codes aus Code.Sitzungsergebnistyp festgelegt.

Jede Sitzung enthält die Information, ob sie zeitplanungsrelevant oder nicht zeitplanungsrelevant ist. Bei Relevanz für die Zeitplanung ist ebenfalls anzugeben ob Monitoring- und/oder Prognoserelevanz gewünscht ist. Zusätzlich ist die vorgesehene Wirkung in der Modellberechnung anzugeben. Dies erfolgt über die Verzögerung, Dauer und das Setzen auf Aktiv. Die möglichen Verzögerungsgründe werden hier nicht angegeben, sondern sind je nach V-Typ festgelegt und stammen aus der Codeliste Code.Verzoegerungsgrund.

Für nicht zeitplanungsrelevante Sitzungen ist nur anzugeben, welcher Datumstyp gewünscht ist. Dieser kann ein einzelner Tag (Angabe zeitpunkt), Zeitraum (Angabe zeitraum) oder flexibel (Angabe zeitpunkt_oder_zeitraum) sein.
{| class="wikitable"
!Name
!Zweck
|-
|ergebnistyp
|Codeliste der Ergebnistypen.
|-
|zeitplanungsrelevant oder nichtzeitplanungsrelevant
|Legt Zeitplanungsrelevanz fest.
|-
|monitoringrelevant
|Legt Monitoringrelevanz fest. Angabe "ja" oder "nein".
|-
|prognoserelevant
|Legt Prognoserelevanz fest. Angabe "ja" oder "nein".
|-
|modellberechnung
|Enthält Informationen zur Berechnung in der Zeitplanung.
|-
|verzoegerung
|Bestimmt die Verzögerung. Angabe als ganze Zahl.
|-
|dauer
|Bestimmt die Dauer. Angabe als ganze Zahl.
|-
|aktiv
|(De-)aktiviert den Einfluss auf die Modellberechnung. Angabe "ja" oder "nein".
|-
|datumstyp
|Beschreibt für nicht zeitplanungsrelevante Termine die Art der Datumsangabe. Angabe "zeitpunkt", "zeitraum" oder "zeitpunkt_oder_zeitraum".
|}

==== Sonstiger Termin ====
[[Datei:ImageSonstigeTermine.png|links|rahmenlos|507x507px]]
(Hinweis: Des Screenshot zeigt zwei verschiedene sonstige Termine, um möglichst viele Optionen der Konfiguration abzubilden.)

Sonstige Termine werden über einen Code aus der Codeliste Code.SonstigeTermin bestimmt. Zu beachten ist, dass die Bezeichnung eines sonstigen Termins maximal 255 Zeichen umfassen darf. Zusätzlich wird in der Beschreibung der anzuzeigende Text zu dem sonstigen Termin definiert.

Jeder sonstige Termin enthält die Information, ob er zeitplanungsrelevant oder nicht zeitplanungsrelevant ist. Bei Relevanz für die Zeitplanung ist ebenfalls anzugeben ob Monitoring- und/oder Prognoserelevanz gewünscht ist. Zusätzlich ist die vorgesehene Wirkung in der Modellberechnung anzugeben. Dies erfolgt über die Verzögerung, Dauer und das Setzen auf Aktiv. Die möglichen Verzögerungsgründe werden hier nicht angegeben, sondern sind je nach V-Typ fest vorgegeben.

Für nicht zeitplanungsrelevante sonstige Termine ist nur anzugeben, welcher Datumstyp gewünscht ist. Dieser kann ein einzelner Tag (Angabe zeitpunkt), Zeitraum (Angabe zeitraum) oder flexibel (Angabe zeitpunkt_oder_zeitraum) sein.

Sonstige Termine können außerdem über eine oder mehrere Angaben einer "eigenschaft" verfügen. Es stehen unterschiedliche Datentypen zur Verfügung (siehe Tabelle), mit denen weitere Informationen zu einem Termin angegeben werden können.
{| class="wikitable"
!Name
!Zweck
|-
|beschreibung
|Anzuzeigende Beschreibung des sonstigen Termins.
|-
|zeitplanungsrelevant oder nichtzeitplanungsrelevant
|Legt Zeitplanungsrelevanz fest.
|-
|monitoringrelevant
|Legt Monitoringrelevanz fest. Angabe "ja" oder "nein".
|-
|prognoserelevant
|Legt Prognoserelevanz fest. Angabe "ja" oder "nein".
|-
|modellberechnung
|Enthält Informationen zur Berechnung in der Zeitplanung.
|-
|verzoegerung
|Bestimmt die Verzögerung. Angabe als ganze Zahl.
|-
|dauer
|Bestimmt die Dauer. Angabe als ganze Zahl.
|-
|aktiv
|(De-)aktiviert den Einfluss auf die Modellberechnung. Angabe "ja" oder "nein".
|-
|datumstyp
|Beschreibt für nicht zeitplanungsrelevante Termine die Art der Datumsangabe. Angabe "zeitpunkt", "zeitraum" oder "zeitpunkt_oder_zeitraum".
|-
|eigenschaft
|Beschreibt zusätzliche Informationen zu dem Termin. Umfasst "name", "typ" und optional "codelistName".
|-
|name
|Benennt die "eigenschaft" des Termins. Angabe als String.
|-
|typ
|Beschreibt das Datenformat der "eigenschaft" des Termins. Optionen: "TEXT", "FLOAT", "INTEGER", "BOOLEAN", "DATE", "URL", "CODELIST"
|-
|codelistName
|Benennt die zu referenzierende Codeliste, wenn der "typ" der "eigenschaft" "CODELIST" ist.
|}

==== Unterverfahrensteilschritt ====
[[Datei:ImageVKUVTS.png|links|436x436px|alternativtext=|rahmenlos]]
Unterverfahrensteilschritte bilden die dritte Ebene in der Strukturierung des Verfahrensablaufs. Sie werden durch die Angabe des Codes aus Code.Unterverfahrensteilschritte bestimmt. Die Angabe bei "pflicht" legt fest, ob der Unterverfahrensteilschritt immer aktiviert sein soll (Angabe "ja"), oder ob er optional und manuell aktivierbar sein soll (Angabe "nein"). Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen. Aktuell werden Durchgänge auf Ebene der Unterverfahrensteilschritte durch das Cockpit nicht unterstützt, sodass die Angabe von "ja" keinen Effekt hat. Optional kann eine Bedingung angegeben werden, wann der UVTS angezeigt werden soll. Details zu Bedingungen finden sich im Abschnitt [https://wiki.diplanung.de/index.php?title=Verfahrenskonfiguration_Pro#Aufgabe Aufgaben].

In jedem Unterverfahrensteilschritt können 0 bis beliebig viele Aufgaben enthalten sein. Unterverfahrensteilschritte werden auch dann dargestellt, wenn sie keine Aufgaben enthalten.
{| class="wikitable"
!Name
!Zweck
|-
|pflicht
|Legt fest, ob der Unterverfahrensteilschritt verpflichten oder optional ist. Angabe "ja" oder "nein".
|-
|bedingung
|Bedingung in Platzhalter-Syntax, wann der UVTS angezeigt werden soll.
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein". Im Cockpit werden Durchgänge für Unterverfahrensteilschritte nicht unterstützt.
|-
|aufgabe
|Angabe einer untergeordneten Aufgabe.
|}

==== Aufgabe ====
[[Datei:ImageVKAufgabe.png|zentriert|719x719px|alternativtext=|rahmenlos]]
Aufgaben sind in Unterverfahrensteilschritten enthalten. Pro Unterverfahrensteilschritt sind 0 bis beliebig viele Aufgaben möglich.

Jede Aufgabe benötigt eine eindeutige ID zur Identifikation und eine Beschreibung, die im Cockpit angezeigt wird. Optional kann eine Bedingung angegeben werden, wann die Aufgabe angezeigt werden soll. Im dargestellten Beispiel wird die Aufgabe nur angezeigt, wenn der sonstige Termin "InfoFoeb_Zeitraum" als Eigenschaft den Code 0200 erhalten hat.
{| class="wikitable"
!Name
!Zweck
|-
|id
|Eindeutige ID der Aufgabe.
|-
|bedingung
|Bedingung in Platzhalter-Syntax, wann die Aufgabe angezeigt werden soll.
|-
|beschreibung
|Anzuzeigende Beschreibung der Aufgabe.
|-
|unteraufgabe
|Unteraufgabe der Aufgabe, enthält die ActionItems.
|}
Es können auch Werte von ActionItems in Bedinungen genutzt werden. Dabei sind jedoch nur ActionItems möglich, die im selben Verfahrensteilschritt definiert sind, in dem auch die Aufgabe/Unteraufgabe mit der Bedingung enthalten ist. Zudem muss das ActionItem in der Verfahrenskonfiguration eine refID definiert haben, welche dann genutzt wird um das ActionItem in der Bedingung zu referenzieren.

Beispiele:
{| class="wikitable"
!Beispiel
!Erklärung
|-
|<code>actionItem('ref-checkbox').checked=true</code>
|Das ActionItem vom Typ Checkbox mit der refID <code>ref-checkbox</code> muss angehakt sein, damit die Bedingung zutrifft.
|-
|<code>actionItem('ref-string').value!=someValue</code>
|Das ActionItem vom Typ Text mit der refID <code>ref-string</code> darf nicht den Wert <code>someValue</code> haben, damit die Bedingung zutrifft.
|-
|<code>actionItem('ref-dropdown').valueSelected=someValue</code>
|Das ActionItem vom Typ Dropdown mit der refID <code>ref-dropdown</code> muss den Wert <code>someValue</code> ausgewählt haben, damit die Bedingung zutrifft.
|}

==== Unteraufgabe ====
[[Datei:ImageVKUnteraufgabe.png|zentriert|531x531px|alternativtext=|rahmenlos]]
Unteraufgaben sind in beliebiger Anzahl in Aufgaben enthalten und umfassen beliebig viele ActionItems. ActionItems sind auf einer eigenen Unterseite beschrieben. Um ein ActionItem einer Aufgabe hinzuzufügen, muss eine Unteraufgabe vorhanden und das ActionItem darin ergänzt werden. Direkt in eine Aufgabe ohne Unteraufgabe ActionItems hinzuzufügen ist nicht möglich.

Analog zu Aufgaben benötigt je Unteraufgabe eine eindeutige ID zur Identifikation und eine Beschreibung, die im Cockpit angezeigt wird. Optional kann auch für Unteraufgaben eine Bedingung angegeben werden, wann sie angezeigt werden soll. Im dargestellten Beispiel wird die Unteraufgabe nur angezeigt, wenn der Hauptbezirk Harburg ist.
{| class="wikitable"
!Name
!Zweck
|-
|id
|Eindeutige ID der Aufgabe.
|-
|bedingung
|Bedingung in Platzhalter-Syntax ob die Unteraufgabe angezeigt werden soll.
|-
|beschreibung
|Anzuzeigende Beschreibung der Aufgabe.
|-
|Auflistung der ActionItems
|Liste der ActionItems.
|}

Verfahren hinzufügen (XPlanverfahren) DiPlanCockpit Pro

2026-04-08T14:21:17Z

Diplanung: /* Mandaten spezifische Stammdaten */

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

Die Funktion "Verfahren hinzufügen (XPlanverfahren)" ermöglicht den Import von Verfahren, welche im XML-Format und nach dem XöV Standard XPlanverfahren bereitgestellt werden. Diese Funktion ist im Reiter "Konfiguration" des Admin-Bereichs zu finden.

Für den Import sind XML-Dateien der Verfahren nach dem Standard XPlanverfahren zu erstellen. Die Angaben zu einem Verfahren können sehr detailliert sein und beispielsweise Dokumente umfassen. Verpflichtend sind hingegen nur einige der möglichen Angaben. Sie sind im Abschnitt mit der Beschreibung der einzelnen Abschnitte einer Importdatei durch einen Stern (*) gekennzeichnet. In einer minimalen Importdatei müssen mindestens diese Informationen enthalten sein.

Der Import kann ein einzelnes oder auch mehrere Verfahren umfassen. Die Größe des Imports hat Einfluss auf die Dauer des Import-Vorgangs. Während des Imports wird das System stark ausgelastet und ist unter Umständen eingeschränkt verfügbar. Es wird deswegen empfohlen größere Importe idealerweise in Randzeiten anzustoßen.

In jeder Datei können mehrere Verfahren angegeben sein, sodass sie gleichzeitig importiert werden können. Aus technischen Gründen ist jedoch die Anzahl der simultan importierbaren Verfahren in einem XPlanverfahren Importdokument limitiert.

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).

Das Importdokument durchläuft eine mehrstufige Validierung:

# XöV Schemavalidierung (z.B. Prüfung der korrekten Datentypen und von Pflichtfeldern)
# Referenzierte Codelistenwerte im Importdokument werden gegen die im Cockpit hinterlegten Codelisten abgeglichen
# Plannamen werden auf Eindeutigkeit innerhalb des Mandanten geprüft
# Weitere fachliche Validierungen wie Prüfung bestimmter Felder in Abhängigkeit von anderen Feldern, [[Editieren der Stammdaten - DiPlanCockpit Pro|Prüfung von Datumsangaben in Abhängigkeit von der Fachdomäne und des Verfahrensstandes]]
# Referenzierte Codelistenwerte im Importdokument werden gegen die im Cockpit hinterlegte Verfahrenskonfiguration abgeglichen, welche im Importdokument referenziert wird.

Kommt es bei der Validierung zu Fehlern, so 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.

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

= Wichtige Voraussetzungen =
Jedes Verfahren referenziert auf eine Verfahrenskonfiguration (VK) und die dazugehörigen Codelisten - sowohl feste als auch (vom Mandanten) änderbare Codelisten. Um Fehler zu vermeiden, muss sichergestellt werden, dass das zu importierende Verfahren mit der VK und änderbaren Codelisten stets auf dem gleichen Stand ist und dieses spezifische Set an VK + Codelisten im Cockpit verfügbar sind. Weitere Details dazu sowie zur Anpassung einer VK finden sich in der Dokumentation zur [[Verfahrenskonfiguration Pro|Verfahrenskonfiguration]].

Je Verfahrenssteuerungstyp sollte eine eigene VK vorliegen, um künftige Auswertungen bedienen zu können. Ebenso sollte je XPlan Fachmodell (BP, FB; LP, RP etc.) eine eigene VK vorliegen.

Es können sowohl beschlossene als auch laufende Verfahren importiert werden. Für den Import beschlossener Verfahren kann eine Basis VK (ohne VTS, UVTS, Aufgaben) ausreichend sein. Doch auch hier sollte nach Verfahrenssteuerungstyp differenziert werden. Für laufende Verfahren sind i.d.R. vollständige VKs notwendig. Zu beachten ist, dass allgemein der Status von Aufgaben nicht übernommen wird, sodass jedes Verfahren nachgepflegt werden muss.

= Verfahren importieren =
Um ein oder mehrere Planverfahren zu importieren, benötigen Sie ein lokal abgelegtes valides XPlanverfahren Importdokument. Dieses können Sie über die entsprechende Schaltfläche "Verfahren hinzufügen (XPlanverfahren)" hochladen und so den Importprozess starten.

Klicken Sie auf das Lupen-Symbol, um das lokale XPlanverfahren Importdokument auszuwählen. Die Dateiendung muss dem XML-Format entsprechen.

Nach Auswahl und Bestätigung des Dateinamen starten Sie den Importprozess durch Klick auf Hochladen.

Ob der Import erfolgreich war, lässt sich dem allgemeinen Protokoll entnehmen. Erfolgreiche Imports werden dort festgehalten. Ob ein bestimmtes Verfahren aus einem Import stammt, sieht man wiederum im Verfahrensprotokoll.

== Prüfung der Eingabedaten ==
Während des Importprozesses wird die Überprüfung der Eingabedaten vorgenommen. Neben einer allgemeinen XML-Schemaprüfung werden im Importdokument referenzierte Codelistenwerte gegen aktuell in im Cockpit hinterlegte Codelisten abgeglichen. Zusätzlich werden Plannamen auf Eindeutigkeit und die Existenz von Pflichtattributen geprüft.

Falls während des Imports ein ein Fehler identifiziert wird, dann wird der Importvorgang abgebrochen und es wird eine Fehlermeldung erzeugt. 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 ===
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. Die Inhalte können sich zwischen Versionen semantisch und syntaktisch ändern bzw. es können neue Inhalte hinzugefügt oder alte Inhalte entfernt werden. XPlanverfahren ist im XRepository zudem 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 (bitte zur Validierung nur die Version aus dem Cockpit verwenden) und die Spezifikation mit allen Inhalten als PDF-Datei.

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.
= Aufbau eines Verfahrens für den Import =
Die Inhalte eines Imports sind in XPlanverfahren beschrieben und im [https://www.xrepository.de/details/urn:xoev-de:xleitstelle:standard:xplanverfahren XRepository] veröffentlicht. Im Folgenden finden Sie über den Standard hinausgehende Beschreibungen und Hinweise anhand eines beispielhaften Verfahrens im XML-Format.

Die folgenden Screenshots zeigen exemplarisch ein Verfahren, das ins Cockpit importiert werden kann. Die Zahlen am linken Rand der Screenshots zeigen die Zeilennummern der XML-Datei. Insgesamt sind es im Beispiel 284. Um eine kompakte Darstellung zu ermöglichen, sind die Bereiche, die für die jeweilige Erläuterung irrelevant sind, eingeklappt. Das ist an den kleinen blauen Pfeilen rechts von den Zeilennummern zu erkennen. Ein Pfeil nach unten bedeutet, dass der Abschnitt aufgeklappt ist. Ein Pfeil nach rechts hingegen heißt, dass an dieser Stelle noch weitere Zeilen sind, die lediglich nicht angezeigt werden. Die Anzahl der ausgeblendeten Zeilen ist in Klammern angegeben. Die Form der Darstellung ist dem verwendeten Programm geschuldet. Bei der Verwendung anderer Programme kann die visuelle Darstellung der XML abweichen.

== Struktur des Verfahrens ==
[[Datei:ImageStrukturVerfahren.png|zentriert|alternativtext=|rahmenlos|916x916px]]
Dieser Screenshot gibt einen Überblick über die Informationen, die zu einem Verfahren angegeben werden können. Die Reihenfolge der Angaben ist nicht beliebig, sondern muss den Vorgaben aus XPlanverfahren entsprechen.

Die oberste Ebene der XML-Datei mit "planung2Empfaenger.UebersichtVerfahren.0811" ist technisch erforderlich und enthält in Form von URLs beispielsweise Informationen zu den verwendeten namespaces.

Darin folgt der eigentliche "nachrichteninhalt" mit der "verfahrensuebersicht" und darin der "verfahrensbeschreibung" eines konkreten Verfahrens. Sollen mehrere Verfahren in einer XML importiert werden, so muss für jedes Verfahren ein eigener Abschnitt "verfahrensuebersicht" mit der "verfahrensbeschreibung" enthalten sein.

== Beschreibung der einzelnen Abschnitte ==
Im Folgenden werden die einzelnen Unterkapitel anhand von Beispielen aus der XML erläutert. Für alle Unterkapitel gilt:

* Die "listURI" gibt die konkrete Codeliste an und die "listVersionID" die zu verwendende Version der Codeliste.
* Screenshots aus dem DiPlanCockpit zeigen einzelne Elemente des importierten Verfahrens, dazu gehören z.B. Verträge im Reiter Dokumente. Wenn kein Screenshot des DiPlanCockpit für ein Unterkapitel eingefügt ist, finden sich die dargestellten Informationen allgemein auf der Stammdatenseite im DiPlanCockpit wieder.
* Ein Stern (*) vor der Überschrift des Unterkapitels markiert die verpflichtenden Inhalte für den Import.

=== *Verfahrensverweis ===
[[Datei:ImageVerfahrensverweis.png|zentriert|rahmenlos|705x705px]]
Der "verfahrensverweis" ist verpflichtend und enthält die im oberen Screenshot dargestellten grundlegenden Informationen eines Verfahrens, wie die obligatorische Angabe der "verfahrenssteuerung". Der Arbeitstitel ist bei simulierten Verfahren verpflichtend. Bei nicht simulierten Verfahren ist der Planname verpflichtend.

Aufgaben sind in der Verfahrenskonfiguration aufgeführt und ergeben sich für ein Verfahren über den Code für die Verfahrenssteuerung. Der Status von Aufgaben (erledigt/nicht erledigt) kann nicht importiert werden und muss im Cockpit händisch nach Öffnen des Verfahrens angepasst werden. Es ist jedoch möglich für einzelne Action Items Inhalte bzw. Ergebnisse anzugeben, bspw. eine Checkbox anzuhaken oder den Wert in einem Textfeld. Eine genauere Erläuterung befindet sich im Abschnitt [[Verfahren hinzufügen (XPlanverfahren) DiPlanCockpit Pro|zum Import von Action Items]].

=== *Verfahrensstand ===
[[Datei:ImageVerfahrensstand.png|zentriert|rahmenlos|702x702px]]
Der "verfahrensstand" ist verpflichtend anzugeben. Er beschreibt den aktuellen Stand des Verfahrens als Wert aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensstand Codeliste] und muss zum Planstatus passen. So muss beispielsweise für ein simuliertes Verfahren Verfahrensstand 1000 und der Planstatus 0300 sein. Außerdem gibt es Abhängigkeiten zwischen dem Verfahrensstand und Datumsangaben, siehe Tabelle unter [[Verfahren hinzufügen (XPlanverfahren) DiPlanCockpit Pro#Satzung%20Beschluss|https://wiki.diplanung.de/index.php?title=Verfahren_hinzufügen_(XPlanverfahren)_DiPlanCockpit_Pro#Satzung_Beschluss]].

=== *Beschreibungen und Schlagworte ===
[[Datei:ImageBeschreibungSchlagworte.png|zentriert|rahmenlos|698x698px]]
Für "beschreibungPlanungsanlass" und "beschreibungGeltungsbereich" werden verpflichtend textliche Beschreibungen festgehalten werden und optional relevante Schlagworte jeweils einzeln als "schlagwort".

=== *Planart und Planstatus ===
[[Datei:ImagePlanartPlanstatus.png|zentriert|rahmenlos|701x701px]]
Sowohl die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planart planart]" als auch der "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planstatus planstatus]" werden über einen Code aus der jeweiligen Codeliste verpflichtend angegeben. Der Planstatus muss zum Verfahrensstand passen. Für ein simuliertes Verfahren muss der Verfahrensstand 1000 und der Planstatus 0300 sein.

=== Relation zum Planrecht ===
[[Datei:ImageRelationPlanrecht.png|zentriert|rahmenlos|697x697px]]
Für die optionale Darstellung der [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:relationplanrecht Relation] des Verfahrens zum Planrecht werden die "planID" (optional) sowie der "typ" (verpflichtend) der Relation angegeben.

=== Ausgleichsflächen ===
[[Datei:ImageAusgleichsflaechen.png|zentriert|rahmenlos|696x696px]]
Die Angabe zu "ausgleichsflaechen" ist optional und erfolgt über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:ausgleichsflaechen Codeliste].

=== Kontakte ===
[[Datei:ImageKontakte.png|zentriert|rahmenlos|700x700px]]
Informationen zu Kontakten sind optional und werden für jeden "kontakt" einzeln angegeben. Es müssen nicht alle dargestellten Informationen enthalten sein, so können beispielsweise die Angaben zur "person" entfallen. Die Angabe der "artDesKontaktes" ist erforderlich und erfolgt über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:artdeskontaktes Codeliste].

=== *Zuständigkeit und Gebietseinheit ===
[[Datei:ImageZustaendigkeitGebietseinheit.png|zentriert|rahmenlos|708x708px]]
Sowohl die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:zustaendigkeit zustaendigkeit]" als auch die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:gebietseinheit gebietseinheit]" sind verpflichtend und werden über einen Code aus der jeweiligen Codeliste angegeben. Beide Codelisten sind im Cockpit über den Administrationsbereich anpassbar. Es können mehrere Gebietseinheiten angegeben werden.

=== *Geobezug (Planwerkreferenz) ===
[[Datei:ImageGeobezug.png|zentriert|rahmenlos|700x700px]]
In Abhängigkeit des Verfahrensstandes kann bereits ein XPlanGML vorliegen, dies ist optional. Evtl. liegt 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 kann entweder als Geobezug ein "xPlan" (im Beispiel auskommentiert (grüne Schrift)) oder eine "flaechenabgrenzung" angegeben werden. 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: 25832
* EPSG: 25833
* EPSG: 325833
* EPSG: 31466
* EPSG: 31467
* EPSG: 31468
* EPSG: 31469
* EPSG: 4258
* EPSG: 4326
* EPSG: 4839
* CRS: 84
Der Geltungsbereich (flaechenabgrenzung) wird als GeoJson in EPSG:4326 erwartet. Die Koordinaten aller Geometrien eines Planwerks müssen innerhalb des Geltungsbereichs des Koordinatenreferenzsystems (KRS) liegen. Bei der Validierung wird nur gegen das im XPlanGML gesetzte KRS geprüft.

Ist das Ziel ein XPlanGML in das DiPlanCockpit zu importieren, so kann in "xPlan" eine xPlanURL angegeben werden. Die Anwendung unterstützt sowohl Netzwerk- als auch Downloadressourcen. Die Ressource muss von der Anwendung frei erreichbar sein, insbesondere ohne vorgeschaltete Authentifizierung.

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 auch Netzwerkressourcen auf IONOS verwendet werden. Dabei werden die Schemas http://, https://, s3:// sowie file:// unterstützt. Der Dateiname wird hinter dem "/" der URL erwartet. Der Support unterstützt gerne bei den Zugangsdaten.

Durch das Setzen eines optionalen "veroeffentlichungsdatum" ist zusätzlich zum Import ins DiPlanCockpit die Veröffentlichung des XPlanGML als Dienst im Internet möglich. 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. den Plannamenabgleich.

Voraussetzung für die automatische Veröffentlichung des Planwerks in der XPlanBox mit dem Import ist, dass das Verfahren aktiv ist und das Veröffentlichungsdatum nicht gesetzt ist oder in der Zukunft liegt.

=== Fläche und geplante Wohneinheiten ===
[[Datei:ImageFlaecheGeplanteWohneinheiten.png|zentriert|rahmenlos|617x617px]]
Die "flaeche" und die Anzahl für "geplanteWohneinheiten" werden optional direkt als Zahl eingetragen.

=== Geförderter Wohnungsbau ===
[[Datei:ImageGefoerderterWohnungsbau.png|zentriert|rahmenlos|646x646px]]
Der Abschnitt "gefoerderterWohnungsbau" ist optional und es können optional die "prozent", die "geplanteWohneinheiten" und der "foerderweg" angegeben werden.

=== Zusätzliche Gewerbeflächen ===
[[Datei:ImageZusaetzlicheGewerbeflaechen.png|zentriert|rahmenlos|656x656px]]
Für "zusaetzlicheGewerbeflaechen" wird optional direkt deren Anzahl angegeben.

=== Vorgesehene Nutzungen ===
[[Datei:ImageVorgeseheneNutzungen.png|zentriert|rahmenlos|638x638px]]
Die Angabe für "vorgeseheneNutzungen" erfolgt optional über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:artdernutzung Codeliste].

=== Zurückstellung ===
[[Datei:ImageZurueckstellung.png|zentriert|rahmenlos|645x645px]]
Im Falle einer "zurueckstellung" (optional) sind verpflichtend der "identifikator", das Datum des Bescheids als "bescheidVon", die Dauer der "rueckstellungBis" sowie die "belegenheit" anzugeben.

=== Veränderungssperre ===
[[Datei:ImageVeraenderungssperre.png|zentriert|rahmenlos|637x637px]]
Für eine "veraenderungssperre" (optional) sind verpflichtend der "geltungsbereich", der "zeitraum" und das "beschlussdatum" anzugeben. Optional können bis zu zwei "verlaengerung" angegeben werden, ebenfalls mit "geltungsbereich", "zeitraum" und "beschlussdatum" (nicht dargestellt im Beispiel).

=== Zugeordnete Nutzer ===
[[Datei:ImageZugeordneteNutzer.png|zentriert|rahmenlos|632x632px]]
Alle "zugeordneteNutzer" sind optional und werden einzeln angegeben, wobei der erste Eintrag als Besitzer gewertet wird. Die Angabe der "rolle" per [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:rolle Code] ist optional, die "nutzerID" erforderlich.

=== Planreife nach § 33 BauGB ===
[[Datei:ImagePlanreife33BauGB.png|zentriert|rahmenlos|617x617px]]
Bezüglich der Planreife nach § 33 BauGB kann optional angegeben werden, ob "planreifeNachPara33" gilt und wenn ja, seit wann.

=== Vertrag ===
[[Datei:ImageVertrag.png|zentriert|rahmenlos|610x610px]]
Verträge werden optional und dann jeweils einzeln als "vertrag" aufgeführt, optional mit einem oder mehreren "ergaenzungstext". Verpflichtend sind die Angabe der "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:vertragsart vertragsart]", des "vertragstext" und des "filename".

Der Vertragstext wird direkt in der XML als Bytearray im Format base64Binary angegeben. Beispielsweise PDF lassen sich in dieses Format konvertieren. Es handelt sich dabei um eine sehr lange Zeichenfolge, aus Platzgründen ist im Screenshot keine dargestellt. Unter dem "filename" wird der "vertragstext" als Datei im Cockpit hinterlegt, automatisch wieder im ursprünglichen PDF-Format.

Für Ergänzungstexte können ebenfalls "vertragsabschluss", "unterzeichner", "abschlussdatum" und "inKraftGetretenAm" angegeben werden (nicht dargestellt im Beispiel).
[[Datei:ImageVertragFE.png|zentriert|rahmenlos|623x623px]]

=== Mitwirkungsbereitschaft ===
[[Datei:ImageMitwirkungsbereitschaft.png|zentriert|rahmenlos|625x625px]]
Wenn eine "mitwirkungsbereitschaft" (optional) besteht, kann optional deren "erklaerungsdatum" und ein "kommentar" angegeben werden. Die Angabe der "bereitschaft" ist verpflichtend.

=== Internetseite ===
[[Datei:ImageInternetseite.png|zentriert|rahmenlos|628x628px]]
Wenn eine "internetseite" des Verfahrens existiert, kann optional deren Adresse angegeben werden.

=== Dokumente ===
[[Datei:ImageDokumente.png|zentriert|rahmenlos|625x625px]]
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 <code><xplan:link>s3://test-dokument-2.pdf</xplan:link></code>. 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 <code><xplan:link>s3://test dokument 2.pdf</xplan:link></code> sondern <code><xplan:link>s3://test%20dokument%202.pdf</xplan:link></code>.

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", "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensunterlagentyp dokumentart]" und "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:dokumentstatus 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.
[[Datei:ImageDokumenteFE.png|zentriert|rahmenlos|605x605px]]

=== *Verfahrensart ===
[[Datei:ImageVerfahrensart.png|zentriert|rahmenlos|630x630px]]
Die Angabe der "verfahrensart" ist verpflichtend und erfolgt über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensart Codeliste].

=== Bodenordnung ===
[[Datei:ImageBodenordnung.png|zentriert|rahmenlos|631x631px]]
Optional können bezüglich der "bodenordnung" das "bodenordnungsgebiet" und beliebig viele "belegenheitBodenordnungsgebiet" angegeben werden.

=== *Verfahrensschritt ===
[[Datei:ImageVerfahrensschritt.png|zentriert|rahmenlos|630x630px]]
Die Angabe des aktuellen "verfahrensschritt" erfolgt verpflichtend über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensschritt Codeliste].

=== Satzung Beschluss ===
[[Datei:ImageSatzungBeschluss.png|zentriert|rahmenlos|655x655px]]
Optional können Informationen zur Feststellung in "satzungBeschluss" angegeben werden, mit einem optionalen "beschlussdatum" und "bekanntmachung". Wenn erforderlich kann zwischen dem "beschlussdatum" und der "bekanntmachung" optional auch die "aufhebung" angegeben werden. Dazu werden das "aufhebungsdatum" sowie der "aufhebungsgrund" angegeben (als Code) (nicht dargestellt im Beispiel).

Zu beachten ist bei Datumsangaben das Zusammenspiel mit dem Verfahrensstand. Es sind nur bestimmte Kombinationen zulässig. Folgende Tabelle zeigt die möglichen Kombinationen für die Fachdomäne der Bauleitplanung (die Fachdomäne wird in der [[Verfahrenskonfiguration Pro|Verfahrenskonfiguration]] angegeben):
{| class="wikitable"
!Code
!Verfahrensstand
!Datumsangaben
|-
|2000
|im Verfahren
|kein stattgefundenes Beschlussdatum UND kein stattgefundenes Bekanntmachungsdatum
|-
|3000
|beschlossen
|stattgefundenes Beschlussdatum UND kein stattgefundenes Bekanntmachungsdatum
|-
|3100
|inkraftgetreten
|stattgefundenes Beschlussdatum UND stattgefundenes Bekanntmachungsdatum
|-
|4000
|ganz aufgehoben
|stattgefundenes Beschlussdatum ODER stattgefundenes Bekanntmachungsdatum UND stattgefundenes Untergangsdatum (Aufhebungsdatum)
|-
|5000
|eingestellt
|kein stattgefundenes Beschlussdatum UND kein stattgefundenes Bekanntmachungsdatum
|-
|6000
|laufendes Normenkontrollverfahren
|stattgefundenes Beschlussdatum UND stattgefundenes Bekanntmachungsdatum
|}
=== Termine ===
[[Datei:ImageTermine.png|zentriert|rahmenlos|657x657px]]
Jeweils einzeln in einem Abschnitt "termine" können beliebig viele Termine angegeben werden. Es kann sich bei Terminen um Sitzungen (oben im Beispiel) oder sonstige Termine (unten im Beispiel) handeln. In beiden Fällen sind "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:datumsstatus datumsstatus]", "datumstyp" (zeitpunkt oder zeitraum oder zeitpunkt_oder_zeitraum), "datum" und "metatadatenTermin" verpflichtend anzugeben, das "kommentar" ist optional. In "metadatenTermin" sind die für Sitzungen bzw. sonstige Termine spezifischen Informationen enthalten.

Die Termine erscheinen im importierten Verfahren im Reiter Aufgaben und, wenn sie zeitplanungsrelevant sind, im Reiter Zeitplanung. Um einen Termin importieren zu können, muss er in der Verfahrenskonfiguration im passenden Verfahrensteilschritt angelegt sein.

Zu beachten ist, das immer nur Termine für den ersten Durchgang importiert werden können. Weitere Durchgänge lassen sich nicht hinzufügen.
[[Datei:ImageTermineFE.png|zentriert|rahmenlos|660x660px]]

==== Sitzung ====
[[Datei:ImageSitzung.png|zentriert|rahmenlos|631x631px]]
Für Sitzungen sind die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sitzungen sitzungsart]" sowie das "sitzungsergebnis" verpflichtend per Code anzugeben. Das Sitzungsergebnis kann ein "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sitzungsergebnispolitisch sitzungsergebnisPolitisch]", "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sitzungsergebnisrechtspruefung sitzungsergebnisRechtspruefung]" oder "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sitzungsergebnisverwaltungstechnisch sitzungsergebnisVerwaltungstechnisch]" sein. Optional ist die Angabe des "versanddatum". Zu beachten ist, dass die Bezeichnung einer Sitzung maximal 255 Zeichen umfassen darf. Die Codeliste der Sitzungsart kann im Administrationsbereich des Cockpits aktualisiert werden.

==== Sonstiger Termin ====
[[Datei:ImageSonstigerTermin.png|zentriert|rahmenlos|648x648px]]
Im Falle "sonstigerTermin" ist die Angabe des "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sonstigetermin codeSonstigerTermin]" verpflichtend. Die Codeliste kann im Administrationsbereich des Cockpits aktualisiert werden. Zu beachten ist, dass die Bezeichnung eines sonstigen Termins maximal 255 Zeichen umfassen darf. Optional können weitere Informationen zu dem Termin als "eigenschaft" angegeben werden, jeweils mit "name" und "value". Sie müssen dabei den für den Termin vorgesehenen Eigenschaften gemäß der Verfahrenskonfiguration entsprechen.

Im obigen Beispiel hat der sonstige Termin den Code "InfoOeffentlicheAuslegung_Auslegungszeitraum". In der Verfahrenskonfiguration ist er wie folgt angelegt:
[[Datei:ImageVKSonstigerTerminBeispiel.png|zentriert|rahmenlos|628x628px]]
Der Termin hat die Eigenschaft "artDerAuslegung", die mit dem Wert aus der Codeliste "ArtDerAuslegung" zu befüllen ist. Dementsprechend ist in der XML-Datei für den Import eines Verfahrens als "name" der "name" der "eigenschaft" aus der Verfahrenskonfiguration angegeben und als "value" der Code 100, der sich in der Codeliste "ArtDerAuslegung" wiederfindet. Alle möglichen Typen der Eigenschaft sind in der [[Verfahrenskonfiguration Pro#Sonstiger%20Termin|Dokumentation zur Verfahrenskonfiguration]] erläutert.

== Weitere mögliche Inhalte ==
Neben den im Beispielverfahren beschriebenen können je nach Bedarf weitere Informationen zu einem Verfahren angegeben werden.

=== Parallelverfahren ===
Wenn es "parallelverfahren" gibt, so können diese nach der "verfahrensbeschreibung" innerhalb der "Verfahrensuebersicht" eingefügt werden. Darin können die Informationen gemäß des "Verfahrensverweis" angegeben werden.

=== Mandantenspezifische Erweiterungen ===
Man kann im XPlanverfahren Standard eine Mandatenspezifische Erweiterung angeben, in der wir eine DiPlanung-Erweiterung unterstützen. '''Wichtig''': Mit 'Mandant' ist hier DiPlanCockpit gemeint. Es gibt keine Erweiterungen für einzelne Bundesländer.

Valide Erweiterungen sind im Schema diplanung-xplanverfahren-erweiterung.xsd definiert. Derzeit ist es mittels der Erweiterung möglich Werte für Action Items zu importieren. Dazu muss auch der verwendete Namespace in der XML definiert werden:
[[Datei:ImageImportNamespace.png|zentriert|rahmenlos|583x583px]]

==== Action Items für Aufgaben ====
[[Datei:ImageAIImport.png|zentriert|rahmenlos|660x660px|

]]Um ein Action Item importieren zu können, muss es in der Verfahrenskonfiguration mit einer refID versehen sein. Sie dient dazu, das konkrete Action Item zu identifizieren. Zu beachten ist, dass nur für eine Auswahl an Action Items (Checkbox, Float, Integer, String, Textarea, Link und Input Link) der Import möglich ist. Der folgende Screenshot zeigt beispielhaft, wie Action Items in der Import-XML aufgeführt werden. Die übrigen Action Items sind bei Bedarf händisch im Anschluss an den Import im Verfahren nachzupflegen.

==== 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. Der Elementname z.B. ''importEigenschaft'''Date''''' referenziert dabei auf den Typ und wird zur Validierung verwendet. Über das Attribut ''name'' wird hingegen auf das eindeutige Feld verwiesen.
[[Datei:ImageMandantenSpezifischeStammdatenImport3.png|zentriert|mini|597x597px]]

Rollen und Rechte

2026-04-07T09:40:26Z

Diplanung:

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

== Einleitung ==
Diese Dokumentation richtet sich an Nutzer der Rolle Mandanten-Administration für das DiPlanCockpit Pro (Kürzel: M-A). Damit Admins ihre Aufgaben zielgerichtet ausführen können, haben sie eine eigene Ansicht "Fachliche Leitstelle Administration". Der Admin-Bereich unterscheidet sich grundlegend von der Sachbearbeitungsebene, dem Cockpit-Bereich.

Die Aufgaben des M-A sind darauf ausgerichtet, das Fachverfahren für die Sachbearbeitung vorzubereiten/einzurichten und bestimmte Aufgaben im laufenden Betrieb auszuführen wie gestartete Verfahren zu löschen.

== 1. Systemkontext ==
Bei DiPlanCockpit Basis und DiPlanCockpit Pro handelt sich um ein Gesamtsystem und nicht um unterschiedliche Entwicklungen. Für Basis und Pro gibt es unterschiedliche Verfahrenskonfigurationen und Aufgabenkonfigurationen. Pro Verfahrenssteuerungstyp (auch Verfahrenssteuerung genannt) können so unterschiedliche Vorgaben und Abläufe definiert werden.

Bei DiPlanCockpit Basis und DiPlanCockpit Pro handelt sich um ein Gesamtsystem und nicht um separate Entwicklungen. Für Basis und Pro gibt es unterschiedliche Verfahrenskonfigurationen (VK), die wiederum pro Verfahrenssteuerungstyp (auch Verfahrenssteuerung genannt) individuelle Vorgaben definieren. In Pro lassen sich komplexe Abläufe abbilden, die der Sachbearbeitung Workflow-Unterstützung liefert.

Das hinterlegte Rollen- und Rechte-Konzept differenziert, was die einzelnen Nutzer (je nach Rolle und Zuständigkeit) sehen und an Funktionen ausführen können (Lese- und Schreibrechte), sodass sie ihre spezifischen Aufgaben ausführen können. Dies wirkt sich auch auf die Rolle M-A aus. Im Folgenden wird dargestellt, welche Funktionen für die Rollen M-A-Basis und M-A zur Verfügung stehen.
{| class="wikitable sortable mw-collapsible"
!Bereich
!Beschreibung
!Basis
!Pro
|-
|Fachliche Leitstelle
|Reiter Systemparameter
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Konfiguration
|vorhanden in geringem Umfang
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Codelisten
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Verfahrensverwaltung
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Planwerksverwaltung
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Transfermessages
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Mustervorlagen
|nicht vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Rechtszitate
|nicht vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Protokolle
|vorhanden
|vorhanden
|}
* Die Rolle M-A sieht im DiPlanCockpit Pro zwei Reiter, die in Basis nicht angezeigt werden:
** Der Reiter Mustervorlagen erlaubt das Anlegen, Ändern, Ersetzen und Löschen von Mustervorlagen. Diese basieren auf .dotx-Vorlagen und enthalten feste Texte sowie Platzhalter für Stammdaten, Metadaten oder Rechtszitate. Die Sachbearbeitung kann auf Basis einer Mustervorlage ein so genanntes Verfahrensdokument generieren (Word-Datei). Im Zuge der Initialisierung werden die Platzhalter aufgelöst und bilden den zu der Zeit gültigen Stand ab. '''Wichtig''': Eine nachträgliche Synchronisierung von Platzhaltern findet nicht statt.
** Der Reiter Rechtszitate erlaubt das Anlegen, Bearbeiten und Löschen von Rechtszitaten, die sich als Platzhalter in Mustervorlagen einbinden lassen. Die hinterlegten Texte bilden Rechtsbezüge ab und lassen sich hier zentral aktualisieren. Die einzelnen Reiter werden im [[Admin-Bereich DiPlan Cockpit Pro|Kapitel sechs der Doku zu DiPlanCockpit Pro]] mit seinen Unterkapiteln detailliert beschreiben.
== 2 Adminstrationsebenen ==
Die Module der DiPlanung umfassen mehrere Administrationsebenen. Die erste Ebene umfasst den Betrieb der Anwendungen und dient als fachliche Leitstelle, wobei die Freie- und Hansestadt Hamburg die maßnahmenverantwortliche Stelle ist (BeLa = Betreibendes Land).

=== 2.1 Erste Administrationsebene ===
Die erste Ebene beinhaltet die Administration mandantenübergreifender, also globaler Einstellungen innerhalb einer Komponente und steht der zentralen Fachlichen Leistelle DiPlanung und dem Betrieb zur Verfügung. Letzterer hat aktuell noch keinen Bedarf an entsprechenden Rollen, da alle Einstellungen außerhalb eines Logins über andere Bereich der DiPlanungs-Architektur erfolgen (z.B. Helmcharts), daher ist die entsprechende Rolle bislang nur als Platzhalter zu verstehen. Auf dieser Ebene stehen die Rollen Global-Administration (GL-Administration) und Global-Redaktion (GL-Redaktion) zur Verfügung.

=== 2.2 Zweite Administrationsebene ===
Die zweite Ebene beinhaltet die Administration der dezentralen fachlichen Leitstellen und Mandanten-Administrationen in den nachnutzenden Bundesländern (NN Länder bzw. MiLas = Mitnutzende Länder).

=== 2.3 Dritte Administrationsebene ===
Optional kann eine dritte Ebene eingezogen werden, wenn das nachnutzende Land weitere nachgelagerte Behörden in die Administration der Fachanwendung einbinden möchte.

=== 2.4 Vierte Administrationsebene ===
Die vierte Ebene umfasst die nutzenden Stellen der Anwendung, darunter Sachbearbeitungen in den Behörden und Kommunen, Träger öffentlicher Belange (TöB), Planungsbüros und Bürger:innen.

== 3. Rollen- und Rechte-Konzept ==
Das Rollen- und Rechte-Konzept bildet die Grundlage für rechtssichere Zuständigkeiten und Aufgabenverteilungen innerhalb des Fachverfahrens.

=== 3.1 KeyCloak ===
Die Rollen und Rechte werden zentral in KeyCloak verwaltet. Keycloak ist ein Open-Source-Softwareprodukt, das Single Sign-On mit Identitäts- und Zugriffsverwaltung für moderne Anwendungen und Dienste ermöglicht. Pro Mandant wird ein DiplanCockpit Basis Client in Keycloak zur Verfügung gestellt. Hierüber können die einzelnen Rollen und Rechte gesteuert werden. Dadurch wird gesteuert, welcher User auf welche Funktionen Zugriff hat. Eine featuregenaue Steuerung pro User ist nicht möglich, aber auch konzeptionell nicht gewollt.

Für jeden Mandanten werden Berechtigungen (Rollen/Rechte) und Verfahrensverantwortung über zwei getrennte Gruppen in Keycloak gesteuert.

==== 3.1.1 Gruppe Cockpit Berechtigung ====
In dieser Gruppe sind die fachlich definierten Rollen aufgeführt. Differenzierung zwischen Cockpit Basis und Cockpit Pro Nutzer über die K1 Nutzerrechte:

VERFAHRENSSTEUERUNG_WRITE

VERFAHRENSSTEUERUNG_READ

==== 3.1.2 Gruppe Cockpit-Zuständigkeit ====
In dieser Gruppe ist die Zuständigkeit pro Mandant hierarchisch aufgeschlüsselt.

Die Rollen und Rechte werden über die Cockpit-Berechtigung und die Cockpit-Zuständigkeit definiert. Ein Anwender hat immer mindestens eine Cockpit-Berechtigungsrolle. Ein Anwender kann für den Mandanten Hamburg keine oder genau eine Zuständigkeit zugewiesen bekommen z.B. Senat oder Altona oder Bergedorf.

Beispiel für mehrfache Gruppenzugehörigkeit: Die Anwendenden in EfA können den Gruppen Verfahrensmanagement (Cockpit-Berechtigung) oder - Sachbearbeitung (Cockpit-Berechtigung) und Altona (Cockpit-Zuständigkeit) zugeordnet sein.

==== 3.1.3 Gruppe Organisation ====
In diese Gruppe fallen die Planungsbüros (PB). Eine Besonderheit ist, dass Planungsbüros KEINE Zuständigkeit haben.

=== 3.2 Erklärung der Rollen ===
Im Folgenden werden jede Rolle und die dazugehörigen Rechte in Tabellenform dargestellt.

Die Tabelle zeigt, dass die Rolle M-A-Basis klar von den weiteren Rollen abgegrenzt werden kann, da ihr Fokus nicht auf fachlichen Aufgaben beruht. Stattdessen steht die Verwaltung der Rollen und Rechte der Nutzer im Vordergrund.

==== 3.2.1 Erläuterung der Abkürzungen der Rollen ====
* M-A = Mandanten-Administration - Mandanten spezifische Administration
* FP-A = Fachplanung Administration - Verfahrensmanager/in über alle Verfahren innerhalb des Mandanten
* FP-VM = Fachplanung-Verfahrensmanagement - Verfahrensmanager/in über Verfahren in eigener Verfahrensverantwortung (insb. auch Anlegen) und lesende Rechte in allen Verfahren des Mandanten
* FP-SB = Fachplanung-Sachbearbeitung - Verfahrensmanager/in über Verfahren in eigener Verfahrensverantwortung (insb. auch Anlegen)
* FP-PB-SB = Fachplanung-Planungsbüro-Sachbearbeiter (1. Stufe) mit Schreibrecht in einem ausgewählten Verfahren, für das die Organisation (Planungsbüro) berechtigt wurde. Rolle hat keine Zuständigkeit, d.h. sie kann über Zuständigkeiten an Verfahren mitarbeiten, für die sie berechtigt wurde.
* C-VM = Controlling-Verfahrensmanagement - Alle Verfahren innerhalb des Mandanten lesen, alle Reports erzeugen, nur eigene Verträge, Dokumente, Stellungnahmen lesen
* C-SB = Controlling-Sachbearbeitung - Verfahren, Verträge, Dokumente in eigener Verfahrensverantwortung lesen, eigene Reports erzeugen

==== 3.2.2 Hinweise ====

# "Eigene" im Recht bezieht sich immer auf die eigene Zuständigkeit, nicht darauf, ob das Verfahren abonniert ist oder selbst angelegt wurde. "Eigene" bezieht sich auf interne Nutzer (Behördenvertretende).
# Alle schreibenden Rechte in der K1 erfordern, dass das Verfahren abonniert ist, um Änderungen vornehmen zu können. Mit Klick auf ein Verfahren, wird es automatisch abonniert.
# Externe Planungsbüros (PB) können in angelegten Verfahren mitarbeiten, haben selbst aber keine Zuständigkeit. Sie erhalten eine eigene Übersichtsseite "Berechtigte Verfahren", auf der 0..n Verfahren aufgelistet sind, für die ein PB berechtigt wurde. Abonnieren ist dafür irrelevant. Es werden in der 1. Stufe die Rollen FP-PB-SB#1 (Pro) + FP-PB-SB_Basis#1 (Basis) umgesetzt.
# In KeyCloak gibt es für alle PB - unabhängig von der Berechtigungsstufe im DiPlanCockpit - nur eine Rolle / Gruppe / Organisation: FP-PB.

'''Legende zur Tabelle:'''

X = Recht gilt bei dieser Rolle
{| class="wikitable"
! rowspan="2" |Zugeordnete Rechte pro Rolle
!
! colspan="7" |Rollen EfA Cockpit Basis
|-
!Erläuterung des Rechts
!M-A-Basis
!FP-A-Basis
!FP-VM-Basis
!FP-SB-Basis
!FP-PB-SB-Basis
!C-VM-Basis
!C-SB-Basis
|-
|ADMIN
|Zugriff auf den Admin-Bereich (fachliche Leitstelle Administration) sowie den Cockpit-Bereich.
|X
|
|
|
|
|
|
|-
|VERFAHREN_EINSTELLUNGEN
|Zugriff auf den Reiter Einstellungen im Cockpit-Bereich.
|X
|X
|
|
|
|
|
|-
|VERFAHREN_READ
|Interne SBs: Alle Verfahren eines Mandanten - über Zuständigkeiten hinweg können über die Suche gefunden und gelesen werden. Externe PBs: Leserecht für Verfahren, für die das PB berechtigt wurde. Suchfunktion gibt es für sie nicht. Interne SBs: Ist ein Verfahren nicht abonniert, kann nur die Stammdatenseite gelesen werden.
|X
|X
|X
|
|X
|X
|
|-
|VERFAHREN_WRITE
|Alle Verfahren eines Mandanten - über Zuständigkeiten hinweg - können schreibend bearbeitet werden. Interne SBs: Verfahren muss abonniert sein. Externe PBs: Schreibrecht für Verfahren, für die das PB berechtigt wurde. Abonnieren gibt es für sie nicht.
|X
|X
|
|
|X
|
|
|-
|VERFAHREN_BERECHTIGUNG_WRITE
|Über Zuständigkeiten hinweg: Reiter Stammdaten, Sektion Berechtigung für Planungs- und Ingenieurbüros ist editierbar = Interne SBs können Berechtigung 0..n fach an externe PBs vergeben und wieder entziehen. Die Berechtigung für PBs gilt pro Verfahren und über Zuständigkeiten hinweg. Nur bereits in KeyCloak eingerichtete, externe Planungsbüros (PB) werden angezeigt.
|X
|X
|
|
|
|
|
|-
|VERFAHREN_BERECHTIGUNG_READ
|Über Zuständigkeiten hinweg: Reiter Stammdaten, Sektion Berechtigung für Planungs- und Ingenieurbüros ist sichtbar. Nur bereits in KeyCloak eingerichtete, externe Planungsbüros (PB) werden angezeigt.
|X
|X
|
|
|X
|X
|
|-
|VERFAHREN_ABONNIEREN
|Verfahren können abonniert und de-abonniert werden.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_VERFAHREN_READ
|Verfahren in der eigenen Zuständigkeit können über die Suche gefunden und gelesen werden. Ist ein Verfahren nicht abonniert, kann nur die Stammdatenseite gelesen werden.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_VERFAHREN_WRITE
|Verfahren in der eigenen Zuständigkeit können schreibend bearbeitet werden. Verfahren muss abonniert sein. Es ist möglich, ein simuliertes Verfahren (endgültig) zu löschen; gestartete Verfahren können nur vom M-A gelöscht werden.
|X
|X
|X
|X
|
|
|
|-
|EIGENE_VERFAHREN_
BERECHTIGUNG_WRITE
|In der jeweiligen Zuständigkeit: Reiter Stammdaten, Sektion Berechtigung für Planungs- und Ingenieurbüros ist editierbar = Interne Nutzer können Berechtigung 0..n fach an externe PBs vergeben und wieder entziehen. Die Berechtigung für PBs gilt pro Verfahren. Nur bereits in KeyCloak eingerichtete, externe Planungsbüros (PB) werden angezeigt.
|X
|X
|X
|X
|
|
|
|-
|EIGENE_VERFAHREN_
BERECHTIGUNG_READ
|In der jeweiligen Zuständigkeit: Reiter Stammdaten, Sektion Berechtigung für Planungs- und Ingenieurbüros ist sichtbar.
|X
|X
|X
|X
|
|X
|X
|-
|EXTERNES_PLANUNGSBUERO
|1. Differenzierung für externes Planungsbüro (PB). PBs sehen nur den Reiter "Berechtigte Verfahren"(andere Art der Übersichtsseite) mit den Verfahren, für die sie berechtigt wurden - über Zuständigkeiten hinweg. Sie können an berechtigen Verfahren mitarbeiten, sehen aber bestimmte Inhalte nicht, wie Verträge, und können bestimmte Funktionen nicht ausführen, wie Berechtigung ändern.
|
|
|
|
|X
|
|
|-
|VERTRAG_READ
|Nur für interne SBs: Verträge von allen Verfahren können gelesen werden. Verfahren muss abonniert sein.
|X
|X
|
|
|
|
|
|-
|VERTRAG_WRITE
|Nur für interne SBs: Verträge von allen Verfahren können hochgeladen, bearbeitet und gelöscht werden. Verfahren muss abonniert sein.
|X
|X
|
|
|
|
|
|-
|EIGENE_VERTRAG_READ
|Nur für interne SBs: Verträge von Verfahren in eigener Zuständigkeit können gelesen werden. Verfahren muss abonniert sein.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_VERTRAG_WRITE
|Nur für interne SBs: Verträge von Verfahren in eigener Zuständigkeit können hochgeladen, bearbeitet und gelöscht werden. Verfahren muss abonniert sein.
|X
|X
|X
|X
|
|
|
|-
|DOKUMENT_READ
|(Verfahrens-) Dokumente von allen Verfahren können gelesen werden. Verfahren muss abonniert sein.
|X
|X
|X
|
|X
|
|
|-
|DOKUMENT_WRITE
|(Verfahrens-) Dokumente von allen Verfahren können hochgeladen, bearbeitet und gelöscht werden; Dokumente können aus Mustervorlagen generiert werden. Verfahren muss abonniert sein. VERFAHREN_WRITE erforderlich.
|X
|X
|
|
|X
|
|
|-
|EIGENE_DOKUMENT_READ
|(Verfahrens-) Dokumente von Verfahren in eigener Zuständigkeit können gelesen werden. Verfahren muss abonniert sein.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_DOKUMENT_WRITE
|(Verfahrens-) Dokumente von Verfahren in eigener Zuständigkeit können hochgeladen, bearbeitet und gelöscht werden; Dokumente können aus Mustervorlagen generiert werden. Verfahren muss abonniert sein. EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|X
|X
|
|
|
|-
|REPORT
|Reports/Auswertungen können erstellt werden - über Zuständigkeiten hinweg.
|X
|X
|
|
|
|
|
|-
|EIGENE_REPORT
|Reports/Auswertungen der eigenen Zuständigkeit können erstellt werden.
|X
|X
|X
|X
|
|X
|X
|-
|VERFAHREN_CREATE
|Verfahren anlegen. Sonderfall für die Rollen M-A und FP-A: Verfahren können angelegt werden - über Zuständigkeiten hinweg. VERFAHREN_WRITE oder EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|
|
|
|
|
|-
|VERFAHREN_DELETE
|Gestartete Verfahren können endgültig gelöscht werden. VERFAHREN_WRITE erforderlich.
|X
|
|
|
|
|
|
|-
|EIGENE_VERFAHREN_DELETE_
SIMULIERTES_VERFAHREN
|Simulierte Verfahren in der eigenen Zuständigkeit können endgültig gelöscht werden. Verfahren muss abonniert sein. EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|X
|X
|
|
|
|-
|EIGENE_VERFAHREN_CREATE
|Verfahren anlegen. Standardfall für Rollen wie FP-SB innerhalb der eigenen Zuständigkeit. Externe Sachbearbeiter wie externe Planungsbüros haben dieses Recht nicht. VERFAHREN_WRITE oder EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|X
|X
|
|
|
|-
|VERFAHREN_SUCHE
|Nur für interne SBs: Verfahren können gesucht und abonniert werden.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_PLANWERKE_READ
|Planwerke von Verfahren in eigener Zuständigkeit können gelesen und heruntergeladen werden. Verfahren muss abonniert sein.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_PLANWERKE_WRITE
|Planwerke von Verfahren in eigener Zuständigkeit können hochgeladen, bearbeitet und gelöscht werden. Verfahren muss abonniert sein. EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|X
|X
|
|
|
|-
|PLANWERKE_READ
|Planwerke von allen Verfahren können gelesen und heruntergeladen werden. Verfahren muss abonniert sein.
|X
|X
|
|
|X
|
|
|-
|PLANWERKE_WRITE
|Planwerke von allen Verfahren können hochgeladen, bearbeitet und gelöscht werden. Verfahren muss abonniert sein. VERFAHREN_WRITE erforderlich.
|X
|X
|
|
|X
|
|
|}

Rollen und Rechte DiPlanCockpit Pro

2026-04-07T09:39:03Z

Diplanung: /* 2. Administrationsebene */

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

==Einleitung==
Diese Dokumentation richtet sich an Nutzer der Rolle Mandanten-Administration für das DiPlanCockpit Pro (Kürzel: M-A). Damit Admins ihre Aufgaben zielgerichtet ausführen können, haben sie eine eigene Ansicht "Fachliche Leitstelle Administration". Der Admin-Bereich unterscheidet sich grundlegend von der Sachbearbeitungsebene, dem Cockpit-Bereich.

Die Aufgaben des M-A sind darauf ausgerichtet, das Fachverfahren für die Sachbearbeitung vorzubereiten/einzurichten und bestimmte Aufgaben im laufenden Betrieb auszuführen wie gestartete Verfahren zu löschen.

==1. Systemkontext==
Bei DiPlanCockpit Basis und DiPlanCockpit Pro handelt sich um ein Gesamtsystem und nicht um unterschiedliche Entwicklungen. Für Basis und Pro gibt es unterschiedliche Verfahrenskonfigurationen und Aufgabenkonfigurationen. Pro Verfahrenssteuerungstyp (auch Verfahrenssteuerung genannt) können so unterschiedliche Vorgaben und Abläufe definiert werden.

Bei DiPlanCockpit Basis und DiPlanCockpit Pro handelt sich um ein Gesamtsystem und nicht um separate Entwicklungen. Für Basis und Pro gibt es unterschiedliche Verfahrenskonfigurationen (VK), die wiederum pro Verfahrenssteuerungstyp (auch Verfahrenssteuerung genannt) individuelle Vorgaben definieren. In Pro lassen sich komplexe Abläufe abbilden, die der Sachbearbeitung Workflow-Unterstützung liefert.

Das hinterlegte Rollen- und Rechte-Konzept differenziert, was die einzelnen Nutzer (je nach Rolle und Zuständigkeit) sehen und an Funktionen ausführen können (Lese- und Schreibrechte), sodass sie ihre spezifischen Aufgaben ausführen können. Dies wirkt sich auch auf die Rolle M-A aus. Im Folgenden wird dargestellt, welche Funktionen für die Rollen M-A-Basis und M-A zur Verfügung stehen.
{| class="wikitable sortable mw-collapsible"
!Bereich
!Beschreibung
!Basis
!Pro
|-
|Fachliche Leitstelle
|Reiter Systemparameter
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Konfiguration
|vorhanden in geringem Umfang
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Codelisten
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Verfahrensverwaltung
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Planwerksverwaltung
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Transfermessages
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Mustervorlagen
|nicht vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Rechtszitate
|nicht vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Protokolle
|vorhanden
|vorhanden
|}
Die Rolle M-A sieht im DiPlanCockpit Pro zwei Reiter, die in Basis nicht angezeigt werden:

* Der Reiter Mustervorlagen erlaubt das Anlegen, Ändern, Ersetzen und Löschen von Mustervorlagen. Diese basieren auf .dotx-Vorlagen und enthalten feste Texte sowie Platzhalter für Stammdaten, Metadaten oder Rechtszitate. Die Sachbearbeitung kann auf Basis einer Mustervorlage ein so genanntes Verfahrensdokument generieren (Word-Datei). Im Zuge der Initialisierung werden die Platzhalter aufgelöst und bilden den zu der Zeit gültigen Stand ab. '''Wichtig''': Eine nachträgliche Synchronisierung von Platzhaltern findet nicht statt.
* Der Reiter Rechtszitate erlaubt das Anlegen, Bearbeiten und Löschen von Rechtszitaten, die sich als Platzhalter in Mustervorlagen einbinden lassen. Die hinterlegten Texte bilden Rechtsbezüge ab und lassen sich hier zentral aktualisieren.

Die einzelnen Reiter werden im [[Admin-Bereich DiPlan Cockpit Pro|Kapitel sechs]] mit seinen Unterkapiteln detailliert beschreiben.
==2 Adminstrationsebenen==
Die Module der DiPlanung umfassen mehrere Administrationsebenen. Die erste Ebene umfasst den Betrieb der Anwendungen und dient als fachliche Leitstelle, wobei die Freie- und Hansestadt Hamburg die maßnahmenverantwortliche Stelle ist (BeLa = Betreibendes Land).

=== 2.1 Erste Administrationsebene ===
Die erste Ebene beinhaltet die Administration mandantenübergreifender, also globaler Einstellungen innerhalb einer Komponente und steht der zentralen Fachlichen Leistelle DiPlanung und dem Betrieb zur Verfügung. Letzterer hat aktuell noch keinen Bedarf an entsprechenden Rollen, da alle Einstellungen außerhalb eines Logins über andere Bereich der DiPlanungs-Architektur erfolgen (z.B. Helmcharts), daher ist die entsprechende Rolle bislang nur als Platzhalter zu verstehen. Auf dieser Ebene stehen die Rollen Global-Administration (GL-Administration) und Global-Redaktion (GL-Redaktion) zur Verfügung.

=== 2.2 Zweite Administrationsebene ===
Die zweite Ebene beinhaltet die Administration der dezentralen fachlichen Leitstellen und Mandanten-Administrationen in den nachnutzenden Bundesländern (NN Länder bzw. MiLas = Mitnutzende Länder).

=== 2.3 Dritte Administrationsebene ===
Optional kann eine dritte Ebene eingezogen werden, wenn das nachnutzende Land weitere nachgelagerte Behörden in die Administration der Fachanwendung einbinden möchte.

=== 2.4 Vierte Administrationsebene ===
Die vierte Ebene umfasst die nutzenden Stellen der Anwendung, darunter Sachbearbeitungen in den Behörden und Kommunen, Träger öffentlicher Belange (TöB), Planungsbüros und Bürger:innen.

==3. Rollen- und Rechte-Konzept==
Das Rollen- und Rechte-Konzept im DiPlanCockpit bildet die Grundlage für rechtssichere Zuständigkeiten und Aufgabenverteilungen innerhalb des Fachverfahrens.
===3.1 KeyCloak===
Die Rollen und Rechte werden zentral in KeyCloak verwaltet. Keycloak ist ein Open-Source-Softwareprodukt, das Single Sign-On mit Identitäts- und Zugriffsverwaltung (IAM) für moderne Anwendungen und Dienste ermöglicht. Pro Mandant wird ein DiplanCockpit Client in Keycloak zur Verfügung gestellt. Hierüber können die einzelnen Rollen und Rechte gesteuert werden. Dadurch wird gesteuert, welcher User auf welche Funktionen Zugriff hat. Eine Feature genaue Steuerung pro User ist nicht möglich, aber auch konzeptionell nicht gewollt.

Für jeden Mandanten werden Berechtigungen (Rollen/Rechte) und Zuständigkeit (früherer Begriff: Verfahrensverantwortung) über zwei getrennte Gruppen in Keycloak gesteuert.

====3.1.1 Gruppe Cockpit Berechtigung====
In dieser Gruppe sind die fachlich definierten Rollen aufgeführt. Ein Anwender hat immer mindestens eine Cockpit-Berechtigungsrolle. Es erfolgt eine Differenzierung über die K1 Nutzerrechte:

VERFAHRENSSTEUERUNG_WRITE

VERFAHRENSSTEUERUNG_READ

==== 3.1.2 Gruppe Cockpit-Zuständigkeit ====
In dieser Gruppe ist die Zuständigkeit pro Mandant hierarchisch aufgeschlüsselt.

Die Rollen und Rechte werden über die Cockpit-Berechtigung und die Cockpit-Zuständigkeit definiert. Ein Anwender hat immer mindestens eine Cockpit-Berechtigungsrolle. Ein Anwender kann für den Mandanten Hamburg keine oder genau eine Zuständigkeit zugewiesen bekommen z.B. Senat oder Altona oder Bergedorf.

Beispiel für mehrfache Gruppenzugehörigkeit: Die Anwendenden in EfA können den Gruppen Verfahrensmanagement (Cockpit-Berechtigung) oder - Sachbearbeitung (Cockpit-Berechtigung) und Altona (Cockpit-Zuständigkeit) zugeordnet sein.

==== 3.1.3 Gruppe Organisation ====
In diese Gruppe fallen die Planungsbüros (PB). Eine Besonderheit ist, dass Planungsbüros KEINE Zuständigkeit haben.

===3.2 Erklärung der Rollen===
Im Folgenden werden jede Rolle und die dazugehörigen Rechte in Tabellenform dargestellt.

Die Tabelle zeigt, dass die Rolle M-A klar von den weiteren Rollen abgegrenzt werden kann, da ihr Fokus nicht auf fachlichen Aufgaben beruht. Stattdessen steht die Verwaltung der Rollen und Rechte der Nutzer im Vordergrund.

==== 3.2.1 Erläuterung der Abkürzungen der Rollen ====
* M-A = Mandanten-Administration - Mandanten spezifische Administration
* FP-A = Fachplanung Administration - Verfahrensmanager/in über alle Verfahren innerhalb des Mandanten
* FP-VM = Fachplanung-Verfahrensmanagement - Verfahrensmanager/in über Verfahren in eigener Verfahrensverantwortung (insb. auch Anlegen) und lesende Rechte in allen Verfahren des Mandanten
* FP-SB = Fachplanung-Sachbearbeitung - Verfahrensmanager/in über Verfahren in eigener Verfahrensverantwortung (insb. auch Anlegen)
* FP-PB-SB = Fachplanung-Planungsbüro-Sachbearbeiter (1. Stufe) mit Schreibrecht in einem ausgewählten Verfahren, für das die Organisation (Planungsbüro) berechtigt wurde. Rolle hat keine Zuständigkeit, d.h. sie kann über Zuständigkeiten an Verfahren mitarbeiten, für die sie berechtigt wurde.
* C-VM = Controlling-Verfahrensmanagement - Alle Verfahren innerhalb des Mandanten lesen, alle Reports erzeugen, nur eigene Verträge, Dokumente, Stellungnahmen lesen
* C-SB = Controlling-Sachbearbeitung - Verfahren, Verträge, Dokumente in eigener Verfahrensverantwortung lesen, eigene Reports erzeugen

==== 3.2.2 Hinweise ====

# "Eigene" im Recht bezieht sich immer auf die eigene Zuständigkeit, nicht darauf, ob das Verfahren abonniert ist oder selbst angelegt wurde. "Eigene" bezieht sich auf interne Nutzer (Behördenvertretende).
# Alle schreibenden Rechte in der K1 erfordern, dass das Verfahren abonniert ist, um Änderungen vornehmen zu können. Mit Klick auf ein Verfahren, wird es automatisch abonniert.
# Externe Planungsbüros (PB) können in angelegten Verfahren mitarbeiten, haben selbst aber keine Zuständigkeit. Sie erhalten eine eigene Übersichtsseite "Berechtigte Verfahren", auf der 0..n Verfahren aufgelistet sind, für die ein PB berechtigt wurde. Abonnieren ist dafür irrelevant. Es werden in der 1. Stufe die Rollen FP-PB-SB#1 (Pro) + FP-PB-SB_Basis#1 (Basis) umgesetzt.
# In KeyCloak gibt es für alle PB - unabhängig von der Berechtigungsstufe im DiPlanCockpit - nur eine Rolle / Gruppe / Organisation: FP-PB.

{| class="wikitable mw-collapsible"
! rowspan="2" |Zugeordnete Rechte pro Rolle
!
! colspan="7" |Rollen DiPlanCockpit Pro
|-
!Erläuterung des Rechts
!M-A
!FP-A
!FP-VM
!FP-SB
!FP-PB-SB
!C-VM
!C-SB
|-
|ADMIN
|Zugriff auf den Admin-Bereich (fachliche Leitstelle Administration) sowie den Cockpit-Bereich.
|X
|
|
|
|
|
|
|-
|VERFAHREN_EINSTELLUNGEN
|Zugriff auf den Reiter Einstellungen im Cockpit-Bereich.
|X
|X
|
|
|
|
|
|-
|VERFAHREN_READ
|Interne SBs: Alle Verfahren eines Mandanten - über Zuständigkeiten hinweg können über die Suche gefunden und gelesen werden. Externe PBs: Leserecht für Verfahren, für die das PB berechtigt wurde. Suchfunktion gibt es für sie nicht. Interne SBs: Ist ein Verfahren nicht abonniert, kann nur die Stammdatenseite gelesen werden.
|X
|X
|X
|
|X
|X
|
|-
|VERFAHREN_WRITE
|Alle Verfahren eines Mandanten - über Zuständigkeiten hinweg - können schreibend bearbeitet werden. Interne SBs: Verfahren muss abonniert sein. Externe PBs: Schreibrecht für Verfahren, für die das PB berechtigt wurde. Abonnieren gibt es für sie nicht.
|X
|X
|
|
|X
|
|
|-
|VERFAHREN_BERECHTIGUNG_WRITE
|Über Zuständigkeiten hinweg: Reiter Stammdaten, Sektion Berechtigung für Planungs- und Ingenieurbüros ist editierbar = Interne SBs können Berechtigung 0..n-fach an externe PBs vergeben und wieder entziehen. Die Berechtigung für PBs gilt pro Verfahren und über Zuständigkeiten hinweg. Nur bereits in KeyCloak eingerichtete, externe Planungsbüros (PB) werden angezeigt.
|X
|X
|
|
|
|
|
|-
|VERFAHREN_BERECHTIGUNG_READ
|Über Zuständigkeiten hinweg: Reiter Stammdaten, Sektion Berechtigung für Planungs- und Ingenieurbüros ist sichtbar. Nur bereits in KeyCloak eingerichtete, externe Planungsbüros (PB) werden angezeigt.
|X
|X
|
|
|X
|X
|
|-
|VERFAHREN_ABONNIEREN
|Verfahren können abonniert und de-abonniert werden.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_VERFAHREN_READ
|Verfahren in der eigenen Zuständigkeit können über die Suche gefunden und gelesen werden. Ist ein Verfahren nicht abonniert, kann nur die Stammdatenseite gelesen werden.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_VERFAHREN_WRITE
|Verfahren in der eigenen Zuständigkeit können schreibend bearbeitet werden. Verfahren muss abonniert sein. Es ist möglich, ein simuliertes Verfahren (endgültig) zu löschen; gestartete Verfahren können nur vom M-A gelöscht werden.
|X
|X
|X
|X
|
|
|
|-
|EIGENE_VERFAHREN_
BERECHTIGUNG_WRITE
|In der jeweiligen Zuständigkeit: Reiter Stammdaten, Sektion Berechtigung für Planungs- und Ingenieurbüros ist editierbar = Interne Nutzer können Berechtigung 0..n-fach an externe PBs vergeben und wieder entziehen. Die Berechtigung für PBs gilt pro Verfahren. Nur bereits in KeyCloak eingerichtete, externe Planungsbüros (PB) werden angezeigt.
|X
|X
|X
|X
|
|
|
|-
|EIGENE_VERFAHREN_
BERECHTIGUNG_READ
|In der jeweiligen Zuständigkeit: Reiter Stammdaten, Sektion Berechtigung für Planungs- und Ingenieurbüros ist sichtbar.
|X
|X
|X
|X
|
|X
|X
|-
|EXTERNES_PLANUNGSBUERO
|1. Differenzierung für externes Planungsbüro (PB). PBs sehen nur den Reiter "Berechtigte Verfahren" (andere Art der Übersichtsseite) mit den Verfahren, für die sich berechtigt wurden - über Zuständigkeiten hinweg. Sie können an berechtigen Verfahren mitarbeiten, sehen aber bestimmte Inhalte nicht, wie Verträge, und können bestimmte Funktionen nicht ausführen, wie Berechtigung ändern.
|
|
|
|
|X
|
|
|-
|VERTRAG_READ
|Nur für interne SBs: Verträge von allen Verfahren können gelesen werden. Verfahren muss abonniert sein.
|X
|X
|
|
|
|
|
|-
|VERTRAG_WRITE
|Nur für interne SBs: Verträge von allen Verfahren können hochgeladen, bearbeitet und gelöscht werden. Verfahren muss abonniert sein.
|X
|X
|
|
|
|
|
|-
|EIGENE_VERTRAG_READ
|Nur für interne SBs: Verträge von Verfahren in eigener Zuständigkeit können gelesen werden. Verfahren muss abonniert sein.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_VERTRAG_WRITE
|Nur für interne SBs: Verträge von Verfahren in eigener Zuständigkeit können hochgeladen, bearbeitet und gelöscht werden. Verfahren muss abonniert sein.
|X
|X
|X
|X
|
|
|
|-
|DOKUMENT_READ
|(Verfahrens-) Dokumente von allen Verfahren können gelesen werden. Verfahren muss abonniert sein.
|X
|X
|X
|
|X
|
|
|-
|DOKUMENT_WRITE
|(Verfahrens-) Dokumente von allen Verfahren können hochgeladen, bearbeitet und gelöscht werden; Dokumente können aus Mustervorlagen generiert werden. Verfahren muss abonniert sein. VERFAHREN_WRITE erforderlich.
|X
|X
|
|
|X
|
|
|-
|EIGENE_DOKUMENT_READ
|(Verfahrens-) Dokumente von Verfahren in eigener Zuständigkeit können gelesen werden. Verfahren muss abonniert sein.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_DOKUMENT_WRITE
|(Verfahrens-) Dokumente von Verfahren in eigener Zuständigkeit können hochgeladen, bearbeitet und gelöscht werden; Dokumente können aus Mustervorlagen generiert werden. Verfahren muss abonniert sein. EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|X
|X
|
|
|
|-
|VORLAGE_READ
|Mustervorlagen, die dem Verfahrenssteuerungstyp zugeordnet sind, werden im Reiter Dokumente angezeigt und können zum Generieren von (Verfahrens-) Dokumenten genutzt werden. Verfahren muss abonniert sein.
|X
|X
|X
|X
|X
|
|
|-
|VORLAGE_WRITE
|Mustervorlagen können im Admin-Bereich hinzugefügt, bearbeitet und gelöscht werden. Sie dienen als Basis für (Verfahrens-) Dokumente.
|X
|
|
|
|
|
|
|-
|STELLUNGNAHME_READ
|Stellungnahmen zu allen Verfahren können gelesen werden.
|X
|X
|
|
|X
|
|
|-
|STELLUNGNAHME_WRITE
|Stellungnahmen zu allen Verfahren können bearbeitet werden = Umweltrelevanz aktivieren.
|X
|X
|
|
|X
|
|
|-
|EIGENE_STELLUNGNAHME_READ
|Stellungnahmen zu Verfahren in eigener Zuständigkeit können gelesen werden.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_STELLUNGNAHME_WRITE
|Stellungnahmen zu Verfahren in eigener Zuständigkeit können bearbeitet werden = Umweltrelevanz aktivieren.
|X
|X
|X
|X
|
|
|
|-
|REPORT
|Reports/Auswertungen können erstellt werden - über Zuständigkeiten hinweg.
|X
|X
|
|
|
|
|
|-
|EIGENE_REPORT
|Reports/Auswertungen der eigenen Zuständigkeit können erstellt werden.
|X
|X
|X
|X
|
|X
|X
|-
|VERFAHRENSSTEUERUNG_READ
|Weiche zwischen DiPlanCockpit Basis und Pro. Mit diesem Recht sind die DiPlanCockpit Pro Features sichtbar: Aufgabenreiter, Zeitplanung, Verfahrensschrittansicht. Recht zur Steuerung der Cockpit Pro Features. Für Mustervorlagen und Rechtszitate im Admin-Bereich ist das Recht ADMIN erforderlich.
|X
|X
|X
|X
|X
|X
|X
|-
|VERFAHRENSSTEUERUNG_WRITE
|Weiche zwischen DiPlanCockpit Basis und Pro. Mit diesem Recht sind die DiPlanCockpit Pro Features editierbar: Aufgabenreiter, Zeitplanung mit Blacklists/Whitelists nutzbar, Verfahrensschrittansicht, Mustervorlagen, Rechtszitate fließen über Platzhalter in Verfahrensdokumente ein. Recht zur Steuerung der Cockpit Pro Features. Für Mustervorlagen und Rechtszitate, Blacklists/Whitelists hochladen im Admin-Bereich ist das Recht ADMIN erforderlich.
|X
|X
|X
|X
|X
|
|
|-
|VERFAHREN_CREATE
|Verfahren anlegen. Sonderfall für die Rollen M-A und FP-A: Verfahren können angelegt werden - über Zuständigkeiten hinweg. VERFAHREN_WRITE oder EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|
|
|
|
|
|-
|VERFAHREN_DELETE
|Gestartete Verfahren können endgültig gelöscht werden. VERFAHREN_WRITE erforderlich.
|X
|
|
|
|
|
|
|-
|EIGENE_VERFAHREN_DELETE_
SIMULIERTES_VERFAHREN
|Simulierte Verfahren in der eigenen Zuständigkeit können endgültig gelöscht werden. Verfahren muss abonniert sein. EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|X
|X
|
|
|
|-
|EIGENE_VERFAHREN_CREATE
|Verfahren anlegen. Standardfall für Rollen wie FP-SB innerhalb der eigenen Zuständigkeit. Externe Sachbearbeiter wie externe Planungsbüros haben dieses Recht nicht. VERFAHREN_WRITE oder EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|X
|X
|
|
|
|-
|VERFAHREN_PROTOKOLL_READ
|Externe Planungsbüros sehen den Reiter Protokolle nicht. Alle anderen Pro Nutzer Rollen sehen ihn über das Recht "VERFAHREN_PROTOKOLLE_READ".
|X
|X
|X
|
|
|X
|X
|-
|VERFAHREN_SUCHE
|Nur für interne SBs: Verfahren können gesucht und abonniert werden.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_PLANWERKE_READ
|Planwerke von Verfahren in eigener Zuständigkeit können gelesen und heruntergeladen werden. Verfahren muss abonniert sein.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_PLANWERKE_WRITE
|Planwerke von Verfahren in eigener Zuständigkeit können hochgeladen, bearbeitet und gelöscht werden. Verfahren muss abonniert sein. EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|X
|X
|
|
|
|-
|PLANWERKE_READ
|Planwerke von allen Verfahren können gelesen und heruntergeladen werden. Verfahren muss abonniert sein.
|X
|X
|
|
|X
|
|
|-
|PLANWERKE_WRITE
|Planwerke von allen Verfahren können hochgeladen, bearbeitet und gelöscht werden. Verfahren muss abonniert sein. VERFAHREN_WRITE erforderlich.
|X
|X
|
|
|X
|
|
|}

Rollen und Rechte

2026-04-07T09:29:18Z

Diplanung:

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

== Einleitung ==
Diese Dokumentation richtet sich an Nutzer der Rolle Mandanten-Administration für das DiPlanCockpit Basis (Kürzel: M-A-Basis). Damit Admins ihre Aufgaben zielgerichtet ausführen können, haben sie eine eigene Ansicht "Fachliche Leitstelle Administration", die sich grundlegend von der Sachbearbeitungsebene unterscheidet.

Die Aufgaben des Admins sind darauf ausgerichtet, das Verfahren für die Sachbearbeitung vorzubereiten/einzurichten.

== 1. Systemkontext ==
Bei DiPlanCockpit Basis und DiPlanCockpit Pro handelt sich um ein Gesamtsystem und nicht um unterschiedliche Entwicklungen. Für Basis und Pro gibt es unterschiedliche Verfahrenskonfigurationen. Pro Verfahrenssteuerungstyp (auch Verfahrenssteuerung genannt) können so unterschiedliche Vorgaben und Abläufe definiert werden.

Das hinterlegte Rollen- und Rechte-Konzept differenziert, was die einzelnen Nutzer (je nach Rolle und Zuständigkeit) sehen und an Funktionen ausführen können (Lese- und Schreibrechte), sodass sie ihre spezifischen Aufgaben ausführen können. Dies wirkt sich auch auf die Rolle der Mandantenadministration im DiPlanCockpit Basis aus. Im Folgenden wird dargestellt, welche Funktionen für die Rolle M-A in Basis und Pro zur Verfügung stehen.
{| class="wikitable sortable mw-collapsible"
!Bereich
!Beschreibung
!Basis
!Pro
|-
|Fachliche Leitstelle
|Reiter Systemparameter
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Konfiguration
|vorhanden in geringem Umfang
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Codelisten
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Verfahrensverwaltung
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Planwerksverwaltung
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Transfermessages
|vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Mustervorlagen
|nicht vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Rechtszitate
|nicht vorhanden
|vorhanden
|-
|Fachliche Leitstelle
|Reiter Protokolle
|vorhanden
|vorhanden
|}
* Der Reiter Konfiguration wird für den M-A-Basis zwar dargestellt, hat jedoch einen geringeren Funktionsumfang.
* Der Reiter Mustervorlagen erlaubt dem M-A-Pro das Erstellen, Ändern, Ersetzen und Löschen von Mustervorlagen. Diese basieren auf .dotx-Vorlagen und ermöglichen es, verfahrensübergreifend Musterdokumente auf Grundlage der Vorlage zu erstellen.
* Der Reiter Rechtszitate erlaubt dem M-A-Pro das Erstellen, Bearbeiten und Löschen von Rechtszitaten. Diese werden als Platzhalter in Mustervorlagen eingefügt, um die Rechtssicherheit von Mustervorlagen zu gewährleisten.

Der Reiter Zugriffsverwaltung im Bereich Fachliche Leitstelle wurde aus Basis und Pro entfernt. Die Verwaltung der Rollen und Rechte erfolgt in KeyCloak (siehe unten).

Die einzelnen Reiter werden an dieser Stelle detailliert beschrieben: [[Admin-Bereich|https://wiki.diplanung.de/index.php/Admin-Bereich]]

== 2. Administrationsebene ==
DiPlanung ist in mehrere Administrationsebenen strukturiert. Die erste Ebene umfasst den Betrieb der Anwendungen und dient als fachliche Leitstelle, wobei die Freie- und Hansestadt Hamburg die maßnahmenverantwortliche Stelle ist. Die zweite Ebene beinhaltet die Administration der dezentralen fachlichen Leitstellen und Mandanten-Administrationen in den nachnutzenden Bundesländern. Optional kann eine dritte Ebene eingezogen werden, wenn das nachnutzende Land weitere nachgelagerte Behörden in die Administration der Fachanwendung einbinden möchte. Die vierte Ebene umfasst die nutzenden Stellen der Anwendung, darunter Sachbearbeitungen in den Behörden und Kommunen, Träger öffentlicher Belange (TöB), Planungsbüros und Bürger:innen.

=== 2.1 2FA ===
Die obligatorische Verwendung von 2FA (Zwei-Faktor-Authentifizierung) ist für alle drei Administrationsebenen anzustreben.

== 3. Rollen- und Rechte-Konzept ==
Das Rollen- und Rechte-Konzept bildet die Grundlage für rechtssichere Zuständigkeiten und Aufgabenverteilungen innerhalb des Fachverfahrens.

=== 3.1 KeyCloak ===
Die Rollen und Rechte werden zentral in KeyCloak verwaltet. Keycloak ist ein Open-Source-Softwareprodukt, das Single Sign-On mit Identitäts- und Zugriffsverwaltung für moderne Anwendungen und Dienste ermöglicht. Pro Mandant wird ein DiplanCockpit Basis Client in Keycloak zur Verfügung gestellt. Hierüber können die einzelnen Rollen und Rechte gesteuert werden. Dadurch wird gesteuert, welcher User auf welche Funktionen Zugriff hat. Eine featuregenaue Steuerung pro User ist nicht möglich, aber auch konzeptionell nicht gewollt.

Für jeden Mandanten werden Berechtigungen (Rollen/Rechte) und Verfahrensverantwortung über zwei getrennte Gruppen in Keycloak gesteuert.

==== 3.1.1 Gruppe Cockpit Berechtigung ====
In dieser Gruppe sind die fachlich definierten Rollen aufgeführt. Differenzierung zwischen Cockpit Basis und Cockpit Pro Nutzer über die K1 Nutzerrechte:

VERFAHRENSSTEUERUNG_WRITE

VERFAHRENSSTEUERUNG_READ

==== 3.1.2 Gruppe Cockpit-Zuständigkeit ====
In dieser Gruppe ist die Zuständigkeit pro Mandant hierarchisch aufgeschlüsselt.

Die Rollen und Rechte werden über die Cockpit-Berechtigung und die Cockpit-Zuständigkeit definiert. Ein Anwender hat immer mindestens eine Cockpit-Berechtigungsrolle. Ein Anwender kann für den Mandanten Hamburg keine oder genau eine Zuständigkeit zugewiesen bekommen z.B. Senat oder Altona oder Bergedorf.

Beispiel für mehrfache Gruppenzugehörigkeit: Die Anwendenden in EfA können den Gruppen Verfahrensmanagement (Cockpit-Berechtigung) oder - Sachbearbeitung (Cockpit-Berechtigung) und Altona (Cockpit-Zuständigkeit) zugeordnet sein.

==== 3.1.3 Gruppe Organisation ====
In diese Gruppe fallen die Planungsbüros (PB). Eine Besonderheit ist, dass Planungsbüros KEINE Zuständigkeit haben.

=== 3.2 Erklärung der Rollen ===
Im Folgenden werden jede Rolle und die dazugehörigen Rechte in Tabellenform dargestellt.

Die Tabelle zeigt, dass die Rolle M-A-Basis klar von den weiteren Rollen abgegrenzt werden kann, da ihr Fokus nicht auf fachlichen Aufgaben beruht. Stattdessen steht die Verwaltung der Rollen und Rechte der Nutzer im Vordergrund.

==== 3.2.1 Erläuterung der Abkürzungen der Rollen ====
* M-A = Mandanten-Administration - Mandanten spezifische Administration
* FP-A = Fachplanung Administration - Verfahrensmanager/in über alle Verfahren innerhalb des Mandanten
* FP-VM = Fachplanung-Verfahrensmanagement - Verfahrensmanager/in über Verfahren in eigener Verfahrensverantwortung (insb. auch Anlegen) und lesende Rechte in allen Verfahren des Mandanten
* FP-SB = Fachplanung-Sachbearbeitung - Verfahrensmanager/in über Verfahren in eigener Verfahrensverantwortung (insb. auch Anlegen)
* FP-PB-SB = Fachplanung-Planungsbüro-Sachbearbeiter (1. Stufe) mit Schreibrecht in einem ausgewählten Verfahren, für das die Organisation (Planungsbüro) berechtigt wurde. Rolle hat keine Zuständigkeit, d.h. sie kann über Zuständigkeiten an Verfahren mitarbeiten, für die sie berechtigt wurde.
* C-VM = Controlling-Verfahrensmanagement - Alle Verfahren innerhalb des Mandanten lesen, alle Reports erzeugen, nur eigene Verträge, Dokumente, Stellungnahmen lesen
* C-SB = Controlling-Sachbearbeitung - Verfahren, Verträge, Dokumente in eigener Verfahrensverantwortung lesen, eigene Reports erzeugen

==== 3.2.2 Hinweise ====

# "Eigene" im Recht bezieht sich immer auf die eigene Zuständigkeit, nicht darauf, ob das Verfahren abonniert ist oder selbst angelegt wurde. "Eigene" bezieht sich auf interne Nutzer (Behördenvertretende).
# Alle schreibenden Rechte in der K1 erfordern, dass das Verfahren abonniert ist, um Änderungen vornehmen zu können. Mit Klick auf ein Verfahren, wird es automatisch abonniert.
# Externe Planungsbüros (PB) können in angelegten Verfahren mitarbeiten, haben selbst aber keine Zuständigkeit. Sie erhalten eine eigene Übersichtsseite "Berechtigte Verfahren", auf der 0..n Verfahren aufgelistet sind, für die ein PB berechtigt wurde. Abonnieren ist dafür irrelevant. Es werden in der 1. Stufe die Rollen FP-PB-SB#1 (Pro) + FP-PB-SB_Basis#1 (Basis) umgesetzt.
# In KeyCloak gibt es für alle PB - unabhängig von der Berechtigungsstufe im DiPlanCockpit - nur eine Rolle / Gruppe / Organisation: FP-PB.

'''Legende zur Tabelle:'''

X = Recht gilt bei dieser Rolle
{| class="wikitable"
! rowspan="2" |Zugeordnete Rechte pro Rolle
!
! colspan="7" |Rollen EfA Cockpit Basis
|-
!Erläuterung des Rechts
!M-A-Basis
!FP-A-Basis
!FP-VM-Basis
!FP-SB-Basis
!FP-PB-SB-Basis
!C-VM-Basis
!C-SB-Basis
|-
|ADMIN
|Zugriff auf den Admin-Bereich (fachliche Leitstelle Administration) sowie den Cockpit-Bereich.
|X
|
|
|
|
|
|
|-
|VERFAHREN_EINSTELLUNGEN
|Zugriff auf den Reiter Einstellungen im Cockpit-Bereich.
|X
|X
|
|
|
|
|
|-
|VERFAHREN_READ
|Interne SBs: Alle Verfahren eines Mandanten - über Zuständigkeiten hinweg können über die Suche gefunden und gelesen werden. Externe PBs: Leserecht für Verfahren, für die das PB berechtigt wurde. Suchfunktion gibt es für sie nicht. Interne SBs: Ist ein Verfahren nicht abonniert, kann nur die Stammdatenseite gelesen werden.
|X
|X
|X
|
|X
|X
|
|-
|VERFAHREN_WRITE
|Alle Verfahren eines Mandanten - über Zuständigkeiten hinweg - können schreibend bearbeitet werden. Interne SBs: Verfahren muss abonniert sein. Externe PBs: Schreibrecht für Verfahren, für die das PB berechtigt wurde. Abonnieren gibt es für sie nicht.
|X
|X
|
|
|X
|
|
|-
|VERFAHREN_BERECHTIGUNG_WRITE
|Über Zuständigkeiten hinweg: Reiter Stammdaten, Sektion Berechtigung für Planungs- und Ingenieurbüros ist editierbar = Interne SBs können Berechtigung 0..n fach an externe PBs vergeben und wieder entziehen. Die Berechtigung für PBs gilt pro Verfahren und über Zuständigkeiten hinweg. Nur bereits in KeyCloak eingerichtete, externe Planungsbüros (PB) werden angezeigt.
|X
|X
|
|
|
|
|
|-
|VERFAHREN_BERECHTIGUNG_READ
|Über Zuständigkeiten hinweg: Reiter Stammdaten, Sektion Berechtigung für Planungs- und Ingenieurbüros ist sichtbar. Nur bereits in KeyCloak eingerichtete, externe Planungsbüros (PB) werden angezeigt.
|X
|X
|
|
|X
|X
|
|-
|VERFAHREN_ABONNIEREN
|Verfahren können abonniert und de-abonniert werden.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_VERFAHREN_READ
|Verfahren in der eigenen Zuständigkeit können über die Suche gefunden und gelesen werden. Ist ein Verfahren nicht abonniert, kann nur die Stammdatenseite gelesen werden.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_VERFAHREN_WRITE
|Verfahren in der eigenen Zuständigkeit können schreibend bearbeitet werden. Verfahren muss abonniert sein. Es ist möglich, ein simuliertes Verfahren (endgültig) zu löschen; gestartete Verfahren können nur vom M-A gelöscht werden.
|X
|X
|X
|X
|
|
|
|-
|EIGENE_VERFAHREN_
BERECHTIGUNG_WRITE
|In der jeweiligen Zuständigkeit: Reiter Stammdaten, Sektion Berechtigung für Planungs- und Ingenieurbüros ist editierbar = Interne Nutzer können Berechtigung 0..n fach an externe PBs vergeben und wieder entziehen. Die Berechtigung für PBs gilt pro Verfahren. Nur bereits in KeyCloak eingerichtete, externe Planungsbüros (PB) werden angezeigt.
|X
|X
|X
|X
|
|
|
|-
|EIGENE_VERFAHREN_
BERECHTIGUNG_READ
|In der jeweiligen Zuständigkeit: Reiter Stammdaten, Sektion Berechtigung für Planungs- und Ingenieurbüros ist sichtbar.
|X
|X
|X
|X
|
|X
|X
|-
|EXTERNES_PLANUNGSBUERO
|1. Differenzierung für externes Planungsbüro (PB). PBs sehen nur den Reiter "Berechtigte Verfahren"(andere Art der Übersichtsseite) mit den Verfahren, für die sie berechtigt wurden - über Zuständigkeiten hinweg. Sie können an berechtigen Verfahren mitarbeiten, sehen aber bestimmte Inhalte nicht, wie Verträge, und können bestimmte Funktionen nicht ausführen, wie Berechtigung ändern.
|
|
|
|
|X
|
|
|-
|VERTRAG_READ
|Nur für interne SBs: Verträge von allen Verfahren können gelesen werden. Verfahren muss abonniert sein.
|X
|X
|
|
|
|
|
|-
|VERTRAG_WRITE
|Nur für interne SBs: Verträge von allen Verfahren können hochgeladen, bearbeitet und gelöscht werden. Verfahren muss abonniert sein.
|X
|X
|
|
|
|
|
|-
|EIGENE_VERTRAG_READ
|Nur für interne SBs: Verträge von Verfahren in eigener Zuständigkeit können gelesen werden. Verfahren muss abonniert sein.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_VERTRAG_WRITE
|Nur für interne SBs: Verträge von Verfahren in eigener Zuständigkeit können hochgeladen, bearbeitet und gelöscht werden. Verfahren muss abonniert sein.
|X
|X
|X
|X
|
|
|
|-
|DOKUMENT_READ
|(Verfahrens-) Dokumente von allen Verfahren können gelesen werden. Verfahren muss abonniert sein.
|X
|X
|X
|
|X
|
|
|-
|DOKUMENT_WRITE
|(Verfahrens-) Dokumente von allen Verfahren können hochgeladen, bearbeitet und gelöscht werden; Dokumente können aus Mustervorlagen generiert werden. Verfahren muss abonniert sein. VERFAHREN_WRITE erforderlich.
|X
|X
|
|
|X
|
|
|-
|EIGENE_DOKUMENT_READ
|(Verfahrens-) Dokumente von Verfahren in eigener Zuständigkeit können gelesen werden. Verfahren muss abonniert sein.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_DOKUMENT_WRITE
|(Verfahrens-) Dokumente von Verfahren in eigener Zuständigkeit können hochgeladen, bearbeitet und gelöscht werden; Dokumente können aus Mustervorlagen generiert werden. Verfahren muss abonniert sein. EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|X
|X
|
|
|
|-
|REPORT
|Reports/Auswertungen können erstellt werden - über Zuständigkeiten hinweg.
|X
|X
|
|
|
|
|
|-
|EIGENE_REPORT
|Reports/Auswertungen der eigenen Zuständigkeit können erstellt werden.
|X
|X
|X
|X
|
|X
|X
|-
|VERFAHREN_CREATE
|Verfahren anlegen. Sonderfall für die Rollen M-A und FP-A: Verfahren können angelegt werden - über Zuständigkeiten hinweg. VERFAHREN_WRITE oder EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|
|
|
|
|
|-
|VERFAHREN_DELETE
|Gestartete Verfahren können endgültig gelöscht werden. VERFAHREN_WRITE erforderlich.
|X
|
|
|
|
|
|
|-
|EIGENE_VERFAHREN_DELETE_
SIMULIERTES_VERFAHREN
|Simulierte Verfahren in der eigenen Zuständigkeit können endgültig gelöscht werden. Verfahren muss abonniert sein. EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|X
|X
|
|
|
|-
|EIGENE_VERFAHREN_CREATE
|Verfahren anlegen. Standardfall für Rollen wie FP-SB innerhalb der eigenen Zuständigkeit. Externe Sachbearbeiter wie externe Planungsbüros haben dieses Recht nicht. VERFAHREN_WRITE oder EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|X
|X
|
|
|
|-
|VERFAHREN_SUCHE
|Nur für interne SBs: Verfahren können gesucht und abonniert werden.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_PLANWERKE_READ
|Planwerke von Verfahren in eigener Zuständigkeit können gelesen und heruntergeladen werden. Verfahren muss abonniert sein.
|X
|X
|X
|X
|
|X
|X
|-
|EIGENE_PLANWERKE_WRITE
|Planwerke von Verfahren in eigener Zuständigkeit können hochgeladen, bearbeitet und gelöscht werden. Verfahren muss abonniert sein. EIGENE_VERFAHREN_WRITE erforderlich.
|X
|X
|X
|X
|
|
|
|-
|PLANWERKE_READ
|Planwerke von allen Verfahren können gelesen und heruntergeladen werden. Verfahren muss abonniert sein.
|X
|X
|
|
|X
|
|
|-
|PLANWERKE_WRITE
|Planwerke von allen Verfahren können hochgeladen, bearbeitet und gelöscht werden. Verfahren muss abonniert sein. VERFAHREN_WRITE erforderlich.
|X
|X
|
|
|X
|
|
|}

Verfahrenskonfiguration Pro

2026-03-30T09:35:56Z

Diplanung: /* Unterverfahrensteilschritt */

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

Die Verfahrenskonfiguration, kurz VK, ist das zentrale Element in der Konfiguration. Über Verfahrenskonfigurationen wird je nach Verfahrenssteuerungstyp (kurz V-Typ) der Ablauf des Verfahrens festgelegt. Das heißt, die VK bestimmt den Ablauf des Verfahrens und die vorgesehenen Aufgaben innerhalb eines Verfahrens. Außerdem enthält sie grundlegende Einstellungen zur Zeitplanung.

Es ist eine Default-Stellung für die kommunale Bauleitplanung verfügbar, die Mandanten spezifisch angepasst werden kann. Es lassen sich beliebig viele unterschiedliche VKs konfigurieren, die für jeden V-Typ eigene Abläufe definieren.

== Tab Verfahrenskonfiguration ==
Im Tab Verfahrenskonfiguration sind die verfügbaren Verfahrenskonfigurationen aufgelistet. Sie lassen sich nach Name, Status, Verwendung, Aktualisierungsdatum und bearbeitender Person filtern. Das Herunterladen erfolgt wahlweise einzeln als XML für eine Verfahrenskonfiguration oder für alle zusammen in Form einer ZIP-Datei.

Eine Verfahrenskonfiguration kann angepasst und bzw. neu erstellt und anschließend über das dafür vorgesehene Feld hochgeladen werden. Eine neu hochgeladene Verfahrenskonfiguration gilt für alle danach neu angelegten Verfahren, bereits vorhandene Verfahren werden nicht verändert.

Es ist ebenfalls möglich Verfahrenskonfigurationen zu löschen. Das erfolgt in zwei Schritten. Zuerst wird eine Verfahrenskonfiguration per Klick auf "Löschen" im Drei-Punkte-Menü als gelöscht markiert. Anschließend kann sie wiederhergestellt oder endgültig gelöscht werden. Für die endgültige Löschung ist Voraussetzung, dass die Verfahrenskonfiguration nicht mehr in Verwendung ist. Gegebenenfalls sind deswegen zuerst die Verfahren zu löschen, die die Verfahrenskonfiguration noch verwenden. Die betreffenden Verfahren werden per Klick auf die Werte in der Spalte "in Verwendung" angezeigt.

== Wichtige Hinweise ==
Jede VK bezieht sich auf Codelisten - sowohl feste als auch (vom Mandanten) änderbare Codelisten. Um Fehler zu vermeiden, muss sichergestellt werden, dass VK und änderbare Codelisten stets auf dem gleichen Stand sind. Das bedeutet:

* Anpassungen in einer VK können Konsequenzen auf änderbare Codelisten haben. = Anpassungen IMMER für VK und änderbare Codelisten umsetzen.
* Entfernung von Codes in änderbaren Codelisten müssen mit Umsicht vorgenommen und mögliche Auswirkungen auf VK(s) geprüft und bei Bedarf umgesetzt werden.
* Einfacher ist es, Einträge / Codes in änderbaren Codelisten ergänzend vorzunehmen, also den Bestand um neue Einträge zu ergänzen.
* Beim Hochladen ist die Reihenfolge wichtig: Angepasste, änderbare Codelisten müssen zuerst hochgeladen werden. Danach folgt die angepasste VK. Wird die Reihenfolge nicht eingehalten, kann es zur Fehlermeldung kommen.
* Für die Änderung von VK und Codelisten empfiehlt sich der Einsatz eines professionellen XLM-Tools, das Validierungs-Funktionen bietet. Diese laufen i.d.R. im Hintergrund ab und zeigen optisch Fehler an, wie falsche Einrückungen im XML-Baum oder fehlende Bestandteile wie der End-Tag eines Elements. Die Validierung erfolgt gegen die Datei diplanung.xsd.
* Bestimmte Zeichen in einer XML müssen encoded werden, damit sie nicht eine besondere Rolle im XML-Syntax erfüllen. Allgemein gibt es 5 Zeichen, die [https://stackoverflow.com/a/1091953 in XML escaped] werden müssen:
** " muss escaped werden als &quot;
** ' muss escaped werden als &apos;
** < muss escaped werden als &lt;
** > muss escaped werden als &gt;
** & muss escaped werden als &amp;

Mehr Details zur Mandanten spezifischen Anpassung von VK + änderbaren Codelisten siehe Abschnitt: [https://wiki.diplanung.de/index.php/Verfahrenskonfiguration_Pro#Mandanten_spezifische_Anpassung_und_Erstellung_von_VK Mandanten spezifische Anpassung und Erstellung von Verfahrenskonfigurationen.]

== Elemente der Verfahrenskonfiguration im Frontend ==
Der folgende Screenshot mit farblichen Beschriftungen und Markierungen zeigt den Reiter Aufgaben im DiPlanCockpit Pro. Darin sind die meisten Elemente der VK zu sehen, die in den folgenden Abschnitten erklärt werden.

Die gelbe Markierung zeigt jeweils exemplarisch ein Element an, der nächstliegende rote Kasten mit Text die Bezeichnung.
[[Datei:ImageVKFrontend.png|zentriert|719x719px|alternativtext=|rahmenlos]]

== Struktur der Verfahrenskonfiguration ==
In den folgenden Abschnitten wird eine beispielhafte VK anhand von Screenshots erläutert. Die Zahlen am linken Rand der Screenshots zeigen die Zeilennummern der XML-Datei. Insgesamt sind es im Beispiel 4836. Um eine kompakte Darstellung zu ermöglichen, sind die Bereiche, die für die jeweilige Erläuterung irrelevant sind, eingeklappt. Das ist an den kleinen blauen Pfeilen rechts von den Zeilennummern zu erkennen. Ein Pfeil nach unten bedeutet, dass der Abschnitt aufgeklappt ist. Ein Pfeil nach rechts hingegen heißt, dass an dieser Stelle noch weitere Zeilen sind, die lediglich nicht angezeigt werden. Die Anzahl der ausgeblendeten Zeilen ist in Klammern angegeben. Die Form der Darstellung ist dem verwendeten Programm geschuldet. Bei der Verwendung anderer Programme kann die visuelle Darstellung der XML abweichen.

== Screenshot mit Überblick der VK ==
'''Hinweis''': Neben dem Code der Verfahrenssteuerung (Zeile 3) ist die Fachdomäne anzugeben, hier "KommunaleBauleitplanung" (fehlt im Screenshot). Die Zeile muss lauten <code><verfahrenssteuerung code="6100" fachdomaene="KommunaleBauleitplanung"></code>[[Datei:ImageVKUeberblick1.png|zentriert|rahmenlos|619x619px]]

=== Erläuterung der Grundstruktur ===
[[Datei:VKRahmen2.png|alternativtext=|zentriert|rahmenlos|418x418px]]
Den äußeren Rahmen bildet die Angabe des Codes für die jeweilige VK. Im dargestellten Beispiel ist dies der Code 6100. Für jeden gewünschten V-Typ ist eine separate Datei mit einem eindeutigen Code erforderlich. Dieser Code MUSS in der Codeliste Code.Verfahrenssteuerung enthalten sein.

Daneben folgt die Angabe der Fachdomäne, hier ist es die "KommunaleBauleitplanung". Andere mögliche Fachdomänen sind "Planfeststellung" und "Raumordnung". Die Fachdomäne steuert unter anderem, [[Editieren der Stammdaten - DiPlanCockpit Pro#Verf.C3.BCgbare%20Stammdaten%20pro%20Fachdom.C3.A4ne|welche Stammdaten]] angezeigt werden.

Unterhalb der Verfahrenssteuerung und einmal eingerückt folgen die Angabe der Veranlasser für die Beteiligung sowie die gewünschten Planarten und Verfahrensarten für die VK. Die Beteiligung ist verpflichten mit einem "StandardVeranlasser" anzugeben. Optional können weitere Veranlasser mit einer Zuständigkeit angegeben werden. Zu beachten sind hierbei zwei Punkte:

# Der Code-Wert aus der Codeliste Zuständigkeit muss mit dem Wert des Attributs zuständigkeit im Element veranlasser in der VK übereinstimmen.
# Der Wert des Elements veranlasser muss mit der Organisations-ID der Organisation in der Beteiligung übereinstimmen. Der Wert lässt sich üblicherweise dem verwendeten ELSTER-Zertifikat entnehmen.

Beim Nachrichtenaustausch mit DiPlanBeteiligung wird geprüft, ob ein spezifisch zur Zuständigkeit passender Veranlasser vorhanden ist. Wenn ja, wird dieser übermittelt, andernfalls der Standard-Veranlasser ohne Zuständigkeit.[[Datei:ImageVKBeteiligungVeranlasser.png|zentriert|rahmenlos|455x455px]]
Die angegebenen Planarten sollten fachlich zum Verfahrenssteuerungstyp passen. Zulässige Kombinationen sind im XRepository in der [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planart Codeliste Planart] aufgeführt. Der Eintrag in der Spalte "Übergeordneter Wert" der Codeliste bezeichnet den passenden Verfahrenssteuerungstyp.
[[Datei:ImageVKZustaendigkeit1.png|zentriert|rahmenlos]]
Optional kann oberhalb der Beteiligung noch die Zuständigkeit angegeben sein. Wenn eine oder mehrere Zuständigkeiten in der VK aufgeführt sind, steht die VK nur für diese zur Verfügung. Andernfalls ist die Nutzung der VK für alle Zuständigkeiten möglich.

An die Verfahrensarten schließen sich allgemeine Angaben zur Zeitplanung an. Anschließend folgt der Hauptteil der VK mit der Auflistung aller Verfahrensschritte. Diese enthalten jeweils Verfahrensteilschritte, Unterverfahrensteilschritte, Aufgaben, Unteraufgaben und schließlich die ActionItems.

Sämtliche ActionItems sind im Detail auf einer eigenen Unterseite beschrieben. Auf dieser Seite folgt eine Erläuterung der übrigen Elemente der VK.

=== Erläuterung der einzelnen Abschnitte ===

==== Zeitplanung ====
[[Datei:ImageVKZeitplanung2.png|zentriert|rahmenlos|744x744px]]
Im Abschnitt zur Zeitplanung wird festgelegt, ob ein Monitoring vorgesehen ist. Im dargestellten Beispiel ist es vorgesehen. Zusätzlich ist angegeben, welche möglichen Arten der Monitoringrelevanz es geben soll und welche Nicht-Monitoring-Gründe.

Außerdem wird im Abschnitt zur Zeitplanung festgelegt, welcher Termin als Prognosestarttermin dienen soll. Von diesem geht die gesamte Zeitplanung aus. Im Beispiel ist es der Termin "Grobabstimmung". Angegeben ist der entsprechende Code "grobabstimmung" aus der Codeliste Code.Sitzungen, alternativ ist auch ein Code aus Code.SonstigeTermin möglich. Zu beachten ist, dass der gewählte Termin mit dem Attribut "prognoserelevant=ja" angelegt werden muss.
{| class="wikitable"
!Name
!Zweck
|-
|monitoring
|Angabe, ob ein Monitoring vorgesehen ist.
|-
|artDerMonitoringRelevanz
|Angabe möglicher Arten der Monitoringrelevanz mit Name und Beschreibung.
|-
|nichtMonitoringGrund
|Angabe von Codes aus der Codeliste Code.NichtMonitoringGrund, die für Verfahren mit dieser Verfahrenskonfiguration zur Verfügung stehen sollen.
|-
|prognosestarttermin
|Definiert den Prognosestarttermin, von dem die Zeitplanung ausgeht. Zu beachten ist, dass der gewählte Termin mit dem Attribut "prognoserelevant=ja" angelegt werden muss.
|}

==== Optional: Fachdomänenspezifische Ordnerstruktur ====
Eine konfigurierbare fachdomänenspezifische Ordnerstruktur zum Hochladen der Dokumente kann durch den Mandanten-Administrator über den Abschnitt <dokumentbibliothek> ergänzt werden. Zurzeit ist diese Ordnerstruktur nur für die Fachdomäne Planfeststellung konfiguriert.
[[Datei:ImageFachdomänenspezifischeOrdner.png|zentriert|rahmenlos|748x748px]]
Erklärung der Felder:
{| class="wikitable"
!Name
!Zweck
|-
|name
|Name bzw. Bezeichnung des Ordners (im Frontend für Nutzende sichtbar), darf nicht leer sein und darf pro Ebene nicht doppelt auftauchen.
|-
|upload
|Gibt an, ob ein Dokumentenupload über den Ordner möglich ist (true) oder nicht (false).
|-
|verfahrensunterlagentyp
|Der standardmäßig automatisch zugeordnete Verfahrensunterlagentyp für alle Dokumente / Dateien im Ordner.
|-
|pflicht
|"ja" bedeutet, dass sich mindestens eine Datei im Ordner befinden muss, was im Rahmen der Vollzähligkeitsprüfung für Vorhabens- und Antragsdokumente der Fachdomäne Planfeststellung überprüft wird. "nein" bedeutet, dass der Ordner leer sein darf und keine Auswirkung auf die Vollzähligkeitsprüfung hat.
|-
|beschreibung
|Textliche Beschreibung der fachlichen Inhalte der Dokumente im Ordner, die für die KI-Prüfung genutzt wird.
|}
Die folgenden Regeln und Einschränkungen müssen beachtet werden:

* Die Ordnerstruktur entspricht einer Baumstruktur (ähnlich wie Windows-Explorer) mit den Ebenen 0 (Wurzel) bis n.
* Die Codeliste der Verfahrensunterlagentypen muss um die für die Ordnerstruktur vorgesehenen Verfahrensunterlagentypen ergänzt und hochgeladen sein, anschließend kann die VK hochgeladen werden.
* Das Attribut verfahrensunterlagentyp darf nicht leer sein und nicht doppelt über die ganze Ordnerstruktur vorkommen.
* Wenn Dokumente innerhalb dieser Ordnerstruktur von einem DiPlan-System (z. B. Vorhaben-Cockpit - Antragsstellung) zu einem andern DiPlan-System (z. B. Behörden-Cockpit - Verfahrens-Verwaltung) übertragen werden, dann muss die Ordnerstruktur in beiden Systemen exakt identisch sein. Dabei muss beachtet werden, dass in den Codelisten die Codewerte für Verfahrensunterlagentypen in beiden Systemen eindeutig sind und keine Widersprüche vorhanden sind.

==== Optional: Mandanten spezifische Stammdaten ====
Optional können oberhalb der Verfahrensschritte zusätzliche Mandanten spezifische Stammdaten angegeben werden. Diese ermöglichen die Gestaltung individueller Eingabefelder für die Stammdatenseite. Sie erscheinen auf der Stammdatenseite oberhalb des Abschnitts zu Parallelverfahren in der Reihenfolge, mit der sie in der Verfahrenskonfiguration aufgeführt sind. Ihre Definition erfolgt beispielsweise in der Form <code><eigenschaft label="Beispiel eines Mandanten spezifischen Feldes zur Eingabe von Text" name="Beispiel6200Text" typ="TEXT" subtyp="SINGLE" pflicht="nein"/></code>.

Erklärung der Felder:
{| class="wikitable"
!Name
!Zweck
|-
|label
|Wird als Beschriftung des Feldes angezeigt, kann frei gewählt werden.
|-
|name
|Technischer Name, muss eindeutig sein, sprich darf nur einmal verwendet werden.
|-
|typ
|Gibt den Datentyp an. Zulässige Werte sind: TEXT (Freitextfeld mit max. 255 Zeichen), FLOAT (Zahlenfeld für Gleitkommazahlen), INTEGER (Zahlenfeld für ganze Zahlen), BOOLEAN (Checkbox), DATE (Datumsfeld), TIME (Zeitangabe), DATE_TIME (Datums- und Zeitangabe), DATE_TIME_RANGE (Zeitspanne), URL (Link), CODELIST (Dropdown-Auswahl, Inhalte kommen aus einer Codeliste), DROPDOWN (Dropdown-Auswahl, Optionen individuell festgelegt ohne Codeliste)
|-
|subtyp
|Muss für alle Typen außer CODELIST und DROPDOWN den Wert SINGLE haben. Bei CODELIST bzw. DROPDOWN ermöglicht SINGLE die Auswahl genau eines Wertes aus dem Dropdown, bei LIST können mehrere ausgewählt werden (Multiselect).
|-
|pflicht
|Gibt an, ob das Feld verpflichtend ist (ja oder nein).
|-
|codelistName
|Nur erforderlich bei Typ CODELIST. Der Wert muss dann lauten: "Code." + Name der Codeliste, z.B. "Code.Zustaendigkeit".
|-
|option
|Nur erforderlich bei Typ DROPDOWN. Einmal bis beliebig oft mit je einem Eintrag für das Dropdown einfügen.
|}

==== Verfahrensschritt ====
[[Datei:ImageVKVS.png|links|488x488px|alternativtext=|rahmenlos]]
Ein Verfahrensschritt ist die oberste Ebene in der Unterteilung eines Verfahrens in mehrere Abschnitte. Er wird durch die Angabe des Codes aus Code.Verfahrensschritte bestimmt. Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen. Aktuell werden Durchgänge auf Ebene der Verfahrensschritte durch das Cockpit nicht unterstützt, sodass die Angabe von "ja" keinen Effekt hat.

Jeder Verfahrensschritt enthält beliebig viele Verfahrensteilschritte. Es ist möglich keinen Verfahrensteilschritt anzugeben, dann wird der Verfahrensschritt jedoch nicht im Cockpit sichtbar.

Die Reihenfolge der Verschachtelung (Verfahrensschritt > Verfahrensteilschritt > Unterverfahrensteilschritt) muss eingehalten werden. In einen Verfahrensschritt direkt einen Unterverfahrensteilschritt einzufügen ist nicht zulässig. Ebenso wenig ist es zulässig, innerhalb eines Verfahrensteilschritts oder einer tieferen Ebene, Verfahrensschritte zu ergänzen.

Damit die Verfahrensschritte in der richtigen Reihenfolge dargestellt werden, ist es notwendig ihre Codes in alphabetischer/numerischer Reihenfolge zu vergeben, also beispielsweise "0001VerfahrensschrittEins", "0002Verfahrensschritt2" usw.
{| class="wikitable"
!Name
!Zweck
|-
|verfahrensteilschritt
|Angabe eines untergeordneten Verfahrensteilschritts.
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein". Im Cockpit werden Durchgänge für Verfahrensschritte nicht unterstützt.
|}
Eine Besonderheit ist der Verfahrensschritt 9998. Dieser ist obligatorisch mitsamt des Verfahrensteilschritts 9998. Darin können Termine aufgeführt sein, die Eingaben auf der Stammdatenseite referenzieren.

Die mit der Stammdatenseite verknüpften Termine sind für die kommunale Bauleitplanung 0100 (Beschlussdatum), 0200 (Vorweggenehmigung bzw. Planreife gemäß §33 BauGB) und 9300 (Aufhebungsdatum). Der Termin 9300 muss zudem die beiden Eigenschaften "linkPlanzeichnung" und "linkBegruendung" des Typs URL haben.

Für die Fachdomäne Raumordnung sind es die Termine pflicht_9400 (Tag des Inkrafttretens) und pflicht_9450 (Tag des Außerkrafttretens). Diese Termine müssen im VS 9998 angegeben werden, wenn sie nicht bereits in einem vorherigen Verfahrensschritt definiert sind.

Wichtig für die Stammdatenseite ist, dass diese Termine in der Verfahrenskonfiguration enthalten sind, aber nicht an welcher Stelle. Der VS 9998 dienst als Option, wenn nicht gewünscht ist, die Termine in den Verfahrensablauf einzubinden.
[[Datei:ImageVS9998 2.png|zentriert|rahmenlos|572x572px]]

==== Verfahrensteilschritt ====
[[Datei:ImageVKVTS.png|601x601px|alternativtext=|zentriert|rahmenlos]]
Verfahrensteilschritte bilden die zweite Ebene in der Strukturierung des Verfahrensablaufs. Sie werden durch die Angabe eines Codes aus Code.Verfahrensteilschritte bestimmt. Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen.

Zu jedem Verfahrensteilschritt können 0 bis beliebig viele Sitzungen und/oder sonstige Termine angegeben werden. Anschließend folgt die Auflistung aller Unterverfahrensteilschritte.
{| class="wikitable"
!Name
!Zweck
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein".
|-
|sitzung
|Sitzung innerhalb des Verfahrensteilschritts.
|-
|sonstigerTermin
|Sonstiger Termin innerhalb des Verfahrensteilschritts.
|-
|unterverfahrensteilschritt
|Angabe eines untergeordneten Unterverfahrensteilschritts.
|}

==== Sitzung ====
[[Datei:ImageVKSitzung.png|links|474x474px|alternativtext=|rahmenlos]]
Sitzungen werden über einen Code aus der Codeliste Code.Sitzungscodes bestimmt. Zu beachten ist, dass die Bezeichnung einer Sitzung maximal 255 Zeichen umfassen darf. Zusätzlich werden mögliche Ergebnisse über die Angabe eines Codes aus Code.Sitzungsergebnistyp festgelegt.

Jede Sitzung enthält die Information, ob sie zeitplanungsrelevant oder nicht zeitplanungsrelevant ist. Bei Relevanz für die Zeitplanung ist ebenfalls anzugeben ob Monitoring- und/oder Prognoserelevanz gewünscht ist. Zusätzlich ist die vorgesehene Wirkung in der Modellberechnung anzugeben. Dies erfolgt über die Verzögerung, Dauer und das Setzen auf Aktiv. Die möglichen Verzögerungsgründe werden hier nicht angegeben, sondern sind je nach V-Typ festgelegt und stammen aus der Codeliste Code.Verzoegerungsgrund.

Für nicht zeitplanungsrelevante Sitzungen ist nur anzugeben, welcher Datumstyp gewünscht ist. Dieser kann ein einzelner Tag (Angabe zeitpunkt), Zeitraum (Angabe zeitraum) oder flexibel (Angabe zeitpunkt_oder_zeitraum) sein.
{| class="wikitable"
!Name
!Zweck
|-
|ergebnistyp
|Codeliste der Ergebnistypen.
|-
|zeitplanungsrelevant oder nichtzeitplanungsrelevant
|Legt Zeitplanungsrelevanz fest.
|-
|monitoringrelevant
|Legt Monitoringrelevanz fest. Angabe "ja" oder "nein".
|-
|prognoserelevant
|Legt Prognoserelevanz fest. Angabe "ja" oder "nein".
|-
|modellberechnung
|Enthält Informationen zur Berechnung in der Zeitplanung.
|-
|verzoegerung
|Bestimmt die Verzögerung. Angabe als ganze Zahl.
|-
|dauer
|Bestimmt die Dauer. Angabe als ganze Zahl.
|-
|aktiv
|(De-)aktiviert den Einfluss auf die Modellberechnung. Angabe "ja" oder "nein".
|-
|datumstyp
|Beschreibt für nicht zeitplanungsrelevante Termine die Art der Datumsangabe. Angabe "zeitpunkt", "zeitraum" oder "zeitpunkt_oder_zeitraum".
|}

==== Sonstiger Termin ====
[[Datei:ImageSonstigeTermine.png|links|rahmenlos|507x507px]]
(Hinweis: Des Screenshot zeigt zwei verschiedene sonstige Termine, um möglichst viele Optionen der Konfiguration abzubilden.)

Sonstige Termine werden über einen Code aus der Codeliste Code.SonstigeTermin bestimmt. Zu beachten ist, dass die Bezeichnung eines sonstigen Termins maximal 255 Zeichen umfassen darf. Zusätzlich wird in der Beschreibung der anzuzeigende Text zu dem sonstigen Termin definiert.

Jeder sonstige Termin enthält die Information, ob er zeitplanungsrelevant oder nicht zeitplanungsrelevant ist. Bei Relevanz für die Zeitplanung ist ebenfalls anzugeben ob Monitoring- und/oder Prognoserelevanz gewünscht ist. Zusätzlich ist die vorgesehene Wirkung in der Modellberechnung anzugeben. Dies erfolgt über die Verzögerung, Dauer und das Setzen auf Aktiv. Die möglichen Verzögerungsgründe werden hier nicht angegeben, sondern sind je nach V-Typ fest vorgegeben.

Für nicht zeitplanungsrelevante sonstige Termine ist nur anzugeben, welcher Datumstyp gewünscht ist. Dieser kann ein einzelner Tag (Angabe zeitpunkt), Zeitraum (Angabe zeitraum) oder flexibel (Angabe zeitpunkt_oder_zeitraum) sein.

Sonstige Termine können außerdem über eine oder mehrere Angaben einer "eigenschaft" verfügen. Es stehen unterschiedliche Datentypen zur Verfügung (siehe Tabelle), mit denen weitere Informationen zu einem Termin angegeben werden können.
{| class="wikitable"
!Name
!Zweck
|-
|beschreibung
|Anzuzeigende Beschreibung des sonstigen Termins.
|-
|zeitplanungsrelevant oder nichtzeitplanungsrelevant
|Legt Zeitplanungsrelevanz fest.
|-
|monitoringrelevant
|Legt Monitoringrelevanz fest. Angabe "ja" oder "nein".
|-
|prognoserelevant
|Legt Prognoserelevanz fest. Angabe "ja" oder "nein".
|-
|modellberechnung
|Enthält Informationen zur Berechnung in der Zeitplanung.
|-
|verzoegerung
|Bestimmt die Verzögerung. Angabe als ganze Zahl.
|-
|dauer
|Bestimmt die Dauer. Angabe als ganze Zahl.
|-
|aktiv
|(De-)aktiviert den Einfluss auf die Modellberechnung. Angabe "ja" oder "nein".
|-
|datumstyp
|Beschreibt für nicht zeitplanungsrelevante Termine die Art der Datumsangabe. Angabe "zeitpunkt", "zeitraum" oder "zeitpunkt_oder_zeitraum".
|-
|eigenschaft
|Beschreibt zusätzliche Informationen zu dem Termin. Umfasst "name", "typ" und optional "codelistName".
|-
|name
|Benennt die "eigenschaft" des Termins. Angabe als String.
|-
|typ
|Beschreibt das Datenformat der "eigenschaft" des Termins. Optionen: "TEXT", "FLOAT", "INTEGER", "BOOLEAN", "DATE", "URL", "CODELIST"
|-
|codelistName
|Benennt die zu referenzierende Codeliste, wenn der "typ" der "eigenschaft" "CODELIST" ist.
|}

==== Unterverfahrensteilschritt ====
[[Datei:ImageVKUVTS.png|links|436x436px|alternativtext=|rahmenlos]]
Unterverfahrensteilschritte bilden die dritte Ebene in der Strukturierung des Verfahrensablaufs. Sie werden durch die Angabe des Codes aus Code.Unterverfahrensteilschritte bestimmt. Die Angabe bei "pflicht" legt fest, ob der Unterverfahrensteilschritt immer aktiviert sein soll (Angabe "ja"), oder ob er optional und manuell aktivierbar sein soll (Angabe "nein"). Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen. Aktuell werden Durchgänge auf Ebene der Unterverfahrensteilschritte durch das Cockpit nicht unterstützt, sodass die Angabe von "ja" keinen Effekt hat. Optional kann eine Bedingung angegeben werden, wann der UVTS angezeigt werden soll.

In jedem Unterverfahrensteilschritt können 0 bis beliebig viele Aufgaben enthalten sein. Unterverfahrensteilschritte werden auch dann dargestellt, wenn sie keine Aufgaben enthalten.
{| class="wikitable"
!Name
!Zweck
|-
|pflicht
|Legt fest, ob der Unterverfahrensteilschritt verpflichten oder optional ist. Angabe "ja" oder "nein".
|-
|bedingung
|Bedingung in Platzhalter-Syntax, wann der UVTS angezeigt werden soll.
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein". Im Cockpit werden Durchgänge für Unterverfahrensteilschritte nicht unterstützt.
|-
|aufgabe
|Angabe einer untergeordneten Aufgabe.
|}

==== Aufgabe ====
[[Datei:ImageVKAufgabe.png|zentriert|719x719px|alternativtext=|rahmenlos]]
Aufgaben sind in Unterverfahrensteilschritten enthalten. Pro Unterverfahrensteilschritt sind 0 bis beliebig viele Aufgaben möglich.

Jede Aufgabe benötigt eine eindeutige ID zur Identifikation und eine Beschreibung, die im Cockpit angezeigt wird. Optional kann eine Bedingung angegeben werden, wann die Aufgabe angezeigt werden soll. Im dargestellten Beispiel wird die Aufgabe nur angezeigt, wenn der sonstige Termin "InfoFoeb_Zeitraum" als Eigenschaft den Code 0200 erhalten hat.
{| class="wikitable"
!Name
!Zweck
|-
|id
|Eindeutige ID der Aufgabe.
|-
|bedingung
|Bedingung in Platzhalter-Syntax, wann die Aufgabe angezeigt werden soll.
|-
|beschreibung
|Anzuzeigende Beschreibung der Aufgabe.
|-
|unteraufgabe
|Unteraufgabe der Aufgabe, enthält die ActionItems.
|}
Es können auch Werte von ActionItems in Bedinungen genutzt werden. Dabei sind jedoch nur ActionItems möglich, die im selben Verfahrensteilschritt definiert sind, in dem auch die Aufgabe/Unteraufgabe mit der Bedingung enthalten ist. Zudem muss das ActionItem in der Verfahrenskonfiguration eine refID definiert haben, welche dann genutzt wird um das ActionItem in der Bedingung zu referenzieren.

Beispiele:
{| class="wikitable"
!Beispiel
!Erklärung
|-
|<code>actionItem('ref-checkbox').checked=true</code>
|Das ActionItem vom Typ Checkbox mit der refID <code>ref-checkbox</code> muss angehakt sein, damit die Bedingung zutrifft.
|-
|<code>actionItem('ref-string').value!=someValue</code>
|Das ActionItem vom Typ Text mit der refID <code>ref-string</code> darf nicht den Wert <code>someValue</code> haben, damit die Bedingung zutrifft.
|-
|<code>actionItem('ref-dropdown').valueSelected=someValue</code>
|Das ActionItem vom Typ Dropdown mit der refID <code>ref-dropdown</code> muss den Wert <code>someValue</code> ausgewählt haben, damit die Bedingung zutrifft.
|}

==== Unteraufgabe ====
[[Datei:ImageVKUnteraufgabe.png|zentriert|531x531px|alternativtext=|rahmenlos]]
Unteraufgaben sind in beliebiger Anzahl in Aufgaben enthalten und umfassen beliebig viele ActionItems. ActionItems sind auf einer eigenen Unterseite beschrieben. Um ein ActionItem einer Aufgabe hinzuzufügen, muss eine Unteraufgabe vorhanden und das ActionItem darin ergänzt werden. Direkt in eine Aufgabe ohne Unteraufgabe ActionItems hinzuzufügen ist nicht möglich.

Analog zu Aufgaben benötigt je Unteraufgabe eine eindeutige ID zur Identifikation und eine Beschreibung, die im Cockpit angezeigt wird. Optional kann auch für Unteraufgaben eine Bedingung angegeben werden, wann sie angezeigt werden soll. Im dargestellten Beispiel wird die Unteraufgabe nur angezeigt, wenn der Hauptbezirk Harburg ist.
{| class="wikitable"
!Name
!Zweck
|-
|id
|Eindeutige ID der Aufgabe.
|-
|bedingung
|Bedingung in Platzhalter-Syntax ob die Unteraufgabe angezeigt werden soll.
|-
|beschreibung
|Anzuzeigende Beschreibung der Aufgabe.
|-
|Auflistung der ActionItems
|Liste der ActionItems.
|}

Platzhalter und Platzhalterprüfung DiPlanCockpit Pro

2026-03-30T09:01:13Z

Diplanung: /* Platzhalter */

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

== Platzhalter ==
Bei der Erstellung von Mustervorlagen kann auf Platzhalter zurückgegriffen werden. Bei diesen Platzhaltern handelt es sich u.a. um Stammdaten oder hinterlegte Textbausteine zum Rechtsbezug (letztere werden im Reiter "Rechtszitate" gepflegt). Sie greifen auf Informationen aus dem System zurück, sodass im Verfahren geführte Daten automatisch in die Mustervorlage übernommen werden.[[Datei:ImagePlatzhalter.png|zentriert|mini|437x437px|Beispiel für ein Set an Platzhaltern in einer Mustervorlage]]

== Platzhaltersyntax ==
Für alle Platzhalter gilt, dass sie in eckigen Klammern angegeben werden, z.B. [verfahrensart]. Alles, was in eckigen Klammern steht, wird als Platzhalter interpretiert. Deswegen dürfen in Musterdokumenten, außer für Platzhalter, keine eckigen Klammern verwendet werden.

Zu beachten ist, dass der Platzhalter in den eckigen Klammern exakt so geschrieben ist, wie er im System vorliegt. Wenn beispielsweise automatische Silbentrennung im Dokument aus [planname] wegen eines Zeilenumbruchs [plan-name] macht, kommt es zu einem Fehler.

Neben der direkten Ausgabe des Werts eines Platzhalters kann dieser auch in einer Formel eingesetzt werden. So gibt z.B. [flaeche!=null? Flaeche + ' ha': <nowiki>''</nowiki> ] nur dann die Fläche aus, wenn diese nicht "null" ist.

== Verfügbare Platzhalter ==

=== Verfahrensdaten und Termine ===
Eine Übersicht mit vielen der verfügbaren Platzhalter findet sich für jede Umgebung unter /api/cockpit/platzhalter (ans Ende der URL der Umgebung gestellt). Zusätzlich lassen sich Sitzungen und Termine als Platzhalter einsetzen. Die Syntax kann der zuvor genannten Platzhalterübersicht entnommen werden und die Bezeichnung des Termins erfolgt über den Code aus der Codeliste. Einige Platzhalter, wie z.B. getDate werden für einen Termin nur dann ausgefüllt, wenn der Termin den Status stattgefunden hat.

=== Keycloak ===
Aus per Keycloak verfügbaren Informationen leiten sich weitere Platzhalter ab. Diese sind:

* DienststelleStrasseHausnummer
* DienststellePostleitzahlOrt
* SachbearbeitungEmailAdresse
* SachbearbeitungVornameName
* DienststelleName

=== Kontakte ===
Einträge der kontakte.xml können ebenfalls für Platzhalter verwendet werden. Dafür dient die Funktion "getKontaktInfo". Um beispielsweise aus der kontakte.xml den Ort im Eintrag mit der ID "berlin-west" in einem Platzhalter zu verwenden, ist folgende Angabe in der Mustervorlage notwendig: [#getKontaktInfo('berlin-west', 'ort')].

=== Mandanten spezifische Stammdaten ===
Mandanten spezifische Stammdaten sind weitere mögliche Platzhalter in Dokumenten. Hierfür ist ihr Name in eckigen Klammern anzugeben. Ist beispielsweise in der Verfahrenskonfiguration folgendes Feld konfiguriert: <code><eigenschaft label="Beispiel eines Mandanten spezifischen Feldes zur Eingabe von Text" name="Beispiel6200Text" typ="TEXT" subtyp="SINGLE" pflicht="nein"/></code>, so lautet der zugehörige Platzhalter [Beispiel6200Text].

=== Rechtszitate ===
Im Reiter Rechtszitate können ebensolche Informationen hinterlegt und anschließend per Platzhalter abgerufen werden.

Eine Übersicht mit vielen der verfügbaren Platzhalter findet sich für jede Umgebung unter /api/cockpit/platzhalter (ans Ende der URL der Umgebung gestellt). Zusätzlich lassen sich Sitzungen und Termine als Platzhalter einsetzen. Die Syntax kann der zuvor genannten Platzhalterübersicht entnommen werden und die Bezeichnung des Termins erfolgt über den Code aus der Codeliste. Einige Platzhalter, wie z.B. getDate werden für einen Termin nur dann ausgefüllt, wenn der Termin den Status stattgefunden hat.

Neben der direkten Ausgabe des Werts eines Platzhalters kann dieser auch in einer Formel eingesetzt werden. So gibt z.B. [flaeche!=null? Flaeche + ' ha': <nowiki>''</nowiki> ] nur dann die Fläche aus, wenn diese nicht "null" ist.

Einträge der kontakte.xml können ebenfalls für Platzhalter verwendet werden. Dafür dient die Funktion "getKontaktInfo". Um beispielsweise aus der kontakte.xml den Ort im Eintrag mit der ID "berlin-west" in einem Platzhalter zu verwenden, ist folgende Angabe in der Mustervorlage notwendig: [#getKontaktInfo('berlin-west', 'ort')].

Mandanten spezifische Stammdaten sind weitere mögliche Platzhalter in Dokumenten. Hierfür ist ihr Name in eckigen Klammern anzugeben. Ist beispielsweise in der Verfahrenskonfiguration folgendes Feld konfiguriert: <code><eigenschaft label="Beispiel eines Mandanten spezifischen Feldes zur Eingabe von Text" name="Beispiel6200Text" typ="TEXT" subtyp="SINGLE" pflicht="nein"/></code>, so lautet der zugehörige Platzhalter [Beispiel6200Text].

== Platzhalterprüfung ==
Mit der Funktion "Platzhalterprüfung" wird geprüft, ob Platzhalter vorhanden sind und ob diese korrekt geschrieben wurden.

Die Platzhalterprüfung kann bei der Erstellung, dem Ersetzen oder bei bereits vorhandenen [[Mustervorlagen DiPlanCockpit Pro|Mustervorlagen]] genutzt werden.

Damit eine Platzhalterprüfung beim Erstellen und Ersetzen ausgeführt wird, muss das entsprechende Häkchen bei "Platzhaltersyntax validieren" aktiviert werden. Bei vorhandenen Mustervorlagen wird dies über das Drei-Punkte-Menü und "validieren" angestoßen.

Bei der Prüfung kann es zwei Ergebnisse geben:

# Die Prüfung ist valide. Es wird ein Hinweisfeld angezeigt, dass die Prüfung erfolgreich war.
# Die Prüfung ist invalide. Es wird ein Modal dargestellt, welches Informationen zu der Anzahl an fehlerhaften Platzhaltern darstellt. Es werden alle Platzhalter aufgelistet, welche invalide sind. Das Dokument kann dann geöffnet und die Platzhalter angepasst werden. Die Ergebnisse des Modals werden nicht als Datei zur Verfügung gestellt. Entweder kann ein Screenshot gemacht werden, oder die Datei, die als Basis für die Mustervorlage dient, wird direkt geöffnet und die fehlerhaften Platzhalter behoben. Per Button "Schließen" wird das Modal geschlossen und die Mustervorlage wird nicht erstellt. Wenn der Button "zurück" angeklickt wird, kann die Platzhalterprüfung ausgeschaltet werden. Das Dokument enthält dann evtl. Fehler, es kann trotzdem angelegt werden.

== Beispiel ==
Die von oben gezeigte Beispieldatei wurde innerhalb eines Verfahrens (Planname = "Review 22.05.2024") genutzt. Die manuell nachträglich hinzugefügten farbigen Markierungen zeigen, welche Platzhalter aufgelöst (schwarz), nicht aufgelöst (gelb) oder nicht vorhanden (rot) sind.
[[Datei:ImagePlatzhalterBeispielMarkiert.png|zentriert|mini|699x699px]]

* Aufgelöste Platzhalter: sind durch Werte aus dem Planverfahren ersetzt. Das können Werte aus Feldern der Stammdatenseite, Datumswerte aus Zeitplanung/Aufgaben o.ä. sein.
* Nicht aufgelöste Platzhalter: entsprechendes Feld wurde im Planverfahren (noch) nicht befüllt/aktiviert
* Nicht vorhandene Platzhalter: Platzhalter existiert nicht

Die zuvor erläuterte Platzhalterprüfung hilft dabei, nicht vorhandene, oder falsch geschriebene Platzhalter zu identifizieren. Die Datei und die gezeigten Informationen aus der Platzhalterprüfung müssen manuell abgeglichen werden. Fehler in der dotx.-Datei werden nicht wie hier im Beispiel farbig markiert.

== Platzhalter in XML-Templates ==
Platzhalter, die auf XML-Templates verwendet werden, werden automatisch vom System escaped. D.h. die folgenden Sonderzeichen werden wie folgt ersetzt:
" &quot;
' &apos;
< &lt;
> &gt;
& &amp;

Verfahren hinzufügen (XPlanverfahren)

2026-03-24T14:06:23Z

Diplanung: /* Mandaten spezifische Stammdaten */

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

Die Funktion "Verfahren hinzufügen (XPlanverfahren)" ermöglicht den Import von Verfahren, welche im XML-Format und nach dem XöV Standard XPlanverfahren bereitgestellt werden. Diese Funktion ist im Reiter "Konfiguration" des Admin-Bereichs zu finden.

Für den Import sind XML-Dateien der Verfahren nach dem Standard XPlanverfahren zu erstellen. Die Angaben zu einem Verfahren können sehr detailliert sein und beispielsweise Dokumente umfassen. Verpflichtend sind hingegen nur einige der möglichen Angaben. Sie sind im Abschnitt mit der Beschreibung der einzelnen Abschnitte einer Importdatei durch einen Stern (*) gekennzeichnet. In einer minimalen Importdatei müssen mindestens diese Informationen enthalten sein.

Der Import kann ein einzelnes oder auch mehrere Verfahren umfassen. Die Größe des Imports hat Einfluss auf die Dauer des Import-Vorgangs. Während des Imports wird das System stark ausgelastet und ist unter Umständen eingeschränkt verfügbar. Es wird deswegen empfohlen größere Importe idealerweise in Randzeiten anzustoßen.

In jeder Datei können mehrere Verfahren angegeben sein, sodass sie gleichzeitig importiert werden können. Aus technischen Gründen ist jedoch die Anzahl der simultan importierbaren Verfahren in einem XPlanverfahren Importdokument limitiert.

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).

Das Importdokument durchläuft eine mehrstufige Validierung:
#XöV Schemavalidierung (z.B. Prüfung der korrekten Datentypen und von Pflichtfeldern)
#Referenzierte Codelistenwerte im Importdokument werden gegen die im Cockpit hinterlegten Codelisten abgeglichen
#Plannamen werden auf Eindeutigkeit innerhalb des Mandanten geprüft
#Weitere fachliche Validierungen wie Prüfung bestimmter Felder in Abhängigkeit von anderen Feldern, [https://wiki.diplanung.de/index.php%3Ftitle=Editieren_der_Stammdaten_-_DiPlanCockpit_Pro Prüfung von Datumsangaben in Abhängigkeit von der Fachdomäne und des Verfahrensstandes]
Kommt es bei der Validierung zu Fehlern, so 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.

Der '''Import von Verfahren zur Raumordnung / Raumordnungsplan-Verfahren''' ins DiPlanCockpit ist nicht vorgesehen. Stattdessen sind die (wenigen) Bestandsdaten manuell im DiPlanCockpit anzulegen.
= Wichtige Voraussetzungen=
Jedes Verfahren referenziert auf eine Verfahrenskonfiguration (VK) und die dazugehörigen Codelisten - sowohl feste als auch (vom Mandanten) änderbare Codelisten. Um Fehler zu vermeiden, muss sichergestellt werden, dass das zu importierende Verfahren mit der VK und änderbaren Codelisten stets auf dem gleichen Stand ist und dieses spezifische Set an VK + Codelisten im Cockpit verfügbar sind. Weitere Details dazu sowie zur Anpassung einer VK finden sich in der Dokumentation zur [https://wiki.diplanung.de/index.php%3Ftitle=Verfahrenskonfiguration_Pro Verfahrenskonfiguration].

Je Verfahrenssteuerungstyp sollte eine eigene VK vorliegen, um künftige Auswertungen bedienen zu können. Ebenso sollte je XPlan Fachmodell (BP, FB; LP, RP etc.) eine eigene VK vorliegen.

Es können sowohl beschlossene als auch laufende Verfahren importiert werden. Für den Import beschlossener Verfahren kann eine Basis VK (ohne VTS, UVTS, Aufgaben) ausreichend sein. Doch auch hier sollte nach Verfahrenssteuerungstyp differenziert werden. Für laufende Verfahren sind i.d.R. vollständige VKs notwendig. Zu beachten ist, dass allgemein der Status von Aufgaben nicht übernommen wird, sodass jedes Verfahren nachgepflegt werden muss.
=Verfahren importieren=
Um ein oder mehrere Planverfahren zu importieren, benötigen Sie ein lokal abgelegtes valides XPlanverfahren Importdokument. Dieses können Sie über die entsprechende Schaltfläche "Verfahren hinzufügen (XPlanverfahren)" hochladen und so den Importprozess starten.

Klicken Sie auf das Lupen-Symbol, um das lokale XPlanverfahren Importdokument auszuwählen. Die Dateiendung muss dem XML-Format entsprechen.

Nach Auswahl und Bestätigung des Dateinamen starten Sie den Importprozess durch Klick auf Hochladen.

Ob der Import erfolgreich war, lässt sich dem allgemeinen Protokoll entnehmen. Erfolgreiche Imports werden dort festgehalten. Ob ein bestimmtes Verfahren aus einem Import stammt, sieht man wiederum im Verfahrensprotokoll.
==Prüfung der Eingabedaten==
Während des Importprozesses wird die Überprüfung der Eingabedaten vorgenommen. Neben einer allgemeinen XML-Schemaprüfung werden im Importdokument referenzierte Codelistenwerte gegen aktuell in im Cockpit hinterlegte Codelisten abgeglichen. Zusätzlich werden Plannamen auf Eindeutigkeit und die Existenz von Pflichtattributen geprüft.

Falls während des Imports ein ein Fehler identifiziert wird, dann wird der Importvorgang abgebrochen und es wird eine Fehlermeldung erzeugt. 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===
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. Die Inhalte können sich zwischen Versionen semantisch und syntaktisch ändern bzw. es können neue Inhalte hinzugefügt oder alte Inhalte entfernt werden. XPlanverfahren ist im XRepository zudem 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 (bitte zur Validierung nur die Version aus dem Cockpit verwenden) und die Spezifikation mit allen Inhalten als PDF-Datei.

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.
= Aufbau eines Verfahrens für den Import=
Die Inhalte eines Imports sind in XPlanverfahren beschrieben und im [https://www.xrepository.de/details/urn:xoev-de:xleitstelle:standard:xplanverfahren XRepository] veröffentlicht. Im Folgenden finden Sie über den Standard hinausgehende Beschreibungen und Hinweise anhand eines beispielhaften Verfahrens im XML-Format.

Die folgenden Screenshots zeigen exemplarisch ein Verfahren, das ins Cockpit importiert werden kann. Die Zahlen am linken Rand der Screenshots zeigen die Zeilennummern der XML-Datei. Insgesamt sind es im Beispiel 284. Um eine kompakte Darstellung zu ermöglichen, sind die Bereiche, die für die jeweilige Erläuterung irrelevant sind, eingeklappt. Das ist an den kleinen blauen Pfeilen rechts von den Zeilennummern zu erkennen. Ein Pfeil nach unten bedeutet, dass der Abschnitt aufgeklappt ist. Ein Pfeil nach rechts hingegen heißt, dass an dieser Stelle noch weitere Zeilen sind, die lediglich nicht angezeigt werden. Die Anzahl der ausgeblendeten Zeilen ist in Klammern angegeben. Die Form der Darstellung ist dem verwendeten Programm geschuldet. Bei der Verwendung anderer Programme kann die visuelle Darstellung der XML abweichen.
==Struktur des Verfahrens==
[[Datei:ImageStrukturVerfahren.png|zentriert|alternativtext=|rahmenlos|916x916px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageStrukturVerfahren.png]]Dieser Screenshot gibt einen Überblick über die Informationen, die zu einem Verfahren angegeben werden können. Die Reihenfolge der Angaben ist nicht beliebig, sondern muss den Vorgaben aus XPlanverfahren entsprechen. Termine werden nur mit DiPlanCockpit Pro dargestellt.

Die oberste Ebene der XML-Datei mit "planung2Empfaenger.UebersichtVerfahren.0811" ist technisch erforderlich und enthält in Form von URLs beispielsweise Informationen zu den verwendeten namespaces.

Darin folgt der eigentliche "nachrichteninhalt" mit der "verfahrensuebersicht" und darin der "verfahrensbeschreibung" eines konkreten Verfahrens. Sollen mehrere Verfahren in einer XML importiert werden, so muss für jedes Verfahren ein eigener Abschnitt "verfahrensuebersicht" mit der "verfahrensbeschreibung" enthalten sein.
==Beschreibung der einzelnen Abschnitte ==
Im Folgenden werden die einzelnen Unterkapitel anhand von Beispielen aus der XML erläutert. Für alle Unterkapitel gilt:
*Die "listURI" gibt die konkrete Codeliste an und die "listVersionID" die zu verwendende Version der Codeliste.
*Screenshots aus dem DiPlanCockpit zeigen einzelne Elemente des importierten Verfahrens, dazu gehören z.B. Verträge im Reiter Dokumente. Wenn kein Screenshot des DiPlanCockpit für ein Unterkapitel eingefügt ist, finden sich die dargestellten Informationen allgemein auf der Stammdatenseite im DiPlanCockpit wieder.
*Ein Stern (*) vor der Überschrift des Unterkapitels markiert die verpflichtenden Inhalte für den Import.
===*Verfahrensverweis===
[[Datei:ImageVerfahrensverweis.png|zentriert|rahmenlos|705x705px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageVerfahrensverweis.png]]Der "verfahrensverweis" ist verpflichtend und enthält die im oberen Screenshot dargestellten grundlegenden Informationen eines Verfahrens, wie die obligatorische Angabe der "verfahrenssteuerung". Der Arbeitstitel ist bei simulierten Verfahren verpflichtend. Bei nicht simulierten Verfahren ist der Planname verpflichtend.

Aufgaben sind in der Verfahrenskonfiguration aufgeführt und ergeben sich für ein Verfahren über den Code für die Verfahrenssteuerung. Der Status von Aufgaben (erledigt/nicht erledigt) kann nicht importiert werden und muss im Cockpit händisch nach Öffnen des Verfahrens angepasst werden. Es ist jedoch möglich für einzelne Action Items Inhalte bzw. Ergebnisse anzugeben, bspw. eine Checkbox anzuhaken oder den Wert in einem Textfeld. Eine genauere Erläuterung befindet sich im Abschnitt [https://wiki.diplanung.de/index.php%3Ftitle=Verfahren_hinzuf%C3%BCgen_(XPlanverfahren)_DiPlanCockpit_Pro zum Import von Action Items].
===*Verfahrensstand ===
[[Datei:ImageVerfahrensstand.png|zentriert|rahmenlos|702x702px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageVerfahrensstand.png]]Der "verfahrensstand" ist verpflichtend anzugeben. Er beschreibt den aktuellen Stand des Verfahrens als Wert aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensstand Codeliste] und muss zum Planstatus passen. So muss beispielsweise für ein simuliertes Verfahren Verfahrensstand 1000 und der Planstatus 0300 sein. Außerdem gibt es Abhängigkeiten zwischen dem Verfahrensstand und Datumsangaben, siehe Tabelle unter [https://wiki.diplanung.de/index.php%3Ftitle=Verfahren_hinzuf%C3%BCgen_(XPlanverfahren)_DiPlanCockpit_Pro#Satzung_Beschluss https://wiki.diplanung.de/index.php?title=Verfahren_hinzufügen_(XPlanverfahren)_DiPlanCockpit_Pro#Satzung_Beschluss].
===*Beschreibungen und Schlagworte===
[[Datei:ImageBeschreibungSchlagworte.png|zentriert|rahmenlos|698x698px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageBeschreibungSchlagworte.png]]Für "beschreibungPlanungsanlass" und "beschreibungGeltungsbereich" werden verpflichtend textliche Beschreibungen festgehalten werden und optional relevante Schlagworte jeweils einzeln als "schlagwort".
===*Planart und Planstatus===
[[Datei:ImagePlanartPlanstatus.png|zentriert|rahmenlos|701x701px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImagePlanartPlanstatus.png]]Sowohl die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planart planart]" als auch der "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planstatus planstatus]" werden über einen Code aus der jeweiligen Codeliste verpflichtend angegeben. Der Planstatus muss zum Verfahrensstand passen. Für ein simuliertes Verfahren muss der Verfahrensstand 1000 und der Planstatus 0300 sein.
===Relation zum Planrecht===
[[Datei:ImageRelationPlanrecht.png|zentriert|rahmenlos|697x697px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageRelationPlanrecht.png]]Für die optionale Darstellung der [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:relationplanrecht Relation] des Verfahrens zum Planrecht werden die "planID" (optional) sowie der "typ" (verpflichtend) der Relation angegeben.
===Ausgleichsflächen ===
[[Datei:ImageAusgleichsflaechen.png|zentriert|rahmenlos|696x696px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageAusgleichsflaechen.png]]Die Angabe zu "ausgleichsflaechen" ist optional und erfolgt über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:ausgleichsflaechen Codeliste].
===Kontakte===
[[Datei:ImageKontakte.png|zentriert|rahmenlos|700x700px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageKontakte.png]]Informationen zu Kontakten sind optional und werden für jeden "kontakt" einzeln angegeben. Es müssen nicht alle dargestellten Informationen enthalten sein, so können beispielsweise die Angaben zur "person" entfallen. Die Angabe der "artDesKontaktes" ist erforderlich und erfolgt über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:artdeskontaktes Codeliste].
===*Zuständigkeit und Gebietseinheit===
[[Datei:ImageZustaendigkeitGebietseinheit.png|zentriert|rahmenlos|708x708px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageZustaendigkeitGebietseinheit.png]]Sowohl die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:zustaendigkeit zustaendigkeit]" als auch die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:gebietseinheit gebietseinheit]" sind verpflichtend und werden über einen Code aus der jeweiligen Codeliste angegeben. Beide Codelisten sind im Cockpit über den Administrationsbereich anpassbar. Es können mehrere Gebietseinheiten angegeben werden.
===*Geobezug (Planwerkreferenz)===
[[Datei:ImageGeobezug.png|zentriert|rahmenlos|700x700px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageGeobezug.png]]In Abhängigkeit des Verfahrensstandes kann bereits ein XPlanGML vorliegen, dies ist optional. Evtl. liegt 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 kann entweder als Geobezug ein "xPlan" (im Beispiel auskommentiert (grüne Schrift)) oder eine "flaechenabgrenzung" angegeben werden. 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: 25832
*EPSG: 25833
*EPSG: 325833
*EPSG: 31466
*EPSG: 31467
*EPSG: 31468
*EPSG: 31469
*EPSG: 4258
*EPSG: 4326
*EPSG: 4839
*CRS: 84
Der Geltungsbereich (flaechenabgrenzung) wird als GeoJson in EPSG:4326 erwartet. Die Koordinaten aller Geometrien eines Planwerks müssen innerhalb des Geltungsbereichs des Koordinatenreferenzsystems (KRS) liegen. Bei der Validierung wird nur gegen das im XPlanGML gesetzte KRS geprüft.

Ist das Ziel ein XPlanGML in das DiPlanCockpit zu importieren, so kann in "xPlan" eine xPlanURL angegeben werden. Die Anwendung unterstützt sowohl Netzwerk- als auch Downloadressourcen. Die Ressource muss von der Anwendung frei erreichbar sein, insbesondere ohne vorgeschaltete Authentifizierung.

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 auch Netzwerkressourcen auf IONOS verwendet werden. Dabei werden die Schemas http://, https://, s3:// sowie file:// unterstützt. Der Dateiname wird hinter dem "/" der URL erwartet. Der Support unterstützt gerne bei den Zugangsdaten.

Durch das Setzen eines optionalen "veroeffentlichungsdatum" ist zusätzlich zum Import ins DiPlanCockpit die Veröffentlichung des XPlanGML als Dienst im Internet möglich. 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. den Plannamenabgleich.

Voraussetzung für die automatische Veröffentlichung des Planwerks in der XPlanBox mit dem Import ist, dass das Verfahren aktiv ist und das Veröffentlichungsdatum nicht gesetzt ist oder in der Zukunft liegt.
===Fläche und geplante Wohneinheiten===
[[Datei:ImageFlaecheGeplanteWohneinheiten.png|zentriert|rahmenlos|617x617px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageFlaecheGeplanteWohneinheiten.png]]Die "flaeche" und die Anzahl für "geplanteWohneinheiten" werden optional direkt als Zahl eingetragen.
===Geförderter Wohnungsbau===
[[Datei:ImageGefoerderterWohnungsbau.png|zentriert|rahmenlos|646x646px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageGefoerderterWohnungsbau.png]]Der Abschnitt "gefoerderterWohnungsbau" ist optional und es können optional die "prozent", die "geplanteWohneinheiten" und der "foerderweg" angegeben werden.
===Zusätzliche Gewerbeflächen===
[[Datei:ImageZusaetzlicheGewerbeflaechen.png|zentriert|rahmenlos|656x656px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageZusaetzlicheGewerbeflaechen.png]]Für "zusaetzlicheGewerbeflaechen" wird optional direkt deren Anzahl angegeben.
===Vorgesehene Nutzungen===
[[Datei:ImageVorgeseheneNutzungen.png|zentriert|rahmenlos|638x638px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageVorgeseheneNutzungen.png]]Die Angabe für "vorgeseheneNutzungen" erfolgt optional über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:artdernutzung Codeliste].
===Zurückstellung===
[[Datei:ImageZurueckstellung.png|zentriert|rahmenlos|645x645px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageZurueckstellung.png]]Im Falle einer "zurueckstellung" (optional) sind verpflichtend der "identifikator", das Datum des Bescheids als "bescheidVon", die Dauer der "rueckstellungBis" sowie die "belegenheit" anzugeben.
===Veränderungssperre===
[[Datei:ImageVeraenderungssperre.png|zentriert|rahmenlos|637x637px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageVeraenderungssperre.png]]Für eine "veraenderungssperre" (optional) sind verpflichtend der "geltungsbereich", der "zeitraum" und das "beschlussdatum" anzugeben. Optional können bis zu zwei "verlaengerung" angegeben werden, ebenfalls mit "geltungsbereich", "zeitraum" und "beschlussdatum" (nicht dargestellt im Beispiel).
===Zugeordnete Nutzer===
[[Datei:ImageZugeordneteNutzer.png|zentriert|rahmenlos|632x632px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageZugeordneteNutzer.png]]Alle "zugeordneteNutzer" sind optional und werden einzeln angegeben, wobei der erste Eintrag als Besitzer gewertet wird. Die Angabe der "rolle" per [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:rolle Code] ist optional, die "nutzerID" erforderlich.
===Planreife nach § 33 BauGB===
[[Datei:ImagePlanreife33BauGB.png|zentriert|rahmenlos|617x617px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImagePlanreife33BauGB.png]]Bezüglich der Planreife nach § 33 BauGB kann optional angegeben werden, ob "planreifeNachPara33" gilt und wenn ja, seit wann.
===Vertrag===
[[Datei:ImageVertrag.png|zentriert|rahmenlos|610x610px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageVertrag.png]]Verträge werden optional und dann jeweils einzeln als "vertrag" aufgeführt, optional mit einem oder mehreren "ergaenzungstext". Verpflichtend sind die Angabe der "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:vertragsart vertragsart]", des "vertragstext" und des "filename".

Der Vertragstext wird direkt in der XML als Bytearray im Format base64Binary angegeben. Beispielsweise PDF lassen sich in dieses Format konvertieren. Es handelt sich dabei um eine sehr lange Zeichenfolge, aus Platzgründen ist im Screenshot keine dargestellt. Unter dem "filename" wird der "vertragstext" als Datei im Cockpit hinterlegt, automatisch wieder im ursprünglichen PDF-Format.

Für Ergänzungstexte können ebenfalls "vertragsabschluss", "unterzeichner", "abschlussdatum" und "inKraftGetretenAm" angegeben werden (nicht dargestellt im Beispiel).[[Datei:ImageVertragFE.png|zentriert|rahmenlos|623x623px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageVertragFE.png]]
===Mitwirkungsbereitschaft===
[[Datei:ImageMitwirkungsbereitschaft.png|zentriert|rahmenlos|625x625px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageMitwirkungsbereitschaft.png]]Wenn eine "mitwirkungsbereitschaft" (optional) besteht, kann optional deren "erklaerungsdatum" und ein "kommentar" angegeben werden. Die Angabe der "bereitschaft" ist verpflichtend.
===Internetseite===
[[Datei:ImageInternetseite.png|zentriert|rahmenlos|628x628px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageInternetseite.png]]Wenn eine "internetseite" des Verfahrens existiert, kann optional deren Adresse angegeben werden.
===Dokumente===
[[Datei:ImageDokumente.png|zentriert|rahmenlos|625x625px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageDokumente.png]]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 <code><xplan:link>s3://test-dokument-2.pdf</xplan:link></code>. 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 <code><xplan:link>s3://test dokument 2.pdf</xplan:link></code> sondern <code><xplan:link>s3://test%20dokument%202.pdf</xplan:link></code>.

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", "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensunterlagentyp dokumentart]" und "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:dokumentstatus 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.[[Datei:ImageDokumenteFE.png|zentriert|rahmenlos|605x605px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageDokumenteFE.png]]
===*Verfahrensart===
[[Datei:ImageVerfahrensart.png|zentriert|rahmenlos|630x630px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageVerfahrensart.png]]Die Angabe der "verfahrensart" ist verpflichtend und erfolgt über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensart Codeliste].
===Bodenordnung===
[[Datei:ImageBodenordnung.png|zentriert|rahmenlos|631x631px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageBodenordnung.png]]Optional können bezüglich der "bodenordnung" das "bodenordnungsgebiet" und beliebig viele "belegenheitBodenordnungsgebiet" angegeben werden.
===*Verfahrensschritt===
[[Datei:ImageVerfahrensschritt.png|zentriert|rahmenlos|630x630px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageVerfahrensschritt.png]]Die Angabe des aktuellen "verfahrensschritt" erfolgt verpflichtend über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensschritt Codeliste].
===Satzung Beschluss===
[[Datei:ImageSatzungBeschluss.png|zentriert|rahmenlos|655x655px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageSatzungBeschluss.png]]Optional können Informationen zur Feststellung in "satzungBeschluss" angegeben werden, mit einem optionalen "beschlussdatum" und "bekanntmachung". Wenn erforderlich kann zwischen dem "beschlussdatum" und der "bekanntmachung" optional auch die "aufhebung" angegeben werden. Dazu werden das "aufhebungsdatum" sowie der "aufhebungsgrund" angegeben (als Code) (nicht dargestellt im Beispiel).

Zu beachten ist bei Datumsangaben das Zusammenspiel mit dem Verfahrensstand. Es sind nur bestimmte Kombinationen zulässig. Folgende Tabelle zeigt die möglichen Kombinationen für die Fachdomäne der Bauleitplanung (die Fachdomäne wird in der [https://wiki.diplanung.de/index.php%3Ftitle=Verfahrenskonfiguration_Pro Verfahrenskonfiguration] angegeben):
{| class="wikitable"
!Code
!Verfahrensstand
!Datumsangaben
|-
|2000
|im Verfahren
|kein stattgefundenes Beschlussdatum UND kein stattgefundenes Bekanntmachungsdatum
|-
|3000
|beschlossen
|stattgefundenes Beschlussdatum UND kein stattgefundenes Bekanntmachungsdatum
|-
|3100
|inkraftgetreten
|stattgefundenes Beschlussdatum UND stattgefundenes Bekanntmachungsdatum
|-
|4000
|ganz aufgehoben
|stattgefundenes Beschlussdatum ODER stattgefundenes Bekanntmachungsdatum UND stattgefundenes Untergangsdatum (Aufhebungsdatum)
|-
|5000
|eingestellt
|kein stattgefundenes Beschlussdatum UND kein stattgefundenes Bekanntmachungsdatum
|-
|6000
|laufendes Normenkontrollverfahren
|stattgefundenes Beschlussdatum UND stattgefundenes Bekanntmachungsdatum
|}
==Weitere mögliche Inhalte==
Neben den im Beispielverfahren beschriebenen können je nach Bedarf weitere Informationen zu einem Verfahren angegeben werden.
===Parallelverfahren===
Wenn es "parallelverfahren" gibt, so können diese nach der "verfahrensbeschreibung" innerhalb der "Verfahrensuebersicht" eingefügt werden. Darin können die Informationen gemäß des "Verfahrensverweis" angegeben werden.
===Mandantenspezifische Erweiterungen===
Man kann im XPlanverfahren Standard eine Mandatenspezifische Erweiterung angeben, in der wir eine DiPlanung-Erweiterung unterstützen. '''Wichtig''': Mit 'Mandant' ist hier DiPlanCockpit gemeint. Es gibt keine Erweiterungen für einzelne Bundesländer.

Valide Erweiterungen sind im Schema diplanung-xplanverfahren-erweiterung.xsd definiert. Derzeit ist es mittels der Erweiterung möglich Werte für Action Items zu importieren. Dazu muss auch der verwendete Namespace in der XML definiert werden:[[Datei:ImageImportNamespace.png|zentriert|rahmenlos|583x583px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageImportNamespace.png]]
====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.
[[Datei:ImageMandantenSpezifischeStammdatenImport3.png|zentriert|mini|543x543px]]

Verfahren hinzufügen (XPlanverfahren) DiPlanCockpit Pro

2026-03-24T13:58:37Z

Diplanung: /* Mandaten spezifische Stammdaten */

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

Die Funktion "Verfahren hinzufügen (XPlanverfahren)" ermöglicht den Import von Verfahren, welche im XML-Format und nach dem XöV Standard XPlanverfahren bereitgestellt werden. Diese Funktion ist im Reiter "Konfiguration" des Admin-Bereichs zu finden.

Für den Import sind XML-Dateien der Verfahren nach dem Standard XPlanverfahren zu erstellen. Die Angaben zu einem Verfahren können sehr detailliert sein und beispielsweise Dokumente umfassen. Verpflichtend sind hingegen nur einige der möglichen Angaben. Sie sind im Abschnitt mit der Beschreibung der einzelnen Abschnitte einer Importdatei durch einen Stern (*) gekennzeichnet. In einer minimalen Importdatei müssen mindestens diese Informationen enthalten sein.

Der Import kann ein einzelnes oder auch mehrere Verfahren umfassen. Die Größe des Imports hat Einfluss auf die Dauer des Import-Vorgangs. Während des Imports wird das System stark ausgelastet und ist unter Umständen eingeschränkt verfügbar. Es wird deswegen empfohlen größere Importe idealerweise in Randzeiten anzustoßen.

In jeder Datei können mehrere Verfahren angegeben sein, sodass sie gleichzeitig importiert werden können. Aus technischen Gründen ist jedoch die Anzahl der simultan importierbaren Verfahren in einem XPlanverfahren Importdokument limitiert.

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).

Das Importdokument durchläuft eine mehrstufige Validierung:

# XöV Schemavalidierung (z.B. Prüfung der korrekten Datentypen und von Pflichtfeldern)
# Referenzierte Codelistenwerte im Importdokument werden gegen die im Cockpit hinterlegten Codelisten abgeglichen
# Plannamen werden auf Eindeutigkeit innerhalb des Mandanten geprüft
# Weitere fachliche Validierungen wie Prüfung bestimmter Felder in Abhängigkeit von anderen Feldern, [[Editieren der Stammdaten - DiPlanCockpit Pro|Prüfung von Datumsangaben in Abhängigkeit von der Fachdomäne und des Verfahrensstandes]]
# Referenzierte Codelistenwerte im Importdokument werden gegen die im Cockpit hinterlegte Verfahrenskonfiguration abgeglichen, welche im Importdokument referenziert wird.

Kommt es bei der Validierung zu Fehlern, so 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.

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

= Wichtige Voraussetzungen =
Jedes Verfahren referenziert auf eine Verfahrenskonfiguration (VK) und die dazugehörigen Codelisten - sowohl feste als auch (vom Mandanten) änderbare Codelisten. Um Fehler zu vermeiden, muss sichergestellt werden, dass das zu importierende Verfahren mit der VK und änderbaren Codelisten stets auf dem gleichen Stand ist und dieses spezifische Set an VK + Codelisten im Cockpit verfügbar sind. Weitere Details dazu sowie zur Anpassung einer VK finden sich in der Dokumentation zur [[Verfahrenskonfiguration Pro|Verfahrenskonfiguration]].

Je Verfahrenssteuerungstyp sollte eine eigene VK vorliegen, um künftige Auswertungen bedienen zu können. Ebenso sollte je XPlan Fachmodell (BP, FB; LP, RP etc.) eine eigene VK vorliegen.

Es können sowohl beschlossene als auch laufende Verfahren importiert werden. Für den Import beschlossener Verfahren kann eine Basis VK (ohne VTS, UVTS, Aufgaben) ausreichend sein. Doch auch hier sollte nach Verfahrenssteuerungstyp differenziert werden. Für laufende Verfahren sind i.d.R. vollständige VKs notwendig. Zu beachten ist, dass allgemein der Status von Aufgaben nicht übernommen wird, sodass jedes Verfahren nachgepflegt werden muss.

= Verfahren importieren =
Um ein oder mehrere Planverfahren zu importieren, benötigen Sie ein lokal abgelegtes valides XPlanverfahren Importdokument. Dieses können Sie über die entsprechende Schaltfläche "Verfahren hinzufügen (XPlanverfahren)" hochladen und so den Importprozess starten.

Klicken Sie auf das Lupen-Symbol, um das lokale XPlanverfahren Importdokument auszuwählen. Die Dateiendung muss dem XML-Format entsprechen.

Nach Auswahl und Bestätigung des Dateinamen starten Sie den Importprozess durch Klick auf Hochladen.

Ob der Import erfolgreich war, lässt sich dem allgemeinen Protokoll entnehmen. Erfolgreiche Imports werden dort festgehalten. Ob ein bestimmtes Verfahren aus einem Import stammt, sieht man wiederum im Verfahrensprotokoll.

== Prüfung der Eingabedaten ==
Während des Importprozesses wird die Überprüfung der Eingabedaten vorgenommen. Neben einer allgemeinen XML-Schemaprüfung werden im Importdokument referenzierte Codelistenwerte gegen aktuell in im Cockpit hinterlegte Codelisten abgeglichen. Zusätzlich werden Plannamen auf Eindeutigkeit und die Existenz von Pflichtattributen geprüft.

Falls während des Imports ein ein Fehler identifiziert wird, dann wird der Importvorgang abgebrochen und es wird eine Fehlermeldung erzeugt. 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 ===
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. Die Inhalte können sich zwischen Versionen semantisch und syntaktisch ändern bzw. es können neue Inhalte hinzugefügt oder alte Inhalte entfernt werden. XPlanverfahren ist im XRepository zudem 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 (bitte zur Validierung nur die Version aus dem Cockpit verwenden) und die Spezifikation mit allen Inhalten als PDF-Datei.

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.
= Aufbau eines Verfahrens für den Import =
Die Inhalte eines Imports sind in XPlanverfahren beschrieben und im [https://www.xrepository.de/details/urn:xoev-de:xleitstelle:standard:xplanverfahren XRepository] veröffentlicht. Im Folgenden finden Sie über den Standard hinausgehende Beschreibungen und Hinweise anhand eines beispielhaften Verfahrens im XML-Format.

Die folgenden Screenshots zeigen exemplarisch ein Verfahren, das ins Cockpit importiert werden kann. Die Zahlen am linken Rand der Screenshots zeigen die Zeilennummern der XML-Datei. Insgesamt sind es im Beispiel 284. Um eine kompakte Darstellung zu ermöglichen, sind die Bereiche, die für die jeweilige Erläuterung irrelevant sind, eingeklappt. Das ist an den kleinen blauen Pfeilen rechts von den Zeilennummern zu erkennen. Ein Pfeil nach unten bedeutet, dass der Abschnitt aufgeklappt ist. Ein Pfeil nach rechts hingegen heißt, dass an dieser Stelle noch weitere Zeilen sind, die lediglich nicht angezeigt werden. Die Anzahl der ausgeblendeten Zeilen ist in Klammern angegeben. Die Form der Darstellung ist dem verwendeten Programm geschuldet. Bei der Verwendung anderer Programme kann die visuelle Darstellung der XML abweichen.

== Struktur des Verfahrens ==
[[Datei:ImageStrukturVerfahren.png|zentriert|alternativtext=|rahmenlos|916x916px]]
Dieser Screenshot gibt einen Überblick über die Informationen, die zu einem Verfahren angegeben werden können. Die Reihenfolge der Angaben ist nicht beliebig, sondern muss den Vorgaben aus XPlanverfahren entsprechen.

Die oberste Ebene der XML-Datei mit "planung2Empfaenger.UebersichtVerfahren.0811" ist technisch erforderlich und enthält in Form von URLs beispielsweise Informationen zu den verwendeten namespaces.

Darin folgt der eigentliche "nachrichteninhalt" mit der "verfahrensuebersicht" und darin der "verfahrensbeschreibung" eines konkreten Verfahrens. Sollen mehrere Verfahren in einer XML importiert werden, so muss für jedes Verfahren ein eigener Abschnitt "verfahrensuebersicht" mit der "verfahrensbeschreibung" enthalten sein.

== Beschreibung der einzelnen Abschnitte ==
Im Folgenden werden die einzelnen Unterkapitel anhand von Beispielen aus der XML erläutert. Für alle Unterkapitel gilt:

* Die "listURI" gibt die konkrete Codeliste an und die "listVersionID" die zu verwendende Version der Codeliste.
* Screenshots aus dem DiPlanCockpit zeigen einzelne Elemente des importierten Verfahrens, dazu gehören z.B. Verträge im Reiter Dokumente. Wenn kein Screenshot des DiPlanCockpit für ein Unterkapitel eingefügt ist, finden sich die dargestellten Informationen allgemein auf der Stammdatenseite im DiPlanCockpit wieder.
* Ein Stern (*) vor der Überschrift des Unterkapitels markiert die verpflichtenden Inhalte für den Import.

=== *Verfahrensverweis ===
[[Datei:ImageVerfahrensverweis.png|zentriert|rahmenlos|705x705px]]
Der "verfahrensverweis" ist verpflichtend und enthält die im oberen Screenshot dargestellten grundlegenden Informationen eines Verfahrens, wie die obligatorische Angabe der "verfahrenssteuerung". Der Arbeitstitel ist bei simulierten Verfahren verpflichtend. Bei nicht simulierten Verfahren ist der Planname verpflichtend.

Aufgaben sind in der Verfahrenskonfiguration aufgeführt und ergeben sich für ein Verfahren über den Code für die Verfahrenssteuerung. Der Status von Aufgaben (erledigt/nicht erledigt) kann nicht importiert werden und muss im Cockpit händisch nach Öffnen des Verfahrens angepasst werden. Es ist jedoch möglich für einzelne Action Items Inhalte bzw. Ergebnisse anzugeben, bspw. eine Checkbox anzuhaken oder den Wert in einem Textfeld. Eine genauere Erläuterung befindet sich im Abschnitt [[Verfahren hinzufügen (XPlanverfahren) DiPlanCockpit Pro|zum Import von Action Items]].

=== *Verfahrensstand ===
[[Datei:ImageVerfahrensstand.png|zentriert|rahmenlos|702x702px]]
Der "verfahrensstand" ist verpflichtend anzugeben. Er beschreibt den aktuellen Stand des Verfahrens als Wert aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensstand Codeliste] und muss zum Planstatus passen. So muss beispielsweise für ein simuliertes Verfahren Verfahrensstand 1000 und der Planstatus 0300 sein. Außerdem gibt es Abhängigkeiten zwischen dem Verfahrensstand und Datumsangaben, siehe Tabelle unter [[Verfahren hinzufügen (XPlanverfahren) DiPlanCockpit Pro#Satzung%20Beschluss|https://wiki.diplanung.de/index.php?title=Verfahren_hinzufügen_(XPlanverfahren)_DiPlanCockpit_Pro#Satzung_Beschluss]].

=== *Beschreibungen und Schlagworte ===
[[Datei:ImageBeschreibungSchlagworte.png|zentriert|rahmenlos|698x698px]]
Für "beschreibungPlanungsanlass" und "beschreibungGeltungsbereich" werden verpflichtend textliche Beschreibungen festgehalten werden und optional relevante Schlagworte jeweils einzeln als "schlagwort".

=== *Planart und Planstatus ===
[[Datei:ImagePlanartPlanstatus.png|zentriert|rahmenlos|701x701px]]
Sowohl die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planart planart]" als auch der "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planstatus planstatus]" werden über einen Code aus der jeweiligen Codeliste verpflichtend angegeben. Der Planstatus muss zum Verfahrensstand passen. Für ein simuliertes Verfahren muss der Verfahrensstand 1000 und der Planstatus 0300 sein.

=== Relation zum Planrecht ===
[[Datei:ImageRelationPlanrecht.png|zentriert|rahmenlos|697x697px]]
Für die optionale Darstellung der [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:relationplanrecht Relation] des Verfahrens zum Planrecht werden die "planID" (optional) sowie der "typ" (verpflichtend) der Relation angegeben.

=== Ausgleichsflächen ===
[[Datei:ImageAusgleichsflaechen.png|zentriert|rahmenlos|696x696px]]
Die Angabe zu "ausgleichsflaechen" ist optional und erfolgt über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:ausgleichsflaechen Codeliste].

=== Kontakte ===
[[Datei:ImageKontakte.png|zentriert|rahmenlos|700x700px]]
Informationen zu Kontakten sind optional und werden für jeden "kontakt" einzeln angegeben. Es müssen nicht alle dargestellten Informationen enthalten sein, so können beispielsweise die Angaben zur "person" entfallen. Die Angabe der "artDesKontaktes" ist erforderlich und erfolgt über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:artdeskontaktes Codeliste].

=== *Zuständigkeit und Gebietseinheit ===
[[Datei:ImageZustaendigkeitGebietseinheit.png|zentriert|rahmenlos|708x708px]]
Sowohl die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:zustaendigkeit zustaendigkeit]" als auch die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:gebietseinheit gebietseinheit]" sind verpflichtend und werden über einen Code aus der jeweiligen Codeliste angegeben. Beide Codelisten sind im Cockpit über den Administrationsbereich anpassbar. Es können mehrere Gebietseinheiten angegeben werden.

=== *Geobezug (Planwerkreferenz) ===
[[Datei:ImageGeobezug.png|zentriert|rahmenlos|700x700px]]
In Abhängigkeit des Verfahrensstandes kann bereits ein XPlanGML vorliegen, dies ist optional. Evtl. liegt 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 kann entweder als Geobezug ein "xPlan" (im Beispiel auskommentiert (grüne Schrift)) oder eine "flaechenabgrenzung" angegeben werden. 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: 25832
* EPSG: 25833
* EPSG: 325833
* EPSG: 31466
* EPSG: 31467
* EPSG: 31468
* EPSG: 31469
* EPSG: 4258
* EPSG: 4326
* EPSG: 4839
* CRS: 84
Der Geltungsbereich (flaechenabgrenzung) wird als GeoJson in EPSG:4326 erwartet. Die Koordinaten aller Geometrien eines Planwerks müssen innerhalb des Geltungsbereichs des Koordinatenreferenzsystems (KRS) liegen. Bei der Validierung wird nur gegen das im XPlanGML gesetzte KRS geprüft.

Ist das Ziel ein XPlanGML in das DiPlanCockpit zu importieren, so kann in "xPlan" eine xPlanURL angegeben werden. Die Anwendung unterstützt sowohl Netzwerk- als auch Downloadressourcen. Die Ressource muss von der Anwendung frei erreichbar sein, insbesondere ohne vorgeschaltete Authentifizierung.

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 auch Netzwerkressourcen auf IONOS verwendet werden. Dabei werden die Schemas http://, https://, s3:// sowie file:// unterstützt. Der Dateiname wird hinter dem "/" der URL erwartet. Der Support unterstützt gerne bei den Zugangsdaten.

Durch das Setzen eines optionalen "veroeffentlichungsdatum" ist zusätzlich zum Import ins DiPlanCockpit die Veröffentlichung des XPlanGML als Dienst im Internet möglich. 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. den Plannamenabgleich.

Voraussetzung für die automatische Veröffentlichung des Planwerks in der XPlanBox mit dem Import ist, dass das Verfahren aktiv ist und das Veröffentlichungsdatum nicht gesetzt ist oder in der Zukunft liegt.

=== Fläche und geplante Wohneinheiten ===
[[Datei:ImageFlaecheGeplanteWohneinheiten.png|zentriert|rahmenlos|617x617px]]
Die "flaeche" und die Anzahl für "geplanteWohneinheiten" werden optional direkt als Zahl eingetragen.

=== Geförderter Wohnungsbau ===
[[Datei:ImageGefoerderterWohnungsbau.png|zentriert|rahmenlos|646x646px]]
Der Abschnitt "gefoerderterWohnungsbau" ist optional und es können optional die "prozent", die "geplanteWohneinheiten" und der "foerderweg" angegeben werden.

=== Zusätzliche Gewerbeflächen ===
[[Datei:ImageZusaetzlicheGewerbeflaechen.png|zentriert|rahmenlos|656x656px]]
Für "zusaetzlicheGewerbeflaechen" wird optional direkt deren Anzahl angegeben.

=== Vorgesehene Nutzungen ===
[[Datei:ImageVorgeseheneNutzungen.png|zentriert|rahmenlos|638x638px]]
Die Angabe für "vorgeseheneNutzungen" erfolgt optional über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:artdernutzung Codeliste].

=== Zurückstellung ===
[[Datei:ImageZurueckstellung.png|zentriert|rahmenlos|645x645px]]
Im Falle einer "zurueckstellung" (optional) sind verpflichtend der "identifikator", das Datum des Bescheids als "bescheidVon", die Dauer der "rueckstellungBis" sowie die "belegenheit" anzugeben.

=== Veränderungssperre ===
[[Datei:ImageVeraenderungssperre.png|zentriert|rahmenlos|637x637px]]
Für eine "veraenderungssperre" (optional) sind verpflichtend der "geltungsbereich", der "zeitraum" und das "beschlussdatum" anzugeben. Optional können bis zu zwei "verlaengerung" angegeben werden, ebenfalls mit "geltungsbereich", "zeitraum" und "beschlussdatum" (nicht dargestellt im Beispiel).

=== Zugeordnete Nutzer ===
[[Datei:ImageZugeordneteNutzer.png|zentriert|rahmenlos|632x632px]]
Alle "zugeordneteNutzer" sind optional und werden einzeln angegeben, wobei der erste Eintrag als Besitzer gewertet wird. Die Angabe der "rolle" per [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:rolle Code] ist optional, die "nutzerID" erforderlich.

=== Planreife nach § 33 BauGB ===
[[Datei:ImagePlanreife33BauGB.png|zentriert|rahmenlos|617x617px]]
Bezüglich der Planreife nach § 33 BauGB kann optional angegeben werden, ob "planreifeNachPara33" gilt und wenn ja, seit wann.

=== Vertrag ===
[[Datei:ImageVertrag.png|zentriert|rahmenlos|610x610px]]
Verträge werden optional und dann jeweils einzeln als "vertrag" aufgeführt, optional mit einem oder mehreren "ergaenzungstext". Verpflichtend sind die Angabe der "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:vertragsart vertragsart]", des "vertragstext" und des "filename".

Der Vertragstext wird direkt in der XML als Bytearray im Format base64Binary angegeben. Beispielsweise PDF lassen sich in dieses Format konvertieren. Es handelt sich dabei um eine sehr lange Zeichenfolge, aus Platzgründen ist im Screenshot keine dargestellt. Unter dem "filename" wird der "vertragstext" als Datei im Cockpit hinterlegt, automatisch wieder im ursprünglichen PDF-Format.

Für Ergänzungstexte können ebenfalls "vertragsabschluss", "unterzeichner", "abschlussdatum" und "inKraftGetretenAm" angegeben werden (nicht dargestellt im Beispiel).
[[Datei:ImageVertragFE.png|zentriert|rahmenlos|623x623px]]

=== Mitwirkungsbereitschaft ===
[[Datei:ImageMitwirkungsbereitschaft.png|zentriert|rahmenlos|625x625px]]
Wenn eine "mitwirkungsbereitschaft" (optional) besteht, kann optional deren "erklaerungsdatum" und ein "kommentar" angegeben werden. Die Angabe der "bereitschaft" ist verpflichtend.

=== Internetseite ===
[[Datei:ImageInternetseite.png|zentriert|rahmenlos|628x628px]]
Wenn eine "internetseite" des Verfahrens existiert, kann optional deren Adresse angegeben werden.

=== Dokumente ===
[[Datei:ImageDokumente.png|zentriert|rahmenlos|625x625px]]
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 <code><xplan:link>s3://test-dokument-2.pdf</xplan:link></code>. 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 <code><xplan:link>s3://test dokument 2.pdf</xplan:link></code> sondern <code><xplan:link>s3://test%20dokument%202.pdf</xplan:link></code>.

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", "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensunterlagentyp dokumentart]" und "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:dokumentstatus 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.
[[Datei:ImageDokumenteFE.png|zentriert|rahmenlos|605x605px]]

=== *Verfahrensart ===
[[Datei:ImageVerfahrensart.png|zentriert|rahmenlos|630x630px]]
Die Angabe der "verfahrensart" ist verpflichtend und erfolgt über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensart Codeliste].

=== Bodenordnung ===
[[Datei:ImageBodenordnung.png|zentriert|rahmenlos|631x631px]]
Optional können bezüglich der "bodenordnung" das "bodenordnungsgebiet" und beliebig viele "belegenheitBodenordnungsgebiet" angegeben werden.

=== *Verfahrensschritt ===
[[Datei:ImageVerfahrensschritt.png|zentriert|rahmenlos|630x630px]]
Die Angabe des aktuellen "verfahrensschritt" erfolgt verpflichtend über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensschritt Codeliste].

=== Satzung Beschluss ===
[[Datei:ImageSatzungBeschluss.png|zentriert|rahmenlos|655x655px]]
Optional können Informationen zur Feststellung in "satzungBeschluss" angegeben werden, mit einem optionalen "beschlussdatum" und "bekanntmachung". Wenn erforderlich kann zwischen dem "beschlussdatum" und der "bekanntmachung" optional auch die "aufhebung" angegeben werden. Dazu werden das "aufhebungsdatum" sowie der "aufhebungsgrund" angegeben (als Code) (nicht dargestellt im Beispiel).

Zu beachten ist bei Datumsangaben das Zusammenspiel mit dem Verfahrensstand. Es sind nur bestimmte Kombinationen zulässig. Folgende Tabelle zeigt die möglichen Kombinationen für die Fachdomäne der Bauleitplanung (die Fachdomäne wird in der [[Verfahrenskonfiguration Pro|Verfahrenskonfiguration]] angegeben):
{| class="wikitable"
!Code
!Verfahrensstand
!Datumsangaben
|-
|2000
|im Verfahren
|kein stattgefundenes Beschlussdatum UND kein stattgefundenes Bekanntmachungsdatum
|-
|3000
|beschlossen
|stattgefundenes Beschlussdatum UND kein stattgefundenes Bekanntmachungsdatum
|-
|3100
|inkraftgetreten
|stattgefundenes Beschlussdatum UND stattgefundenes Bekanntmachungsdatum
|-
|4000
|ganz aufgehoben
|stattgefundenes Beschlussdatum ODER stattgefundenes Bekanntmachungsdatum UND stattgefundenes Untergangsdatum (Aufhebungsdatum)
|-
|5000
|eingestellt
|kein stattgefundenes Beschlussdatum UND kein stattgefundenes Bekanntmachungsdatum
|-
|6000
|laufendes Normenkontrollverfahren
|stattgefundenes Beschlussdatum UND stattgefundenes Bekanntmachungsdatum
|}
=== Termine ===
[[Datei:ImageTermine.png|zentriert|rahmenlos|657x657px]]
Jeweils einzeln in einem Abschnitt "termine" können beliebig viele Termine angegeben werden. Es kann sich bei Terminen um Sitzungen (oben im Beispiel) oder sonstige Termine (unten im Beispiel) handeln. In beiden Fällen sind "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:datumsstatus datumsstatus]", "datumstyp" (zeitpunkt oder zeitraum oder zeitpunkt_oder_zeitraum), "datum" und "metatadatenTermin" verpflichtend anzugeben, das "kommentar" ist optional. In "metadatenTermin" sind die für Sitzungen bzw. sonstige Termine spezifischen Informationen enthalten.

Die Termine erscheinen im importierten Verfahren im Reiter Aufgaben und, wenn sie zeitplanungsrelevant sind, im Reiter Zeitplanung. Um einen Termin importieren zu können, muss er in der Verfahrenskonfiguration im passenden Verfahrensteilschritt angelegt sein.

Zu beachten ist, das immer nur Termine für den ersten Durchgang importiert werden können. Weitere Durchgänge lassen sich nicht hinzufügen.
[[Datei:ImageTermineFE.png|zentriert|rahmenlos|660x660px]]

==== Sitzung ====
[[Datei:ImageSitzung.png|zentriert|rahmenlos|631x631px]]
Für Sitzungen sind die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sitzungen sitzungsart]" sowie das "sitzungsergebnis" verpflichtend per Code anzugeben. Das Sitzungsergebnis kann ein "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sitzungsergebnispolitisch sitzungsergebnisPolitisch]", "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sitzungsergebnisrechtspruefung sitzungsergebnisRechtspruefung]" oder "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sitzungsergebnisverwaltungstechnisch sitzungsergebnisVerwaltungstechnisch]" sein. Optional ist die Angabe des "versanddatum". Zu beachten ist, dass die Bezeichnung einer Sitzung maximal 255 Zeichen umfassen darf. Die Codeliste der Sitzungsart kann im Administrationsbereich des Cockpits aktualisiert werden.

==== Sonstiger Termin ====
[[Datei:ImageSonstigerTermin.png|zentriert|rahmenlos|648x648px]]
Im Falle "sonstigerTermin" ist die Angabe des "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sonstigetermin codeSonstigerTermin]" verpflichtend. Die Codeliste kann im Administrationsbereich des Cockpits aktualisiert werden. Zu beachten ist, dass die Bezeichnung eines sonstigen Termins maximal 255 Zeichen umfassen darf. Optional können weitere Informationen zu dem Termin als "eigenschaft" angegeben werden, jeweils mit "name" und "value". Sie müssen dabei den für den Termin vorgesehenen Eigenschaften gemäß der Verfahrenskonfiguration entsprechen.

Im obigen Beispiel hat der sonstige Termin den Code "InfoOeffentlicheAuslegung_Auslegungszeitraum". In der Verfahrenskonfiguration ist er wie folgt angelegt:
[[Datei:ImageVKSonstigerTerminBeispiel.png|zentriert|rahmenlos|628x628px]]
Der Termin hat die Eigenschaft "artDerAuslegung", die mit dem Wert aus der Codeliste "ArtDerAuslegung" zu befüllen ist. Dementsprechend ist in der XML-Datei für den Import eines Verfahrens als "name" der "name" der "eigenschaft" aus der Verfahrenskonfiguration angegeben und als "value" der Code 100, der sich in der Codeliste "ArtDerAuslegung" wiederfindet. Alle möglichen Typen der Eigenschaft sind in der [[Verfahrenskonfiguration Pro#Sonstiger%20Termin|Dokumentation zur Verfahrenskonfiguration]] erläutert.

== Weitere mögliche Inhalte ==
Neben den im Beispielverfahren beschriebenen können je nach Bedarf weitere Informationen zu einem Verfahren angegeben werden.

=== Parallelverfahren ===
Wenn es "parallelverfahren" gibt, so können diese nach der "verfahrensbeschreibung" innerhalb der "Verfahrensuebersicht" eingefügt werden. Darin können die Informationen gemäß des "Verfahrensverweis" angegeben werden.

=== Mandantenspezifische Erweiterungen ===
Man kann im XPlanverfahren Standard eine Mandatenspezifische Erweiterung angeben, in der wir eine DiPlanung-Erweiterung unterstützen. '''Wichtig''': Mit 'Mandant' ist hier DiPlanCockpit gemeint. Es gibt keine Erweiterungen für einzelne Bundesländer.

Valide Erweiterungen sind im Schema diplanung-xplanverfahren-erweiterung.xsd definiert. Derzeit ist es mittels der Erweiterung möglich Werte für Action Items zu importieren. Dazu muss auch der verwendete Namespace in der XML definiert werden:
[[Datei:ImageImportNamespace.png|zentriert|rahmenlos|583x583px]]

==== Action Items für Aufgaben ====
[[Datei:ImageAIImport.png|zentriert|rahmenlos|660x660px|

]]Um ein Action Item importieren zu können, muss es in der Verfahrenskonfiguration mit einer refID versehen sein. Sie dient dazu, das konkrete Action Item zu identifizieren. Zu beachten ist, dass nur für eine Auswahl an Action Items (Checkbox, Float, Integer, String, Textarea, Link und Input Link) der Import möglich ist. Der folgende Screenshot zeigt beispielhaft, wie Action Items in der Import-XML aufgeführt werden. Die übrigen Action Items sind bei Bedarf händisch im Anschluss an den Import im Verfahren nachzupflegen.

==== 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.
[[Datei:ImageMandantenSpezifischeStammdatenImport3.png|zentriert|mini|597x597px]]

Verfahren hinzufügen (XPlanverfahren) DiPlanCockpit Pro

2026-03-24T13:57:24Z

Diplanung: /* Mandaten spezifische Stammdaten */

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

Die Funktion "Verfahren hinzufügen (XPlanverfahren)" ermöglicht den Import von Verfahren, welche im XML-Format und nach dem XöV Standard XPlanverfahren bereitgestellt werden. Diese Funktion ist im Reiter "Konfiguration" des Admin-Bereichs zu finden.

Für den Import sind XML-Dateien der Verfahren nach dem Standard XPlanverfahren zu erstellen. Die Angaben zu einem Verfahren können sehr detailliert sein und beispielsweise Dokumente umfassen. Verpflichtend sind hingegen nur einige der möglichen Angaben. Sie sind im Abschnitt mit der Beschreibung der einzelnen Abschnitte einer Importdatei durch einen Stern (*) gekennzeichnet. In einer minimalen Importdatei müssen mindestens diese Informationen enthalten sein.

Der Import kann ein einzelnes oder auch mehrere Verfahren umfassen. Die Größe des Imports hat Einfluss auf die Dauer des Import-Vorgangs. Während des Imports wird das System stark ausgelastet und ist unter Umständen eingeschränkt verfügbar. Es wird deswegen empfohlen größere Importe idealerweise in Randzeiten anzustoßen.

In jeder Datei können mehrere Verfahren angegeben sein, sodass sie gleichzeitig importiert werden können. Aus technischen Gründen ist jedoch die Anzahl der simultan importierbaren Verfahren in einem XPlanverfahren Importdokument limitiert.

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).

Das Importdokument durchläuft eine mehrstufige Validierung:

# XöV Schemavalidierung (z.B. Prüfung der korrekten Datentypen und von Pflichtfeldern)
# Referenzierte Codelistenwerte im Importdokument werden gegen die im Cockpit hinterlegten Codelisten abgeglichen
# Plannamen werden auf Eindeutigkeit innerhalb des Mandanten geprüft
# Weitere fachliche Validierungen wie Prüfung bestimmter Felder in Abhängigkeit von anderen Feldern, [[Editieren der Stammdaten - DiPlanCockpit Pro|Prüfung von Datumsangaben in Abhängigkeit von der Fachdomäne und des Verfahrensstandes]]
# Referenzierte Codelistenwerte im Importdokument werden gegen die im Cockpit hinterlegte Verfahrenskonfiguration abgeglichen, welche im Importdokument referenziert wird.

Kommt es bei der Validierung zu Fehlern, so 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.

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

= Wichtige Voraussetzungen =
Jedes Verfahren referenziert auf eine Verfahrenskonfiguration (VK) und die dazugehörigen Codelisten - sowohl feste als auch (vom Mandanten) änderbare Codelisten. Um Fehler zu vermeiden, muss sichergestellt werden, dass das zu importierende Verfahren mit der VK und änderbaren Codelisten stets auf dem gleichen Stand ist und dieses spezifische Set an VK + Codelisten im Cockpit verfügbar sind. Weitere Details dazu sowie zur Anpassung einer VK finden sich in der Dokumentation zur [[Verfahrenskonfiguration Pro|Verfahrenskonfiguration]].

Je Verfahrenssteuerungstyp sollte eine eigene VK vorliegen, um künftige Auswertungen bedienen zu können. Ebenso sollte je XPlan Fachmodell (BP, FB; LP, RP etc.) eine eigene VK vorliegen.

Es können sowohl beschlossene als auch laufende Verfahren importiert werden. Für den Import beschlossener Verfahren kann eine Basis VK (ohne VTS, UVTS, Aufgaben) ausreichend sein. Doch auch hier sollte nach Verfahrenssteuerungstyp differenziert werden. Für laufende Verfahren sind i.d.R. vollständige VKs notwendig. Zu beachten ist, dass allgemein der Status von Aufgaben nicht übernommen wird, sodass jedes Verfahren nachgepflegt werden muss.

= Verfahren importieren =
Um ein oder mehrere Planverfahren zu importieren, benötigen Sie ein lokal abgelegtes valides XPlanverfahren Importdokument. Dieses können Sie über die entsprechende Schaltfläche "Verfahren hinzufügen (XPlanverfahren)" hochladen und so den Importprozess starten.

Klicken Sie auf das Lupen-Symbol, um das lokale XPlanverfahren Importdokument auszuwählen. Die Dateiendung muss dem XML-Format entsprechen.

Nach Auswahl und Bestätigung des Dateinamen starten Sie den Importprozess durch Klick auf Hochladen.

Ob der Import erfolgreich war, lässt sich dem allgemeinen Protokoll entnehmen. Erfolgreiche Imports werden dort festgehalten. Ob ein bestimmtes Verfahren aus einem Import stammt, sieht man wiederum im Verfahrensprotokoll.

== Prüfung der Eingabedaten ==
Während des Importprozesses wird die Überprüfung der Eingabedaten vorgenommen. Neben einer allgemeinen XML-Schemaprüfung werden im Importdokument referenzierte Codelistenwerte gegen aktuell in im Cockpit hinterlegte Codelisten abgeglichen. Zusätzlich werden Plannamen auf Eindeutigkeit und die Existenz von Pflichtattributen geprüft.

Falls während des Imports ein ein Fehler identifiziert wird, dann wird der Importvorgang abgebrochen und es wird eine Fehlermeldung erzeugt. 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 ===
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. Die Inhalte können sich zwischen Versionen semantisch und syntaktisch ändern bzw. es können neue Inhalte hinzugefügt oder alte Inhalte entfernt werden. XPlanverfahren ist im XRepository zudem 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 (bitte zur Validierung nur die Version aus dem Cockpit verwenden) und die Spezifikation mit allen Inhalten als PDF-Datei.

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.
= Aufbau eines Verfahrens für den Import =
Die Inhalte eines Imports sind in XPlanverfahren beschrieben und im [https://www.xrepository.de/details/urn:xoev-de:xleitstelle:standard:xplanverfahren XRepository] veröffentlicht. Im Folgenden finden Sie über den Standard hinausgehende Beschreibungen und Hinweise anhand eines beispielhaften Verfahrens im XML-Format.

Die folgenden Screenshots zeigen exemplarisch ein Verfahren, das ins Cockpit importiert werden kann. Die Zahlen am linken Rand der Screenshots zeigen die Zeilennummern der XML-Datei. Insgesamt sind es im Beispiel 284. Um eine kompakte Darstellung zu ermöglichen, sind die Bereiche, die für die jeweilige Erläuterung irrelevant sind, eingeklappt. Das ist an den kleinen blauen Pfeilen rechts von den Zeilennummern zu erkennen. Ein Pfeil nach unten bedeutet, dass der Abschnitt aufgeklappt ist. Ein Pfeil nach rechts hingegen heißt, dass an dieser Stelle noch weitere Zeilen sind, die lediglich nicht angezeigt werden. Die Anzahl der ausgeblendeten Zeilen ist in Klammern angegeben. Die Form der Darstellung ist dem verwendeten Programm geschuldet. Bei der Verwendung anderer Programme kann die visuelle Darstellung der XML abweichen.

== Struktur des Verfahrens ==
[[Datei:ImageStrukturVerfahren.png|zentriert|alternativtext=|rahmenlos|916x916px]]
Dieser Screenshot gibt einen Überblick über die Informationen, die zu einem Verfahren angegeben werden können. Die Reihenfolge der Angaben ist nicht beliebig, sondern muss den Vorgaben aus XPlanverfahren entsprechen.

Die oberste Ebene der XML-Datei mit "planung2Empfaenger.UebersichtVerfahren.0811" ist technisch erforderlich und enthält in Form von URLs beispielsweise Informationen zu den verwendeten namespaces.

Darin folgt der eigentliche "nachrichteninhalt" mit der "verfahrensuebersicht" und darin der "verfahrensbeschreibung" eines konkreten Verfahrens. Sollen mehrere Verfahren in einer XML importiert werden, so muss für jedes Verfahren ein eigener Abschnitt "verfahrensuebersicht" mit der "verfahrensbeschreibung" enthalten sein.

== Beschreibung der einzelnen Abschnitte ==
Im Folgenden werden die einzelnen Unterkapitel anhand von Beispielen aus der XML erläutert. Für alle Unterkapitel gilt:

* Die "listURI" gibt die konkrete Codeliste an und die "listVersionID" die zu verwendende Version der Codeliste.
* Screenshots aus dem DiPlanCockpit zeigen einzelne Elemente des importierten Verfahrens, dazu gehören z.B. Verträge im Reiter Dokumente. Wenn kein Screenshot des DiPlanCockpit für ein Unterkapitel eingefügt ist, finden sich die dargestellten Informationen allgemein auf der Stammdatenseite im DiPlanCockpit wieder.
* Ein Stern (*) vor der Überschrift des Unterkapitels markiert die verpflichtenden Inhalte für den Import.

=== *Verfahrensverweis ===
[[Datei:ImageVerfahrensverweis.png|zentriert|rahmenlos|705x705px]]
Der "verfahrensverweis" ist verpflichtend und enthält die im oberen Screenshot dargestellten grundlegenden Informationen eines Verfahrens, wie die obligatorische Angabe der "verfahrenssteuerung". Der Arbeitstitel ist bei simulierten Verfahren verpflichtend. Bei nicht simulierten Verfahren ist der Planname verpflichtend.

Aufgaben sind in der Verfahrenskonfiguration aufgeführt und ergeben sich für ein Verfahren über den Code für die Verfahrenssteuerung. Der Status von Aufgaben (erledigt/nicht erledigt) kann nicht importiert werden und muss im Cockpit händisch nach Öffnen des Verfahrens angepasst werden. Es ist jedoch möglich für einzelne Action Items Inhalte bzw. Ergebnisse anzugeben, bspw. eine Checkbox anzuhaken oder den Wert in einem Textfeld. Eine genauere Erläuterung befindet sich im Abschnitt [[Verfahren hinzufügen (XPlanverfahren) DiPlanCockpit Pro|zum Import von Action Items]].

=== *Verfahrensstand ===
[[Datei:ImageVerfahrensstand.png|zentriert|rahmenlos|702x702px]]
Der "verfahrensstand" ist verpflichtend anzugeben. Er beschreibt den aktuellen Stand des Verfahrens als Wert aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensstand Codeliste] und muss zum Planstatus passen. So muss beispielsweise für ein simuliertes Verfahren Verfahrensstand 1000 und der Planstatus 0300 sein. Außerdem gibt es Abhängigkeiten zwischen dem Verfahrensstand und Datumsangaben, siehe Tabelle unter [[Verfahren hinzufügen (XPlanverfahren) DiPlanCockpit Pro#Satzung%20Beschluss|https://wiki.diplanung.de/index.php?title=Verfahren_hinzufügen_(XPlanverfahren)_DiPlanCockpit_Pro#Satzung_Beschluss]].

=== *Beschreibungen und Schlagworte ===
[[Datei:ImageBeschreibungSchlagworte.png|zentriert|rahmenlos|698x698px]]
Für "beschreibungPlanungsanlass" und "beschreibungGeltungsbereich" werden verpflichtend textliche Beschreibungen festgehalten werden und optional relevante Schlagworte jeweils einzeln als "schlagwort".

=== *Planart und Planstatus ===
[[Datei:ImagePlanartPlanstatus.png|zentriert|rahmenlos|701x701px]]
Sowohl die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planart planart]" als auch der "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planstatus planstatus]" werden über einen Code aus der jeweiligen Codeliste verpflichtend angegeben. Der Planstatus muss zum Verfahrensstand passen. Für ein simuliertes Verfahren muss der Verfahrensstand 1000 und der Planstatus 0300 sein.

=== Relation zum Planrecht ===
[[Datei:ImageRelationPlanrecht.png|zentriert|rahmenlos|697x697px]]
Für die optionale Darstellung der [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:relationplanrecht Relation] des Verfahrens zum Planrecht werden die "planID" (optional) sowie der "typ" (verpflichtend) der Relation angegeben.

=== Ausgleichsflächen ===
[[Datei:ImageAusgleichsflaechen.png|zentriert|rahmenlos|696x696px]]
Die Angabe zu "ausgleichsflaechen" ist optional und erfolgt über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:ausgleichsflaechen Codeliste].

=== Kontakte ===
[[Datei:ImageKontakte.png|zentriert|rahmenlos|700x700px]]
Informationen zu Kontakten sind optional und werden für jeden "kontakt" einzeln angegeben. Es müssen nicht alle dargestellten Informationen enthalten sein, so können beispielsweise die Angaben zur "person" entfallen. Die Angabe der "artDesKontaktes" ist erforderlich und erfolgt über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:artdeskontaktes Codeliste].

=== *Zuständigkeit und Gebietseinheit ===
[[Datei:ImageZustaendigkeitGebietseinheit.png|zentriert|rahmenlos|708x708px]]
Sowohl die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:zustaendigkeit zustaendigkeit]" als auch die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:gebietseinheit gebietseinheit]" sind verpflichtend und werden über einen Code aus der jeweiligen Codeliste angegeben. Beide Codelisten sind im Cockpit über den Administrationsbereich anpassbar. Es können mehrere Gebietseinheiten angegeben werden.

=== *Geobezug (Planwerkreferenz) ===
[[Datei:ImageGeobezug.png|zentriert|rahmenlos|700x700px]]
In Abhängigkeit des Verfahrensstandes kann bereits ein XPlanGML vorliegen, dies ist optional. Evtl. liegt 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 kann entweder als Geobezug ein "xPlan" (im Beispiel auskommentiert (grüne Schrift)) oder eine "flaechenabgrenzung" angegeben werden. 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: 25832
* EPSG: 25833
* EPSG: 325833
* EPSG: 31466
* EPSG: 31467
* EPSG: 31468
* EPSG: 31469
* EPSG: 4258
* EPSG: 4326
* EPSG: 4839
* CRS: 84
Der Geltungsbereich (flaechenabgrenzung) wird als GeoJson in EPSG:4326 erwartet. Die Koordinaten aller Geometrien eines Planwerks müssen innerhalb des Geltungsbereichs des Koordinatenreferenzsystems (KRS) liegen. Bei der Validierung wird nur gegen das im XPlanGML gesetzte KRS geprüft.

Ist das Ziel ein XPlanGML in das DiPlanCockpit zu importieren, so kann in "xPlan" eine xPlanURL angegeben werden. Die Anwendung unterstützt sowohl Netzwerk- als auch Downloadressourcen. Die Ressource muss von der Anwendung frei erreichbar sein, insbesondere ohne vorgeschaltete Authentifizierung.

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 auch Netzwerkressourcen auf IONOS verwendet werden. Dabei werden die Schemas http://, https://, s3:// sowie file:// unterstützt. Der Dateiname wird hinter dem "/" der URL erwartet. Der Support unterstützt gerne bei den Zugangsdaten.

Durch das Setzen eines optionalen "veroeffentlichungsdatum" ist zusätzlich zum Import ins DiPlanCockpit die Veröffentlichung des XPlanGML als Dienst im Internet möglich. 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. den Plannamenabgleich.

Voraussetzung für die automatische Veröffentlichung des Planwerks in der XPlanBox mit dem Import ist, dass das Verfahren aktiv ist und das Veröffentlichungsdatum nicht gesetzt ist oder in der Zukunft liegt.

=== Fläche und geplante Wohneinheiten ===
[[Datei:ImageFlaecheGeplanteWohneinheiten.png|zentriert|rahmenlos|617x617px]]
Die "flaeche" und die Anzahl für "geplanteWohneinheiten" werden optional direkt als Zahl eingetragen.

=== Geförderter Wohnungsbau ===
[[Datei:ImageGefoerderterWohnungsbau.png|zentriert|rahmenlos|646x646px]]
Der Abschnitt "gefoerderterWohnungsbau" ist optional und es können optional die "prozent", die "geplanteWohneinheiten" und der "foerderweg" angegeben werden.

=== Zusätzliche Gewerbeflächen ===
[[Datei:ImageZusaetzlicheGewerbeflaechen.png|zentriert|rahmenlos|656x656px]]
Für "zusaetzlicheGewerbeflaechen" wird optional direkt deren Anzahl angegeben.

=== Vorgesehene Nutzungen ===
[[Datei:ImageVorgeseheneNutzungen.png|zentriert|rahmenlos|638x638px]]
Die Angabe für "vorgeseheneNutzungen" erfolgt optional über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:artdernutzung Codeliste].

=== Zurückstellung ===
[[Datei:ImageZurueckstellung.png|zentriert|rahmenlos|645x645px]]
Im Falle einer "zurueckstellung" (optional) sind verpflichtend der "identifikator", das Datum des Bescheids als "bescheidVon", die Dauer der "rueckstellungBis" sowie die "belegenheit" anzugeben.

=== Veränderungssperre ===
[[Datei:ImageVeraenderungssperre.png|zentriert|rahmenlos|637x637px]]
Für eine "veraenderungssperre" (optional) sind verpflichtend der "geltungsbereich", der "zeitraum" und das "beschlussdatum" anzugeben. Optional können bis zu zwei "verlaengerung" angegeben werden, ebenfalls mit "geltungsbereich", "zeitraum" und "beschlussdatum" (nicht dargestellt im Beispiel).

=== Zugeordnete Nutzer ===
[[Datei:ImageZugeordneteNutzer.png|zentriert|rahmenlos|632x632px]]
Alle "zugeordneteNutzer" sind optional und werden einzeln angegeben, wobei der erste Eintrag als Besitzer gewertet wird. Die Angabe der "rolle" per [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:rolle Code] ist optional, die "nutzerID" erforderlich.

=== Planreife nach § 33 BauGB ===
[[Datei:ImagePlanreife33BauGB.png|zentriert|rahmenlos|617x617px]]
Bezüglich der Planreife nach § 33 BauGB kann optional angegeben werden, ob "planreifeNachPara33" gilt und wenn ja, seit wann.

=== Vertrag ===
[[Datei:ImageVertrag.png|zentriert|rahmenlos|610x610px]]
Verträge werden optional und dann jeweils einzeln als "vertrag" aufgeführt, optional mit einem oder mehreren "ergaenzungstext". Verpflichtend sind die Angabe der "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:vertragsart vertragsart]", des "vertragstext" und des "filename".

Der Vertragstext wird direkt in der XML als Bytearray im Format base64Binary angegeben. Beispielsweise PDF lassen sich in dieses Format konvertieren. Es handelt sich dabei um eine sehr lange Zeichenfolge, aus Platzgründen ist im Screenshot keine dargestellt. Unter dem "filename" wird der "vertragstext" als Datei im Cockpit hinterlegt, automatisch wieder im ursprünglichen PDF-Format.

Für Ergänzungstexte können ebenfalls "vertragsabschluss", "unterzeichner", "abschlussdatum" und "inKraftGetretenAm" angegeben werden (nicht dargestellt im Beispiel).
[[Datei:ImageVertragFE.png|zentriert|rahmenlos|623x623px]]

=== Mitwirkungsbereitschaft ===
[[Datei:ImageMitwirkungsbereitschaft.png|zentriert|rahmenlos|625x625px]]
Wenn eine "mitwirkungsbereitschaft" (optional) besteht, kann optional deren "erklaerungsdatum" und ein "kommentar" angegeben werden. Die Angabe der "bereitschaft" ist verpflichtend.

=== Internetseite ===
[[Datei:ImageInternetseite.png|zentriert|rahmenlos|628x628px]]
Wenn eine "internetseite" des Verfahrens existiert, kann optional deren Adresse angegeben werden.

=== Dokumente ===
[[Datei:ImageDokumente.png|zentriert|rahmenlos|625x625px]]
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 <code><xplan:link>s3://test-dokument-2.pdf</xplan:link></code>. 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 <code><xplan:link>s3://test dokument 2.pdf</xplan:link></code> sondern <code><xplan:link>s3://test%20dokument%202.pdf</xplan:link></code>.

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", "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensunterlagentyp dokumentart]" und "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:dokumentstatus 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.
[[Datei:ImageDokumenteFE.png|zentriert|rahmenlos|605x605px]]

=== *Verfahrensart ===
[[Datei:ImageVerfahrensart.png|zentriert|rahmenlos|630x630px]]
Die Angabe der "verfahrensart" ist verpflichtend und erfolgt über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensart Codeliste].

=== Bodenordnung ===
[[Datei:ImageBodenordnung.png|zentriert|rahmenlos|631x631px]]
Optional können bezüglich der "bodenordnung" das "bodenordnungsgebiet" und beliebig viele "belegenheitBodenordnungsgebiet" angegeben werden.

=== *Verfahrensschritt ===
[[Datei:ImageVerfahrensschritt.png|zentriert|rahmenlos|630x630px]]
Die Angabe des aktuellen "verfahrensschritt" erfolgt verpflichtend über einen Code aus der entsprechenden [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:verfahrensschritt Codeliste].

=== Satzung Beschluss ===
[[Datei:ImageSatzungBeschluss.png|zentriert|rahmenlos|655x655px]]
Optional können Informationen zur Feststellung in "satzungBeschluss" angegeben werden, mit einem optionalen "beschlussdatum" und "bekanntmachung". Wenn erforderlich kann zwischen dem "beschlussdatum" und der "bekanntmachung" optional auch die "aufhebung" angegeben werden. Dazu werden das "aufhebungsdatum" sowie der "aufhebungsgrund" angegeben (als Code) (nicht dargestellt im Beispiel).

Zu beachten ist bei Datumsangaben das Zusammenspiel mit dem Verfahrensstand. Es sind nur bestimmte Kombinationen zulässig. Folgende Tabelle zeigt die möglichen Kombinationen für die Fachdomäne der Bauleitplanung (die Fachdomäne wird in der [[Verfahrenskonfiguration Pro|Verfahrenskonfiguration]] angegeben):
{| class="wikitable"
!Code
!Verfahrensstand
!Datumsangaben
|-
|2000
|im Verfahren
|kein stattgefundenes Beschlussdatum UND kein stattgefundenes Bekanntmachungsdatum
|-
|3000
|beschlossen
|stattgefundenes Beschlussdatum UND kein stattgefundenes Bekanntmachungsdatum
|-
|3100
|inkraftgetreten
|stattgefundenes Beschlussdatum UND stattgefundenes Bekanntmachungsdatum
|-
|4000
|ganz aufgehoben
|stattgefundenes Beschlussdatum ODER stattgefundenes Bekanntmachungsdatum UND stattgefundenes Untergangsdatum (Aufhebungsdatum)
|-
|5000
|eingestellt
|kein stattgefundenes Beschlussdatum UND kein stattgefundenes Bekanntmachungsdatum
|-
|6000
|laufendes Normenkontrollverfahren
|stattgefundenes Beschlussdatum UND stattgefundenes Bekanntmachungsdatum
|}
=== Termine ===
[[Datei:ImageTermine.png|zentriert|rahmenlos|657x657px]]
Jeweils einzeln in einem Abschnitt "termine" können beliebig viele Termine angegeben werden. Es kann sich bei Terminen um Sitzungen (oben im Beispiel) oder sonstige Termine (unten im Beispiel) handeln. In beiden Fällen sind "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:datumsstatus datumsstatus]", "datumstyp" (zeitpunkt oder zeitraum oder zeitpunkt_oder_zeitraum), "datum" und "metatadatenTermin" verpflichtend anzugeben, das "kommentar" ist optional. In "metadatenTermin" sind die für Sitzungen bzw. sonstige Termine spezifischen Informationen enthalten.

Die Termine erscheinen im importierten Verfahren im Reiter Aufgaben und, wenn sie zeitplanungsrelevant sind, im Reiter Zeitplanung. Um einen Termin importieren zu können, muss er in der Verfahrenskonfiguration im passenden Verfahrensteilschritt angelegt sein.

Zu beachten ist, das immer nur Termine für den ersten Durchgang importiert werden können. Weitere Durchgänge lassen sich nicht hinzufügen.
[[Datei:ImageTermineFE.png|zentriert|rahmenlos|660x660px]]

==== Sitzung ====
[[Datei:ImageSitzung.png|zentriert|rahmenlos|631x631px]]
Für Sitzungen sind die "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sitzungen sitzungsart]" sowie das "sitzungsergebnis" verpflichtend per Code anzugeben. Das Sitzungsergebnis kann ein "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sitzungsergebnispolitisch sitzungsergebnisPolitisch]", "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sitzungsergebnisrechtspruefung sitzungsergebnisRechtspruefung]" oder "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sitzungsergebnisverwaltungstechnisch sitzungsergebnisVerwaltungstechnisch]" sein. Optional ist die Angabe des "versanddatum". Zu beachten ist, dass die Bezeichnung einer Sitzung maximal 255 Zeichen umfassen darf. Die Codeliste der Sitzungsart kann im Administrationsbereich des Cockpits aktualisiert werden.

==== Sonstiger Termin ====
[[Datei:ImageSonstigerTermin.png|zentriert|rahmenlos|648x648px]]
Im Falle "sonstigerTermin" ist die Angabe des "[https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:sonstigetermin codeSonstigerTermin]" verpflichtend. Die Codeliste kann im Administrationsbereich des Cockpits aktualisiert werden. Zu beachten ist, dass die Bezeichnung eines sonstigen Termins maximal 255 Zeichen umfassen darf. Optional können weitere Informationen zu dem Termin als "eigenschaft" angegeben werden, jeweils mit "name" und "value". Sie müssen dabei den für den Termin vorgesehenen Eigenschaften gemäß der Verfahrenskonfiguration entsprechen.

Im obigen Beispiel hat der sonstige Termin den Code "InfoOeffentlicheAuslegung_Auslegungszeitraum". In der Verfahrenskonfiguration ist er wie folgt angelegt:
[[Datei:ImageVKSonstigerTerminBeispiel.png|zentriert|rahmenlos|628x628px]]
Der Termin hat die Eigenschaft "artDerAuslegung", die mit dem Wert aus der Codeliste "ArtDerAuslegung" zu befüllen ist. Dementsprechend ist in der XML-Datei für den Import eines Verfahrens als "name" der "name" der "eigenschaft" aus der Verfahrenskonfiguration angegeben und als "value" der Code 100, der sich in der Codeliste "ArtDerAuslegung" wiederfindet. Alle möglichen Typen der Eigenschaft sind in der [[Verfahrenskonfiguration Pro#Sonstiger%20Termin|Dokumentation zur Verfahrenskonfiguration]] erläutert.

== Weitere mögliche Inhalte ==
Neben den im Beispielverfahren beschriebenen können je nach Bedarf weitere Informationen zu einem Verfahren angegeben werden.

=== Parallelverfahren ===
Wenn es "parallelverfahren" gibt, so können diese nach der "verfahrensbeschreibung" innerhalb der "Verfahrensuebersicht" eingefügt werden. Darin können die Informationen gemäß des "Verfahrensverweis" angegeben werden.

=== Mandantenspezifische Erweiterungen ===
Man kann im XPlanverfahren Standard eine Mandatenspezifische Erweiterung angeben, in der wir eine DiPlanung-Erweiterung unterstützen. '''Wichtig''': Mit 'Mandant' ist hier DiPlanCockpit gemeint. Es gibt keine Erweiterungen für einzelne Bundesländer.

Valide Erweiterungen sind im Schema diplanung-xplanverfahren-erweiterung.xsd definiert. Derzeit ist es mittels der Erweiterung möglich Werte für Action Items zu importieren. Dazu muss auch der verwendete Namespace in der XML definiert werden:
[[Datei:ImageImportNamespace.png|zentriert|rahmenlos|583x583px]]

==== Action Items für Aufgaben ====
[[Datei:ImageAIImport.png|zentriert|rahmenlos|660x660px|

]]Um ein Action Item importieren zu können, muss es in der Verfahrenskonfiguration mit einer refID versehen sein. Sie dient dazu, das konkrete Action Item zu identifizieren. Zu beachten ist, dass nur für eine Auswahl an Action Items (Checkbox, Float, Integer, String, Textarea, Link und Input Link) der Import möglich ist. Der folgende Screenshot zeigt beispielhaft, wie Action Items in der Import-XML aufgeführt werden. Die übrigen Action Items sind bei Bedarf händisch im Anschluss an den Import im Verfahren nachzupflegen.

==== 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.
[[Datei:ImageMandantenSpezifischeStammdatenImport3.png|zentriert|mini|456x456px]]

Datei:ImageMandantenSpezifischeStammdatenImport3.png

2026-03-24T13:55:33Z

Diplanung:

ImageMandantenSpezifischeStammdatenImport3

Verfahrenskonfiguration Pro

2026-03-24T13:38:51Z

Diplanung: /* Optional: Mandanten spezifische Stammdaten */

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

Die Verfahrenskonfiguration, kurz VK, ist das zentrale Element in der Konfiguration. Über Verfahrenskonfigurationen wird je nach Verfahrenssteuerungstyp (kurz V-Typ) der Ablauf des Verfahrens festgelegt. Das heißt, die VK bestimmt den Ablauf des Verfahrens und die vorgesehenen Aufgaben innerhalb eines Verfahrens. Außerdem enthält sie grundlegende Einstellungen zur Zeitplanung.

Es ist eine Default-Stellung für die kommunale Bauleitplanung verfügbar, die Mandanten spezifisch angepasst werden kann. Es lassen sich beliebig viele unterschiedliche VKs konfigurieren, die für jeden V-Typ eigene Abläufe definieren.

== Tab Verfahrenskonfiguration ==
Im Tab Verfahrenskonfiguration sind die verfügbaren Verfahrenskonfigurationen aufgelistet. Sie lassen sich nach Name, Status, Verwendung, Aktualisierungsdatum und bearbeitender Person filtern. Das Herunterladen erfolgt wahlweise einzeln als XML für eine Verfahrenskonfiguration oder für alle zusammen in Form einer ZIP-Datei.

Eine Verfahrenskonfiguration kann angepasst und bzw. neu erstellt und anschließend über das dafür vorgesehene Feld hochgeladen werden. Eine neu hochgeladene Verfahrenskonfiguration gilt für alle danach neu angelegten Verfahren, bereits vorhandene Verfahren werden nicht verändert.

Es ist ebenfalls möglich Verfahrenskonfigurationen zu löschen. Das erfolgt in zwei Schritten. Zuerst wird eine Verfahrenskonfiguration per Klick auf "Löschen" im Drei-Punkte-Menü als gelöscht markiert. Anschließend kann sie wiederhergestellt oder endgültig gelöscht werden. Für die endgültige Löschung ist Voraussetzung, dass die Verfahrenskonfiguration nicht mehr in Verwendung ist. Gegebenenfalls sind deswegen zuerst die Verfahren zu löschen, die die Verfahrenskonfiguration noch verwenden. Die betreffenden Verfahren werden per Klick auf die Werte in der Spalte "in Verwendung" angezeigt.

== Wichtige Hinweise ==
Jede VK bezieht sich auf Codelisten - sowohl feste als auch (vom Mandanten) änderbare Codelisten. Um Fehler zu vermeiden, muss sichergestellt werden, dass VK und änderbare Codelisten stets auf dem gleichen Stand sind. Das bedeutet:

* Anpassungen in einer VK können Konsequenzen auf änderbare Codelisten haben. = Anpassungen IMMER für VK und änderbare Codelisten umsetzen.
* Entfernung von Codes in änderbaren Codelisten müssen mit Umsicht vorgenommen und mögliche Auswirkungen auf VK(s) geprüft und bei Bedarf umgesetzt werden.
* Einfacher ist es, Einträge / Codes in änderbaren Codelisten ergänzend vorzunehmen, also den Bestand um neue Einträge zu ergänzen.
* Beim Hochladen ist die Reihenfolge wichtig: Angepasste, änderbare Codelisten müssen zuerst hochgeladen werden. Danach folgt die angepasste VK. Wird die Reihenfolge nicht eingehalten, kann es zur Fehlermeldung kommen.
* Für die Änderung von VK und Codelisten empfiehlt sich der Einsatz eines professionellen XLM-Tools, das Validierungs-Funktionen bietet. Diese laufen i.d.R. im Hintergrund ab und zeigen optisch Fehler an, wie falsche Einrückungen im XML-Baum oder fehlende Bestandteile wie der End-Tag eines Elements. Die Validierung erfolgt gegen die Datei diplanung.xsd.
* Bestimmte Zeichen in einer XML müssen encoded werden, damit sie nicht eine besondere Rolle im XML-Syntax erfüllen. Allgemein gibt es 5 Zeichen, die [https://stackoverflow.com/a/1091953 in XML escaped] werden müssen:
** " muss escaped werden als &quot;
** ' muss escaped werden als &apos;
** < muss escaped werden als &lt;
** > muss escaped werden als &gt;
** & muss escaped werden als &amp;

Mehr Details zur Mandanten spezifischen Anpassung von VK + änderbaren Codelisten siehe Abschnitt: [https://wiki.diplanung.de/index.php/Verfahrenskonfiguration_Pro#Mandanten_spezifische_Anpassung_und_Erstellung_von_VK Mandanten spezifische Anpassung und Erstellung von Verfahrenskonfigurationen.]

== Elemente der Verfahrenskonfiguration im Frontend ==
Der folgende Screenshot mit farblichen Beschriftungen und Markierungen zeigt den Reiter Aufgaben im DiPlanCockpit Pro. Darin sind die meisten Elemente der VK zu sehen, die in den folgenden Abschnitten erklärt werden.

Die gelbe Markierung zeigt jeweils exemplarisch ein Element an, der nächstliegende rote Kasten mit Text die Bezeichnung.
[[Datei:ImageVKFrontend.png|zentriert|719x719px|alternativtext=|rahmenlos]]

== Struktur der Verfahrenskonfiguration ==
In den folgenden Abschnitten wird eine beispielhafte VK anhand von Screenshots erläutert. Die Zahlen am linken Rand der Screenshots zeigen die Zeilennummern der XML-Datei. Insgesamt sind es im Beispiel 4836. Um eine kompakte Darstellung zu ermöglichen, sind die Bereiche, die für die jeweilige Erläuterung irrelevant sind, eingeklappt. Das ist an den kleinen blauen Pfeilen rechts von den Zeilennummern zu erkennen. Ein Pfeil nach unten bedeutet, dass der Abschnitt aufgeklappt ist. Ein Pfeil nach rechts hingegen heißt, dass an dieser Stelle noch weitere Zeilen sind, die lediglich nicht angezeigt werden. Die Anzahl der ausgeblendeten Zeilen ist in Klammern angegeben. Die Form der Darstellung ist dem verwendeten Programm geschuldet. Bei der Verwendung anderer Programme kann die visuelle Darstellung der XML abweichen.

== Screenshot mit Überblick der VK ==
'''Hinweis''': Neben dem Code der Verfahrenssteuerung (Zeile 3) ist die Fachdomäne anzugeben, hier "KommunaleBauleitplanung" (fehlt im Screenshot). Die Zeile muss lauten <code><verfahrenssteuerung code="6100" fachdomaene="KommunaleBauleitplanung"></code>[[Datei:ImageVKUeberblick1.png|zentriert|rahmenlos|619x619px]]

=== Erläuterung der Grundstruktur ===
[[Datei:VKRahmen2.png|alternativtext=|zentriert|rahmenlos|418x418px]]
Den äußeren Rahmen bildet die Angabe des Codes für die jeweilige VK. Im dargestellten Beispiel ist dies der Code 6100. Für jeden gewünschten V-Typ ist eine separate Datei mit einem eindeutigen Code erforderlich. Dieser Code MUSS in der Codeliste Code.Verfahrenssteuerung enthalten sein.

Daneben folgt die Angabe der Fachdomäne, hier ist es die "KommunaleBauleitplanung". Andere mögliche Fachdomänen sind "Planfeststellung" und "Raumordnung". Die Fachdomäne steuert unter anderem, [[Editieren der Stammdaten - DiPlanCockpit Pro#Verf.C3.BCgbare%20Stammdaten%20pro%20Fachdom.C3.A4ne|welche Stammdaten]] angezeigt werden.

Unterhalb der Verfahrenssteuerung und einmal eingerückt folgen die Angabe der Veranlasser für die Beteiligung sowie die gewünschten Planarten und Verfahrensarten für die VK. Die Beteiligung ist verpflichten mit einem "StandardVeranlasser" anzugeben. Optional können weitere Veranlasser mit einer Zuständigkeit angegeben werden. Zu beachten sind hierbei zwei Punkte:

# Der Code-Wert aus der Codeliste Zuständigkeit muss mit dem Wert des Attributs zuständigkeit im Element veranlasser in der VK übereinstimmen.
# Der Wert des Elements veranlasser muss mit der Organisations-ID der Organisation in der Beteiligung übereinstimmen. Der Wert lässt sich üblicherweise dem verwendeten ELSTER-Zertifikat entnehmen.

Beim Nachrichtenaustausch mit DiPlanBeteiligung wird geprüft, ob ein spezifisch zur Zuständigkeit passender Veranlasser vorhanden ist. Wenn ja, wird dieser übermittelt, andernfalls der Standard-Veranlasser ohne Zuständigkeit.[[Datei:ImageVKBeteiligungVeranlasser.png|zentriert|rahmenlos|455x455px]]
Die angegebenen Planarten sollten fachlich zum Verfahrenssteuerungstyp passen. Zulässige Kombinationen sind im XRepository in der [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planart Codeliste Planart] aufgeführt. Der Eintrag in der Spalte "Übergeordneter Wert" der Codeliste bezeichnet den passenden Verfahrenssteuerungstyp.
[[Datei:ImageVKZustaendigkeit1.png|zentriert|rahmenlos]]
Optional kann oberhalb der Beteiligung noch die Zuständigkeit angegeben sein. Wenn eine oder mehrere Zuständigkeiten in der VK aufgeführt sind, steht die VK nur für diese zur Verfügung. Andernfalls ist die Nutzung der VK für alle Zuständigkeiten möglich.

An die Verfahrensarten schließen sich allgemeine Angaben zur Zeitplanung an. Anschließend folgt der Hauptteil der VK mit der Auflistung aller Verfahrensschritte. Diese enthalten jeweils Verfahrensteilschritte, Unterverfahrensteilschritte, Aufgaben, Unteraufgaben und schließlich die ActionItems.

Sämtliche ActionItems sind im Detail auf einer eigenen Unterseite beschrieben. Auf dieser Seite folgt eine Erläuterung der übrigen Elemente der VK.

=== Erläuterung der einzelnen Abschnitte ===

==== Zeitplanung ====
[[Datei:ImageVKZeitplanung2.png|zentriert|rahmenlos|744x744px]]
Im Abschnitt zur Zeitplanung wird festgelegt, ob ein Monitoring vorgesehen ist. Im dargestellten Beispiel ist es vorgesehen. Zusätzlich ist angegeben, welche möglichen Arten der Monitoringrelevanz es geben soll und welche Nicht-Monitoring-Gründe.

Außerdem wird im Abschnitt zur Zeitplanung festgelegt, welcher Termin als Prognosestarttermin dienen soll. Von diesem geht die gesamte Zeitplanung aus. Im Beispiel ist es der Termin "Grobabstimmung". Angegeben ist der entsprechende Code "grobabstimmung" aus der Codeliste Code.Sitzungen, alternativ ist auch ein Code aus Code.SonstigeTermin möglich. Zu beachten ist, dass der gewählte Termin mit dem Attribut "prognoserelevant=ja" angelegt werden muss.
{| class="wikitable"
!Name
!Zweck
|-
|monitoring
|Angabe, ob ein Monitoring vorgesehen ist.
|-
|artDerMonitoringRelevanz
|Angabe möglicher Arten der Monitoringrelevanz mit Name und Beschreibung.
|-
|nichtMonitoringGrund
|Angabe von Codes aus der Codeliste Code.NichtMonitoringGrund, die für Verfahren mit dieser Verfahrenskonfiguration zur Verfügung stehen sollen.
|-
|prognosestarttermin
|Definiert den Prognosestarttermin, von dem die Zeitplanung ausgeht. Zu beachten ist, dass der gewählte Termin mit dem Attribut "prognoserelevant=ja" angelegt werden muss.
|}

==== Optional: Fachdomänenspezifische Ordnerstruktur ====
Eine konfigurierbare fachdomänenspezifische Ordnerstruktur zum Hochladen der Dokumente kann durch den Mandanten-Administrator über den Abschnitt <dokumentbibliothek> ergänzt werden. Zurzeit ist diese Ordnerstruktur nur für die Fachdomäne Planfeststellung konfiguriert.
[[Datei:ImageFachdomänenspezifischeOrdner.png|zentriert|rahmenlos|748x748px]]
Erklärung der Felder:
{| class="wikitable"
!Name
!Zweck
|-
|name
|Name bzw. Bezeichnung des Ordners (im Frontend für Nutzende sichtbar), darf nicht leer sein und darf pro Ebene nicht doppelt auftauchen.
|-
|upload
|Gibt an, ob ein Dokumentenupload über den Ordner möglich ist (true) oder nicht (false).
|-
|verfahrensunterlagentyp
|Der standardmäßig automatisch zugeordnete Verfahrensunterlagentyp für alle Dokumente / Dateien im Ordner.
|-
|pflicht
|"ja" bedeutet, dass sich mindestens eine Datei im Ordner befinden muss, was im Rahmen der Vollzähligkeitsprüfung für Vorhabens- und Antragsdokumente der Fachdomäne Planfeststellung überprüft wird. "nein" bedeutet, dass der Ordner leer sein darf und keine Auswirkung auf die Vollzähligkeitsprüfung hat.
|-
|beschreibung
|Textliche Beschreibung der fachlichen Inhalte der Dokumente im Ordner, die für die KI-Prüfung genutzt wird.
|}
Die folgenden Regeln und Einschränkungen müssen beachtet werden:

* Die Ordnerstruktur entspricht einer Baumstruktur (ähnlich wie Windows-Explorer) mit den Ebenen 0 (Wurzel) bis n.
* Die Codeliste der Verfahrensunterlagentypen muss um die für die Ordnerstruktur vorgesehenen Verfahrensunterlagentypen ergänzt und hochgeladen sein, anschließend kann die VK hochgeladen werden.
* Das Attribut verfahrensunterlagentyp darf nicht leer sein und nicht doppelt über die ganze Ordnerstruktur vorkommen.
* Wenn Dokumente innerhalb dieser Ordnerstruktur von einem DiPlan-System (z. B. Vorhaben-Cockpit - Antragsstellung) zu einem andern DiPlan-System (z. B. Behörden-Cockpit - Verfahrens-Verwaltung) übertragen werden, dann muss die Ordnerstruktur in beiden Systemen exakt identisch sein. Dabei muss beachtet werden, dass in den Codelisten die Codewerte für Verfahrensunterlagentypen in beiden Systemen eindeutig sind und keine Widersprüche vorhanden sind.

==== Optional: Mandanten spezifische Stammdaten ====
Optional können oberhalb der Verfahrensschritte zusätzliche Mandanten spezifische Stammdaten angegeben werden. Diese ermöglichen die Gestaltung individueller Eingabefelder für die Stammdatenseite. Sie erscheinen auf der Stammdatenseite oberhalb des Abschnitts zu Parallelverfahren in der Reihenfolge, mit der sie in der Verfahrenskonfiguration aufgeführt sind. Ihre Definition erfolgt beispielsweise in der Form <code><eigenschaft label="Beispiel eines Mandanten spezifischen Feldes zur Eingabe von Text" name="Beispiel6200Text" typ="TEXT" subtyp="SINGLE" pflicht="nein"/></code>.

Erklärung der Felder:
{| class="wikitable"
!Name
!Zweck
|-
|label
|Wird als Beschriftung des Feldes angezeigt, kann frei gewählt werden.
|-
|name
|Technischer Name, muss eindeutig sein, sprich darf nur einmal verwendet werden.
|-
|typ
|Gibt den Datentyp an. Zulässige Werte sind: TEXT (Freitextfeld mit max. 255 Zeichen), FLOAT (Zahlenfeld für Gleitkommazahlen), INTEGER (Zahlenfeld für ganze Zahlen), BOOLEAN (Checkbox), DATE (Datumsfeld), TIME (Zeitangabe), DATE_TIME (Datums- und Zeitangabe), DATE_TIME_RANGE (Zeitspanne), URL (Link), CODELIST (Dropdown-Auswahl, Inhalte kommen aus einer Codeliste), DROPDOWN (Dropdown-Auswahl, Optionen individuell festgelegt ohne Codeliste)
|-
|subtyp
|Muss für alle Typen außer CODELIST und DROPDOWN den Wert SINGLE haben. Bei CODELIST bzw. DROPDOWN ermöglicht SINGLE die Auswahl genau eines Wertes aus dem Dropdown, bei LIST können mehrere ausgewählt werden (Multiselect).
|-
|pflicht
|Gibt an, ob das Feld verpflichtend ist (ja oder nein).
|-
|codelistName
|Nur erforderlich bei Typ CODELIST. Der Wert muss dann lauten: "Code." + Name der Codeliste, z.B. "Code.Zustaendigkeit".
|-
|option
|Nur erforderlich bei Typ DROPDOWN. Einmal bis beliebig oft mit je einem Eintrag für das Dropdown einfügen.
|}

==== Verfahrensschritt ====
[[Datei:ImageVKVS.png|links|488x488px|alternativtext=|rahmenlos]]
Ein Verfahrensschritt ist die oberste Ebene in der Unterteilung eines Verfahrens in mehrere Abschnitte. Er wird durch die Angabe des Codes aus Code.Verfahrensschritte bestimmt. Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen. Aktuell werden Durchgänge auf Ebene der Verfahrensschritte durch das Cockpit nicht unterstützt, sodass die Angabe von "ja" keinen Effekt hat.

Jeder Verfahrensschritt enthält beliebig viele Verfahrensteilschritte. Es ist möglich keinen Verfahrensteilschritt anzugeben, dann wird der Verfahrensschritt jedoch nicht im Cockpit sichtbar.

Die Reihenfolge der Verschachtelung (Verfahrensschritt > Verfahrensteilschritt > Unterverfahrensteilschritt) muss eingehalten werden. In einen Verfahrensschritt direkt einen Unterverfahrensteilschritt einzufügen ist nicht zulässig. Ebenso wenig ist es zulässig, innerhalb eines Verfahrensteilschritts oder einer tieferen Ebene, Verfahrensschritte zu ergänzen.

Damit die Verfahrensschritte in der richtigen Reihenfolge dargestellt werden, ist es notwendig ihre Codes in alphabetischer/numerischer Reihenfolge zu vergeben, also beispielsweise "0001VerfahrensschrittEins", "0002Verfahrensschritt2" usw.
{| class="wikitable"
!Name
!Zweck
|-
|verfahrensteilschritt
|Angabe eines untergeordneten Verfahrensteilschritts.
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein". Im Cockpit werden Durchgänge für Verfahrensschritte nicht unterstützt.
|}
Eine Besonderheit ist der Verfahrensschritt 9998. Dieser ist obligatorisch mitsamt des Verfahrensteilschritts 9998. Darin können Termine aufgeführt sein, die Eingaben auf der Stammdatenseite referenzieren.

Die mit der Stammdatenseite verknüpften Termine sind für die kommunale Bauleitplanung 0100 (Beschlussdatum), 0200 (Vorweggenehmigung bzw. Planreife gemäß §33 BauGB) und 9300 (Aufhebungsdatum). Der Termin 9300 muss zudem die beiden Eigenschaften "linkPlanzeichnung" und "linkBegruendung" des Typs URL haben.

Für die Fachdomäne Raumordnung sind es die Termine pflicht_9400 (Tag des Inkrafttretens) und pflicht_9450 (Tag des Außerkrafttretens). Diese Termine müssen im VS 9998 angegeben werden, wenn sie nicht bereits in einem vorherigen Verfahrensschritt definiert sind.

Wichtig für die Stammdatenseite ist, dass diese Termine in der Verfahrenskonfiguration enthalten sind, aber nicht an welcher Stelle. Der VS 9998 dienst als Option, wenn nicht gewünscht ist, die Termine in den Verfahrensablauf einzubinden.
[[Datei:ImageVS9998 2.png|zentriert|rahmenlos|572x572px]]

==== Verfahrensteilschritt ====
[[Datei:ImageVKVTS.png|601x601px|alternativtext=|zentriert|rahmenlos]]
Verfahrensteilschritte bilden die zweite Ebene in der Strukturierung des Verfahrensablaufs. Sie werden durch die Angabe eines Codes aus Code.Verfahrensteilschritte bestimmt. Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen.

Zu jedem Verfahrensteilschritt können 0 bis beliebig viele Sitzungen und/oder sonstige Termine angegeben werden. Anschließend folgt die Auflistung aller Unterverfahrensteilschritte.
{| class="wikitable"
!Name
!Zweck
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein".
|-
|sitzung
|Sitzung innerhalb des Verfahrensteilschritts.
|-
|sonstigerTermin
|Sonstiger Termin innerhalb des Verfahrensteilschritts.
|-
|unterverfahrensteilschritt
|Angabe eines untergeordneten Unterverfahrensteilschritts.
|}

==== Sitzung ====
[[Datei:ImageVKSitzung.png|links|474x474px|alternativtext=|rahmenlos]]
Sitzungen werden über einen Code aus der Codeliste Code.Sitzungscodes bestimmt. Zu beachten ist, dass die Bezeichnung einer Sitzung maximal 255 Zeichen umfassen darf. Zusätzlich werden mögliche Ergebnisse über die Angabe eines Codes aus Code.Sitzungsergebnistyp festgelegt.

Jede Sitzung enthält die Information, ob sie zeitplanungsrelevant oder nicht zeitplanungsrelevant ist. Bei Relevanz für die Zeitplanung ist ebenfalls anzugeben ob Monitoring- und/oder Prognoserelevanz gewünscht ist. Zusätzlich ist die vorgesehene Wirkung in der Modellberechnung anzugeben. Dies erfolgt über die Verzögerung, Dauer und das Setzen auf Aktiv. Die möglichen Verzögerungsgründe werden hier nicht angegeben, sondern sind je nach V-Typ festgelegt und stammen aus der Codeliste Code.Verzoegerungsgrund.

Für nicht zeitplanungsrelevante Sitzungen ist nur anzugeben, welcher Datumstyp gewünscht ist. Dieser kann ein einzelner Tag (Angabe zeitpunkt), Zeitraum (Angabe zeitraum) oder flexibel (Angabe zeitpunkt_oder_zeitraum) sein.
{| class="wikitable"
!Name
!Zweck
|-
|ergebnistyp
|Codeliste der Ergebnistypen.
|-
|zeitplanungsrelevant oder nichtzeitplanungsrelevant
|Legt Zeitplanungsrelevanz fest.
|-
|monitoringrelevant
|Legt Monitoringrelevanz fest. Angabe "ja" oder "nein".
|-
|prognoserelevant
|Legt Prognoserelevanz fest. Angabe "ja" oder "nein".
|-
|modellberechnung
|Enthält Informationen zur Berechnung in der Zeitplanung.
|-
|verzoegerung
|Bestimmt die Verzögerung. Angabe als ganze Zahl.
|-
|dauer
|Bestimmt die Dauer. Angabe als ganze Zahl.
|-
|aktiv
|(De-)aktiviert den Einfluss auf die Modellberechnung. Angabe "ja" oder "nein".
|-
|datumstyp
|Beschreibt für nicht zeitplanungsrelevante Termine die Art der Datumsangabe. Angabe "zeitpunkt", "zeitraum" oder "zeitpunkt_oder_zeitraum".
|}

==== Sonstiger Termin ====
[[Datei:ImageSonstigeTermine.png|links|rahmenlos|507x507px]]
(Hinweis: Des Screenshot zeigt zwei verschiedene sonstige Termine, um möglichst viele Optionen der Konfiguration abzubilden.)

Sonstige Termine werden über einen Code aus der Codeliste Code.SonstigeTermin bestimmt. Zu beachten ist, dass die Bezeichnung eines sonstigen Termins maximal 255 Zeichen umfassen darf. Zusätzlich wird in der Beschreibung der anzuzeigende Text zu dem sonstigen Termin definiert.

Jeder sonstige Termin enthält die Information, ob er zeitplanungsrelevant oder nicht zeitplanungsrelevant ist. Bei Relevanz für die Zeitplanung ist ebenfalls anzugeben ob Monitoring- und/oder Prognoserelevanz gewünscht ist. Zusätzlich ist die vorgesehene Wirkung in der Modellberechnung anzugeben. Dies erfolgt über die Verzögerung, Dauer und das Setzen auf Aktiv. Die möglichen Verzögerungsgründe werden hier nicht angegeben, sondern sind je nach V-Typ fest vorgegeben.

Für nicht zeitplanungsrelevante sonstige Termine ist nur anzugeben, welcher Datumstyp gewünscht ist. Dieser kann ein einzelner Tag (Angabe zeitpunkt), Zeitraum (Angabe zeitraum) oder flexibel (Angabe zeitpunkt_oder_zeitraum) sein.

Sonstige Termine können außerdem über eine oder mehrere Angaben einer "eigenschaft" verfügen. Es stehen unterschiedliche Datentypen zur Verfügung (siehe Tabelle), mit denen weitere Informationen zu einem Termin angegeben werden können.
{| class="wikitable"
!Name
!Zweck
|-
|beschreibung
|Anzuzeigende Beschreibung des sonstigen Termins.
|-
|zeitplanungsrelevant oder nichtzeitplanungsrelevant
|Legt Zeitplanungsrelevanz fest.
|-
|monitoringrelevant
|Legt Monitoringrelevanz fest. Angabe "ja" oder "nein".
|-
|prognoserelevant
|Legt Prognoserelevanz fest. Angabe "ja" oder "nein".
|-
|modellberechnung
|Enthält Informationen zur Berechnung in der Zeitplanung.
|-
|verzoegerung
|Bestimmt die Verzögerung. Angabe als ganze Zahl.
|-
|dauer
|Bestimmt die Dauer. Angabe als ganze Zahl.
|-
|aktiv
|(De-)aktiviert den Einfluss auf die Modellberechnung. Angabe "ja" oder "nein".
|-
|datumstyp
|Beschreibt für nicht zeitplanungsrelevante Termine die Art der Datumsangabe. Angabe "zeitpunkt", "zeitraum" oder "zeitpunkt_oder_zeitraum".
|-
|eigenschaft
|Beschreibt zusätzliche Informationen zu dem Termin. Umfasst "name", "typ" und optional "codelistName".
|-
|name
|Benennt die "eigenschaft" des Termins. Angabe als String.
|-
|typ
|Beschreibt das Datenformat der "eigenschaft" des Termins. Optionen: "TEXT", "FLOAT", "INTEGER", "BOOLEAN", "DATE", "URL", "CODELIST"
|-
|codelistName
|Benennt die zu referenzierende Codeliste, wenn der "typ" der "eigenschaft" "CODELIST" ist.
|}

==== Unterverfahrensteilschritt ====
[[Datei:ImageVKUVTS.png|links|436x436px|alternativtext=|rahmenlos]]
Unterverfahrensteilschritte bilden die dritte Ebene in der Strukturierung des Verfahrensablaufs. Sie werden durch die Angabe des Codes aus Code.Unterverfahrensteilschritte bestimmt. Die Angabe bei "pflicht" legt fest, ob der Unterverfahrensteilschritt immer aktiviert sein soll (Angabe "ja"), oder ob er optional und manuell aktivierbar sein soll (Angabe "nein"). Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen. Aktuell werden Durchgänge auf Ebene der Unterverfahrensteilschritte durch das Cockpit nicht unterstützt, sodass die Angabe von "ja" keinen Effekt hat.

In jedem Unterverfahrensteilschritt können 0 bis beliebig viele Aufgaben enthalten sein. Unterverfahrensteilschritte werden auch dann dargestellt, wenn sie keine Aufgaben enthalten.
{| class="wikitable"
!Name
!Zweck
|-
|pflicht
|Legt fest, ob der Unterverfahrensteilschritt verpflichten oder optional ist. Angabe "ja" oder "nein".
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein". Im Cockpit werden Durchgänge für Unterverfahrensteilschritte nicht unterstützt.
|-
|aufgabe
|Angabe einer untergeordneten Aufgabe.
|}

==== Aufgabe ====
[[Datei:ImageVKAufgabe.png|zentriert|719x719px|alternativtext=|rahmenlos]]
Aufgaben sind in Unterverfahrensteilschritten enthalten. Pro Unterverfahrensteilschritt sind 0 bis beliebig viele Aufgaben möglich.

Jede Aufgabe benötigt eine eindeutige ID zur Identifikation und eine Beschreibung, die im Cockpit angezeigt wird. Optional kann eine Bedingung angegeben werden, wann die Aufgabe angezeigt werden soll. Im dargestellten Beispiel wird die Aufgabe nur angezeigt, wenn der sonstige Termin "InfoFoeb_Zeitraum" als Eigenschaft den Code 0200 erhalten hat.
{| class="wikitable"
!Name
!Zweck
|-
|id
|Eindeutige ID der Aufgabe.
|-
|bedingung
|Bedingung in Platzhalter-Syntax, wann die Aufgabe angezeigt werden soll.
|-
|beschreibung
|Anzuzeigende Beschreibung der Aufgabe.
|-
|unteraufgabe
|Unteraufgabe der Aufgabe, enthält die ActionItems.
|}
Es können auch Werte von ActionItems in Bedinungen genutzt werden. Dabei sind jedoch nur ActionItems möglich, die im selben Verfahrensteilschritt definiert sind, in dem auch die Aufgabe/Unteraufgabe mit der Bedingung enthalten ist. Zudem muss das ActionItem in der Verfahrenskonfiguration eine refID definiert haben, welche dann genutzt wird um das ActionItem in der Bedingung zu referenzieren.

Beispiele:
{| class="wikitable"
!Beispiel
!Erklärung
|-
|<code>actionItem('ref-checkbox').checked=true</code>
|Das ActionItem vom Typ Checkbox mit der refID <code>ref-checkbox</code> muss angehakt sein, damit die Bedingung zutrifft.
|-
|<code>actionItem('ref-string').value!=someValue</code>
|Das ActionItem vom Typ Text mit der refID <code>ref-string</code> darf nicht den Wert <code>someValue</code> haben, damit die Bedingung zutrifft.
|-
|<code>actionItem('ref-dropdown').valueSelected=someValue</code>
|Das ActionItem vom Typ Dropdown mit der refID <code>ref-dropdown</code> muss den Wert <code>someValue</code> ausgewählt haben, damit die Bedingung zutrifft.
|}

==== Unteraufgabe ====
[[Datei:ImageVKUnteraufgabe.png|zentriert|531x531px|alternativtext=|rahmenlos]]
Unteraufgaben sind in beliebiger Anzahl in Aufgaben enthalten und umfassen beliebig viele ActionItems. ActionItems sind auf einer eigenen Unterseite beschrieben. Um ein ActionItem einer Aufgabe hinzuzufügen, muss eine Unteraufgabe vorhanden und das ActionItem darin ergänzt werden. Direkt in eine Aufgabe ohne Unteraufgabe ActionItems hinzuzufügen ist nicht möglich.

Analog zu Aufgaben benötigt je Unteraufgabe eine eindeutige ID zur Identifikation und eine Beschreibung, die im Cockpit angezeigt wird. Optional kann auch für Unteraufgaben eine Bedingung angegeben werden, wann sie angezeigt werden soll. Im dargestellten Beispiel wird die Unteraufgabe nur angezeigt, wenn der Hauptbezirk Harburg ist.
{| class="wikitable"
!Name
!Zweck
|-
|id
|Eindeutige ID der Aufgabe.
|-
|bedingung
|Bedingung in Platzhalter-Syntax ob die Unteraufgabe angezeigt werden soll.
|-
|beschreibung
|Anzuzeigende Beschreibung der Aufgabe.
|-
|Auflistung der ActionItems
|Liste der ActionItems.
|}

Verfahrenskonfiguration

2026-03-24T13:37:41Z

Diplanung: /* Optional: Mandanten spezifische Stammdaten */

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

Mit einer Verfahrenskonfiguration wird festgelegt, wie ein Verfahren aufgebaut ist. Anhand eines Beispiels wird im Folgenden die Struktur einer Verfahrenskonfiguration beschrieben.

== Gesamtansicht des Beispiels ==
[[Datei:ImageVKBasis2neu.png|zentriert|rahmenlos|590x590px]]

=== Erläuterung der einzelnen Abschnitte ===
Im Folgenden sind die einzelnen Abschnitte des Screenshots beschrieben. Die Zeilenangabe bezieht sich auf die im Screenshot sichtbare Zeilennummerierung auf der linken Seite.

==== Zeilen 2-4 ====
Abschnitt mit Metadaten zur VK

==== Verfahrenssteuerung (Zeile 5) ====
Es können beliebig viele Verfahrenssteuerungstypen angelegt werden, eine je Verfahrenskonfiguration. Im DiPlanCockpit Basis sind zur Konfiguration nur Plan- und Verfahrensarten anzugeben bzw. relevant.

Jeder Verfahrenssteuerungstyp wird selbst unter einer eigenständigen Bezeichnung mit einem Code definiert. Der Code referenziert auf einen Eintrag der Codeliste Code.Verfahrenssteuerung. Wenn man einen neuen Verfahrenssteuerungstyp verwenden möchte, dann benötigt man dafür eine neue Verfahrenskonfiguration und die Codeliste Code.Verfahrenssteuerung muss um den Code erweitert werden.

Neben dem Code der Verfahrenssteuerung ist die Fachdomäne anzugeben, hier "KommunaleBauleitplanung". Andere mögliche Fachdomänen sind "Planfeststellung" und "Raumordnung". Die Fachdomäne steuert unter anderem, [[Editieren der Stammdaten#Verf.C3.BCgbare%20Stammdaten%20pro%20Fachdom.C3.A4ne|welche Stammdaten]] angezeigt werden.

==== Optional: Zuständigkeit (nicht abgebildet) ====
Die Angabe einer oder mehrerer Zuständigkeiten schränkt die Verfügbarkeit der VK ein. Sie steht dann nur für die aufgeführten Zuständigkeiten zur Auswahl. Wenn keine Zuständigkeit in der VK genannt ist, dann ist sie für alle verfügbar.

==== Planarten (Zeilen 6-9) ====
Hier erfolgt die Angabe der gültigen Planarten für diesen Verfahrenssteuerungstyp. Dafür werden beliebig viele Einträge aus der Codeliste Code.Planart referenziert. Die angegebenen Planarten sollten fachlich zum Verfahrenssteuerungstyp passen. Zulässige Kombinationen sind im XRepository in der [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planart Codeliste Planart] aufgeführt. Der Eintrag in der Spalte "Übergeordneter Wert" der Codeliste bezeichnet den passenden Verfahrenssteuerungstyp.

==== Verfahrensarten (Zeilen 10-11) ====
Hier sind die gültigen Verfahrensarten für diesen Verfahrenssteuerungstyp angegeben. Dafür werden beliebig viele Einträge aus der Codeliste Code.Verfahrensart referenziert. Auch hier gilt, soll eine neue Verfahrensart verwendet werden, so ist sie hier in der Verfahrenskonfiguration anzugeben und die Codeliste Code.Verfahrensart um den Code zu erweitern.
====Optional: Fachdomänenspezifische Ordnerstruktur====
Eine konfigurierbare fachdomänenspezifische Ordnerstruktur zum Hochladen der Dokumente kann durch den Mandanten-Administrator über den Abschnitt <dokumentbibliothek> ergänzt werden. Zurzeit ist diese Ordnerstruktur nur für die Fachdomäne Planfeststellung konfiguriert.[[Datei:ImageFachdomänenspezifischeOrdner.png|zentriert|rahmenlos|748x748px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageFachdom%C3%A4nenspezifischeOrdner.png]]Erklärung der Felder:
{| class="wikitable"
!Name
!Zweck
|-
|name
|Name bzw. Bezeichnung des Ordners (im Frontend für Nutzende sichtbar), darf nicht leer sein und darf pro Ebene nicht doppelt auftauchen.
|-
|upload
|Gibt an, ob ein Dokumentenupload über den Ordner möglich ist (true) oder nicht (false).
|-
|verfahrensunterlagentyp
|Der standardmäßig automatisch zugeordnete Verfahrensunterlagentyp für alle Dokumente / Dateien im Ordner.
|-
|pflicht
|"ja" bedeutet, dass sich mindestens eine Datei im Ordner befinden muss, was im Rahmen der Vollzähligkeitsprüfung für Vorhabens- und Antragsdokumente der Fachdomäne Planfeststellung überprüft wird. "nein" bedeutet, dass der Ordner leer sein darf und keine Auswirkung auf die Vollzähligkeitsprüfung hat.
|-
|beschreibung
|Textliche Beschreibung der fachlichen Inhalte der Dokumente im Ordner, die für die KI-Prüfung genutzt wird.
|}Die folgenden Regeln und Einschränkungen müssen beachtet werden:
*Die Ordnerstruktur entspricht einer Baumstruktur (ähnlich wie Windows-Explorer) mit den Ebenen 0 (Wurzel) bis n.
*Die Codeliste der Verfahrensunterlagentypen muss um die für die Ordnerstruktur vorgesehenen Verfahrensunterlagentypen ergänzt und hochgeladen sein, anschließend kann die VK hochgeladen werden.
*Das Attribut verfahrensunterlagentyp darf nicht leer sein und nicht doppelt über die ganze Ordnerstruktur vorkommen.
*Wenn Dokumente innerhalb dieser Ordnerstruktur von einem DiPlan-System (z. B. Vorhaben-Cockpit - Antragsstellung) zu einem andern DiPlan-System (z. B. Behörden-Cockpit - Verfahrens-Verwaltung) übertragen werden, dann muss die Ordnerstruktur in beiden Systemen exakt identisch sein. Dabei muss beachtet werden, dass in den Codelisten die Codewerte für Verfahrensunterlagentypen in beiden Systemen eindeutig sind und keine Widersprüche vorhanden sind.
==== Optional: Mandanten spezifische Stammdaten ====
Optional können oberhalb der Verfahrensschritte zusätzliche Mandanten spezifische Stammdaten angegeben werden. Diese ermöglichen die Gestaltung individueller Eingabefelder für die Stammdatenseite. Sie erscheinen auf der Stammdatenseite oberhalb des Abschnitts zu Parallelverfahren in der Reihenfolge, mit der sie in der Verfahrenskonfiguration aufgeführt sind. Ihre Definition erfolgt beispielsweise in der Form <code><eigenschaft label="Beispiel eines Mandanten spezifischen Feldes zur Eingabe von Text" name="Beispiel6200Text" typ="TEXT" subtyp="SINGLE" pflicht="nein"/></code>.

Erklärung der Felder:
{| class="wikitable"
!Name
!Zweck
|-
|label
|Wird als Beschriftung des Feldes angezeigt, kann frei gewählt werden.
|-
|name
|Technischer Name, muss eindeutig sein, sprich darf nur einmal verwendet werden.
|-
|typ
|Gibt den Datentyp an. Zulässige Werte sind: TEXT (Freitextfeld mit max. 255 Zeichen), FLOAT (Zahlenfeld für Gleitkommazahlen), INTEGER (Zahlenfeld für ganze Zahlen), BOOLEAN (Checkbox), DATE (Datumsfeld), TIME (Zeitangabe), DATE_TIME (Datums- und Zeitangabe), DATE_TIME_RANGE (Zeitspanne), URL (Link), CODELIST (Dropdown-Auswahl, Inhalte kommen aus einer Codeliste), DROPDOWN (Dropdown-Auswahl, Optionen individuell festgelegt ohne Codeliste)
|-
|subtyp
|Muss für alle Typen außer CODELIST und DROPDOWN den Wert SINGLE haben. Bei CODELIST bzw. DROPDOWN ermöglicht SINGLE die Auswahl genau eines Wertes aus dem Dropdown, bei LIST können mehrere ausgewählt werden (Multiselect).
|-
|pflicht
|Gibt an, ob das Feld verpflichtend ist (ja oder nein).
|-
|codelistName
|Nur erforderlich bei Typ CODELIST. Der Wert muss dann lauten: "Code." + Name der Codeliste, z.B. "Code.Zustaendigkeit".
|-
|option
|Nur erforderlich bei Typ DROPDOWN. Einmal bis beliebig oft mit je einem Eintrag für das Dropdown einfügen.
|}

==== Verfahrensschritt (Zeile 12-32) ====
Für das DiPlanCockpit Basis ist aus Kompatibilitätsgründen zum DiPlanCockpit Pro lediglich der der VS „9998“ obligatorisch anzugeben, insbesondere um Termine der Stammdatenseite eintragen und speichern zu können. Die mit der Stammdatenseite verknüpften Termine sind für die kommunale Bauleitplanung 0100 (Beschlussdatum), 0200 (Vorweggenehmigung bzw. Planreife gemäß §33 BauGB) und 9300 (Aufhebungsdatum). Der Termin 9300 muss zudem die beiden Eigenschaften "linkPlanzeichnung" und "linkBegruendung" des Typs URL haben.

Für die Fachdomäne Raumordnung sind die Termine pflicht_9400 (Tag des Inkrafttretens) und pflicht_9450 (Tag des Außerkrafttretens) verpflichtend anzugeben.

Weitere Verfahrensschritte können angegeben werden. Sie stehen dann auf der Stammdatenseite zur Angabe des aktuellen Verfahrensschritts zur Auswahl.

== Mandanten spezifische Anpassung als Schritt-Anleitung ==
=== 1. Schritt: Konzeption ===
Sichten der 3 vorhandenen Codelisten

* Verfahrenssteuerung (entspricht dem Verfahrenstyp)
* Planart
* Verfahrensart

Auswahl und Dokumentation der individuell passenden Optionen.

Wenn keine Anpassung der änderbaren Codelisten (Verfahrenssteuerung und Verfahrensart) anliegt, geht es mit dem 2. Schritt weiter. Wenn Codelisten angepasst werden sollen, erfolgt dies zuerst nach der [https://wiki.diplanung.de/index.php/Codelisten#Mandanten_spezifischen_Anpassung_als_Schritt-Anleitung Schritt-Anleitung für Codelisten]. Erst danach steht der 2. Schritt dieser Anleitung an.

=== 2. Schritt: Anpassen der Verfahrenskonfiguration ===
Das Beispiel im obigen Screenshot dient als Kopiervorlage, die 1..n-fach vervielfältigt und angepasst werden kann. Im Code finden sich Kommentare, die die Dokumentation ergänzen.

'''Hinweis:''' Es ist sinnvoll, für die Anpassung ein IDE Tool zu verwenden wie Visual Studio Code oder IntelliJ, um den Code im Hintergrund laufend validieren zu lassen. (IDE = Integrierte Entwicklungsumgebung). Die Prüfung der Formatierung lässt sich per „Shift + Alt + L“ anstoßen.

Die Verfahrenssteuerung wird über ihren Code angegeben und bildet das Element auf der obersten Ebene. Darin werden die zugehörigen Planarten und Verfahrensarten aufgeführt. Es können beliebig viele verschiedene Plan- und Verfahrensarten sein. Sie werden jeweils einzeln ebenfalls über ihren Code angegeben. Die Codes müssen in der jeweiligen Codeliste vorhanden sein.

Auf die Verfahrensart folgt der Abschnitt zur Zeitplanung. Im DiPlanCockpit BASIS steht die Zeitplanung nicht zur Verfügung. Deswegen entfällt dieser Abschnitt inklusive des Monitoring für BASIS und ist entsprechend nicht in der dargestellten VK enthalten.

Es folgt in BASIS direkt auf die Verfahrensart eine Auflistung der Verfahrensschritte (VS) für den definierten Verfahrenstyp. Jeder VS wird dabei wieder einzeln über seinen Code aufgeführt, der in der Codeliste Code.Verfahrensschritt enthalten sein muss. Im Cockpit Basis stehen keine Aufgaben zur Verfügung. Durchgänge von VS sind nur in Zusammenhang mit Aufgaben zu bearbeiten, deswegen erfolgt im DiPlanCockpit BASIS für jeden Verfahrensschritt die Angabe durchgaenge=“nein“: Das heißt, es sind keine Durchgänge vorgesehen.

Der VS „9998“ ist verpflichtend, um Termine auf der Stammdatenseite hinterlegen zu können. Dies trifft auch auf den darunter stehenden Verfahrensteilschritt (VTS) „9998“ mitsamt darunter liegenden Termine zu.

Das vorliegende Element zur Verfahrenssteuerung kann beliebig häufig kopiert und angepasst werden, so dass sich pro Verfahrenstyp individuelle Konfigurationen vornehmen lassen.

=== 3. Schritt: Hochladen ins DiPlanCockpit ===
Das Hochladen der angepassten Verfahrenskonfiguration erfolgt im Admin-Bereich im Reiter Konfiguration, den Nutzer mit der Rolle M-A-Basis aufrufen können.

== Ergänzung ==
Für die änderbaren Codelisten

* Code.Verfahrensschritt
* Code.Verfahrensteilschritt

sind die Codes „9998“ Pflicht-Einträge, um Termine auf der Stammdatenseite eintragen und speichern zu können. Daher müssen sie auch bei einer Mandanten spezifischen Anpassung erhalten bleiben. Hier der passende Code-Schnipsel aus Code.Verfahrensschritt:
[[Datei:9998VS.png|zentriert|rahmenlos|322x322px]]

Weitere Infos finden sich in der [https://wiki.diplanung.de/index.php/Codelisten#Mandanten_spezifischen_Anpassung_als_Schritt-Anleitung Schritt-Anleitung zur Anpassung von änderbaren Codelisten].

Verfahrenskonfiguration Pro

2026-03-24T12:35:46Z

Diplanung: /* Optional: Mandanten spezifische Stammdaten */

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

Die Verfahrenskonfiguration, kurz VK, ist das zentrale Element in der Konfiguration. Über Verfahrenskonfigurationen wird je nach Verfahrenssteuerungstyp (kurz V-Typ) der Ablauf des Verfahrens festgelegt. Das heißt, die VK bestimmt den Ablauf des Verfahrens und die vorgesehenen Aufgaben innerhalb eines Verfahrens. Außerdem enthält sie grundlegende Einstellungen zur Zeitplanung.

Es ist eine Default-Stellung für die kommunale Bauleitplanung verfügbar, die Mandanten spezifisch angepasst werden kann. Es lassen sich beliebig viele unterschiedliche VKs konfigurieren, die für jeden V-Typ eigene Abläufe definieren.

== Tab Verfahrenskonfiguration ==
Im Tab Verfahrenskonfiguration sind die verfügbaren Verfahrenskonfigurationen aufgelistet. Sie lassen sich nach Name, Status, Verwendung, Aktualisierungsdatum und bearbeitender Person filtern. Das Herunterladen erfolgt wahlweise einzeln als XML für eine Verfahrenskonfiguration oder für alle zusammen in Form einer ZIP-Datei.

Eine Verfahrenskonfiguration kann angepasst und bzw. neu erstellt und anschließend über das dafür vorgesehene Feld hochgeladen werden. Eine neu hochgeladene Verfahrenskonfiguration gilt für alle danach neu angelegten Verfahren, bereits vorhandene Verfahren werden nicht verändert.

Es ist ebenfalls möglich Verfahrenskonfigurationen zu löschen. Das erfolgt in zwei Schritten. Zuerst wird eine Verfahrenskonfiguration per Klick auf "Löschen" im Drei-Punkte-Menü als gelöscht markiert. Anschließend kann sie wiederhergestellt oder endgültig gelöscht werden. Für die endgültige Löschung ist Voraussetzung, dass die Verfahrenskonfiguration nicht mehr in Verwendung ist. Gegebenenfalls sind deswegen zuerst die Verfahren zu löschen, die die Verfahrenskonfiguration noch verwenden. Die betreffenden Verfahren werden per Klick auf die Werte in der Spalte "in Verwendung" angezeigt.

== Wichtige Hinweise ==
Jede VK bezieht sich auf Codelisten - sowohl feste als auch (vom Mandanten) änderbare Codelisten. Um Fehler zu vermeiden, muss sichergestellt werden, dass VK und änderbare Codelisten stets auf dem gleichen Stand sind. Das bedeutet:

* Anpassungen in einer VK können Konsequenzen auf änderbare Codelisten haben. = Anpassungen IMMER für VK und änderbare Codelisten umsetzen.
* Entfernung von Codes in änderbaren Codelisten müssen mit Umsicht vorgenommen und mögliche Auswirkungen auf VK(s) geprüft und bei Bedarf umgesetzt werden.
* Einfacher ist es, Einträge / Codes in änderbaren Codelisten ergänzend vorzunehmen, also den Bestand um neue Einträge zu ergänzen.
* Beim Hochladen ist die Reihenfolge wichtig: Angepasste, änderbare Codelisten müssen zuerst hochgeladen werden. Danach folgt die angepasste VK. Wird die Reihenfolge nicht eingehalten, kann es zur Fehlermeldung kommen.
* Für die Änderung von VK und Codelisten empfiehlt sich der Einsatz eines professionellen XLM-Tools, das Validierungs-Funktionen bietet. Diese laufen i.d.R. im Hintergrund ab und zeigen optisch Fehler an, wie falsche Einrückungen im XML-Baum oder fehlende Bestandteile wie der End-Tag eines Elements. Die Validierung erfolgt gegen die Datei diplanung.xsd.
* Bestimmte Zeichen in einer XML müssen encoded werden, damit sie nicht eine besondere Rolle im XML-Syntax erfüllen. Allgemein gibt es 5 Zeichen, die [https://stackoverflow.com/a/1091953 in XML escaped] werden müssen:
** " muss escaped werden als &quot;
** ' muss escaped werden als &apos;
** < muss escaped werden als &lt;
** > muss escaped werden als &gt;
** & muss escaped werden als &amp;

Mehr Details zur Mandanten spezifischen Anpassung von VK + änderbaren Codelisten siehe Abschnitt: [https://wiki.diplanung.de/index.php/Verfahrenskonfiguration_Pro#Mandanten_spezifische_Anpassung_und_Erstellung_von_VK Mandanten spezifische Anpassung und Erstellung von Verfahrenskonfigurationen.]

== Elemente der Verfahrenskonfiguration im Frontend ==
Der folgende Screenshot mit farblichen Beschriftungen und Markierungen zeigt den Reiter Aufgaben im DiPlanCockpit Pro. Darin sind die meisten Elemente der VK zu sehen, die in den folgenden Abschnitten erklärt werden.

Die gelbe Markierung zeigt jeweils exemplarisch ein Element an, der nächstliegende rote Kasten mit Text die Bezeichnung.
[[Datei:ImageVKFrontend.png|zentriert|719x719px|alternativtext=|rahmenlos]]

== Struktur der Verfahrenskonfiguration ==
In den folgenden Abschnitten wird eine beispielhafte VK anhand von Screenshots erläutert. Die Zahlen am linken Rand der Screenshots zeigen die Zeilennummern der XML-Datei. Insgesamt sind es im Beispiel 4836. Um eine kompakte Darstellung zu ermöglichen, sind die Bereiche, die für die jeweilige Erläuterung irrelevant sind, eingeklappt. Das ist an den kleinen blauen Pfeilen rechts von den Zeilennummern zu erkennen. Ein Pfeil nach unten bedeutet, dass der Abschnitt aufgeklappt ist. Ein Pfeil nach rechts hingegen heißt, dass an dieser Stelle noch weitere Zeilen sind, die lediglich nicht angezeigt werden. Die Anzahl der ausgeblendeten Zeilen ist in Klammern angegeben. Die Form der Darstellung ist dem verwendeten Programm geschuldet. Bei der Verwendung anderer Programme kann die visuelle Darstellung der XML abweichen.

== Screenshot mit Überblick der VK ==
'''Hinweis''': Neben dem Code der Verfahrenssteuerung (Zeile 3) ist die Fachdomäne anzugeben, hier "KommunaleBauleitplanung" (fehlt im Screenshot). Die Zeile muss lauten <code><verfahrenssteuerung code="6100" fachdomaene="KommunaleBauleitplanung"></code>[[Datei:ImageVKUeberblick1.png|zentriert|rahmenlos|619x619px]]

=== Erläuterung der Grundstruktur ===
[[Datei:VKRahmen2.png|alternativtext=|zentriert|rahmenlos|418x418px]]
Den äußeren Rahmen bildet die Angabe des Codes für die jeweilige VK. Im dargestellten Beispiel ist dies der Code 6100. Für jeden gewünschten V-Typ ist eine separate Datei mit einem eindeutigen Code erforderlich. Dieser Code MUSS in der Codeliste Code.Verfahrenssteuerung enthalten sein.

Daneben folgt die Angabe der Fachdomäne, hier ist es die "KommunaleBauleitplanung". Andere mögliche Fachdomänen sind "Planfeststellung" und "Raumordnung". Die Fachdomäne steuert unter anderem, [[Editieren der Stammdaten - DiPlanCockpit Pro#Verf.C3.BCgbare%20Stammdaten%20pro%20Fachdom.C3.A4ne|welche Stammdaten]] angezeigt werden.

Unterhalb der Verfahrenssteuerung und einmal eingerückt folgen die Angabe der Veranlasser für die Beteiligung sowie die gewünschten Planarten und Verfahrensarten für die VK. Die Beteiligung ist verpflichten mit einem "StandardVeranlasser" anzugeben. Optional können weitere Veranlasser mit einer Zuständigkeit angegeben werden. Zu beachten sind hierbei zwei Punkte:

# Der Code-Wert aus der Codeliste Zuständigkeit muss mit dem Wert des Attributs zuständigkeit im Element veranlasser in der VK übereinstimmen.
# Der Wert des Elements veranlasser muss mit der Organisations-ID der Organisation in der Beteiligung übereinstimmen. Der Wert lässt sich üblicherweise dem verwendeten ELSTER-Zertifikat entnehmen.

Beim Nachrichtenaustausch mit DiPlanBeteiligung wird geprüft, ob ein spezifisch zur Zuständigkeit passender Veranlasser vorhanden ist. Wenn ja, wird dieser übermittelt, andernfalls der Standard-Veranlasser ohne Zuständigkeit.[[Datei:ImageVKBeteiligungVeranlasser.png|zentriert|rahmenlos|455x455px]]
Die angegebenen Planarten sollten fachlich zum Verfahrenssteuerungstyp passen. Zulässige Kombinationen sind im XRepository in der [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planart Codeliste Planart] aufgeführt. Der Eintrag in der Spalte "Übergeordneter Wert" der Codeliste bezeichnet den passenden Verfahrenssteuerungstyp.
[[Datei:ImageVKZustaendigkeit1.png|zentriert|rahmenlos]]
Optional kann oberhalb der Beteiligung noch die Zuständigkeit angegeben sein. Wenn eine oder mehrere Zuständigkeiten in der VK aufgeführt sind, steht die VK nur für diese zur Verfügung. Andernfalls ist die Nutzung der VK für alle Zuständigkeiten möglich.

An die Verfahrensarten schließen sich allgemeine Angaben zur Zeitplanung an. Anschließend folgt der Hauptteil der VK mit der Auflistung aller Verfahrensschritte. Diese enthalten jeweils Verfahrensteilschritte, Unterverfahrensteilschritte, Aufgaben, Unteraufgaben und schließlich die ActionItems.

Sämtliche ActionItems sind im Detail auf einer eigenen Unterseite beschrieben. Auf dieser Seite folgt eine Erläuterung der übrigen Elemente der VK.

=== Erläuterung der einzelnen Abschnitte ===

==== Zeitplanung ====
[[Datei:ImageVKZeitplanung2.png|zentriert|rahmenlos|744x744px]]
Im Abschnitt zur Zeitplanung wird festgelegt, ob ein Monitoring vorgesehen ist. Im dargestellten Beispiel ist es vorgesehen. Zusätzlich ist angegeben, welche möglichen Arten der Monitoringrelevanz es geben soll und welche Nicht-Monitoring-Gründe.

Außerdem wird im Abschnitt zur Zeitplanung festgelegt, welcher Termin als Prognosestarttermin dienen soll. Von diesem geht die gesamte Zeitplanung aus. Im Beispiel ist es der Termin "Grobabstimmung". Angegeben ist der entsprechende Code "grobabstimmung" aus der Codeliste Code.Sitzungen, alternativ ist auch ein Code aus Code.SonstigeTermin möglich. Zu beachten ist, dass der gewählte Termin mit dem Attribut "prognoserelevant=ja" angelegt werden muss.
{| class="wikitable"
!Name
!Zweck
|-
|monitoring
|Angabe, ob ein Monitoring vorgesehen ist.
|-
|artDerMonitoringRelevanz
|Angabe möglicher Arten der Monitoringrelevanz mit Name und Beschreibung.
|-
|nichtMonitoringGrund
|Angabe von Codes aus der Codeliste Code.NichtMonitoringGrund, die für Verfahren mit dieser Verfahrenskonfiguration zur Verfügung stehen sollen.
|-
|prognosestarttermin
|Definiert den Prognosestarttermin, von dem die Zeitplanung ausgeht. Zu beachten ist, dass der gewählte Termin mit dem Attribut "prognoserelevant=ja" angelegt werden muss.
|}

==== Optional: Fachdomänenspezifische Ordnerstruktur ====
Eine konfigurierbare fachdomänenspezifische Ordnerstruktur zum Hochladen der Dokumente kann durch den Mandanten-Administrator über den Abschnitt <dokumentbibliothek> ergänzt werden. Zurzeit ist diese Ordnerstruktur nur für die Fachdomäne Planfeststellung konfiguriert.
[[Datei:ImageFachdomänenspezifischeOrdner.png|zentriert|rahmenlos|748x748px]]
Erklärung der Felder:
{| class="wikitable"
!Name
!Zweck
|-
|name
|Name bzw. Bezeichnung des Ordners (im Frontend für Nutzende sichtbar), darf nicht leer sein und darf pro Ebene nicht doppelt auftauchen.
|-
|upload
|Gibt an, ob ein Dokumentenupload über den Ordner möglich ist (true) oder nicht (false).
|-
|verfahrensunterlagentyp
|Der standardmäßig automatisch zugeordnete Verfahrensunterlagentyp für alle Dokumente / Dateien im Ordner.
|-
|pflicht
|"ja" bedeutet, dass sich mindestens eine Datei im Ordner befinden muss, was im Rahmen der Vollzähligkeitsprüfung für Vorhabens- und Antragsdokumente der Fachdomäne Planfeststellung überprüft wird. "nein" bedeutet, dass der Ordner leer sein darf und keine Auswirkung auf die Vollzähligkeitsprüfung hat.
|-
|beschreibung
|Textliche Beschreibung der fachlichen Inhalte der Dokumente im Ordner, die für die KI-Prüfung genutzt wird.
|}
Die folgenden Regeln und Einschränkungen müssen beachtet werden:

* Die Ordnerstruktur entspricht einer Baumstruktur (ähnlich wie Windows-Explorer) mit den Ebenen 0 (Wurzel) bis n.
* Die Codeliste der Verfahrensunterlagentypen muss um die für die Ordnerstruktur vorgesehenen Verfahrensunterlagentypen ergänzt und hochgeladen sein, anschließend kann die VK hochgeladen werden.
* Das Attribut verfahrensunterlagentyp darf nicht leer sein und nicht doppelt über die ganze Ordnerstruktur vorkommen.
* Wenn Dokumente innerhalb dieser Ordnerstruktur von einem DiPlan-System (z. B. Vorhaben-Cockpit - Antragsstellung) zu einem andern DiPlan-System (z. B. Behörden-Cockpit - Verfahrens-Verwaltung) übertragen werden, dann muss die Ordnerstruktur in beiden Systemen exakt identisch sein. Dabei muss beachtet werden, dass in den Codelisten die Codewerte für Verfahrensunterlagentypen in beiden Systemen eindeutig sind und keine Widersprüche vorhanden sind.

==== Optional: Mandanten spezifische Stammdaten ====
Optional können oberhalb der Verfahrensschritte zusätzliche Mandanten spezifische Stammdaten angegeben werden. Diese ermöglichen die Gestaltung individueller Eingabefelder für die Stammdatenseite. Sie erscheinen auf der Stammdatenseite oberhalb des Abschnitts zu Parallelverfahren in der Reihenfolge, mit der sie in der Verfahrenskonfiguration aufgeführt sind. Ihre Definition erfolgt beispielsweise in der Form <code><eigenschaft label="Beispiel eines Mandanten spezifischen Feldes zur Eingabe von Text" name="Beispiel6200Text" typ="TEXT" subtyp="SINGLE" pflicht="nein"/></code>.

Erklärung der Felder:
{| class="wikitable"
!Name
!Zweck
|-
|label
|Wird als Beschriftung des Feldes angezeigt, kann frei gewählt werden.
|-
|name
|Technischer Name, muss eindeutig sein, sprich darf nur einmal verwendet werden.
|-
|typ
|Gibt den Datentyp an. Zulässige Werte sind: TEXT (Freitextfeld mit max. 255 Zeichen), FLOAT (Zahlenfeld für Gleitkommazahlen), INTEGER (Zahlenfeld für ganze Zahlen), BOOLEAN (Checkbox), DATE (Datumsfeld), URL (Link), CODELIST (Dropdown-Auswahl, Inhalte kommen aus einer Codeliste), DROPDOWN (Dropdown-Auswahl, Optionen individuell festgelegt ohne Codeliste)
|-
|subtyp
|Muss für alle Typen außer CODELIST und DROPDOWN den Wert SINGLE haben. Bei CODELIST bzw. DROPDOWN ermöglicht SINGLE die Auswahl genau eines Wertes aus dem Dropdown, bei LIST können mehrere ausgewählt werden (Multiselect).
|-
|pflicht
|Gibt an, ob das Feld verpflichtend ist (ja oder nein).
|-
|codelistName
|Nur erforderlich bei Typ CODELIST. Der Wert muss dann lauten: "Code." + Name der Codeliste, z.B. "Code.Zustaendigkeit".
|-
|option
|Nur erforderlich bei Typ DROPDOWN. Einmal bis beliebig oft mit je einem Eintrag für das Dropdown einfügen.
|}

==== Verfahrensschritt ====
[[Datei:ImageVKVS.png|links|488x488px|alternativtext=|rahmenlos]]
Ein Verfahrensschritt ist die oberste Ebene in der Unterteilung eines Verfahrens in mehrere Abschnitte. Er wird durch die Angabe des Codes aus Code.Verfahrensschritte bestimmt. Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen. Aktuell werden Durchgänge auf Ebene der Verfahrensschritte durch das Cockpit nicht unterstützt, sodass die Angabe von "ja" keinen Effekt hat.

Jeder Verfahrensschritt enthält beliebig viele Verfahrensteilschritte. Es ist möglich keinen Verfahrensteilschritt anzugeben, dann wird der Verfahrensschritt jedoch nicht im Cockpit sichtbar.

Die Reihenfolge der Verschachtelung (Verfahrensschritt > Verfahrensteilschritt > Unterverfahrensteilschritt) muss eingehalten werden. In einen Verfahrensschritt direkt einen Unterverfahrensteilschritt einzufügen ist nicht zulässig. Ebenso wenig ist es zulässig, innerhalb eines Verfahrensteilschritts oder einer tieferen Ebene, Verfahrensschritte zu ergänzen.

Damit die Verfahrensschritte in der richtigen Reihenfolge dargestellt werden, ist es notwendig ihre Codes in alphabetischer/numerischer Reihenfolge zu vergeben, also beispielsweise "0001VerfahrensschrittEins", "0002Verfahrensschritt2" usw.
{| class="wikitable"
!Name
!Zweck
|-
|verfahrensteilschritt
|Angabe eines untergeordneten Verfahrensteilschritts.
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein". Im Cockpit werden Durchgänge für Verfahrensschritte nicht unterstützt.
|}
Eine Besonderheit ist der Verfahrensschritt 9998. Dieser ist obligatorisch mitsamt des Verfahrensteilschritts 9998. Darin können Termine aufgeführt sein, die Eingaben auf der Stammdatenseite referenzieren.

Die mit der Stammdatenseite verknüpften Termine sind für die kommunale Bauleitplanung 0100 (Beschlussdatum), 0200 (Vorweggenehmigung bzw. Planreife gemäß §33 BauGB) und 9300 (Aufhebungsdatum). Der Termin 9300 muss zudem die beiden Eigenschaften "linkPlanzeichnung" und "linkBegruendung" des Typs URL haben.

Für die Fachdomäne Raumordnung sind es die Termine pflicht_9400 (Tag des Inkrafttretens) und pflicht_9450 (Tag des Außerkrafttretens). Diese Termine müssen im VS 9998 angegeben werden, wenn sie nicht bereits in einem vorherigen Verfahrensschritt definiert sind.

Wichtig für die Stammdatenseite ist, dass diese Termine in der Verfahrenskonfiguration enthalten sind, aber nicht an welcher Stelle. Der VS 9998 dienst als Option, wenn nicht gewünscht ist, die Termine in den Verfahrensablauf einzubinden.
[[Datei:ImageVS9998 2.png|zentriert|rahmenlos|572x572px]]

==== Verfahrensteilschritt ====
[[Datei:ImageVKVTS.png|601x601px|alternativtext=|zentriert|rahmenlos]]
Verfahrensteilschritte bilden die zweite Ebene in der Strukturierung des Verfahrensablaufs. Sie werden durch die Angabe eines Codes aus Code.Verfahrensteilschritte bestimmt. Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen.

Zu jedem Verfahrensteilschritt können 0 bis beliebig viele Sitzungen und/oder sonstige Termine angegeben werden. Anschließend folgt die Auflistung aller Unterverfahrensteilschritte.
{| class="wikitable"
!Name
!Zweck
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein".
|-
|sitzung
|Sitzung innerhalb des Verfahrensteilschritts.
|-
|sonstigerTermin
|Sonstiger Termin innerhalb des Verfahrensteilschritts.
|-
|unterverfahrensteilschritt
|Angabe eines untergeordneten Unterverfahrensteilschritts.
|}

==== Sitzung ====
[[Datei:ImageVKSitzung.png|links|474x474px|alternativtext=|rahmenlos]]
Sitzungen werden über einen Code aus der Codeliste Code.Sitzungscodes bestimmt. Zu beachten ist, dass die Bezeichnung einer Sitzung maximal 255 Zeichen umfassen darf. Zusätzlich werden mögliche Ergebnisse über die Angabe eines Codes aus Code.Sitzungsergebnistyp festgelegt.

Jede Sitzung enthält die Information, ob sie zeitplanungsrelevant oder nicht zeitplanungsrelevant ist. Bei Relevanz für die Zeitplanung ist ebenfalls anzugeben ob Monitoring- und/oder Prognoserelevanz gewünscht ist. Zusätzlich ist die vorgesehene Wirkung in der Modellberechnung anzugeben. Dies erfolgt über die Verzögerung, Dauer und das Setzen auf Aktiv. Die möglichen Verzögerungsgründe werden hier nicht angegeben, sondern sind je nach V-Typ festgelegt und stammen aus der Codeliste Code.Verzoegerungsgrund.

Für nicht zeitplanungsrelevante Sitzungen ist nur anzugeben, welcher Datumstyp gewünscht ist. Dieser kann ein einzelner Tag (Angabe zeitpunkt), Zeitraum (Angabe zeitraum) oder flexibel (Angabe zeitpunkt_oder_zeitraum) sein.
{| class="wikitable"
!Name
!Zweck
|-
|ergebnistyp
|Codeliste der Ergebnistypen.
|-
|zeitplanungsrelevant oder nichtzeitplanungsrelevant
|Legt Zeitplanungsrelevanz fest.
|-
|monitoringrelevant
|Legt Monitoringrelevanz fest. Angabe "ja" oder "nein".
|-
|prognoserelevant
|Legt Prognoserelevanz fest. Angabe "ja" oder "nein".
|-
|modellberechnung
|Enthält Informationen zur Berechnung in der Zeitplanung.
|-
|verzoegerung
|Bestimmt die Verzögerung. Angabe als ganze Zahl.
|-
|dauer
|Bestimmt die Dauer. Angabe als ganze Zahl.
|-
|aktiv
|(De-)aktiviert den Einfluss auf die Modellberechnung. Angabe "ja" oder "nein".
|-
|datumstyp
|Beschreibt für nicht zeitplanungsrelevante Termine die Art der Datumsangabe. Angabe "zeitpunkt", "zeitraum" oder "zeitpunkt_oder_zeitraum".
|}

==== Sonstiger Termin ====
[[Datei:ImageSonstigeTermine.png|links|rahmenlos|507x507px]]
(Hinweis: Des Screenshot zeigt zwei verschiedene sonstige Termine, um möglichst viele Optionen der Konfiguration abzubilden.)

Sonstige Termine werden über einen Code aus der Codeliste Code.SonstigeTermin bestimmt. Zu beachten ist, dass die Bezeichnung eines sonstigen Termins maximal 255 Zeichen umfassen darf. Zusätzlich wird in der Beschreibung der anzuzeigende Text zu dem sonstigen Termin definiert.

Jeder sonstige Termin enthält die Information, ob er zeitplanungsrelevant oder nicht zeitplanungsrelevant ist. Bei Relevanz für die Zeitplanung ist ebenfalls anzugeben ob Monitoring- und/oder Prognoserelevanz gewünscht ist. Zusätzlich ist die vorgesehene Wirkung in der Modellberechnung anzugeben. Dies erfolgt über die Verzögerung, Dauer und das Setzen auf Aktiv. Die möglichen Verzögerungsgründe werden hier nicht angegeben, sondern sind je nach V-Typ fest vorgegeben.

Für nicht zeitplanungsrelevante sonstige Termine ist nur anzugeben, welcher Datumstyp gewünscht ist. Dieser kann ein einzelner Tag (Angabe zeitpunkt), Zeitraum (Angabe zeitraum) oder flexibel (Angabe zeitpunkt_oder_zeitraum) sein.

Sonstige Termine können außerdem über eine oder mehrere Angaben einer "eigenschaft" verfügen. Es stehen unterschiedliche Datentypen zur Verfügung (siehe Tabelle), mit denen weitere Informationen zu einem Termin angegeben werden können.
{| class="wikitable"
!Name
!Zweck
|-
|beschreibung
|Anzuzeigende Beschreibung des sonstigen Termins.
|-
|zeitplanungsrelevant oder nichtzeitplanungsrelevant
|Legt Zeitplanungsrelevanz fest.
|-
|monitoringrelevant
|Legt Monitoringrelevanz fest. Angabe "ja" oder "nein".
|-
|prognoserelevant
|Legt Prognoserelevanz fest. Angabe "ja" oder "nein".
|-
|modellberechnung
|Enthält Informationen zur Berechnung in der Zeitplanung.
|-
|verzoegerung
|Bestimmt die Verzögerung. Angabe als ganze Zahl.
|-
|dauer
|Bestimmt die Dauer. Angabe als ganze Zahl.
|-
|aktiv
|(De-)aktiviert den Einfluss auf die Modellberechnung. Angabe "ja" oder "nein".
|-
|datumstyp
|Beschreibt für nicht zeitplanungsrelevante Termine die Art der Datumsangabe. Angabe "zeitpunkt", "zeitraum" oder "zeitpunkt_oder_zeitraum".
|-
|eigenschaft
|Beschreibt zusätzliche Informationen zu dem Termin. Umfasst "name", "typ" und optional "codelistName".
|-
|name
|Benennt die "eigenschaft" des Termins. Angabe als String.
|-
|typ
|Beschreibt das Datenformat der "eigenschaft" des Termins. Optionen: "TEXT", "FLOAT", "INTEGER", "BOOLEAN", "DATE", "URL", "CODELIST"
|-
|codelistName
|Benennt die zu referenzierende Codeliste, wenn der "typ" der "eigenschaft" "CODELIST" ist.
|}

==== Unterverfahrensteilschritt ====
[[Datei:ImageVKUVTS.png|links|436x436px|alternativtext=|rahmenlos]]
Unterverfahrensteilschritte bilden die dritte Ebene in der Strukturierung des Verfahrensablaufs. Sie werden durch die Angabe des Codes aus Code.Unterverfahrensteilschritte bestimmt. Die Angabe bei "pflicht" legt fest, ob der Unterverfahrensteilschritt immer aktiviert sein soll (Angabe "ja"), oder ob er optional und manuell aktivierbar sein soll (Angabe "nein"). Außerdem erfolgt die Angabe, ob mehrere Durchgänge möglich sein sollen. Aktuell werden Durchgänge auf Ebene der Unterverfahrensteilschritte durch das Cockpit nicht unterstützt, sodass die Angabe von "ja" keinen Effekt hat.

In jedem Unterverfahrensteilschritt können 0 bis beliebig viele Aufgaben enthalten sein. Unterverfahrensteilschritte werden auch dann dargestellt, wenn sie keine Aufgaben enthalten.
{| class="wikitable"
!Name
!Zweck
|-
|pflicht
|Legt fest, ob der Unterverfahrensteilschritt verpflichten oder optional ist. Angabe "ja" oder "nein".
|-
|durchgaenge
|Bestimmt ob Durchgänge möglich sein sollen. Angabe "ja" oder "nein". Im Cockpit werden Durchgänge für Unterverfahrensteilschritte nicht unterstützt.
|-
|aufgabe
|Angabe einer untergeordneten Aufgabe.
|}

==== Aufgabe ====
[[Datei:ImageVKAufgabe.png|zentriert|719x719px|alternativtext=|rahmenlos]]
Aufgaben sind in Unterverfahrensteilschritten enthalten. Pro Unterverfahrensteilschritt sind 0 bis beliebig viele Aufgaben möglich.

Jede Aufgabe benötigt eine eindeutige ID zur Identifikation und eine Beschreibung, die im Cockpit angezeigt wird. Optional kann eine Bedingung angegeben werden, wann die Aufgabe angezeigt werden soll. Im dargestellten Beispiel wird die Aufgabe nur angezeigt, wenn der sonstige Termin "InfoFoeb_Zeitraum" als Eigenschaft den Code 0200 erhalten hat.
{| class="wikitable"
!Name
!Zweck
|-
|id
|Eindeutige ID der Aufgabe.
|-
|bedingung
|Bedingung in Platzhalter-Syntax, wann die Aufgabe angezeigt werden soll.
|-
|beschreibung
|Anzuzeigende Beschreibung der Aufgabe.
|-
|unteraufgabe
|Unteraufgabe der Aufgabe, enthält die ActionItems.
|}
Es können auch Werte von ActionItems in Bedinungen genutzt werden. Dabei sind jedoch nur ActionItems möglich, die im selben Verfahrensteilschritt definiert sind, in dem auch die Aufgabe/Unteraufgabe mit der Bedingung enthalten ist. Zudem muss das ActionItem in der Verfahrenskonfiguration eine refID definiert haben, welche dann genutzt wird um das ActionItem in der Bedingung zu referenzieren.

Beispiele:
{| class="wikitable"
!Beispiel
!Erklärung
|-
|<code>actionItem('ref-checkbox').checked=true</code>
|Das ActionItem vom Typ Checkbox mit der refID <code>ref-checkbox</code> muss angehakt sein, damit die Bedingung zutrifft.
|-
|<code>actionItem('ref-string').value!=someValue</code>
|Das ActionItem vom Typ Text mit der refID <code>ref-string</code> darf nicht den Wert <code>someValue</code> haben, damit die Bedingung zutrifft.
|-
|<code>actionItem('ref-dropdown').valueSelected=someValue</code>
|Das ActionItem vom Typ Dropdown mit der refID <code>ref-dropdown</code> muss den Wert <code>someValue</code> ausgewählt haben, damit die Bedingung zutrifft.
|}

==== Unteraufgabe ====
[[Datei:ImageVKUnteraufgabe.png|zentriert|531x531px|alternativtext=|rahmenlos]]
Unteraufgaben sind in beliebiger Anzahl in Aufgaben enthalten und umfassen beliebig viele ActionItems. ActionItems sind auf einer eigenen Unterseite beschrieben. Um ein ActionItem einer Aufgabe hinzuzufügen, muss eine Unteraufgabe vorhanden und das ActionItem darin ergänzt werden. Direkt in eine Aufgabe ohne Unteraufgabe ActionItems hinzuzufügen ist nicht möglich.

Analog zu Aufgaben benötigt je Unteraufgabe eine eindeutige ID zur Identifikation und eine Beschreibung, die im Cockpit angezeigt wird. Optional kann auch für Unteraufgaben eine Bedingung angegeben werden, wann sie angezeigt werden soll. Im dargestellten Beispiel wird die Unteraufgabe nur angezeigt, wenn der Hauptbezirk Harburg ist.
{| class="wikitable"
!Name
!Zweck
|-
|id
|Eindeutige ID der Aufgabe.
|-
|bedingung
|Bedingung in Platzhalter-Syntax ob die Unteraufgabe angezeigt werden soll.
|-
|beschreibung
|Anzuzeigende Beschreibung der Aufgabe.
|-
|Auflistung der ActionItems
|Liste der ActionItems.
|}

Verfahrenskonfiguration

2026-03-24T12:34:58Z

Diplanung:

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

Mit einer Verfahrenskonfiguration wird festgelegt, wie ein Verfahren aufgebaut ist. Anhand eines Beispiels wird im Folgenden die Struktur einer Verfahrenskonfiguration beschrieben.

== Gesamtansicht des Beispiels ==
[[Datei:ImageVKBasis2neu.png|zentriert|rahmenlos|590x590px]]

=== Erläuterung der einzelnen Abschnitte ===
Im Folgenden sind die einzelnen Abschnitte des Screenshots beschrieben. Die Zeilenangabe bezieht sich auf die im Screenshot sichtbare Zeilennummerierung auf der linken Seite.

==== Zeilen 2-4 ====
Abschnitt mit Metadaten zur VK

==== Verfahrenssteuerung (Zeile 5) ====
Es können beliebig viele Verfahrenssteuerungstypen angelegt werden, eine je Verfahrenskonfiguration. Im DiPlanCockpit Basis sind zur Konfiguration nur Plan- und Verfahrensarten anzugeben bzw. relevant.

Jeder Verfahrenssteuerungstyp wird selbst unter einer eigenständigen Bezeichnung mit einem Code definiert. Der Code referenziert auf einen Eintrag der Codeliste Code.Verfahrenssteuerung. Wenn man einen neuen Verfahrenssteuerungstyp verwenden möchte, dann benötigt man dafür eine neue Verfahrenskonfiguration und die Codeliste Code.Verfahrenssteuerung muss um den Code erweitert werden.

Neben dem Code der Verfahrenssteuerung ist die Fachdomäne anzugeben, hier "KommunaleBauleitplanung". Andere mögliche Fachdomänen sind "Planfeststellung" und "Raumordnung". Die Fachdomäne steuert unter anderem, [[Editieren der Stammdaten#Verf.C3.BCgbare%20Stammdaten%20pro%20Fachdom.C3.A4ne|welche Stammdaten]] angezeigt werden.

==== Optional: Zuständigkeit (nicht abgebildet) ====
Die Angabe einer oder mehrerer Zuständigkeiten schränkt die Verfügbarkeit der VK ein. Sie steht dann nur für die aufgeführten Zuständigkeiten zur Auswahl. Wenn keine Zuständigkeit in der VK genannt ist, dann ist sie für alle verfügbar.

==== Planarten (Zeilen 6-9) ====
Hier erfolgt die Angabe der gültigen Planarten für diesen Verfahrenssteuerungstyp. Dafür werden beliebig viele Einträge aus der Codeliste Code.Planart referenziert. Die angegebenen Planarten sollten fachlich zum Verfahrenssteuerungstyp passen. Zulässige Kombinationen sind im XRepository in der [https://www.xrepository.de/details/urn:xoev-de:xplanverfahren:codeliste:planart Codeliste Planart] aufgeführt. Der Eintrag in der Spalte "Übergeordneter Wert" der Codeliste bezeichnet den passenden Verfahrenssteuerungstyp.

==== Verfahrensarten (Zeilen 10-11) ====
Hier sind die gültigen Verfahrensarten für diesen Verfahrenssteuerungstyp angegeben. Dafür werden beliebig viele Einträge aus der Codeliste Code.Verfahrensart referenziert. Auch hier gilt, soll eine neue Verfahrensart verwendet werden, so ist sie hier in der Verfahrenskonfiguration anzugeben und die Codeliste Code.Verfahrensart um den Code zu erweitern.
====Optional: Fachdomänenspezifische Ordnerstruktur====
Eine konfigurierbare fachdomänenspezifische Ordnerstruktur zum Hochladen der Dokumente kann durch den Mandanten-Administrator über den Abschnitt <dokumentbibliothek> ergänzt werden. Zurzeit ist diese Ordnerstruktur nur für die Fachdomäne Planfeststellung konfiguriert.[[Datei:ImageFachdomänenspezifischeOrdner.png|zentriert|rahmenlos|748x748px|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:ImageFachdom%C3%A4nenspezifischeOrdner.png]]Erklärung der Felder:
{| class="wikitable"
!Name
!Zweck
|-
|name
|Name bzw. Bezeichnung des Ordners (im Frontend für Nutzende sichtbar), darf nicht leer sein und darf pro Ebene nicht doppelt auftauchen.
|-
|upload
|Gibt an, ob ein Dokumentenupload über den Ordner möglich ist (true) oder nicht (false).
|-
|verfahrensunterlagentyp
|Der standardmäßig automatisch zugeordnete Verfahrensunterlagentyp für alle Dokumente / Dateien im Ordner.
|-
|pflicht
|"ja" bedeutet, dass sich mindestens eine Datei im Ordner befinden muss, was im Rahmen der Vollzähligkeitsprüfung für Vorhabens- und Antragsdokumente der Fachdomäne Planfeststellung überprüft wird. "nein" bedeutet, dass der Ordner leer sein darf und keine Auswirkung auf die Vollzähligkeitsprüfung hat.
|-
|beschreibung
|Textliche Beschreibung der fachlichen Inhalte der Dokumente im Ordner, die für die KI-Prüfung genutzt wird.
|}Die folgenden Regeln und Einschränkungen müssen beachtet werden:
*Die Ordnerstruktur entspricht einer Baumstruktur (ähnlich wie Windows-Explorer) mit den Ebenen 0 (Wurzel) bis n.
*Die Codeliste der Verfahrensunterlagentypen muss um die für die Ordnerstruktur vorgesehenen Verfahrensunterlagentypen ergänzt und hochgeladen sein, anschließend kann die VK hochgeladen werden.
*Das Attribut verfahrensunterlagentyp darf nicht leer sein und nicht doppelt über die ganze Ordnerstruktur vorkommen.
*Wenn Dokumente innerhalb dieser Ordnerstruktur von einem DiPlan-System (z. B. Vorhaben-Cockpit - Antragsstellung) zu einem andern DiPlan-System (z. B. Behörden-Cockpit - Verfahrens-Verwaltung) übertragen werden, dann muss die Ordnerstruktur in beiden Systemen exakt identisch sein. Dabei muss beachtet werden, dass in den Codelisten die Codewerte für Verfahrensunterlagentypen in beiden Systemen eindeutig sind und keine Widersprüche vorhanden sind.
==== Optional: Mandanten spezifische Stammdaten ====
Optional können oberhalb der Verfahrensschritte zusätzliche Mandanten spezifische Stammdaten angegeben werden. Diese ermöglichen die Gestaltung individueller Eingabefelder für die Stammdatenseite. Sie erscheinen auf der Stammdatenseite oberhalb des Abschnitts zu Parallelverfahren in der Reihenfolge, mit der sie in der Verfahrenskonfiguration aufgeführt sind. Ihre Definition erfolgt beispielsweise in der Form <code><eigenschaft label="Beispiel eines Mandanten spezifischen Feldes zur Eingabe von Text" name="Beispiel6200Text" typ="TEXT" subtyp="SINGLE" pflicht="nein"/></code>.

Erklärung der Felder:
{| class="wikitable"
!Name
!Zweck
|-
|label
|Wird als Beschriftung des Feldes angezeigt, kann frei gewählt werden.
|-
|name
|Technischer Name, muss eindeutig sein, sprich darf nur einmal verwendet werden.
|-
|typ
|Gibt den Datentyp an. Zulässige Werte sind: TEXT (Freitextfeld mit max. 255 Zeichen), FLOAT (Zahlenfeld für Gleitkommazahlen), INTEGER (Zahlenfeld für ganze Zahlen), BOOLEAN (Checkbox), DATE (Datumsfeld), URL (Link), CODELIST (Dropdown-Auswahl, Inhalte kommen aus einer Codeliste), DROPDOWN (Dropdown-Auswahl, Optionen individuell festgelegt ohne Codeliste)
|-
|subtyp
|Muss für alle Typen außer CODELIST und DROPDOWN den Wert SINGLE haben. Bei CODELIST bzw. DROPDOWN ermöglicht SINGLE die Auswahl genau eines Wertes aus dem Dropdown, bei LIST können mehrere ausgewählt werden (Multiselect).
|-
|pflicht
|Gibt an, ob das Feld verpflichtend ist (ja oder nein).
|-
|codelistName
|Nur erforderlich bei Typ CODELIST. Der Wert muss dann lauten: "Code." + Name der Codeliste, z.B. "Code.Zustaendigkeit".
|-
|option
|Nur erforderlich bei Typ DROPDOWN. Einmal bis beliebig oft mit je einem Eintrag für das Dropdown einfügen.
|}

==== Verfahrensschritt (Zeile 12-32) ====
Für das DiPlanCockpit Basis ist aus Kompatibilitätsgründen zum DiPlanCockpit Pro lediglich der der VS „9998“ obligatorisch anzugeben, insbesondere um Termine der Stammdatenseite eintragen und speichern zu können. Die mit der Stammdatenseite verknüpften Termine sind für die kommunale Bauleitplanung 0100 (Beschlussdatum), 0200 (Vorweggenehmigung bzw. Planreife gemäß §33 BauGB) und 9300 (Aufhebungsdatum). Der Termin 9300 muss zudem die beiden Eigenschaften "linkPlanzeichnung" und "linkBegruendung" des Typs URL haben.

Für die Fachdomäne Raumordnung sind die Termine pflicht_9400 (Tag des Inkrafttretens) und pflicht_9450 (Tag des Außerkrafttretens) verpflichtend anzugeben.

Weitere Verfahrensschritte können angegeben werden. Sie stehen dann auf der Stammdatenseite zur Angabe des aktuellen Verfahrensschritts zur Auswahl.

== Mandanten spezifische Anpassung als Schritt-Anleitung ==
=== 1. Schritt: Konzeption ===
Sichten der 3 vorhandenen Codelisten

* Verfahrenssteuerung (entspricht dem Verfahrenstyp)
* Planart
* Verfahrensart

Auswahl und Dokumentation der individuell passenden Optionen.

Wenn keine Anpassung der änderbaren Codelisten (Verfahrenssteuerung und Verfahrensart) anliegt, geht es mit dem 2. Schritt weiter. Wenn Codelisten angepasst werden sollen, erfolgt dies zuerst nach der [https://wiki.diplanung.de/index.php/Codelisten#Mandanten_spezifischen_Anpassung_als_Schritt-Anleitung Schritt-Anleitung für Codelisten]. Erst danach steht der 2. Schritt dieser Anleitung an.

=== 2. Schritt: Anpassen der Verfahrenskonfiguration ===
Das Beispiel im obigen Screenshot dient als Kopiervorlage, die 1..n-fach vervielfältigt und angepasst werden kann. Im Code finden sich Kommentare, die die Dokumentation ergänzen.

'''Hinweis:''' Es ist sinnvoll, für die Anpassung ein IDE Tool zu verwenden wie Visual Studio Code oder IntelliJ, um den Code im Hintergrund laufend validieren zu lassen. (IDE = Integrierte Entwicklungsumgebung). Die Prüfung der Formatierung lässt sich per „Shift + Alt + L“ anstoßen.

Die Verfahrenssteuerung wird über ihren Code angegeben und bildet das Element auf der obersten Ebene. Darin werden die zugehörigen Planarten und Verfahrensarten aufgeführt. Es können beliebig viele verschiedene Plan- und Verfahrensarten sein. Sie werden jeweils einzeln ebenfalls über ihren Code angegeben. Die Codes müssen in der jeweiligen Codeliste vorhanden sein.

Auf die Verfahrensart folgt der Abschnitt zur Zeitplanung. Im DiPlanCockpit BASIS steht die Zeitplanung nicht zur Verfügung. Deswegen entfällt dieser Abschnitt inklusive des Monitoring für BASIS und ist entsprechend nicht in der dargestellten VK enthalten.

Es folgt in BASIS direkt auf die Verfahrensart eine Auflistung der Verfahrensschritte (VS) für den definierten Verfahrenstyp. Jeder VS wird dabei wieder einzeln über seinen Code aufgeführt, der in der Codeliste Code.Verfahrensschritt enthalten sein muss. Im Cockpit Basis stehen keine Aufgaben zur Verfügung. Durchgänge von VS sind nur in Zusammenhang mit Aufgaben zu bearbeiten, deswegen erfolgt im DiPlanCockpit BASIS für jeden Verfahrensschritt die Angabe durchgaenge=“nein“: Das heißt, es sind keine Durchgänge vorgesehen.

Der VS „9998“ ist verpflichtend, um Termine auf der Stammdatenseite hinterlegen zu können. Dies trifft auch auf den darunter stehenden Verfahrensteilschritt (VTS) „9998“ mitsamt darunter liegenden Termine zu.

Das vorliegende Element zur Verfahrenssteuerung kann beliebig häufig kopiert und angepasst werden, so dass sich pro Verfahrenstyp individuelle Konfigurationen vornehmen lassen.

=== 3. Schritt: Hochladen ins DiPlanCockpit ===
Das Hochladen der angepassten Verfahrenskonfiguration erfolgt im Admin-Bereich im Reiter Konfiguration, den Nutzer mit der Rolle M-A-Basis aufrufen können.

== Ergänzung ==
Für die änderbaren Codelisten

* Code.Verfahrensschritt
* Code.Verfahrensteilschritt

sind die Codes „9998“ Pflicht-Einträge, um Termine auf der Stammdatenseite eintragen und speichern zu können. Daher müssen sie auch bei einer Mandanten spezifischen Anpassung erhalten bleiben. Hier der passende Code-Schnipsel aus Code.Verfahrensschritt:
[[Datei:9998VS.png|zentriert|rahmenlos|322x322px]]

Weitere Infos finden sich in der [https://wiki.diplanung.de/index.php/Codelisten#Mandanten_spezifischen_Anpassung_als_Schritt-Anleitung Schritt-Anleitung zur Anpassung von änderbaren Codelisten].

Hauptseite neu

2026-03-24T08:00:03Z

Diplanung:

[[Datei:logo_diplanung_wiki.jpg|alternativtext=Diplanung-Logo|zentriert|rahmenlos]]
In diesem Wiki finden Sie aktuell Produktinformationen und Bedienungsanleitungen zu allen Anwendungen der Plattform '''[https://diplanung.de/ DiPlanung]'''. Das Wiki wird kontinuierlich weiterentwickelt.
{| class="teaser-wrapper-table" style="width:100%"
|-
| style="width: 33.33%" |

{| class="wikitable teaser-table" style="width:100%"
|-
! style="width: 100%" | DiPlanCockpit
|-
|[[Datei:DiPlanCockpitBasis 39x36.png|links|rahmenlos|alternativtextLogoDiPlanCockpit=|33x33px]]Das DiPlanCockpit ist das zentrale Verfahreunssteuerungsinstrument für alle plangebenden Stellen und ermöglicht vollintegrierte Verfahrenssteuerungen. DiPlanCockpit BASIS dient der Einstellung von Planwerken ins Internet, DiPlanCockpit PRO bietet eine Ende-zu-Ende-digitalisierte Verfahrensführung.
'''[[Übersicht_DiPlanCockpit|Online-Handbuch zum DiPlanCockpit]]'''
|}

| style="width: 33.33%" |

{| class="wikitable teaser-table" style="width:100%"
|-
! style="width: 100%" | DiPlanVorhaben
|-
|[[Datei:DiPlanCockpitBasis 39x36.png|links|rahmenlos|alternativtext=Logo DiPlanVorhaben|33x33px]]DiPlanVorhaben ist die zentrale Antragsplattform für Vorhabenträger komplexer Infrastrukturprojekte. Sie unterstützt Antragsteller dabei, Genehmigungsverfahren strukturiert, transparent und effizient durchzuführen – von der ersten Datenerfassung bis zur finalen Antragseinreichung.
'''[[Übersicht DiPlanVorhaben|Online-Handbuch zu DiPlanVorhaben]]'''
|}

| style="width: 33.33%" |

{| class="wikitable teaser-table" style="width:100%"
|-
! style="width: 100%" | DiPlanBeteiligung
|-
|[[Datei:ImagePD.png|links|rahmenlos|33x33px|alternativtext=Logo DiPlanBeteiligung]]DiPlanBeteiligung bietet allen Kommunen sowie den beauftragten Planungsbüros als Verfahrensträger eines Bauleitplanverfahrens die Möglichkeit, die gesetzlich festgeschriebene Beteiligung vollständig online durchzuführen. Die Öffentlichkeit kann die Verfahren einsehen und Stellung nehmen.
'''[[DiPlanBeteiligung|Online-Handbuch zu DiPlanBeteiligung]]'''
|}

|}
{| class="teaser-wrapper-table" style="width:100%"
|-
| style="width: 33.33%" |

{| class="wikitable teaser-table" style="width:100%"
|-
! style="width: 100%" | DiPlanPortal
|-
|[[Datei:ImagePD.png|links|rahmenlos|33x33px|alternativtext=Logo DiPlanPortal]]Das DiPlanPortal ist die offizielle Plattform für raumbezogene Pläne und formale Beteiligungsverfahren. Sie ermöglicht es der Öffentlichkeit, sich bundesweit in einer nutzungsfreundlichen Anwendung über ihre Region und die geplanten Entwicklungen in ihrer Umgebung zu informieren.
'''[[Übersicht DiPlanPortal|Online-Handbuch zum DiPlanPortal]]'''
|}

| style="width: 33.33%" |

{| class="wikitable teaser-table" style="width:100%"
|-
! style="width: 100%" | DiPlanWissen
|-
|[[Datei:ImagePD.png|links|rahmenlos|33x33px|alternativtext=Logo DiPlanWissen]]DiPlanWissen ist die Online-Bibliothek zu Fachthemen, Ausarbeitungshinweisen und Praxisbeispielen der Bauleitplanung und Landschaftsplanung. Es ermöglicht eine kontextbezogene Bereitstellung von genau den Informationen, die Planende zur Lösung aktueller Anliegen benötigen.
'''[[Übersicht DiPlanWissen|Online-Handbuch zu DiPlanWissen]]'''
|}

| style="width: 33.33%" |

{| class="wikitable teaser-table" style="width:100%"
|-
! style="width: 100%" | DiPlanPotenziale
|-
|[[Datei:DiPlanPotenziale 39x36.png|alternativtext=Logo DiPlanPotenziale|links|rahmenlos|33x33px]]DiPlanPotenziale dient der Verwaltung, Auswertung, Suche und Weiterentwicklung von städtischen Wohn- und Gewerbepotenzialflächen. Eine feinkörnige Flächensuche und der digitalisierte behördenübergreifende Abstimmungsprozess sind ebenfalls Teile des Funktionsumfangs.
'''[[DiPlanPotenziale|Online-Handbuch zu DiPlanPotenziale]]'''
|}

|}
{| class="teaser-wrapper-table" style="width:100%"
|-
|
{| class="wikitable teaser-table" style="width:100%"
|-
! DiPlanCockpit Pro als Hamburger Verfahrenssteuerung
|-
|[[Datei:HH Logo.png|links|rahmenlos|66x66px|Logo FHH|alternativtext=]]Das DiPlanCockpit ist seit Ende 2021 der zentrale Assistent für die Durchführung von Bebauungsplanverfahren, Flächennutzungsplanverfahren und Verfahren der Landschaftsprogramme in der Freien und Hansestadt Hamburg. Hier finden Sie eine Bedienungsanleitung, ein Schulungsvideo und FAQ.
'''[[DiPlanCockpit_Pro_als_Hamburger_Verfahrenssteuerung|Online-Handbuch zum Hamburger DiPlanCockpit]]'''
|}
|}

{| class="teaser-wrapper-table" style="width:100%"
|-
|
{| class="wikitable teaser-table" style="width:100%"
|-
! Authentifizierung, Rollen und Rechte
|-
|Die Komponenten der DiPlanung beinhalten Bereiche und Funktionen, die nur für authentifizierte Nutzende mit bestimmten Rollen erreichbar sind, z.B. Mandanten-Administration, Fachplanung-Administration, Fachplanung-Sachbearbeitung und Sachbearbeitung extern. Hier erhalten Sie Infos zu den Komponenten des Rollen- und Berechtiguingssystems wie KeyCloak, BeSte, mein Unternehmenskonto (ELSTER) und BundID.
'''[[Authentifizierung, Rollen und Rechte|Mehr Infos zu Authentifizierung, Rollen und Rechten]]'''
|}
|}

__INHALTSVERZEICHNIS_ERZWINGEN__

Datei:Logo diplanung wiki.jpg

2026-03-24T07:56:09Z

Diplanung:

Hauptseite

2026-03-24T07:54:54Z

Diplanung:

[[Datei:logo_diplanung_wiki.jpg|alternativtext=Diplanung-Logo|zentriert|rahmenlos]]
In diesem Wiki finden Sie aktuell Produktinformationen und Bedienungsanleitungen zu allen Anwendungen der DiPlanung Plattform von [https://diplanung.de/ diplanung.de] . Das Wiki wird kontinuierlich weiterentwickelt.
{| class="wikitable"
|+
![[DiPlanCockpit Pro|DiPlanCockpit Pro als Hamburger Verfahrenssteuerung]]
!DiPlanCockpit
!DiPlanVorhaben
![[DiPlanBeteiligung|DiPlanBeteiligung – DiPlanung]]
![[DiPlanPotenziale]]
|-
|[[Datei:HH Logo.png|links|rahmenlos|66x66px|Logo FHH|alternativtext=]]Das DiPlanCockpit ist seit Ende 2021 der zentrale Assistent für die Durchführung von Bebauungsplanverfahren, Flächennutzungsplanverfahren und Verfahren der Landschaftsprogramme in der Freien und Hansestadt Hamburg. Hier finden Sie eine Bedienungsanleitung, ein Schulungsvideo und FAQ.
|[[Datei:DiPlanCockpitBasis 39x36.png|links|rahmenlos|alternativtext=|33x33px]]Das DiPlanCockpit ist das zentrale Steuerungsinstrument für alle plangebenden Stellen und ermöglicht durch einen konfigurativ-generischen Ansatz und Standardisierungen vollintegrierte Verfahrenssteuerungen für alle Planungsebenen in Deutschland. Integriert in die DiPlanungs-Plattform unterstützt es flexible Berechtigungsstrategien, steuert Beteiligungslösungen und Wissensspeicher und bietet eine Vielzahl intelligenter Werkzeuge auch fürs Dokumentenmanagement sowie XPlanungsdaten-Verwaltung.

Das DiPlanCockpit BASIS fokussiert die OZG Leistung "Einstellen von raumbezogenen Planwerken in das Internet" und ist bewusst schlank gehalten.

Das DiPlanCockpit PRO bietet eine Ende-zu-Ende-digitalisierte Verfahrensführung in der Bauleitplanung, Raumordnung und Planfeststellung.
|[[Datei:DiPlanCockpitBasis 39x36.png|links|rahmenlos|alternativtext=|33x33px]]DiPlanVorhaben ist die zentrale Antragsplattform für Vorhabenträger komplexer Infrastrukturprojekte.
Sie unterstützt Antragsteller dabei, Genehmigungsverfahren strukturiert, transparent und effizient durchzuführen – von der ersten Datenerfassung bis zur finalen Antragseinreichung.
|[[Datei:ImagePD.png|links|rahmenlos|33x33px|alternativtext=]]DiPlanBeteiligung bietet allen Kommunen sowie den beauftragten Planungsbüros als Verfahrensträger eines Bauleitplanverfahrens Unterstützung für die Durchführung der gesetzlich festgeschriebenen Beteiligung.
|[[Datei:DiPlanPotenziale 39x36.png|alternativtext=Logo DiPlanPotenziale|links|rahmenlos|33x33px]]DiPlanPotenziale dient der Verwaltung, Auswertung, Suche und Weiterentwicklung von städtischen Potenzialflächen (Wohnen und Gewerbe) in der Freien und Hansestadt Hamburg.
|-
|
|'''DiPlanCockpit BASIS'''
* [[DiPlanCockpit Basis als EfA-Lösung|DiPlanCockpit Basis für Fachplanung-Sachbearbeitung (FP-SB)]]
**[https://www.youtube.com/watch?v=nNOL8EVQ8ko Zum gesamten Schulungsvideo: Sachbearbeitung DiPlanCockpit Basis]
** [https://www.youtube.com/watch?v=nNOL8EVQ8ko&t=27s Schulungsvideo: Kapitel Anmeldung]
** [https://www.youtube.com/watch?v=nNOL8EVQ8ko&t=101s Schulungsvideo: Kapitel Verfahren anlegen]
** [https://www.youtube.com/watch?v=nNOL8EVQ8ko&t=243s Schulungsvideo: Kapitel Kartenwerkzeuge]
** [https://www.youtube.com/watch?v=nNOL8EVQ8ko&t=506s Schulungsvideo: Kapitel Verfahrenssuche]
** [https://www.youtube.com/watch?v=nNOL8EVQ8ko&t=900s Schulungsvideo: Kapitel Verfahren starten]
** [https://www.youtube.com/watch?v=nNOL8EVQ8ko&t=973s Schulungsvideo: Kapitel Parallelverfahren]
** [https://www.youtube.com/watch?v=nNOL8EVQ8ko&t=1129s Schulungsvideo: Kapitel Verfahrensdokumente]
** [https://www.youtube.com/watch?v=nNOL8EVQ8ko&t=1894s Schulungsvideo: Kapitel Planungsbüros]
** [https://www.youtube.com/watch?v=nNOL8EVQ8ko&t=2268s Schulungsvideo: Kapitel Planwerke]
** [https://www.youtube.com/watch?v=nNOL8EVQ8ko&t=3185s Schulungsvideo: Kapitel DiPlanPortal]
* [[DiPlan Cockpit Basis für Mandanten-Administratoren (M-A)|DiPlanCockpit Basis für Mandanten-Administratoren (M-A)]]
|
# [[Über DiPlanVorhaben|Über DiPlan Vorhaben]]
# [[Registrierung und Anmeldung mit Mein Unternehmenskonto|Registrierung und Anmeldung]]
# [[Vorhaben suchen und abonnieren]]
# [[Vorhaben anlegen]]
# [[Vorhaben-Detailansicht]]
# [[Antrag anlegen und einreichen]]
# [[Antrag-Detailansicht]]
# [[Zeitplanung in Vorhaben und Anträgen]]
# [[Aufgaben in Vorhaben und Anträgen]]
# [[Planwerke in Vorhaben und Anträgen]]
# [[Dokumente in Vorhaben und Anträgen]]
# [[Antrag prüfen und einreichen]]
# [[Baugenehmigung starten]]
|
* [https://www.youtube.com/watch?v=W6k0GtYaP38 Schulungsvideo Sachbearbeitung Part 1: Verfahren konfigurieren und Beteiligung vorbereiten]

* [https://www.youtube.com/watch?v=36pyu2_Vtg4 Schulungsvideo Sachbearbeitung Part 2: Beteiligung auswerten und bearbeiten]
* [https://www.youtube.com/watch?v=Y2Wd63dgqs8 Schulungsvideos Träger öffentlicher Belange (TöB): Stellungnahmen abgeben und einreichen]
|
|-
|
|'''DiPlanCockpit PRO'''
* [[DiPlanCockpit Pro für Fachplanung-Sachbearbeitung (FP-SB)]]
* [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]
|
|
|
|-
|
| colspan="3" |'''Keycloak'''

* [https://youtu.be/zx9MBMipdHE Schulungsvideo Nutzendenverwaltung in Keycloak für Mandantenadministration]
|
|}

__INHALTSVERZEICHNIS_ERZWINGEN__

FAQ für M-A

2026-03-23T11:40:21Z

Diplanung: /* XPlanGML / Planwerke */

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

Auf dieser Seite sind typische Fragen und die Antworten darauf gesammelt. Die Sortierung ist thematisch.

== Allgemein ==

* Wie sagen mir die Zahlen am Ende einer URL zum Cockpit im Reiter Aufgaben, z.B. in "meineUmgebung.diplanung.de/details/ID_99c61979-bbb5-4b40-8253-71068e680af5/1200/1/1210"?
** Die Zahlen stehen für den aktuell ausgewählten VTS, Durchgang und UVTS. VTS und UVTS entsprechen dem Code aus der jeweiligen Codeliste.

== Datenexport ==

* Wie werden Metadaten durch das Cockpit bereitgestellt?
** Das DiPlanCockpit Backend stellt Metadaten in unterschiedlichen Datenmodellen/-formaten über folgenden Endpunkt bereit: URL-des-Cockpits/api/cockpit/swagger-ui/index.html#/metadaten-export-resource/getMetadaten. Dieser Endpunkt kann im Cockpit über „Einstellungen / Metadaten-Export an externe Metadateninformationssysteme“ initialisiert werden. Zusätzlich müssen die CSW-Systemparameter gesetzt werden.
* Wie können die Metadaten aus dem Cockpit an Drittsysteme angebunden werden?
** Es gibt die Export-Formate CSW und DCATAP-PLU. Diese können durch einen REST-Endpunkt abgefragt werden. Mittels DCATAP-PLU-Nachrichten werden Metadaten ans DiPlan Portal übergeben. Es sind zudem Transportverfahren für FitConnect und XTA2 im Cockpit integriert, werden Stand heute aber nur für den Nachrichtenaustausch mit XBauleitplanung/XBeteiligung verwendet. Nachrichten aus XPlanverfahren können aktuell nicht exportiert werden.
* Kann das CSW-Template für den Export beliebig angepasst werden? Können benutzerdefinierte Elemente komplett neu hinzugefügt werden?
** Ja. Im Admin-Bereich kann das CSW-Template ausgetauscht und damit angepasst werden.
* Wofür dient der Export mit CSW und DCATAP-PLU?
** CSW dient der Übermittlung von Metadaten zu Planwerken an Metadateninformationssysteme. DCATAP-PLU dient der Kommunikation zwischen dem DiPlan Cockpit und DiPlan Portal und übermittelt unter anderem beispielsweise den Plannamen, Planungsanlass, die Flächenabgrenzung im GeoJSON Format, den Verfahrensstand und die Verfahrensart.
* Welche Bezeichnung/welcher Name von Verfahren wird im Portal angezeigt? Planname? Arbeitstitel?
** Im DCAT-AP-PLU-Template wird im Element <code><plu:planName></code> der Planname übermittelt.

== Dokumente ==

* Ist es möglich alle Dokumente aus dem Cockpit zusammen als ZIP-Datei runterzuladen? (auch die zusätzlichen Dokumente)
** Stand heute ist dies in der Dokumenten-Bibliothek nicht möglich. Die fachliche Anforderung, alle Dokumente eines Verfahrens auszuleiten, ist über den Fachlichen Ordner „Gerichtsordner“ abgebildet.

== Konfiguration ==

* Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Markup im Dokument nach dem Root-Element muss ordnungsgemäß formatiert sein"''?
** Das bedeutet, dass in der Verfahrenskonfiguration ein Fehler hinsichtlich des Aufbaus der Datei vorliegt. Es kann beispielsweise sein, dass man Elemente in der falschen Reihenfolge angegeben hat. Um Fehlern dieser Art vorzubeugen ist es hilfreich, wenn man einen XML-Editor verwendet, der eine Validierung der Datei ermöglicht. So lässt sich vor dem Hochladen ins Cockpit prüfen, ob die XML korrekt gestaltet ist.
* Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Für x sind die folgenden Werte mehrfach vereinbart: A"''?
** Das bedeutet, dass in der Verfahrenskonfiguration ein Wert A mehrfach verwendet wird, der nur einmal verwendet werden darf. Das gilt beispielsweise für Unterverfahrensteilschritte (UVTS). Jeder UVTS darf in einer Verfahrenskonfiguration nur einmal vorkommen. Um den Fehler zu beheben, muss folglich einer der Werte abgeändert werden. Anschließend kann man die Verfahrenskonfiguration hochladen.
* Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Das Element x muss vorhanden sein"''?
** Das bedeutet, dass in der Verfahrenskonfiguration ein zwingend notwendiger Abschnitt x fehlt. Um den Fehler zu beheben, muss man den fehlenden Abschnitt hinzufügen und kann anschließend die Verfahrenskonfiguration hochladen.
* Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Die folgenden refIDs sind in der Verfahrenskonfiguration doppelt vergeben: [X]"''?
** RefIDs müssen eindeutig sein, sprich sie dürfen nur einmal verwendet werden. Der Fehler besagt, dass die refID X mehr als einmal vorhanden ist. Um den Fehler zu beheben, muss das Duplikat entfernt werden, z.B. durch Änderung einer der Angaben von X. Anschließend kann man die Verfahrenskonfiguration hochladen.
* Was bedeutet beim Hochladen einer Codeliste eine Fehlermeldung in der Form ''"Die Codeliste passt nicht zur Verfahrenskonfiguration A: kein Wert für Codeliste B und Wert C zu ermitteln"'' oder ''"Die Codeliste enthält nicht folgende erforderlichen Codes: C"'' oder ''"Code C wird noch in Tabelle X benutzt und kann nicht gelöscht werden"''?
** Die Meldungen bedeuten, dass in der Verfahrenskonfiguration A oder an Stelle X ein Codelistenwert C verwendet wird, der in der Version der Codeliste B, die man versucht hochzuladen, fehlt. Um den Fehler zu lösen, muss man einen Eintrag für den Wert C in die Codeliste B hinzufügen und kann anschließend die Codeliste hochladen. Wenn man den Codelistenwert C löschen möchte, dann muss man zuerst alle Verfahren und Verfahrenskonfigurationen löschen, in denen der Wert verwendet wird.
* Was bedeutet beim Hochladen einer Codeliste eine Fehlermeldung in der Form ''"Die Codeliste enthält Namen die doppelt vergeben sind: [A]"'' oder ''"Duplicate key B"''?
** Die Meldungen bedeuten, dass in der Codeliste, die man versucht hochzuladen, ein Wert doppelt vorhanden ist. Um den Fehler zu lösen, muss man einen der beiden Einträge aus der Codeliste entfernen und kann anschließend die Codeliste hochladen.

* Wer darf änderbare Codelisten anpassen?
** Mandanten-Admins können änderbare Codelisten anpassen.
* Welche Änderungen darf ich als Mandanten-Admin an Codelisten vornehmen?
** Das ist je nach Codeliste unterschiedlich. Teilweise sind gar keine eigenen Anpassungen möglich, teilweise können nur Einträge hinzugefügt, teilweise auch Einträge gelöscht werden. Eine detaillierte Beschreibung findet sich in Kapitel [[Codelisten|6.3]]. des Handbuchs.
* Welche Einträge in veränderbaren Codelisten darf man löschen und welche nicht?
** Alle in einer Verfahrenskonfiguration (VK) enthaltenen Codes müssen in einer Codeliste zu finden sein. Im Zuge der Mandanten spezifischen Anpassung lassen sich weitere Verfahrenstypen/Verfahrenssteuerungen konfigurieren, die auch auf Einträge in veränderbaren Codelisten referenzieren. Diese Einträge in einer VK müssen in veränderbaren Codelisten enthalten sein, die VOR einer neuen Verfahrenskonfiguration ins DiPlanCockpit hochgeladen werden müssen. Dies können Nutzende in der Rollen M-A vornehmen. Im Zuge der Erweiterungen von VKs "wachsen" veränderbare Codelisten mit, d.h. dort enthaltene Einträge werden i.d.R. ergänzt um neue und nicht bestehende Einträge gelöscht bzw. überschrieben.
* Benötigt man als Mandanten-Admin die XSD zu den XML-Dateien?
** Nein. Die XSD dient nur dem System zur Validierung der XMLs.
* Was kann ich tun, wenn sich in einer änderbaren Codeliste ein Fehler eingeschlichen hat?
** Ein fehlerhafter Eintrag in einer änderbaren Codeliste kann korrigiert werden oder auch gelöscht, sofern er nicht in einem Verfahren verwendet wird. Eine detaillierte Anleitung findet sich in Kapitel [[Codelisten|6.3]].
* Sofern man neue Zuständigkeiten über die Codeliste hinzufügt, können diese im Nachgang gelöscht werden, sofern sich doch ein Fehler eingeschlichen hat?
** Nicht verwendete Codelisten-Einträge können aus der Codeliste für die Zuständigkeit gelöscht werden. Das gilt jedoch nicht für alle Codelisten, deswegen bitte die jeweilige Dokumentation dazu beachten.
* Was kann alles über die fachliche Leitstelle für das Cockpit konfiguriert werden? Welche Systemparameter? Welche Konfigurationen? Gibt es eine Übersicht/Liste dazu?
** In den entsprechenden Abschnitten dieses Handbuchs (z.B. bezüglich der Systemparameter oder Verfahrenskonfiguration) ist beschrieben, wer welche Anpassungen vornehmen kann.
* Kann das „Wording“ des Verfahrensstands mandantenspezifisch angepasst/konfiguriert werden?
** Die Codeliste Verfahrensstand ist Stand heute eine nicht änderbare Codelisten und kann daher nicht angepasst werden. Ist dies gewünscht muss das mit der Fachlichkeit (PO/BA) geklärt werden. Sie ist eine feste Codeliste, die den bundesweiten Standard beschreibt. Wenn Ergänzungen gewünscht sind, muss ein nachnutzendes Land / NN Land / MiLa den Bedarf bei der XLeitstelle melden. Dort wird er geprüft und bei positiver Entscheidung die Codeliste ergänzt.
* Müssen die Codes nach einem bestimmten Schema angelegt werden, z.B. Verfahrensschritte nur als vierstellige Codes in Hunderter-Schritten, also 3100, 3200, 3300 usw.?
** Nein. Die Codes können beliebig gestaltet sein, sie müssen weder zwingend vierstellig sein, noch muss ein bestimmtes Muster eingehalten werden. Damit sie übersichtlicher und leichter nachvollziehbar sind, ist es dennoch empfehlenswert nicht vollkommen willkürliche Codes zu verwenden. Wichtig ist bezüglich des Formats nur, dass die Codes innerhalb einer Codeliste eindeutig sind (= nur einmal vorkommen) und keine Zeichen enthalten, die nicht mit der URL-Codierung kompatibel sind. Codes (insbesondere Verfahrensschritte, Verfahrensteilschritte, Unterverfahrensteilschritte) können Teil URL sein, und müssen deswegen darin darstellbar sein. Nicht erlaubt sind: Leerzeichen : / ? # ( ) [ ] @ ! $ % & ' * + , ; =
* Je Verfahrenssteuerungstyp lässt sich eine Verfahrenskonfiguration anlegen. Was ist, wenn man mehrere Verfahrenskonfigurationen für einen Verfahrenssteuerungstyp möchte?
** In diesem Fall muss auch der Verfahrenssteuerungstyp mehrfach angelegt werden, beispielsweise in der Form A und B. Dann kann sowohl für A als auch B eine eigene Verfahrenskonfiguration erstellt werden. Dies sollte nur wenn unbedingt notwendig geschehen, weil sich dadurch der Administrationsaufwand zusätzlich erhöht.
* Muss jeder Verfahrensschritt (VS) Verfahrensteilschritte (VTS) haben?
** Jein. In der Verfahrenkonfiguration können VS ohne VTS angegeben werden. Diese sind jedoch nicht im DiPlan Cockpit sichtbar. Angezeigt werden nur VS mit VTS.

== Logging ==

* Wie lange werden Logs aufbewahrt?
** Aktuell werden Log-Dateien für 30 Tage gespeichert und sind im Reiter "Protokolle" des Bereichs "Fachliche Leitstelle Administration" einsehbar .

== Login ==

* Können mehrere Personen den gleichen Zugang verwenden?
** Nein. Alle Nutzenden müssen eigene Login-Daten haben, z.B. über ein personalisiertes Elster-Zertifikat. Nur so können Log-Einträge eindeutig Nutzenden zugeordnet werden.

== Raumordnung ==

* Kann ich Verfahren für die Raumordnung anlegen?
** Für die Raumordnung sind bis auf Weiteres Basis-Funktionalitäten umgesetzt. Basis-Verfahren sind somit möglich und es gibt eine entsprechende Beispiel-Verfahrenskonfiguration.

== Verfahren ==

* Warum wird mir nach dem Klick auf "Verfahren starten" bei einem simulierten Verfahren ein Fehler angezeigt?
** Ein simuliertes Verfahren kann nur gestartet werden, wenn sowohl der Planstatus als auch der Verfahrensstand den Wert "simuliert" haben. Auf der Stammdatenseite des Verfahrens kann der Verfahrensstand simulierter Verfahren geändert werden. Bitte prüfen Sie diesen und setzen Sie ihn gegebenenfalls auf simuliert, um das Verfahren anschließend starten zu können.
* Kann ein Planname für mehrere Verfahren genutzt werden?
** Der Planname wird beim Starten des Verfahrens eingetragen. Innerhalb eines Mandanten kann ein Planname nur einmal vergeben sein, da auf dem Datenbank-Feld „Planname“ ein unique-Constraint liegt.
* Was bedeutet eine Fehlermeldung wie z.B. "Unerwarteter Fehler - Erstellen des Verfahrens fehlgeschlagen! - Fehlermeldung: Die Verfahrenskonfiguration hat das AktionItem ActionItemEntity[id=null, Code=Code[code=0820, name=drop down], Sitzungscode=Code[code=9100, name=Dummy Sitzung politisch]] konfiguriert, welches auf einen Termin verweist, der am Verfahren nicht existiert"?
** Hier ist das Problem, dass in der Verfahrenskonfiguration ein Termin in einer Aufgabe referenziert wird, der im Bereich zu Zeitplanung fehlt. Dementsprechend muss in der Verfahrenskonfiguration der Termin aus der Aufgabe entfernt oder in die Zeitplanung hinzugefügt werden, um den Fehler zu beheben.
* Können Verfahren in DiPlanCockpit Basis angelegt und später in DiPlanCockpit Pro fortgeführt werden oder umgekehrt?
**Es soll kein Mischbetrieb von DiPlanCockpit Basis und Pro erfolgen und ein Verfahren nur in Basis oder nur in Pro genutzt werden.
* Ist der Import von Verfahren zur Raumordnung / Raumordnungsplan-Verfahren möglich?
** Der Import von Verfahren zur Raumordnung / Raumordnungsplan-Verfahren ins DiPlanCockpit ist nicht vorgesehen. Stattdessen sind die (wenigen) Bestandsdaten manuell im DiPlanCockpit anzulegen.

== XML ==

* Können in den XML-Konfigurationen Sonderzeichen in den Elementen stehen?
** Bestimmte Zeichen in einer XML müssen encoded werden, damit sie nicht eine besondere Rolle im XML-Syntax erfüllen. Allgemein gibt es 5 Zeichen, die in XML escaped werden müssen:
*** " muss escaped werden als &quot;
*** ' muss escaped werden als &apos;
*** < muss escaped werden als &lt;
*** > muss escaped werden als &gt;
*** & muss escaped werden als &amp;

== XPlanGML / Planwerke ==

* Kann das Cockpit Daten über XPlanGML über WFS oder anderem Wege aufnehmen? Wenn ja, welche Version?
** Das System nutzt den Standard XPlanung ab der Version 5.4. Bebauungspläne werden als XPlanGML-Datei hochgeladen und veröffentlicht. WMS und WFS werden als externe Dienste für Verwendung in Drittsystemen bereitgestellt. Das DiPlanCockpit ermöglicht eine Veröffentlichung von XPlanGML Dateien über den Planwerke Reiter im Cockpit. Umringe von Bebauungsplänen können im DiPlan Kartenclient auf Datengrundlage einen ALKIS WFS Dienstes direkt im XPlanung Datenmodell erfasst werden. Weiterhin können vorliegende XPlanGML Dateien über einen XPlanverfahren Massenimport importiert werden. XPlanverfahren Dateien können durch eine Transformation aus XPlanGML Dateien über ein von der XLeitstelle bereitgestelltes Skript in XPlanverfahren transformiert werden und ggf. um weitere Verfahren beschreibende Meta- oder Datumsangaben ergänzt werden.
* Welcher Version muss ein Planwerk mindestens entsprechen, um es ins Cockpit hochzuladen?
** Die Version muss 5.4 oder höher sein.
* Wie groß darf ein Planwerk für den Upload maximal sein?
** Aktuell liegt die maximal erlaubte Dateigröße einer XPlanGML für den Upload bei 100 MB.
* Beim Versuch ein Planwerk hochzuladen wird ein Fehler angezeigt. Woran liegt das?
** Das kann verschiedene Ursachen haben. Bitte prüfen Sie zunächst, ob von Seiten Ihrer hauseigenen IT das Hochladen einer ZIP-Datei gestattet ist. Der Upload kann unterbunden sein und so den Eindruck eines Fehlers im Cockpit erwecken.
** Eine weitere mögliche Ursache ist ein falsch gesetzter Systemparameter. Das kann beispielsweise nach einem Update des Cockpits der Fall sein, wenn durch die zuständige Administration erforderliche Anpassungen der Systemparameter noch nicht erfolgt sind.
* Werden Rasterbilder im Dienst nicht mit dargestellt?
** Wenn korrekte Rasterdaten mit importiert wurden, werden diese auch über den WMS ausgeliefert; ob sie dargestellt werden, hängt dann davon ab, wie der Client konfiguriert ist.
* Wird ein Planwerks-WFS bereit gestellt? Kann man als Admin-Rolle auf alle Dienste (URLs) zugreifen? Wo? Wie?
** Ja und nein. Es wird kein Planwerk-WFS bereitgestellt, sondern ein WFS aller Planwerke, der jedoch über Filter nur die Inhalte eines speziellen Plans ausgeben kann. Über das Cockpit wird heute noch keine aufbereitete URL angeboten.
* Kann ein einmal veröffentlichtes ZIP-Archiv vom Planwerk wieder gelöscht werden?
** Nein. Es ist möglich die Veröffentlichung zurückzuziehen, aber nicht es zu löschen.
* Der Versuch ein Planwerk zu veröffentlichen führt zu einer Fehlermeldung in der Form "Das Verfahren ''LoremIpsum'' besitzt den Verfahrensstand ''im Verfahren''. Die xplan.gml Datei jedoch den Rechtsstand ''beschlossen''". Das heißt, der Verfahrensstand auf der Stammdatenseite passt nicht zum Rechtsstand in der xplan.gml und eines von beidem muss angepasst werden. Das führt zu der Frage: Welche Kombinationen von Verfahrensstand und Rechtsstand sind zulässig?
** Die folgende Tabelle gibt einen Überblick (Tabelle öffnet sich bei Klick auf "Ausklappen"):
{| class="wikitable mw-collapsible mw-collapsed"
!Code
!Verfahrenstand (XPlanverfahren) im DiPlanCockpit
!Rechtsstand (XPlan) im XPlanGML
!Code
!Planarten
!Kommentar
!Planstatus = Dienstebene (ergibt sich aus dem Rechtsstand)
|-
|1000
|simuliert
|nicht vorhanden
|keiner
|BP
|Ein simuliertes Verfahren darf in keinem Dienst auftauchen, da es noch nicht rechtsgültig ist.
|kein Dienst
|-
|
|
|nicht vorhanden
|keiner
|RP
|Ein simuliertes Verfahren darf in keinem Dienst auftauchen, da es noch nicht rechtsgültig ist.
|kein Dienst
|-
|2000
|im Verfahren
|Aufstellungsbeschluss
|1000
|BP
|
|in Aufstellung (pre)
|-
|
|
|Aufstellungsbeschluss
|1000
|FP
|
|in Aufstellung
|-
|
|
|Aufstellungsbeschluss
|1000
|LP
|
|in Aufstellung
|-
|
|
|Aufstellungsbeschluss
|1000
|RP
|
|in Aufstellung
|-
|
|
|Entwurf (XPlan 5.4)
|2000
|BP
|
|in Aufstellung
|-
|
|
|Im Verfahren (XPlan 6.0)
|2000
|FP
|
|in Aufstellung
|-
|
|
|Entwurf
|2000
|FP
|
|in Aufstellung
|-
|
|
|Entwurf
|2000
|LP
|
|in Aufstellung
|-
|
|
|Entwurf
|2000
|RP
|
|in Aufstellung
|-
|
|
|Frühzeitige Behördenbeteiligung
|2100
|BP
|
|in Aufstellung
|-
|
|
|Frühzeitige Öffentlichkeitsbeteiligung
|2200
|BP
|
|in Aufstellung
|-
|
|
|Entwurf geändert
|2002
|RP
|
|in Aufstellung
|-
|
|
|Behördenbeteiligung
|2300
|BP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|BP
|
|in Aufstellung
|-
|
|
|Frühzeitige Behördenbeteiligung
|2100
|FP
|
|in Aufstellung
|-
|
|
|Frühzeitige Öffentlichkeitsbeteiligung
|2200
|FP
|
|in Aufstellung
|-
|
|
|Entwurfsbeschluss
|2250
|FP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|BP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|FP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|LP
|
|in Aufstellung
|-
|3000
|beschlossen
|Satzung
|3000
|BP
|Verfahrensstand: Beschlussdatum gesetzt, aber noch keine Bekanntmachung
|Festgestellt
|-
|
|
|Plan
|3000
|FP
|
|Festgestellt
|-
|
|
|Plan
|3000
|LP
|
|Festgestellt
|-
|
|
|Entwurf genehmigt
|2001
|RP
|
|Festgestellt
|-
|
|
|Inkraftgetreten
|4000
|RP
|
|Festgestellt
|-
|3100
|inkraftgetreten
|Inkraftgetreten
|4000
|BP
|Verfahrensstand: Beschlussdatum + Bekanntmachung gesetzt
|Festgestellt
|-
|
|
|Inkraftgetreten
|4000
|RP
|unter Verfahrensstand: Beschlussdatum + Bekanntmachung gesetzt
|Festgestellt
|-
|
|
|Teilweiseuntergegangen
|4500
|BP
|
|Archiv
|-
|
|
|Teilweiseaufgehoben (XPlan 6.0)
|45000
|BP
|
|Archiv
|-
|
|
|Teilweiseausserkraft (XPlan 6.0)
|45001
|BP
|
|Archiv
|-
|
|
|Wirksamkeit
|4000
|FP
|
|Festgestellt
|-
|
|
|Wirksamkeit
|4000
|LP
|
|Festgestellt
|-
|3200
|außerkraftgetreten
|Teilweiseausserkraft
|6000
|RP
|unter Verfahrensstand: Tag des Inkrafttretens + Tag des Außerkrafttretens
|
|-
|4000
|ganz aufgehoben
|Untergegangen
|5000
|BP
|
|Archiv
|-
|
|
|Aufgehoben
|50000
|BP
|
|archiviert
|-
|
|
|Ausserkraft
|50001
|BP
|
|archiviert
|-
|
|
|Aufgehoben
|50000
|FP
|
|archiviert
|-
|
|
|Ausserkraft
|50001
|FP
|
|archiviert
|-
|
|
|Entwurf aufgegeben
|2003
|RP
|
|archiviert
|-
|5000
|eingestellt
|Untergegangen
|5000
|BP
|Ein eingestelltes Verfahren darf in keinem Dienst auftauchen, da es nicht rechtsgültig war.
|kein Dienst
|-
|
|
|Untergegangen
|5000
|FP
|
|archiviert
|-
|
|
|Untergegangen
|5000
|LP
|
|archiviert
|-
|6000
|laufendes Normenkontrollverfahren
|Im Verfahren (XPlan 6.0); Entwurf (XPlan 5.4) bzw. Inkraftgetreten
|2000 bzw. 4000
|BP
|beim lfd. Normenkontrollverfahren bleibt der Dienst Festgestellt, erst wenn das Verfahren wieder aufgenommen wird, kommt ein neues XPlanGML in den Dienst in Aufstellung
|Festgestellt oder in Aufstellung
|}

FAQ für M-A im DiPlanCockpit Pro

2026-03-23T11:40:12Z

Diplanung: /* XPlanGML / Planwerke */

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

Auf dieser Seite sind typische Fragen und die Antworten darauf gesammelt. Die Sortierung ist thematisch.

== Allgemein ==

* Wie sagen mir die Zahlen am Ende einer URL zum Cockpit im Reiter Aufgaben, z.B. in "meineUmgebung.diplanung.de/details/ID_99c61979-bbb5-4b40-8253-71068e680af5/1200/1/1210"?
** Die Zahlen stehen für den aktuell ausgewählten VTS, Durchgang und UVTS. VTS und UVTS entsprechen dem Code aus der jeweiligen Codeliste.

==Datenexport==
* Wie werden Metadaten durch das Cockpit bereitgestellt?
** Das DiPlanCockpit Backend stellt Metadaten in unterschiedlichen Datenmodellen/-formaten über folgenden Endpunkt bereit: URL-des-Cockpits/api/cockpit/swagger-ui/index.html#/metadaten-export-resource/getMetadaten. Dieser Endpunkt kann im Cockpit über „Einstellungen / Metadaten-Export an externe Metadateninformationssysteme“ initialisiert werden. Zusätzlich müssen die CSW-Systemparameter gesetzt werden.
*Wie können die Metadaten aus dem Cockpit an Drittsysteme angebunden werden?
**Es gibt die Export-Formate CSW und DCATAP-PLU. Diese können durch einen REST-Endpunkt abgefragt werden. Mittels DCATAP-PLU-Nachrichten werden Metadaten ans DiPlan Portal übergeben. Es sind zudem Transportverfahren für FitConnect und XTA2 im Cockpit integriert, werden Stand heute aber nur für den Nachrichtenaustausch mit XBauleitplanung/XBeteiligung verwendet. Nachrichten aus XPlanverfahren können aktuell nicht exportiert werden.
*Kann das CSW-Template für den Export beliebig angepasst werden? Können benutzerdefinierte Elemente komplett neu hinzugefügt werden?
**Ja. Im Admin-Bereich kann das CSW-Template ausgetauscht und damit angepasst werden.
*Wofür dient der Export mit CSW und DCATAP-PLU?
**CSW dient der Übermittlung von Metadaten zu Planwerken an Metadateninformationssysteme. DCATAP-PLU dient der Kommunikation zwischen dem DiPlan Cockpit und DiPlan Portal und übermittelt unter anderem beispielsweise den Plannamen, Planungsanlass, die Flächenabgrenzung im GeoJSON Format, den Verfahrensstand und die Verfahrensart.
*Welche Bezeichnung/welcher Name von Verfahren wird im Portal angezeigt? Planname? Arbeitstitel?
**Im DCAT-AP-PLU-Template wird im Element <code><plu:planName></code> der Planname übermittelt.
==Dokumente==
*Ist es möglich alle Dokumente aus dem Cockpit zusammen als ZIP-Datei runterzuladen? (auch die zusätzlichen Dokumente)
**Stand heute ist dies in der Dokumenten-Bibliothek nicht möglich. Die fachliche Anforderung, alle Dokumente eines Verfahrens auszuleiten, ist über den Fachlichen Ordner „Gerichtsordner“ abgebildet.
*Warum kann ich Dateien eines bestimmten Dateiformats nicht mit der Vormerkung für Beteiligungsverfahren versehen?
** Alle Dateiformate, die mit einer Vormerkung für Beteiligungsverfahren versehen werden können, sind im Systemparameter "fileAllowedExtensions.0800" angegeben. Diese Auflistung im Systemparameter kann bei Bedarf um weitere Dateiformate erweitert werden.
==Konfiguration==
*Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Markup im Dokument nach dem Root-Element muss ordnungsgemäß formatiert sein"''?
** Das bedeutet, dass in der Verfahrenskonfiguration ein Fehler hinsichtlich des Aufbaus der Datei vorliegt. Es kann beispielsweise sein, dass man Elemente in der falschen Reihenfolge angegeben hat. Um Fehlern dieser Art vorzubeugen ist es hilfreich, wenn man einen XML-Editor verwendet, der eine Validierung der Datei ermöglicht. So lässt sich vor dem Hochladen ins Cockpit prüfen, ob die XML korrekt gestaltet ist.
*Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Für x sind die folgenden Werte mehrfach vereinbart: A"''?
** Das bedeutet, dass in der Verfahrenskonfiguration ein Wert A mehrfach verwendet wird, der nur einmal verwendet werden darf. Das gilt beispielsweise für Unterverfahrensteilschritte (UVTS). Jeder UVTS darf in einer Verfahrenskonfiguration nur einmal vorkommen. Um den Fehler zu beheben, muss folglich einer der Werte abgeändert werden. Anschließend kann man die Verfahrenskonfiguration hochladen.
* Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Das Element x muss vorhanden sein"''?
** Das bedeutet, dass in der Verfahrenskonfiguration ein zwingend notwendiger Abschnitt x fehlt. Um den Fehler zu beheben, muss man den fehlenden Abschnitt hinzufügen und kann anschließend die Verfahrenskonfiguration hochladen.
* Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Die folgenden refIDs sind in der Verfahrenskonfiguration doppelt vergeben: [X]"''?
** RefIDs müssen eindeutig sein, sprich sie dürfen nur einmal verwendet werden. Der Fehler besagt, dass die refID X mehr als einmal vorhanden ist. Um den Fehler zu beheben, muss das Duplikat entfernt werden, z.B. durch Änderung einer der Angaben von X. Anschließend kann man die Verfahrenskonfiguration hochladen.

* Was bedeutet beim Hochladen einer Codeliste eine Fehlermeldung in der Form ''"Die Codeliste passt nicht zur Verfahrenskonfiguration A: kein Wert für Codeliste B und Wert C zu ermitteln"'' oder ''"Die Codeliste enthält nicht folgende erforderlichen Codes: C"'' oder ''"Code C wird noch in Tabelle X benutzt und kann nicht gelöscht werden"''?
** Die Meldungen bedeuten, dass in der Verfahrenskonfiguration A oder an Stelle X ein Codelistenwert C verwendet wird, der in der Version der Codeliste B, die man versucht hochzuladen, fehlt. Um den Fehler zu lösen, muss man einen Eintrag für den Wert C in die Codeliste B hinzufügen und kann anschließend die Codeliste hochladen. Wenn man den Codelistenwert C löschen möchte, dann muss man zuerst alle Verfahren und Verfahrenskonfigurationen löschen, in denen der Wert verwendet wird.
* Was bedeutet beim Hochladen einer Codeliste eine Fehlermeldung in der Form ''"Die Codeliste enthält Namen die doppelt vergeben sind: [A]"'' oder ''"Duplicate key B"''?
** Die Meldungen bedeuten, dass in der Codeliste, die man versucht hochzuladen, ein Wert doppelt vorhanden ist. Um den Fehler zu lösen, muss man einen der beiden Einträge aus der Codeliste entfernen und kann anschließend die Codeliste hochladen.
*Was bezwecken die Angaben "code" und "beschreibung" in einer Codeliste bzw. "label" in der Verfahrenskonfiguration?
**In einer Codelisten bilden "code" + "beschreibung" ein Paar, das unique vergeben werden muss. Das heißt, nur einmal enthalten sein darf. Bei mehrfacher Verwendung einer "beschreibung" in einer Codeliste, wird der Upload mit einer Fehlermeldung in folgender Form untersagt: "Die Codeliste enthält Namen, die doppelt vergeben sind: [beispielBeschreibung]". In einer Verfahrenskonfiguration wird auf Codelisteneinträge per "code" referenziert. Im Frontend wird der Wert der "beschreibung" angezeigt. Zusätzlich gibt es z.B. bei Aufgaben in der Verfahrenskonfiguration das "label". Dieses wird als Name der Aufgabe im Frontend angezeigt.
*Wer darf änderbare Codelisten anpassen?
**Mandanten-Admins können änderbare Codelisten anpassen.
*Welche Änderungen darf ich als Mandanten-Admin an Codelisten vornehmen?
**Das ist je nach Codeliste unterschiedlich. Teilweise sind gar keine eigenen Anpassungen möglich, teilweise können nur Einträge hinzugefügt, teilweise auch Einträge gelöscht werden. Eine detaillierte Beschreibung findet sich in Kapitel [[Codelisten für DiPlan Cockpit Pro|6.3]]. des Handbuchs.
*Welche Einträge in veränderbaren Codelisten darf man löschen und welche nicht?
**Alle in einer Verfahrenskonfiguration (VK) enthaltenen Codes müssen in einer Codeliste zu finden sein. Im Zuge der Mandanten spezifischen Anpassung lassen sich weitere Verfahrenstypen/Verfahrenssteuerungen konfigurieren, die auch auf Einträge in veränderbaren Codelisten referenzieren. Diese Einträge in einer VK müssen in veränderbaren Codelisten enthalten sein, die VOR einer neuen Verfahrenskonfiguration ins DiPlanCockpit hochgeladen werden müssen. Dies können Nutzende in der Rollen M-A vornehmen. Im Zuge der Erweiterungen von VKs "wachsen" veränderbare Codelisten mit, d.h. dort enthaltene Einträge werden i.d.R. ergänzt um neue und nicht bestehende Einträge gelöscht bzw. überschrieben.
*Benötigt man als Mandanten-Admin die XSD zu den XML-Dateien?
**Nein. Die XSD dient nur dem System zur Validierung der XMLs.
*Was kann ich tun, wenn sich in einer änderbaren Codeliste ein Fehler eingeschlichen hat?
**Ein fehlerhafter Eintrag in einer änderbaren Codeliste kann korrigiert werden oder auch gelöscht, sofern er nicht in einem Verfahren verwendet wird. Eine detaillierte Anleitung findet sich in Kapitel [[Codelisten für DiPlan Cockpit Pro|6.3]].
*Was kann alles über die fachliche Leitstelle für das Cockpit konfiguriert werden? Welche Systemparameter? Welche Konfigurationen? Gibt es eine Übersicht/Liste dazu?
**In den entsprechenden Abschnitten dieses Handbuchs (z.B. bezüglich der Systemparameter oder Verfahrenskonfiguration) ist beschrieben, wer welche Anpassungen vornehmen kann.
*Kann das „Wording“ des Verfahrensstands mandantenspezifisch angepasst/konfiguriert werden?
**Die Codeliste Verfahrensstand ist Stand heute eine nicht änderbare Codelisten und kann daher nicht angepasst werden. Ist dies gewünscht muss das mit der Fachlichkeit (PO/BA) geklärt werden. Sie ist eine feste Codeliste, die den bundesweiten Standard beschreibt. Wenn Ergänzungen gewünscht sind, muss ein nachnutzendes Land / NN Land / MiLa den Bedarf bei der XLeitstelle melden. Dort wird er geprüft und bei positiver Entscheidung die Codeliste ergänzt.
*Müssen die Codes nach einem bestimmten Schema angelegt werden, z.B. Verfahrensschritte nur als vierstellige Codes in Hunderter-Schritten, also 3100, 3200, 3300 usw.?
**Nein. Die Codes können beliebig gestaltet sein, sie müssen weder zwingend vierstellig sein, noch muss ein bestimmtes Muster eingehalten werden. Damit sie übersichtlicher und leichter nachvollziehbar sind, ist es dennoch empfehlenswert nicht vollkommen willkürliche Codes zu verwenden. Wichtig ist bezüglich des Formats nur, dass die Codes innerhalb einer Codeliste eindeutig sind (= nur einmal vorkommen) und keine Zeichen enthalten, die nicht mit der URL-Codierung kompatibel sind. Codes (insbesondere Verfahrensschritte, Verfahrensteilschritte, Unterverfahrensteilschritte) können Teil URL sein, und müssen deswegen darin darstellbar sein. Nicht erlaubt sind: Leerzeichen : / ? # ( ) [ ] @ ! $ % & ' * + , ; =
*Können Aufgaben "wiederverwendet" werden, beispielsweise wenn für jede Sitzung die gleichen Vorbereitungen erledigt werden müssen?
**Nicht direkt. Es ist keine Referenz, Verlinkung oder ähnliches möglich. Am einfachsten ist es in solchen Fällen die Aufgabe per Copy&Paste zu übernehmen. Dabei ist darauf zu achten, jeweils eine neue, eindeutige ID zu vergeben. Es darf nicht mehrere (Unter-)aufgaben mit der selben ID geben.
*Je Verfahrenssteuerungstyp lässt sich eine Verfahrenskonfiguration anlegen. Was ist, wenn man mehrere Verfahrenskonfigurationen für einen Verfahrenssteuerungstyp möchte?
**In diesem Fall muss auch der Verfahrenssteuerungstyp mehrfach angelegt werden, beispielsweise in der Form A und B. Dann kann sowohl für A als auch B eine eigene Verfahrenskonfiguration erstellt werden. Dies sollte nur wenn unbedingt notwendig geschehen, weil sich dadurch der Administrationsaufwand zusätzlich erhöht.
*Muss jeder Verfahrensschritt (VS) Verfahrensteilschritte (VTS) haben?
**Jein. In der Verfahrenkonfiguration können VS ohne VTS angegeben werden. Diese sind jedoch nicht im DiPlan Cockpit sichtbar. Angezeigt werden nur VS mit VTS.
==Logging==
*Wie lange werden Logs aufbewahrt?
**Aktuell werden Log-Dateien für 30 Tage gespeichert und sind im Reiter "Protokolle" des Bereichs "Fachliche Leitstelle Administration" einsehbar .
==Login==
*Können mehrere Personen den gleichen Zugang verwenden?
**Nein. Alle Nutzenden müssen eigene Login-Daten haben, z.B. über ein personalisiertes Elster-Zertifikat. Nur so können Log-Einträge eindeutig Nutzenden zugeordnet werden.

== Raumordnung ==

* Kann ich Verfahren für die Raumordnung anlegen?
** Für die Raumordnung sind bis auf Weiteres Basis-Funktionalitäten umgesetzt. Basis-Verfahren sind somit möglich und es gibt eine entsprechende Beispiel-Verfahrenskonfiguration.

==Verfahren==
*Warum wird mir nach dem Klick auf "Verfahren starten" bei einem simulierten Verfahren ein Fehler angezeigt?
**Ein simuliertes Verfahren kann nur gestartet werden, wenn sowohl der Planstatus als auch der Verfahrensstand den Wert "simuliert" haben. Auf der Stammdatenseite des Verfahrens kann der Verfahrensstand simulierter Verfahren geändert werden. Bitte prüfen Sie diesen und setzen Sie ihn gegebenenfalls auf simuliert, um das Verfahren anschließend starten zu können.
*Kann ein Planname für mehrere Verfahren genutzt werden?
**Der Planname wird beim Starten des Verfahrens eingetragen. Innerhalb eines Mandanten kann ein Planname nur einmal vergeben sein, da auf dem Datenbank-Feld „Planname“ ein unique-Constraint liegt.
*Was bedeutet eine Fehlermeldung wie z.B. "Unerwarteter Fehler - Erstellen des Verfahrens fehlgeschlagen! - Fehlermeldung: Die Verfahrenskonfiguration hat das AktionItem ActionItemEntity[id=null, Code=Code[code=0820, name=drop down], Sitzungscode=Code[code=9100, name=Dummy Sitzung politisch]] konfiguriert, welches auf einen Termin verweist, der am Verfahren nicht existiert"?
**Hier ist das Problem, dass in der Verfahrenskonfiguration ein Termin in einer Aufgabe referenziert wird, der im Bereich zu Zeitplanung fehlt. Dementsprechend muss in der Verfahrenskonfiguration der Termin aus der Aufgabe entfernt oder in die Zeitplanung hinzugefügt werden, um den Fehler zu beheben.
*Können Verfahren in DiPlanCockpit Basis angelegt und später in DiPlanCockpit Pro fortgeführt werden oder umgekehrt?
**Es soll kein Mischbetrieb von DiPlanCockpit Basis und Pro erfolgen und ein Verfahren nur in Basis oder nur in Pro genutzt werden.
*Ist der Import von Verfahren zur Raumordnung / Raumordnungsplan-Verfahren möglich?
** Der Import von Verfahren zur Raumordnung / Raumordnungsplan-Verfahren ins DiPlanCockpit ist nicht vorgesehen. Stattdessen sind die (wenigen) Bestandsdaten manuell im DiPlanCockpit anzulegen.

== XML ==

* Können in den XML-Konfigurationen Sonderzeichen in den Elementen stehen?
** Bestimmte Zeichen in einer XML müssen encoded werden, damit sie nicht eine besondere Rolle im XML-Syntax erfüllen. Allgemein gibt es 5 Zeichen, die in XML escaped werden müssen:
*** " muss escaped werden als &quot;
*** ' muss escaped werden als &apos;
*** < muss escaped werden als &lt;
*** > muss escaped werden als &gt;
*** & muss escaped werden als &amp;

==XPlanGML / Planwerke==
*Kann das Cockpit Daten über XPlanGML über WFS oder anderem Wege aufnehmen? Wenn ja, welche Version?
** Das System nutzt den Standard XPlanung ab der Version 5.4. Bebauungspläne werden als XPlanGML-Datei hochgeladen und veröffentlicht. WMS und WFS werden als externe Dienste für Verwendung in Drittsystemen bereitgestellt. Das DiPlanCockpit ermöglicht eine Veröffentlichung von XPlanGML Dateien über den Planwerke Reiter im Cockpit. Umringe von Bebauungsplänen können im DiPlan Kartenclient auf Datengrundlage einen ALKIS WFS Dienstes direkt im XPlanung Datenmodell erfasst werden. Weiterhin können vorliegende XPlanGML Dateien über einen XPlanverfahren Massenimport importiert werden. XPlanverfahren Dateien können durch eine Transformation aus XPlanGML Dateien über ein von der XLeitstelle bereitgestelltes Skript in XPlanverfahren transformiert werden und ggf. um weitere Verfahren beschreibende Meta- oder Datumsangaben ergänzt werden.
*Welcher Version muss ein Planwerk mindestens entsprechen, um es ins Cockpit hochzuladen?
**Die Version muss 5.4 oder höher sein.
*Wie groß darf ein Planwerk für den Upload maximal sein?
**Aktuell liegt die maximal erlaubte Dateigröße einer XPlanGML für den Upload bei 100 MB.
*Beim Versuch ein Planwerk hochzuladen wird ein Fehler angezeigt. Woran liegt das?
**Das kann verschiedene Ursachen haben. Bitte prüfen Sie zunächst, ob von Seiten Ihrer hauseigenen IT das Hochladen einer ZIP-Datei gestattet ist. Der Upload kann unterbunden sein und so den Eindruck eines Fehlers im Cockpit erwecken.
**Eine weitere mögliche Ursache ist ein falsch gesetzter Systemparameter. Das kann beispielsweise nach einem Update des Cockpits der Fall sein, wenn durch die zuständige Administration erforderliche Anpassungen der Systemparameter noch nicht erfolgt sind.
*Werden Rasterbilder im Dienst nicht mit dargestellt?
**Wenn korrekte Rasterdaten mit importiert wurden, werden diese auch über den WMS ausgeliefert; ob sie dargestellt werden, hängt dann davon ab, wie der Client konfiguriert ist.
*Wird ein Planwerks-WFS bereit gestellt? Kann man als Admin-Rolle auf alle Dienste (URLs) zugreifen? Wo? Wie?
**Ja und nein. Es wird kein Planwerk-WFS bereitgestellt, sondern ein WFS aller Planwerke, der jedoch über Filter nur die Inhalte eines speziellen Plans ausgeben kann. Über das Cockpit wird heute noch keine aufbereitete URL angeboten.
*Kann ein einmal veröffentlichtes ZIP-Archiv vom Planwerk wieder gelöscht werden?
**Nein. Es ist möglich die Veröffentlichung zurückzuziehen, aber nicht es zu löschen.
*Der Versuch ein Planwerk zu veröffentlichen führt zu einer Fehlermeldung in der Form "Das Verfahren ''LoremIpsum'' besitzt den Verfahrensstand ''im Verfahren''. Die xplan.gml Datei jedoch den Rechtsstand ''beschlossen''". Das heißt, der Verfahrensstand auf der Stammdatenseite passt nicht zum Rechtsstand in der xplan.gml und eines von beidem muss angepasst werden. Das führt zu der Frage: Welche Kombinationen von Verfahrensstand und Rechtsstand sind zulässig?
**Die folgende Tabelle gibt einen Überblick (Tabelle öffnet sich bei Klick auf "Ausklappen"):
{| class="wikitable mw-collapsible mw-collapsed"
!Code
!Verfahrenstand (XPlanverfahren) im DiPlanCockpit
!Rechtsstand (XPlan) im XPlanGML
!Code
!Planarten
!Kommentar
!Planstatus = Dienstebene (ergibt sich aus dem Rechtsstand)
|-
|1000
|simuliert
|nicht vorhanden
|keiner
|BP
|Ein simuliertes Verfahren darf in keinem Dienst auftauchen, da es noch nicht rechtsgültig ist.
|kein Dienst
|-
|
|
|nicht vorhanden
|keiner
|RP
|Ein simuliertes Verfahren darf in keinem Dienst auftauchen, da es noch nicht rechtsgültig ist.
|kein Dienst
|-
|2000
|im Verfahren
|Aufstellungsbeschluss
|1000
|BP
|
|in Aufstellung (pre)
|-
|
|
|Aufstellungsbeschluss
|1000
|FP
|
|in Aufstellung
|-
|
|
|Aufstellungsbeschluss
|1000
|LP
|
|in Aufstellung
|-
|
|
|Aufstellungsbeschluss
|1000
|RP
|
|in Aufstellung
|-
|
|
|Entwurf (XPlan 5.4)
|2000
|BP
|
|in Aufstellung
|-
|
|
|Im Verfahren (XPlan 6.0)
|2000
|FP
|
|in Aufstellung
|-
|
|
|Entwurf
|2000
|FP
|
|in Aufstellung
|-
|
|
|Entwurf
|2000
|LP
|
|in Aufstellung
|-
|
|
|Entwurf
|2000
|RP
|
|in Aufstellung
|-
|
|
|Frühzeitige Behördenbeteiligung
|2100
|BP
|
|in Aufstellung
|-
|
|
|Frühzeitige Öffentlichkeitsbeteiligung
|2200
|BP
|
|in Aufstellung
|-
|
|
|Entwurf geändert
|2002
|RP
|
|in Aufstellung
|-
|
|
|Behördenbeteiligung
|2300
|BP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|BP
|
|in Aufstellung
|-
|
|
|Frühzeitige Behördenbeteiligung
|2100
|FP
|
|in Aufstellung
|-
|
|
|Frühzeitige Öffentlichkeitsbeteiligung
|2200
|FP
|
|in Aufstellung
|-
|
|
|Entwurfsbeschluss
|2250
|FP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|BP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|FP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|LP
|
|in Aufstellung
|-
|3000
|beschlossen
|Satzung
|3000
|BP
|Verfahrensstand: Beschlussdatum gesetzt, aber noch keine Bekanntmachung
|Festgestellt
|-
|
|
|Plan
|3000
|FP
|
|Festgestellt
|-
|
|
|Plan
|3000
|LP
|
|Festgestellt
|-
|
|
|Entwurf genehmigt
|2001
|RP
|
|Festgestellt
|-
|
|
|Inkraftgetreten
|4000
|RP
|
|Festgestellt
|-
|3100
|inkraftgetreten
|Inkraftgetreten
|4000
|BP
|Verfahrensstand: Beschlussdatum + Bekanntmachung gesetzt
|Festgestellt
|-
|
|
|Inkraftgetreten
|4000
|RP
|unter Verfahrensstand: Beschlussdatum + Bekanntmachung gesetzt
|Festgestellt
|-
|
|
|Teilweiseuntergegangen
|4500
|BP
|
|Archiv
|-
|
|
|Teilweiseaufgehoben (XPlan 6.0)
|45000
|BP
|
|Archiv
|-
|
|
|Teilweiseausserkraft (XPlan 6.0)
|45001
|BP
|
|Archiv
|-
|
|
|Wirksamkeit
|4000
|FP
|
|Festgestellt
|-
|
|
|Wirksamkeit
|4000
|LP
|
|Festgestellt
|-
|3200
|außerkraftgetreten
|Teilweiseausserkraft
|6000
|RP
|unter Verfahrensstand: Tag des Inkrafttretens + Tag des Außerkrafttretens
|
|-
|4000
|ganz aufgehoben
|Untergegangen
|5000
|BP
|
|Archiv
|-
|
|
|Aufgehoben
|50000
|BP
|
|archiviert
|-
|
|
|Ausserkraft
|50001
|BP
|
|archiviert
|-
|
|
|Aufgehoben
|50000
|FP
|
|archiviert
|-
|
|
|Ausserkraft
|50001
|FP
|
|archiviert
|-
|
|
|Entwurf aufgegeben
|2003
|RP
|
|archiviert
|-
|5000
|eingestellt
|Untergegangen
|5000
|BP
|Ein eingestelltes Verfahren darf in keinem Dienst auftauchen, da es nicht rechtsgültig war.
|kein Dienst
|-
|
|
|Untergegangen
|5000
|FP
|
|archiviert
|-
|
|
|Untergegangen
|5000
|LP
|
|archiviert
|-
|6000
|laufendes Normenkontrollverfahren
|Im Verfahren (XPlan 6.0); Entwurf (XPlan 5.4) bzw. Inkraftgetreten
|2000 bzw. 4000
|BP
|beim lfd. Normenkontrollverfahren bleibt der Dienst Festgestellt, erst wenn das Verfahren wieder aufgenommen wird, kommt ein neues XPlanGML in den Dienst in Aufstellung
|Festgestellt oder in Aufstellung
|}

FAQ für M-A

2026-03-23T11:26:25Z

Diplanung:

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

Auf dieser Seite sind typische Fragen und die Antworten darauf gesammelt. Die Sortierung ist thematisch.

== Allgemein ==

* Wie sagen mir die Zahlen am Ende einer URL zum Cockpit im Reiter Aufgaben, z.B. in "meineUmgebung.diplanung.de/details/ID_99c61979-bbb5-4b40-8253-71068e680af5/1200/1/1210"?
** Die Zahlen stehen für den aktuell ausgewählten VTS, Durchgang und UVTS. VTS und UVTS entsprechen dem Code aus der jeweiligen Codeliste.

== Datenexport ==

* Wie werden Metadaten durch das Cockpit bereitgestellt?
** Das DiPlanCockpit Backend stellt Metadaten in unterschiedlichen Datenmodellen/-formaten über folgenden Endpunkt bereit: URL-des-Cockpits/api/cockpit/swagger-ui/index.html#/metadaten-export-resource/getMetadaten. Dieser Endpunkt kann im Cockpit über „Einstellungen / Metadaten-Export an externe Metadateninformationssysteme“ initialisiert werden. Zusätzlich müssen die CSW-Systemparameter gesetzt werden.
* Wie können die Metadaten aus dem Cockpit an Drittsysteme angebunden werden?
** Es gibt die Export-Formate CSW und DCATAP-PLU. Diese können durch einen REST-Endpunkt abgefragt werden. Mittels DCATAP-PLU-Nachrichten werden Metadaten ans DiPlan Portal übergeben. Es sind zudem Transportverfahren für FitConnect und XTA2 im Cockpit integriert, werden Stand heute aber nur für den Nachrichtenaustausch mit XBauleitplanung/XBeteiligung verwendet. Nachrichten aus XPlanverfahren können aktuell nicht exportiert werden.
* Kann das CSW-Template für den Export beliebig angepasst werden? Können benutzerdefinierte Elemente komplett neu hinzugefügt werden?
** Ja. Im Admin-Bereich kann das CSW-Template ausgetauscht und damit angepasst werden.
* Wofür dient der Export mit CSW und DCATAP-PLU?
** CSW dient der Übermittlung von Metadaten zu Planwerken an Metadateninformationssysteme. DCATAP-PLU dient der Kommunikation zwischen dem DiPlan Cockpit und DiPlan Portal und übermittelt unter anderem beispielsweise den Plannamen, Planungsanlass, die Flächenabgrenzung im GeoJSON Format, den Verfahrensstand und die Verfahrensart.
* Welche Bezeichnung/welcher Name von Verfahren wird im Portal angezeigt? Planname? Arbeitstitel?
** Im DCAT-AP-PLU-Template wird im Element <code><plu:planName></code> der Planname übermittelt.

== Dokumente ==

* Ist es möglich alle Dokumente aus dem Cockpit zusammen als ZIP-Datei runterzuladen? (auch die zusätzlichen Dokumente)
** Stand heute ist dies in der Dokumenten-Bibliothek nicht möglich. Die fachliche Anforderung, alle Dokumente eines Verfahrens auszuleiten, ist über den Fachlichen Ordner „Gerichtsordner“ abgebildet.

== Konfiguration ==

* Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Markup im Dokument nach dem Root-Element muss ordnungsgemäß formatiert sein"''?
** Das bedeutet, dass in der Verfahrenskonfiguration ein Fehler hinsichtlich des Aufbaus der Datei vorliegt. Es kann beispielsweise sein, dass man Elemente in der falschen Reihenfolge angegeben hat. Um Fehlern dieser Art vorzubeugen ist es hilfreich, wenn man einen XML-Editor verwendet, der eine Validierung der Datei ermöglicht. So lässt sich vor dem Hochladen ins Cockpit prüfen, ob die XML korrekt gestaltet ist.
* Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Für x sind die folgenden Werte mehrfach vereinbart: A"''?
** Das bedeutet, dass in der Verfahrenskonfiguration ein Wert A mehrfach verwendet wird, der nur einmal verwendet werden darf. Das gilt beispielsweise für Unterverfahrensteilschritte (UVTS). Jeder UVTS darf in einer Verfahrenskonfiguration nur einmal vorkommen. Um den Fehler zu beheben, muss folglich einer der Werte abgeändert werden. Anschließend kann man die Verfahrenskonfiguration hochladen.
* Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Das Element x muss vorhanden sein"''?
** Das bedeutet, dass in der Verfahrenskonfiguration ein zwingend notwendiger Abschnitt x fehlt. Um den Fehler zu beheben, muss man den fehlenden Abschnitt hinzufügen und kann anschließend die Verfahrenskonfiguration hochladen.
* Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Die folgenden refIDs sind in der Verfahrenskonfiguration doppelt vergeben: [X]"''?
** RefIDs müssen eindeutig sein, sprich sie dürfen nur einmal verwendet werden. Der Fehler besagt, dass die refID X mehr als einmal vorhanden ist. Um den Fehler zu beheben, muss das Duplikat entfernt werden, z.B. durch Änderung einer der Angaben von X. Anschließend kann man die Verfahrenskonfiguration hochladen.
* Was bedeutet beim Hochladen einer Codeliste eine Fehlermeldung in der Form ''"Die Codeliste passt nicht zur Verfahrenskonfiguration A: kein Wert für Codeliste B und Wert C zu ermitteln"'' oder ''"Die Codeliste enthält nicht folgende erforderlichen Codes: C"'' oder ''"Code C wird noch in Tabelle X benutzt und kann nicht gelöscht werden"''?
** Die Meldungen bedeuten, dass in der Verfahrenskonfiguration A oder an Stelle X ein Codelistenwert C verwendet wird, der in der Version der Codeliste B, die man versucht hochzuladen, fehlt. Um den Fehler zu lösen, muss man einen Eintrag für den Wert C in die Codeliste B hinzufügen und kann anschließend die Codeliste hochladen. Wenn man den Codelistenwert C löschen möchte, dann muss man zuerst alle Verfahren und Verfahrenskonfigurationen löschen, in denen der Wert verwendet wird.
* Was bedeutet beim Hochladen einer Codeliste eine Fehlermeldung in der Form ''"Die Codeliste enthält Namen die doppelt vergeben sind: [A]"'' oder ''"Duplicate key B"''?
** Die Meldungen bedeuten, dass in der Codeliste, die man versucht hochzuladen, ein Wert doppelt vorhanden ist. Um den Fehler zu lösen, muss man einen der beiden Einträge aus der Codeliste entfernen und kann anschließend die Codeliste hochladen.

* Wer darf änderbare Codelisten anpassen?
** Mandanten-Admins können änderbare Codelisten anpassen.
* Welche Änderungen darf ich als Mandanten-Admin an Codelisten vornehmen?
** Das ist je nach Codeliste unterschiedlich. Teilweise sind gar keine eigenen Anpassungen möglich, teilweise können nur Einträge hinzugefügt, teilweise auch Einträge gelöscht werden. Eine detaillierte Beschreibung findet sich in Kapitel [[Codelisten|6.3]]. des Handbuchs.
* Welche Einträge in veränderbaren Codelisten darf man löschen und welche nicht?
** Alle in einer Verfahrenskonfiguration (VK) enthaltenen Codes müssen in einer Codeliste zu finden sein. Im Zuge der Mandanten spezifischen Anpassung lassen sich weitere Verfahrenstypen/Verfahrenssteuerungen konfigurieren, die auch auf Einträge in veränderbaren Codelisten referenzieren. Diese Einträge in einer VK müssen in veränderbaren Codelisten enthalten sein, die VOR einer neuen Verfahrenskonfiguration ins DiPlanCockpit hochgeladen werden müssen. Dies können Nutzende in der Rollen M-A vornehmen. Im Zuge der Erweiterungen von VKs "wachsen" veränderbare Codelisten mit, d.h. dort enthaltene Einträge werden i.d.R. ergänzt um neue und nicht bestehende Einträge gelöscht bzw. überschrieben.
* Benötigt man als Mandanten-Admin die XSD zu den XML-Dateien?
** Nein. Die XSD dient nur dem System zur Validierung der XMLs.
* Was kann ich tun, wenn sich in einer änderbaren Codeliste ein Fehler eingeschlichen hat?
** Ein fehlerhafter Eintrag in einer änderbaren Codeliste kann korrigiert werden oder auch gelöscht, sofern er nicht in einem Verfahren verwendet wird. Eine detaillierte Anleitung findet sich in Kapitel [[Codelisten|6.3]].
* Sofern man neue Zuständigkeiten über die Codeliste hinzufügt, können diese im Nachgang gelöscht werden, sofern sich doch ein Fehler eingeschlichen hat?
** Nicht verwendete Codelisten-Einträge können aus der Codeliste für die Zuständigkeit gelöscht werden. Das gilt jedoch nicht für alle Codelisten, deswegen bitte die jeweilige Dokumentation dazu beachten.
* Was kann alles über die fachliche Leitstelle für das Cockpit konfiguriert werden? Welche Systemparameter? Welche Konfigurationen? Gibt es eine Übersicht/Liste dazu?
** In den entsprechenden Abschnitten dieses Handbuchs (z.B. bezüglich der Systemparameter oder Verfahrenskonfiguration) ist beschrieben, wer welche Anpassungen vornehmen kann.
* Kann das „Wording“ des Verfahrensstands mandantenspezifisch angepasst/konfiguriert werden?
** Die Codeliste Verfahrensstand ist Stand heute eine nicht änderbare Codelisten und kann daher nicht angepasst werden. Ist dies gewünscht muss das mit der Fachlichkeit (PO/BA) geklärt werden. Sie ist eine feste Codeliste, die den bundesweiten Standard beschreibt. Wenn Ergänzungen gewünscht sind, muss ein nachnutzendes Land / NN Land / MiLa den Bedarf bei der XLeitstelle melden. Dort wird er geprüft und bei positiver Entscheidung die Codeliste ergänzt.
* Müssen die Codes nach einem bestimmten Schema angelegt werden, z.B. Verfahrensschritte nur als vierstellige Codes in Hunderter-Schritten, also 3100, 3200, 3300 usw.?
** Nein. Die Codes können beliebig gestaltet sein, sie müssen weder zwingend vierstellig sein, noch muss ein bestimmtes Muster eingehalten werden. Damit sie übersichtlicher und leichter nachvollziehbar sind, ist es dennoch empfehlenswert nicht vollkommen willkürliche Codes zu verwenden. Wichtig ist bezüglich des Formats nur, dass die Codes innerhalb einer Codeliste eindeutig sind (= nur einmal vorkommen) und keine Zeichen enthalten, die nicht mit der URL-Codierung kompatibel sind. Codes (insbesondere Verfahrensschritte, Verfahrensteilschritte, Unterverfahrensteilschritte) können Teil URL sein, und müssen deswegen darin darstellbar sein. Nicht erlaubt sind: Leerzeichen : / ? # ( ) [ ] @ ! $ % & ' * + , ; =
* Je Verfahrenssteuerungstyp lässt sich eine Verfahrenskonfiguration anlegen. Was ist, wenn man mehrere Verfahrenskonfigurationen für einen Verfahrenssteuerungstyp möchte?
** In diesem Fall muss auch der Verfahrenssteuerungstyp mehrfach angelegt werden, beispielsweise in der Form A und B. Dann kann sowohl für A als auch B eine eigene Verfahrenskonfiguration erstellt werden. Dies sollte nur wenn unbedingt notwendig geschehen, weil sich dadurch der Administrationsaufwand zusätzlich erhöht.
* Muss jeder Verfahrensschritt (VS) Verfahrensteilschritte (VTS) haben?
** Jein. In der Verfahrenkonfiguration können VS ohne VTS angegeben werden. Diese sind jedoch nicht im DiPlan Cockpit sichtbar. Angezeigt werden nur VS mit VTS.

== Logging ==

* Wie lange werden Logs aufbewahrt?
** Aktuell werden Log-Dateien für 30 Tage gespeichert und sind im Reiter "Protokolle" des Bereichs "Fachliche Leitstelle Administration" einsehbar .

== Login ==

* Können mehrere Personen den gleichen Zugang verwenden?
** Nein. Alle Nutzenden müssen eigene Login-Daten haben, z.B. über ein personalisiertes Elster-Zertifikat. Nur so können Log-Einträge eindeutig Nutzenden zugeordnet werden.

== Raumordnung ==

* Kann ich Verfahren für die Raumordnung anlegen?
** Für die Raumordnung sind bis auf Weiteres Basis-Funktionalitäten umgesetzt. Basis-Verfahren sind somit möglich und es gibt eine entsprechende Beispiel-Verfahrenskonfiguration.

== Verfahren ==

* Warum wird mir nach dem Klick auf "Verfahren starten" bei einem simulierten Verfahren ein Fehler angezeigt?
** Ein simuliertes Verfahren kann nur gestartet werden, wenn sowohl der Planstatus als auch der Verfahrensstand den Wert "simuliert" haben. Auf der Stammdatenseite des Verfahrens kann der Verfahrensstand simulierter Verfahren geändert werden. Bitte prüfen Sie diesen und setzen Sie ihn gegebenenfalls auf simuliert, um das Verfahren anschließend starten zu können.
* Kann ein Planname für mehrere Verfahren genutzt werden?
** Der Planname wird beim Starten des Verfahrens eingetragen. Innerhalb eines Mandanten kann ein Planname nur einmal vergeben sein, da auf dem Datenbank-Feld „Planname“ ein unique-Constraint liegt.
* Was bedeutet eine Fehlermeldung wie z.B. "Unerwarteter Fehler - Erstellen des Verfahrens fehlgeschlagen! - Fehlermeldung: Die Verfahrenskonfiguration hat das AktionItem ActionItemEntity[id=null, Code=Code[code=0820, name=drop down], Sitzungscode=Code[code=9100, name=Dummy Sitzung politisch]] konfiguriert, welches auf einen Termin verweist, der am Verfahren nicht existiert"?
** Hier ist das Problem, dass in der Verfahrenskonfiguration ein Termin in einer Aufgabe referenziert wird, der im Bereich zu Zeitplanung fehlt. Dementsprechend muss in der Verfahrenskonfiguration der Termin aus der Aufgabe entfernt oder in die Zeitplanung hinzugefügt werden, um den Fehler zu beheben.
* Können Verfahren in DiPlanCockpit Basis angelegt und später in DiPlanCockpit Pro fortgeführt werden oder umgekehrt?
**Es soll kein Mischbetrieb von DiPlanCockpit Basis und Pro erfolgen und ein Verfahren nur in Basis oder nur in Pro genutzt werden.
* Ist der Import von Verfahren zur Raumordnung / Raumordnungsplan-Verfahren möglich?
** Der Import von Verfahren zur Raumordnung / Raumordnungsplan-Verfahren ins DiPlanCockpit ist nicht vorgesehen. Stattdessen sind die (wenigen) Bestandsdaten manuell im DiPlanCockpit anzulegen.

== XML ==

* Können in den XML-Konfigurationen Sonderzeichen in den Elementen stehen?
** Bestimmte Zeichen in einer XML müssen encoded werden, damit sie nicht eine besondere Rolle im XML-Syntax erfüllen. Allgemein gibt es 5 Zeichen, die in XML escaped werden müssen:
*** " muss escaped werden als &quot;
*** ' muss escaped werden als &apos;
*** < muss escaped werden als &lt;
*** > muss escaped werden als &gt;
*** & muss escaped werden als &amp;

== XPlanGML / Planwerke ==

* Welcher Version muss ein Planwerk mindestens entsprechen, um es ins Cockpit hochzuladen?
** Die Version muss 5.4 oder höher sein.
* Wie groß darf ein Planwerk für den Upload maximal sein?
** Aktuell liegt die maximal erlaubte Dateigröße einer XPlanGML für den Upload bei 100 MB.
* Beim Versuch ein Planwerk hochzuladen wird ein Fehler angezeigt. Woran liegt das?
** Das kann verschiedene Ursachen haben. Bitte prüfen Sie zunächst, ob von Seiten Ihrer hauseigenen IT das Hochladen einer ZIP-Datei gestattet ist. Der Upload kann unterbunden sein und so den Eindruck eines Fehlers im Cockpit erwecken.
** Eine weitere mögliche Ursache ist ein falsch gesetzter Systemparameter. Das kann beispielsweise nach einem Update des Cockpits der Fall sein, wenn durch die zuständige Administration erforderliche Anpassungen der Systemparameter noch nicht erfolgt sind.
* Werden Rasterbilder im Dienst nicht mit dargestellt?
** Wenn korrekte Rasterdaten mit importiert wurden, werden diese auch über den WMS ausgeliefert; ob sie dargestellt werden, hängt dann davon ab, wie der Client konfiguriert ist.
* Wird ein Planwerks-WFS bereit gestellt? Kann man als Admin-Rolle auf alle Dienste (URLs) zugreifen? Wo? Wie?
** Ja und nein. Es wird kein Planwerk-WFS bereitgestellt, sondern ein WFS aller Planwerke, der jedoch über Filter nur die Inhalte eines speziellen Plans ausgeben kann. Über das Cockpit wird heute noch keine aufbereitete URL angeboten.
* Kann ein einmal veröffentlichtes ZIP-Archiv vom Planwerk wieder gelöscht werden?
** Nein. Es ist möglich die Veröffentlichung zurückzuziehen, aber nicht es zu löschen.
* Der Versuch ein Planwerk zu veröffentlichen führt zu einer Fehlermeldung in der Form "Das Verfahren ''LoremIpsum'' besitzt den Verfahrensstand ''im Verfahren''. Die xplan.gml Datei jedoch den Rechtsstand ''beschlossen''". Das heißt, der Verfahrensstand auf der Stammdatenseite passt nicht zum Rechtsstand in der xplan.gml und eines von beidem muss angepasst werden. Das führt zu der Frage: Welche Kombinationen von Verfahrensstand und Rechtsstand sind zulässig?
** Die folgende Tabelle gibt einen Überblick (Tabelle öffnet sich bei Klick auf "Ausklappen"):
{| class="wikitable mw-collapsible mw-collapsed"
!Code
!Verfahrenstand (XPlanverfahren) im DiPlanCockpit
!Rechtsstand (XPlan) im XPlanGML
!Code
!Planarten
!Kommentar
!Planstatus = Dienstebene (ergibt sich aus dem Rechtsstand)
|-
|1000
|simuliert
|nicht vorhanden
|keiner
|BP
|Ein simuliertes Verfahren darf in keinem Dienst auftauchen, da es noch nicht rechtsgültig ist.
|kein Dienst
|-
|
|
|nicht vorhanden
|keiner
|RP
|Ein simuliertes Verfahren darf in keinem Dienst auftauchen, da es noch nicht rechtsgültig ist.
|kein Dienst
|-
|2000
|im Verfahren
|Aufstellungsbeschluss
|1000
|BP
|
|in Aufstellung (pre)
|-
|
|
|Aufstellungsbeschluss
|1000
|FP
|
|in Aufstellung
|-
|
|
|Aufstellungsbeschluss
|1000
|LP
|
|in Aufstellung
|-
|
|
|Aufstellungsbeschluss
|1000
|RP
|
|in Aufstellung
|-
|
|
|Entwurf (XPlan 5.4)
|2000
|BP
|
|in Aufstellung
|-
|
|
|Im Verfahren (XPlan 6.0)
|2000
|FP
|
|in Aufstellung
|-
|
|
|Entwurf
|2000
|FP
|
|in Aufstellung
|-
|
|
|Entwurf
|2000
|LP
|
|in Aufstellung
|-
|
|
|Entwurf
|2000
|RP
|
|in Aufstellung
|-
|
|
|Frühzeitige Behördenbeteiligung
|2100
|BP
|
|in Aufstellung
|-
|
|
|Frühzeitige Öffentlichkeitsbeteiligung
|2200
|BP
|
|in Aufstellung
|-
|
|
|Entwurf geändert
|2002
|RP
|
|in Aufstellung
|-
|
|
|Behördenbeteiligung
|2300
|BP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|BP
|
|in Aufstellung
|-
|
|
|Frühzeitige Behördenbeteiligung
|2100
|FP
|
|in Aufstellung
|-
|
|
|Frühzeitige Öffentlichkeitsbeteiligung
|2200
|FP
|
|in Aufstellung
|-
|
|
|Entwurfsbeschluss
|2250
|FP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|BP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|FP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|LP
|
|in Aufstellung
|-
|3000
|beschlossen
|Satzung
|3000
|BP
|Verfahrensstand: Beschlussdatum gesetzt, aber noch keine Bekanntmachung
|Festgestellt
|-
|
|
|Plan
|3000
|FP
|
|Festgestellt
|-
|
|
|Plan
|3000
|LP
|
|Festgestellt
|-
|
|
|Entwurf genehmigt
|2001
|RP
|
|Festgestellt
|-
|
|
|Inkraftgetreten
|4000
|RP
|
|Festgestellt
|-
|3100
|inkraftgetreten
|Inkraftgetreten
|4000
|BP
|Verfahrensstand: Beschlussdatum + Bekanntmachung gesetzt
|Festgestellt
|-
|
|
|Inkraftgetreten
|4000
|RP
|unter Verfahrensstand: Beschlussdatum + Bekanntmachung gesetzt
|Festgestellt
|-
|
|
|Teilweiseuntergegangen
|4500
|BP
|
|Archiv
|-
|
|
|Teilweiseaufgehoben (XPlan 6.0)
|45000
|BP
|
|Archiv
|-
|
|
|Teilweiseausserkraft (XPlan 6.0)
|45001
|BP
|
|Archiv
|-
|
|
|Wirksamkeit
|4000
|FP
|
|Festgestellt
|-
|
|
|Wirksamkeit
|4000
|LP
|
|Festgestellt
|-
|3200
|außerkraftgetreten
|Teilweiseausserkraft
|6000
|RP
|unter Verfahrensstand: Tag des Inkrafttretens + Tag des Außerkrafttretens
|
|-
|4000
|ganz aufgehoben
|Untergegangen
|5000
|BP
|
|Archiv
|-
|
|
|Aufgehoben
|50000
|BP
|
|archiviert
|-
|
|
|Ausserkraft
|50001
|BP
|
|archiviert
|-
|
|
|Aufgehoben
|50000
|FP
|
|archiviert
|-
|
|
|Ausserkraft
|50001
|FP
|
|archiviert
|-
|
|
|Entwurf aufgegeben
|2003
|RP
|
|archiviert
|-
|5000
|eingestellt
|Untergegangen
|5000
|BP
|Ein eingestelltes Verfahren darf in keinem Dienst auftauchen, da es nicht rechtsgültig war.
|kein Dienst
|-
|
|
|Untergegangen
|5000
|FP
|
|archiviert
|-
|
|
|Untergegangen
|5000
|LP
|
|archiviert
|-
|6000
|laufendes Normenkontrollverfahren
|Im Verfahren (XPlan 6.0); Entwurf (XPlan 5.4) bzw. Inkraftgetreten
|2000 bzw. 4000
|BP
|beim lfd. Normenkontrollverfahren bleibt der Dienst Festgestellt, erst wenn das Verfahren wieder aufgenommen wird, kommt ein neues XPlanGML in den Dienst in Aufstellung
|Festgestellt oder in Aufstellung
|}

FAQ für M-A im DiPlanCockpit Pro

2026-03-23T11:26:12Z

Diplanung:

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

Auf dieser Seite sind typische Fragen und die Antworten darauf gesammelt. Die Sortierung ist thematisch.

== Allgemein ==

* Wie sagen mir die Zahlen am Ende einer URL zum Cockpit im Reiter Aufgaben, z.B. in "meineUmgebung.diplanung.de/details/ID_99c61979-bbb5-4b40-8253-71068e680af5/1200/1/1210"?
** Die Zahlen stehen für den aktuell ausgewählten VTS, Durchgang und UVTS. VTS und UVTS entsprechen dem Code aus der jeweiligen Codeliste.

==Datenexport==
* Wie werden Metadaten durch das Cockpit bereitgestellt?
** Das DiPlanCockpit Backend stellt Metadaten in unterschiedlichen Datenmodellen/-formaten über folgenden Endpunkt bereit: URL-des-Cockpits/api/cockpit/swagger-ui/index.html#/metadaten-export-resource/getMetadaten. Dieser Endpunkt kann im Cockpit über „Einstellungen / Metadaten-Export an externe Metadateninformationssysteme“ initialisiert werden. Zusätzlich müssen die CSW-Systemparameter gesetzt werden.
*Wie können die Metadaten aus dem Cockpit an Drittsysteme angebunden werden?
**Es gibt die Export-Formate CSW und DCATAP-PLU. Diese können durch einen REST-Endpunkt abgefragt werden. Mittels DCATAP-PLU-Nachrichten werden Metadaten ans DiPlan Portal übergeben. Es sind zudem Transportverfahren für FitConnect und XTA2 im Cockpit integriert, werden Stand heute aber nur für den Nachrichtenaustausch mit XBauleitplanung/XBeteiligung verwendet. Nachrichten aus XPlanverfahren können aktuell nicht exportiert werden.
*Kann das CSW-Template für den Export beliebig angepasst werden? Können benutzerdefinierte Elemente komplett neu hinzugefügt werden?
**Ja. Im Admin-Bereich kann das CSW-Template ausgetauscht und damit angepasst werden.
*Wofür dient der Export mit CSW und DCATAP-PLU?
**CSW dient der Übermittlung von Metadaten zu Planwerken an Metadateninformationssysteme. DCATAP-PLU dient der Kommunikation zwischen dem DiPlan Cockpit und DiPlan Portal und übermittelt unter anderem beispielsweise den Plannamen, Planungsanlass, die Flächenabgrenzung im GeoJSON Format, den Verfahrensstand und die Verfahrensart.
*Welche Bezeichnung/welcher Name von Verfahren wird im Portal angezeigt? Planname? Arbeitstitel?
**Im DCAT-AP-PLU-Template wird im Element <code><plu:planName></code> der Planname übermittelt.
==Dokumente==
*Ist es möglich alle Dokumente aus dem Cockpit zusammen als ZIP-Datei runterzuladen? (auch die zusätzlichen Dokumente)
**Stand heute ist dies in der Dokumenten-Bibliothek nicht möglich. Die fachliche Anforderung, alle Dokumente eines Verfahrens auszuleiten, ist über den Fachlichen Ordner „Gerichtsordner“ abgebildet.
*Warum kann ich Dateien eines bestimmten Dateiformats nicht mit der Vormerkung für Beteiligungsverfahren versehen?
** Alle Dateiformate, die mit einer Vormerkung für Beteiligungsverfahren versehen werden können, sind im Systemparameter "fileAllowedExtensions.0800" angegeben. Diese Auflistung im Systemparameter kann bei Bedarf um weitere Dateiformate erweitert werden.
==Konfiguration==
*Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Markup im Dokument nach dem Root-Element muss ordnungsgemäß formatiert sein"''?
** Das bedeutet, dass in der Verfahrenskonfiguration ein Fehler hinsichtlich des Aufbaus der Datei vorliegt. Es kann beispielsweise sein, dass man Elemente in der falschen Reihenfolge angegeben hat. Um Fehlern dieser Art vorzubeugen ist es hilfreich, wenn man einen XML-Editor verwendet, der eine Validierung der Datei ermöglicht. So lässt sich vor dem Hochladen ins Cockpit prüfen, ob die XML korrekt gestaltet ist.
*Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Für x sind die folgenden Werte mehrfach vereinbart: A"''?
** Das bedeutet, dass in der Verfahrenskonfiguration ein Wert A mehrfach verwendet wird, der nur einmal verwendet werden darf. Das gilt beispielsweise für Unterverfahrensteilschritte (UVTS). Jeder UVTS darf in einer Verfahrenskonfiguration nur einmal vorkommen. Um den Fehler zu beheben, muss folglich einer der Werte abgeändert werden. Anschließend kann man die Verfahrenskonfiguration hochladen.
* Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Das Element x muss vorhanden sein"''?
** Das bedeutet, dass in der Verfahrenskonfiguration ein zwingend notwendiger Abschnitt x fehlt. Um den Fehler zu beheben, muss man den fehlenden Abschnitt hinzufügen und kann anschließend die Verfahrenskonfiguration hochladen.
* Was bedeutet beim Hochladen einer Verfahrenskonfiguration eine Fehlermeldung in der Form ''"Die folgenden refIDs sind in der Verfahrenskonfiguration doppelt vergeben: [X]"''?
** RefIDs müssen eindeutig sein, sprich sie dürfen nur einmal verwendet werden. Der Fehler besagt, dass die refID X mehr als einmal vorhanden ist. Um den Fehler zu beheben, muss das Duplikat entfernt werden, z.B. durch Änderung einer der Angaben von X. Anschließend kann man die Verfahrenskonfiguration hochladen.

* Was bedeutet beim Hochladen einer Codeliste eine Fehlermeldung in der Form ''"Die Codeliste passt nicht zur Verfahrenskonfiguration A: kein Wert für Codeliste B und Wert C zu ermitteln"'' oder ''"Die Codeliste enthält nicht folgende erforderlichen Codes: C"'' oder ''"Code C wird noch in Tabelle X benutzt und kann nicht gelöscht werden"''?
** Die Meldungen bedeuten, dass in der Verfahrenskonfiguration A oder an Stelle X ein Codelistenwert C verwendet wird, der in der Version der Codeliste B, die man versucht hochzuladen, fehlt. Um den Fehler zu lösen, muss man einen Eintrag für den Wert C in die Codeliste B hinzufügen und kann anschließend die Codeliste hochladen. Wenn man den Codelistenwert C löschen möchte, dann muss man zuerst alle Verfahren und Verfahrenskonfigurationen löschen, in denen der Wert verwendet wird.
* Was bedeutet beim Hochladen einer Codeliste eine Fehlermeldung in der Form ''"Die Codeliste enthält Namen die doppelt vergeben sind: [A]"'' oder ''"Duplicate key B"''?
** Die Meldungen bedeuten, dass in der Codeliste, die man versucht hochzuladen, ein Wert doppelt vorhanden ist. Um den Fehler zu lösen, muss man einen der beiden Einträge aus der Codeliste entfernen und kann anschließend die Codeliste hochladen.
*Was bezwecken die Angaben "code" und "beschreibung" in einer Codeliste bzw. "label" in der Verfahrenskonfiguration?
**In einer Codelisten bilden "code" + "beschreibung" ein Paar, das unique vergeben werden muss. Das heißt, nur einmal enthalten sein darf. Bei mehrfacher Verwendung einer "beschreibung" in einer Codeliste, wird der Upload mit einer Fehlermeldung in folgender Form untersagt: "Die Codeliste enthält Namen, die doppelt vergeben sind: [beispielBeschreibung]". In einer Verfahrenskonfiguration wird auf Codelisteneinträge per "code" referenziert. Im Frontend wird der Wert der "beschreibung" angezeigt. Zusätzlich gibt es z.B. bei Aufgaben in der Verfahrenskonfiguration das "label". Dieses wird als Name der Aufgabe im Frontend angezeigt.
*Wer darf änderbare Codelisten anpassen?
**Mandanten-Admins können änderbare Codelisten anpassen.
*Welche Änderungen darf ich als Mandanten-Admin an Codelisten vornehmen?
**Das ist je nach Codeliste unterschiedlich. Teilweise sind gar keine eigenen Anpassungen möglich, teilweise können nur Einträge hinzugefügt, teilweise auch Einträge gelöscht werden. Eine detaillierte Beschreibung findet sich in Kapitel [[Codelisten für DiPlan Cockpit Pro|6.3]]. des Handbuchs.
*Welche Einträge in veränderbaren Codelisten darf man löschen und welche nicht?
**Alle in einer Verfahrenskonfiguration (VK) enthaltenen Codes müssen in einer Codeliste zu finden sein. Im Zuge der Mandanten spezifischen Anpassung lassen sich weitere Verfahrenstypen/Verfahrenssteuerungen konfigurieren, die auch auf Einträge in veränderbaren Codelisten referenzieren. Diese Einträge in einer VK müssen in veränderbaren Codelisten enthalten sein, die VOR einer neuen Verfahrenskonfiguration ins DiPlanCockpit hochgeladen werden müssen. Dies können Nutzende in der Rollen M-A vornehmen. Im Zuge der Erweiterungen von VKs "wachsen" veränderbare Codelisten mit, d.h. dort enthaltene Einträge werden i.d.R. ergänzt um neue und nicht bestehende Einträge gelöscht bzw. überschrieben.
*Benötigt man als Mandanten-Admin die XSD zu den XML-Dateien?
**Nein. Die XSD dient nur dem System zur Validierung der XMLs.
*Was kann ich tun, wenn sich in einer änderbaren Codeliste ein Fehler eingeschlichen hat?
**Ein fehlerhafter Eintrag in einer änderbaren Codeliste kann korrigiert werden oder auch gelöscht, sofern er nicht in einem Verfahren verwendet wird. Eine detaillierte Anleitung findet sich in Kapitel [[Codelisten für DiPlan Cockpit Pro|6.3]].
*Was kann alles über die fachliche Leitstelle für das Cockpit konfiguriert werden? Welche Systemparameter? Welche Konfigurationen? Gibt es eine Übersicht/Liste dazu?
**In den entsprechenden Abschnitten dieses Handbuchs (z.B. bezüglich der Systemparameter oder Verfahrenskonfiguration) ist beschrieben, wer welche Anpassungen vornehmen kann.
*Kann das „Wording“ des Verfahrensstands mandantenspezifisch angepasst/konfiguriert werden?
**Die Codeliste Verfahrensstand ist Stand heute eine nicht änderbare Codelisten und kann daher nicht angepasst werden. Ist dies gewünscht muss das mit der Fachlichkeit (PO/BA) geklärt werden. Sie ist eine feste Codeliste, die den bundesweiten Standard beschreibt. Wenn Ergänzungen gewünscht sind, muss ein nachnutzendes Land / NN Land / MiLa den Bedarf bei der XLeitstelle melden. Dort wird er geprüft und bei positiver Entscheidung die Codeliste ergänzt.
*Müssen die Codes nach einem bestimmten Schema angelegt werden, z.B. Verfahrensschritte nur als vierstellige Codes in Hunderter-Schritten, also 3100, 3200, 3300 usw.?
**Nein. Die Codes können beliebig gestaltet sein, sie müssen weder zwingend vierstellig sein, noch muss ein bestimmtes Muster eingehalten werden. Damit sie übersichtlicher und leichter nachvollziehbar sind, ist es dennoch empfehlenswert nicht vollkommen willkürliche Codes zu verwenden. Wichtig ist bezüglich des Formats nur, dass die Codes innerhalb einer Codeliste eindeutig sind (= nur einmal vorkommen) und keine Zeichen enthalten, die nicht mit der URL-Codierung kompatibel sind. Codes (insbesondere Verfahrensschritte, Verfahrensteilschritte, Unterverfahrensteilschritte) können Teil URL sein, und müssen deswegen darin darstellbar sein. Nicht erlaubt sind: Leerzeichen : / ? # ( ) [ ] @ ! $ % & ' * + , ; =
*Können Aufgaben "wiederverwendet" werden, beispielsweise wenn für jede Sitzung die gleichen Vorbereitungen erledigt werden müssen?
**Nicht direkt. Es ist keine Referenz, Verlinkung oder ähnliches möglich. Am einfachsten ist es in solchen Fällen die Aufgabe per Copy&Paste zu übernehmen. Dabei ist darauf zu achten, jeweils eine neue, eindeutige ID zu vergeben. Es darf nicht mehrere (Unter-)aufgaben mit der selben ID geben.
*Je Verfahrenssteuerungstyp lässt sich eine Verfahrenskonfiguration anlegen. Was ist, wenn man mehrere Verfahrenskonfigurationen für einen Verfahrenssteuerungstyp möchte?
**In diesem Fall muss auch der Verfahrenssteuerungstyp mehrfach angelegt werden, beispielsweise in der Form A und B. Dann kann sowohl für A als auch B eine eigene Verfahrenskonfiguration erstellt werden. Dies sollte nur wenn unbedingt notwendig geschehen, weil sich dadurch der Administrationsaufwand zusätzlich erhöht.
*Muss jeder Verfahrensschritt (VS) Verfahrensteilschritte (VTS) haben?
**Jein. In der Verfahrenkonfiguration können VS ohne VTS angegeben werden. Diese sind jedoch nicht im DiPlan Cockpit sichtbar. Angezeigt werden nur VS mit VTS.
==Logging==
*Wie lange werden Logs aufbewahrt?
**Aktuell werden Log-Dateien für 30 Tage gespeichert und sind im Reiter "Protokolle" des Bereichs "Fachliche Leitstelle Administration" einsehbar .
==Login==
*Können mehrere Personen den gleichen Zugang verwenden?
**Nein. Alle Nutzenden müssen eigene Login-Daten haben, z.B. über ein personalisiertes Elster-Zertifikat. Nur so können Log-Einträge eindeutig Nutzenden zugeordnet werden.

== Raumordnung ==

* Kann ich Verfahren für die Raumordnung anlegen?
** Für die Raumordnung sind bis auf Weiteres Basis-Funktionalitäten umgesetzt. Basis-Verfahren sind somit möglich und es gibt eine entsprechende Beispiel-Verfahrenskonfiguration.

==Verfahren==
*Warum wird mir nach dem Klick auf "Verfahren starten" bei einem simulierten Verfahren ein Fehler angezeigt?
**Ein simuliertes Verfahren kann nur gestartet werden, wenn sowohl der Planstatus als auch der Verfahrensstand den Wert "simuliert" haben. Auf der Stammdatenseite des Verfahrens kann der Verfahrensstand simulierter Verfahren geändert werden. Bitte prüfen Sie diesen und setzen Sie ihn gegebenenfalls auf simuliert, um das Verfahren anschließend starten zu können.
*Kann ein Planname für mehrere Verfahren genutzt werden?
**Der Planname wird beim Starten des Verfahrens eingetragen. Innerhalb eines Mandanten kann ein Planname nur einmal vergeben sein, da auf dem Datenbank-Feld „Planname“ ein unique-Constraint liegt.
*Was bedeutet eine Fehlermeldung wie z.B. "Unerwarteter Fehler - Erstellen des Verfahrens fehlgeschlagen! - Fehlermeldung: Die Verfahrenskonfiguration hat das AktionItem ActionItemEntity[id=null, Code=Code[code=0820, name=drop down], Sitzungscode=Code[code=9100, name=Dummy Sitzung politisch]] konfiguriert, welches auf einen Termin verweist, der am Verfahren nicht existiert"?
**Hier ist das Problem, dass in der Verfahrenskonfiguration ein Termin in einer Aufgabe referenziert wird, der im Bereich zu Zeitplanung fehlt. Dementsprechend muss in der Verfahrenskonfiguration der Termin aus der Aufgabe entfernt oder in die Zeitplanung hinzugefügt werden, um den Fehler zu beheben.
*Können Verfahren in DiPlanCockpit Basis angelegt und später in DiPlanCockpit Pro fortgeführt werden oder umgekehrt?
**Es soll kein Mischbetrieb von DiPlanCockpit Basis und Pro erfolgen und ein Verfahren nur in Basis oder nur in Pro genutzt werden.
*Ist der Import von Verfahren zur Raumordnung / Raumordnungsplan-Verfahren möglich?
** Der Import von Verfahren zur Raumordnung / Raumordnungsplan-Verfahren ins DiPlanCockpit ist nicht vorgesehen. Stattdessen sind die (wenigen) Bestandsdaten manuell im DiPlanCockpit anzulegen.

== XML ==

* Können in den XML-Konfigurationen Sonderzeichen in den Elementen stehen?
** Bestimmte Zeichen in einer XML müssen encoded werden, damit sie nicht eine besondere Rolle im XML-Syntax erfüllen. Allgemein gibt es 5 Zeichen, die in XML escaped werden müssen:
*** " muss escaped werden als &quot;
*** ' muss escaped werden als &apos;
*** < muss escaped werden als &lt;
*** > muss escaped werden als &gt;
*** & muss escaped werden als &amp;

==XPlanGML / Planwerke==
*Welcher Version muss ein Planwerk mindestens entsprechen, um es ins Cockpit hochzuladen?
**Die Version muss 5.4 oder höher sein.
*Wie groß darf ein Planwerk für den Upload maximal sein?
**Aktuell liegt die maximal erlaubte Dateigröße einer XPlanGML für den Upload bei 100 MB.
*Beim Versuch ein Planwerk hochzuladen wird ein Fehler angezeigt. Woran liegt das?
**Das kann verschiedene Ursachen haben. Bitte prüfen Sie zunächst, ob von Seiten Ihrer hauseigenen IT das Hochladen einer ZIP-Datei gestattet ist. Der Upload kann unterbunden sein und so den Eindruck eines Fehlers im Cockpit erwecken.
**Eine weitere mögliche Ursache ist ein falsch gesetzter Systemparameter. Das kann beispielsweise nach einem Update des Cockpits der Fall sein, wenn durch die zuständige Administration erforderliche Anpassungen der Systemparameter noch nicht erfolgt sind.
*Werden Rasterbilder im Dienst nicht mit dargestellt?
**Wenn korrekte Rasterdaten mit importiert wurden, werden diese auch über den WMS ausgeliefert; ob sie dargestellt werden, hängt dann davon ab, wie der Client konfiguriert ist.
*Wird ein Planwerks-WFS bereit gestellt? Kann man als Admin-Rolle auf alle Dienste (URLs) zugreifen? Wo? Wie?
**Ja und nein. Es wird kein Planwerk-WFS bereitgestellt, sondern ein WFS aller Planwerke, der jedoch über Filter nur die Inhalte eines speziellen Plans ausgeben kann. Über das Cockpit wird heute noch keine aufbereitete URL angeboten.
*Kann ein einmal veröffentlichtes ZIP-Archiv vom Planwerk wieder gelöscht werden?
**Nein. Es ist möglich die Veröffentlichung zurückzuziehen, aber nicht es zu löschen.
*Der Versuch ein Planwerk zu veröffentlichen führt zu einer Fehlermeldung in der Form "Das Verfahren ''LoremIpsum'' besitzt den Verfahrensstand ''im Verfahren''. Die xplan.gml Datei jedoch den Rechtsstand ''beschlossen''". Das heißt, der Verfahrensstand auf der Stammdatenseite passt nicht zum Rechtsstand in der xplan.gml und eines von beidem muss angepasst werden. Das führt zu der Frage: Welche Kombinationen von Verfahrensstand und Rechtsstand sind zulässig?
**Die folgende Tabelle gibt einen Überblick (Tabelle öffnet sich bei Klick auf "Ausklappen"):
{| class="wikitable mw-collapsible mw-collapsed"
!Code
!Verfahrenstand (XPlanverfahren) im DiPlanCockpit
!Rechtsstand (XPlan) im XPlanGML
!Code
!Planarten
!Kommentar
!Planstatus = Dienstebene (ergibt sich aus dem Rechtsstand)
|-
|1000
|simuliert
|nicht vorhanden
|keiner
|BP
|Ein simuliertes Verfahren darf in keinem Dienst auftauchen, da es noch nicht rechtsgültig ist.
|kein Dienst
|-
|
|
|nicht vorhanden
|keiner
|RP
|Ein simuliertes Verfahren darf in keinem Dienst auftauchen, da es noch nicht rechtsgültig ist.
|kein Dienst
|-
|2000
|im Verfahren
|Aufstellungsbeschluss
|1000
|BP
|
|in Aufstellung (pre)
|-
|
|
|Aufstellungsbeschluss
|1000
|FP
|
|in Aufstellung
|-
|
|
|Aufstellungsbeschluss
|1000
|LP
|
|in Aufstellung
|-
|
|
|Aufstellungsbeschluss
|1000
|RP
|
|in Aufstellung
|-
|
|
|Entwurf (XPlan 5.4)
|2000
|BP
|
|in Aufstellung
|-
|
|
|Im Verfahren (XPlan 6.0)
|2000
|FP
|
|in Aufstellung
|-
|
|
|Entwurf
|2000
|FP
|
|in Aufstellung
|-
|
|
|Entwurf
|2000
|LP
|
|in Aufstellung
|-
|
|
|Entwurf
|2000
|RP
|
|in Aufstellung
|-
|
|
|Frühzeitige Behördenbeteiligung
|2100
|BP
|
|in Aufstellung
|-
|
|
|Frühzeitige Öffentlichkeitsbeteiligung
|2200
|BP
|
|in Aufstellung
|-
|
|
|Entwurf geändert
|2002
|RP
|
|in Aufstellung
|-
|
|
|Behördenbeteiligung
|2300
|BP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|BP
|
|in Aufstellung
|-
|
|
|Frühzeitige Behördenbeteiligung
|2100
|FP
|
|in Aufstellung
|-
|
|
|Frühzeitige Öffentlichkeitsbeteiligung
|2200
|FP
|
|in Aufstellung
|-
|
|
|Entwurfsbeschluss
|2250
|FP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|BP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|FP
|
|in Aufstellung
|-
|
|
|Öffentliche Auslegung
|2400
|LP
|
|in Aufstellung
|-
|3000
|beschlossen
|Satzung
|3000
|BP
|Verfahrensstand: Beschlussdatum gesetzt, aber noch keine Bekanntmachung
|Festgestellt
|-
|
|
|Plan
|3000
|FP
|
|Festgestellt
|-
|
|
|Plan
|3000
|LP
|
|Festgestellt
|-
|
|
|Entwurf genehmigt
|2001
|RP
|
|Festgestellt
|-
|
|
|Inkraftgetreten
|4000
|RP
|
|Festgestellt
|-
|3100
|inkraftgetreten
|Inkraftgetreten
|4000
|BP
|Verfahrensstand: Beschlussdatum + Bekanntmachung gesetzt
|Festgestellt
|-
|
|
|Inkraftgetreten
|4000
|RP
|unter Verfahrensstand: Beschlussdatum + Bekanntmachung gesetzt
|Festgestellt
|-
|
|
|Teilweiseuntergegangen
|4500
|BP
|
|Archiv
|-
|
|
|Teilweiseaufgehoben (XPlan 6.0)
|45000
|BP
|
|Archiv
|-
|
|
|Teilweiseausserkraft (XPlan 6.0)
|45001
|BP
|
|Archiv
|-
|
|
|Wirksamkeit
|4000
|FP
|
|Festgestellt
|-
|
|
|Wirksamkeit
|4000
|LP
|
|Festgestellt
|-
|3200
|außerkraftgetreten
|Teilweiseausserkraft
|6000
|RP
|unter Verfahrensstand: Tag des Inkrafttretens + Tag des Außerkrafttretens
|
|-
|4000
|ganz aufgehoben
|Untergegangen
|5000
|BP
|
|Archiv
|-
|
|
|Aufgehoben
|50000
|BP
|
|archiviert
|-
|
|
|Ausserkraft
|50001
|BP
|
|archiviert
|-
|
|
|Aufgehoben
|50000
|FP
|
|archiviert
|-
|
|
|Ausserkraft
|50001
|FP
|
|archiviert
|-
|
|
|Entwurf aufgegeben
|2003
|RP
|
|archiviert
|-
|5000
|eingestellt
|Untergegangen
|5000
|BP
|Ein eingestelltes Verfahren darf in keinem Dienst auftauchen, da es nicht rechtsgültig war.
|kein Dienst
|-
|
|
|Untergegangen
|5000
|FP
|
|archiviert
|-
|
|
|Untergegangen
|5000
|LP
|
|archiviert
|-
|6000
|laufendes Normenkontrollverfahren
|Im Verfahren (XPlan 6.0); Entwurf (XPlan 5.4) bzw. Inkraftgetreten
|2000 bzw. 4000
|BP
|beim lfd. Normenkontrollverfahren bleibt der Dienst Festgestellt, erst wenn das Verfahren wieder aufgenommen wird, kommt ein neues XPlanGML in den Dienst in Aufstellung
|Festgestellt oder in Aufstellung
|}

Verfahrensdokumente verwalten und veröffentlichen - DiPlanCockpit Pro

2026-03-20T13:31:16Z

Diplanung: /* Dokument hochladen */

'''> Zurück zur Hauptseite [[DiPlanCockpit Pro für Fachplanung-Sachbearbeitung (FP-SB)]]'''
----An einem Verfahren können Sie beliebig viele Dokumente ablegen. Zum einen dient diese Funktion dazu, Dokumente mit Kolleg*innen zu teilen und den schnellen Zugriff auf relevante Unterlagen zu ermöglichen. Zum anderen ist es aber auch möglich, die Dokumente zu veröffentlichen und Sie damit der Öffentlichkeit über DiPlanPortal zur Verfügung zu stellen. Außerdem kann für jedes Dokument ein Download-Link generiert werden, der separat, beispielsweise per Mail verschickt werden kann.

Um ein Dokument am Verfahren hochzuladen, klicken Sie auf den Reiter Dokumente.[[Datei:Reiter Dokumente.png|zentriert|mini|Reiter Dokumente|alternativtext=|600x600px|verweis=https://wiki.diplanung.de/index.php/Datei:Reiter_Dokumente.png]]

Dort finden Sie im oberen Bereich Filtermöglichkeiten, um bereits hochgeladene Dokumente schneller finden zu können. Es gibt zwei Arten von Dokumenten in DiPlanCockpit PRO. Zunächst sehen Sie die Kategorie Planwerke. Diese werden über den Reiter Planwerke am Verfahren gesteuert. Mehr Informationen zu den Planwerken finden Sie im Kapitel [[Planwerke validieren und veröffentlichen]].[[Datei:Kategorie Dokumente.png|zentriert|mini|Kategorie Planwerke|alternativtext=|600x600px|verweis=https://wiki.diplanung.de/index.php/Datei:Kategorie_Dokumente.png]]

Unterhalb des Bereichs für die Planwerke finden Sie mehrere Ordner für die Dokumente. Dabei sind die Ordner nach den einzelnen Phasen aus der Zeitplanung benannt. Zusätzlich gibt es einen Ordner für übergreifende Dokumente. In diesen Ordnern können Sie beispielsweise Word-Dokumente oder PDFs hochladen, Dokumente anhand von Mustervorlagen generieren. Dokumente, die Sie im Rahmen der Aufgaben erstellt haben, finden sich ebenfalls dort.

=== Dokument generieren ===
Basierend auf Mustervorlagen, welche von der fachlichen Leitstelle verwaltet werden, können Sie auch Dokumente direkt generieren und in Word bearbeiten. Klicken Sie dabei auf den Button '''Mustervorlage verwenden''':
[[Datei:Datei hochladen.png|zentriert|mini|500x500px|Mustervorlage verwenden]]

Es öffnet sich nun eine Dialogbox, in der Sie nach der für Sie passenden Mustervorlage suchen können.
[[Datei:Dialogbox Mustervorlage.png|zentriert|mini|500x500px|Dialogbox Mustervorlage]]

Nach dem Sie diese ausgewählt haben, klicken Sie auf Dokument generieren und es öffnet sich nun das Dokument in Microsoft Word oder LibreOffice, je nachdem, welches Dateiformat in der Mustervorlage hinterlegt wurde. Wenn Sie das Dokument dort speichern, wird es auch automatisch in DiPlanCockpit gespeichert und es besitzt nun den Status '''generiert'''. Wenn Sie das Dokument weiter bearbeiten möchten, klicken Sie einfach auf die drei Punkte am Dokument und wählen Sie '''bearbeiten''' aus.

=== Dokument hochladen ===
Klicken Sie dafür einfach auf den Button '''Datei hochladen'''.
[[Datei:Datei hochladen.png|zentriert|mini|500x500px|Datei hochladen]]

Klicken Sie dafür auf den Button '''Datei hochladen'''. Im ersten Bereich können nun Dokumente per Drag&Drop hochgeladen werden. Es handelt sich hier bei um einen Multiupload. Es können also mehrere Dokumente auf einmal hochgeladen werden. In den Dropdowns können Sie den [[Glossar|Unterlagentyp]], sowie [[Glossar|Vormerkungen]] auswählen. Ein Dokument kann nur mit einem Unterlagentyp, aber mit mehreren Vormerkungen verbunden werden. Klicken Sie nun auf Hinzufügen, um das Hochladen des Dokuments abzuschließen.[[Datei:Multi.png|alternativtext=|zentriert|mini|462x462px|Dokumente hochladen|verweis=https://wiki.diplanung.de/index.php%3Ftitle=Datei:Multi.png]]'''Es können nur Dokumente der Dateitypen .docx, .pdf und .odt hochgeladen werden.'''

Eine Ausnahme bilden der Vertragsordner. Hier können nur .pdf-Dateien hochgeladen werden.

Ihre Dokumente sind nun hochgeladen und Sie sehen nun Informationen, wie den Dateinamen, den Status, den Unterlagentyp, den Bearbeiter, die Version und den Zeitpunkt der letzten Aktualisierung. Wenn einem Ordner mehr als 25 Dokumente zugeordnet sind, so werden die Dokumente auf Seiten aufgeteilt. Mit der entsprechenden Bedienfläche können Sie zwischen den Seiten wechseln. Nachdem ein Dokument hochgeladen wurde, sind nur der Status und die Vormerkungen bearbeitbar.
[[Datei:Hochgeladenes Dokument.png|zentriert|mini|600x600px|Hochgeladenes Dokument]]

Nach dem initialen Hochladen des Dokuments hat es immer den Status '''hochgeladen'''.
===Dokument herunterladen===
Möchten Sie die aktuelle Version des Dokuments herunterladen, so klicken Sie auf die drei Punkte neben dem Dateinamen und wählen Sie die Option '''Herunterladen''' aus. Das Dokument wird dann direkt heruntergeladen.
[[Datei:Dokument herunterladen PRO.png|zentriert|mini|600x600px|Dokument herunterladen]]
Bitte beachten Sie, dass gemäß Ihren individuellen Browser-Einstellungen weitere Bestätigungen notwendig sein können.
===Neue Version des Dokuments hochladen===
Haben Sie ein Dokument überarbeitet und möchten die neue Version des Dokuments hochladen, so klicken Sie auf die drei Punkte neben dem Dateinamen und wählen Sie die Option '''Datei aktualisieren''' aus. Durch das Aktualisieren des Dokuments wird eine neue Version des Dokuments mit einer neuen Versionsnummer erzeugt.

=== Dokument bearbeiten ===
Sie können auch Dokumente direkt in Microsoft Word oder LibreOffice bearbeiten. Wenn Sie Änderungen auf diese Weise vornehmen wollen, so klicken Sie auf die drei Punkte neben dem Dateinamen und wählen Sie die Option '''Datei bearbeiten''' aus. Die Datei öffnet sich nun der entsprechenden Anwendung und kann dort von Ihnen bearbeitet werden. Sobald Sie die Datei speichern, werden die Änderungen automatisch an das Verfahren synchronisiert.
===Status des Dokuments anpassen===
Wenn Sie denn [[Glossar|Status des Dokuments]] ändern wollen, so klicken Sie auf den aktuellen Status. Es öffnet sich eine Maske zum Steuern des Status. Ein Dokument im Status hochgeladen kann nur in den Status in Bearbeitung oder final geändert werden. Klicken Sie den gewünschten Status an und Klicken Sie dann auf das x. Der Status aktualisiert sich dann automatisch.
===Dokument veröffentlichen===
'''Hinweis''': Mit der Veröffentlichung eines Dokuments wird dieses in externe Systeme, wie DiPlanPortal, übertragen und dort der Öffentlichkeit verfügbar gemacht. Nutzen Sie diese Funktion also mit Bedacht, damit nicht versehentlich Dokumente veröffentlich werden, die nicht für die Öffentlichkeit gedacht sind.
Verfahrensdokumente in Ihrer Bibliothek sind prinzipiell zugriffsbeschränkt. Sie können ein Dokument jedoch explizit unter einer öffentlich erreichbaren URL bereitstellen. Der Status des Dokuments muss '''final''' sein. Es wird eine Kopie der Datei in einem öffentlich zugänglichen Bereich angelegt, wobei Word-Dateien automatisch in PDF konvertiert werden. Dies können Sie auf zwei Wegen erreichen:

Für die erste Option klicken Sie auf die drei Punkte neben dem Dateinamen und wählen Sie die Option '''Dokument veröffentlichen''' aus.

Für den anderen Weg ändern Sie den Status des Dokuments auf '''veröffentlicht'''.

In beiden Fällen erscheint eine Dialogbox, in der Sie '''bestätigen''', dass Sie das Dokument veröffentlichen wollen.[[Datei:Veröffentlichen- Dialogbox.png|zentriert|mini|Veröffentlichen: Dialogbox|alternativtext=|450x450px|verweis=https://wiki.diplanung.de/index.php/Datei:Ver%C3%B6ffentlichen-_Dialogbox.png]]

Sie erhalten nun die URL mit der das Dokument heruntergeladen werden kann.[[Datei:Veröffentlichen- Downloadlink.png|zentriert|mini|Veröffentlichen: Downloadlink|alternativtext=|450x450px|verweis=https://wiki.diplanung.de/index.php/Datei:Ver%C3%B6ffentlichen-_Downloadlink.png]]

Das Dokument wird ggf. über die Verfahrensmetadaten in Drittsystemen recherchierbar. Voraussetzung für eine Übertragung nach DiPlanPortal ist ein gestartetes Verfahren. Die Veröffentlichung und die Nutzung der URL kann aber vor dem Start des Verfahrens erfolgen.
===Dokument zurückziehen===
'''Hinweis''': Mit dem Zurückziehen einer Veröffentlichung wird das Dokument aus dem öffentlich zugänglichen Bereich entfernt und ist ggf. nicht mehr über die Verfahrensmetadaten in Drittsystemen, wie dem DiPlanPortal, recherchierbar. Nutzen Sie diese Funktion also mit Bedacht, damit nicht versehentlich Dokumente zurückgezogen werden, die noch für die Öffentlichkeit verfügbar sein sollen.
Soll ein Dokument der Öffentlichkeit nicht mehr zur Verfügung stehen, können Sie es über zwei Wege zurückziehen. Für die erste Option klicken Sie auf die drei Punkte neben dem Dateinamen und wählen Sie die Option '''Veröffentlichung zurückziehen''' aus.

Für den anderen Weg ändern Sie den Status des Dokuments auf '''final'''.

In beiden Fällen erscheint eine Dialogbox, in der Sie '''bestätigen''', dass Sie das Dokument zurückziehen wollen.[[Datei:Zurückziehen- Dialogbox.png|zentriert|mini|Zurückziehen: Dialogbox|alternativtext=|450x450px|verweis=https://wiki.diplanung.de/index.php/Datei:Zur%C3%BCckziehen-_Dialogbox.png]]Nach dem Zurückziehen befindet sich das Dokument im Status '''final'''.
===Dokument löschen===
Wollen Sie ein Dokument löschen, so darf es '''nicht''' den Status '''veröffentlicht''' haben. Ist diese Voraussetzung gegeben, klicken Sie auf die drei Punkte neben dem Dateinamen und wählen Sie die Option '''Löschen''' aus.

Das Dokument befindet sich nun im '''Papierkorb''', welchen Sie über den '''Button neben der Suche''' aufrufen können.[[Datei:Button Papierkorb.png|zentriert|mini|Button Papierkorb|alternativtext=|600x600px|verweis=https://wiki.diplanung.de/index.php/Datei:Button_Papierkorb.png]]Sie können Dokumente, welche sich im Papierkorb befinden, entweder endgültig löschen oder wiederherstellen, falls ein Dokument versehentlich gelöscht wurde. Dokumente, welche endgültig gelöscht wurden, können nicht wiederhergestellt werden.[[Datei:Übersicht Papierkorb.png|zentriert|mini|Übersicht Papierkorb|alternativtext=|600x600px|verweis=https://wiki.diplanung.de/index.php/Datei:%C3%9Cbersicht_Papierkorb.png]]
Zusätzlich kann die fachliche Leitstelle Houskeeping Jobs definieren, welche in regelmäßigen Abständen Dokumente im Papierkorb endgültig löscht.

=== Dokumentenversionierung - Versionsverlauf ===
Wird ein Dokument fortlaufend aktualisiert, so kann es vorkommen, dass eine falsche Version des Dokumentes hochgeladen wurde. Mit der Dokumentenversionierung kann jede bisherige Version des Dokuments als aktuelle Version wiederhergestellt werden. Dafür muss am Dokument auf die Versionsnummer geklickt werden. Diese ist nur dann klickbar, wenn mindestens die Version 1.1 eines Dokuments vorliegt:
[[Datei:Versionsnummer.png|zentriert|mini|600x600px|Versionsnummer]]

Es öffnet sich nun der Versionsverlauf. Mit Klick auf die drei Punkte bei einer historischen Version kann diese als aktuelle Version wiederhergestellt werden:
[[Datei:Versionsverlauf.png|zentriert|mini|500x500px|Versionsverlauf]]

Es öffnet sich ein neues Dialogfenster, in dem die Wiederherstellung bestätigt werden muss. Es kann zusätzlich ein Kommentar hinterlegt werden, damit transparent erläutert wird, warum die Wiederherstellung durchgeführt wurde:
[[Datei:Wiederherstellung bestätigen.png|zentriert|mini|500x500px|Wiederherstellung bestätigen]]

Die Version wurde nun wiederhergestellt. Die Versionsnummer das Dokuments ist damit um eine Version gestiegen. Der Inhalt stammt jedoch aus der wiederhergestellten Version. Der gesetzte Kommentar ist auch im Versionsverlauf sichtbar:
[[Datei:Versionsverlauf nach Wiederherstellung.png|zentriert|mini|500x500px|Versionsverlauf nach Wiederherstellung]]

Reporting

2026-03-19T10:00:11Z

Diplanung:

'''Bitte beachten: Diese Funktionalität wird in Zukunft von einem neuen Reporting-Tool abgelöst. Informationen vorab hierzu finden Sie hier: [[Reporting: Auswertungen im DiPlan Cockpit]]'''

'''> Zurück zur Hauptseite [[DiPlanCockpit Pro]]'''

----

== Derzeitiges Reporting im Hamburger DiPlan Cockpit Pro ==
Begleitet von dem DiPlanungs-Cockpit sind Sie in der Lage, schnell und gezielt Auskunft über den Stand Ihrer Planverfahren zu geben.

Funktionen zur Erstellung von Auswertungen und Reports finden Sie ebenfalls in der Anwendung.

* Um eine Auswertung zu erstellen, wählen Sie das im oberen Bereich liegende Menü (drei horizontale Balken) aus.
* Sie sehen die verknüpften Partneranwendungen und haben die Option, auf die „Auswertung“ zu wechseln.
* Hier können Sie auf verschiedene Auswertungs-Typen zugreifen:
** Verfahrensstand, Kennzahlen, Auswertung von FNP und LAPRO-Änderungsverfahren, Individuelle Auswertung.

* Wählen Sie eine der Optionen aus und geben Sie wahlweise den Senat oder Bezirk an.
* Sie können definieren, ob Sie den Planungsstatus „festgestellt“ oder „im Verfahren“ auswerten wollen.
* Klicken Sie nun auf die Schaltfläche „Generierung“.
* Der Datenbestand wird aus der Datenbank abgerufen und Ihre Auswertung geladen.
* Die Auswertung wird Ihnen in einer Excel-Datei ausgegeben.
'''> Springen Sie direkt zum Reporting im [https://youtu.be/xhtzPGvyxUY?t=8618 Schulungsvideo]'''
[[Kategorie:Cockpit]]

Reporting: Auswertungen im DiPlan Cockpit

2026-03-18T13:08:16Z

Diplanung: /* Rechte und Rollen */

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

'''> Zurück zur Hauptseite [[DiPlanCockpit Basis als EfA-Lösung|DiPlanCockpit Basis für Fachplanung-Sachbearbeitung (FP-SB)]]'''

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

'''> Zurück zur Hauptseite [[DiPlanCockpit Pro für Fachplanung-Sachbearbeitung (FP-SB)]]'''

⚠️ '''Bitte beachten: Die Reporting-Funktionalität wird nach und nach Mandanten spezifisch freigeschaltet. Informationen zur Funktionsweise finden Sie hier vorab.'''

== Einleitung ==
Die Auswertungskomponente für das DiPlan Cockpit ermöglicht das Abrufen, Filtern und Downloaden von Reports und Auswertungen aus Planungs- und Genehmigungsverfahren. Die Auswertungsdiagramme zu individuellen Fragestellungen werden in dem externen BI-Tool Superset von berechtigten Personen auf Basis grundlegender SQL- und Datenmodell-Kenntnisse erstellt, verwaltet, auf Dashboards zusammengestellt und schließlich für die Darstellung im DiPlan Cockpit freigegeben.

== Aufruf der Auswertungen ==
Die Auswertungen sind in dem gleichnamigen Reiter im DiPlan Cockpit zu finden.

In der linken Bildschirmhälfte sind die Namen der jeweiligen zur Verfügung stehenden Dashboards zu finden. Ein Dashboard ist eine Zusammenstellung von einem oder mehreren Auswertungsdiagrammen auf einer Seite. Standardmäßig wird das Dashboard "Verfahrensstand aller Verfahren" für jeden Mandant initial mit ausgerollt. Alle weiteren Dashboards können je nach Bedarf individuell durch berechtigte Personen je Mandant erstellt werden. Mehr dazu findet sich im Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Auswertungen_erstellen.2C_ver.C3.B6ffentlichen_und_freigeben Auswertungen erstellen, veröffentlichen und freigeben].

'''Gut zu wissen:'''

* '''Datengrundlage:''' Grundsätzlich fließen gelöschte Verfahren nicht in die Auswertungen ein.
* '''Aktualität der Daten:''' Die Daten werden jede Nacht einmal mit der DiPlan Cockpit Datenbank synchronisiert.
* '''Darstellung:''' Das Reporting wird mit dem Tool Superset umgesetzt, welches in das DiPlan Cockpit eingebunden wird. Für eine optimale Darstellung nutzen Sie bitte den Browser Microsoft Edge.
[[Datei:ImageAuswertungenCockpit.png|zentriert|mini|717x717px|Ansicht des Reiters "Auswertungen" im DiPlan Cockpit mit dem Standarddashboard "Verfahrensstand aller Verfahren".]]

== Filtern der Dashboards bzw. Auswertungen ==
Je nach Art der dargestellten Auswertungen können Sie weitere Aktionen in den einzelnen Diagrammen vornehmen. Oftmals sind zum Beispiel verschiedene Filterungsmöglichkeiten hinterlegt. Zum Öffnen der Filter gehen Sie bitte folgendermaßen vor:

* Aufklappen der Filter durch Klick auf den kleinen blauen Pfeil links neben den Diagrammen. Alternativ können die Filter auch am oberen Rand des Dashboards eingebunden sein.
* Auswählen der gewünschten Filter.
* Klick auf "Filter anwenden".
* Bei Klick auf "Alles löschen" werden sämtliche gesetzte Filter wieder zurückgesetzt.
[[Datei:ImageAuswertungenCockpitFilter.png|zentriert|mini|742x742px|Falls eine Filterung im Dashboard integriert wurde, so lässt diese sich über den kleinen Pfeil ausklappen oder befindet sich am oberen Rand des Dashboards. Hier zu sehen eine Filterung auf dem Dashboard nach Zuständigkeit oder Verfahrenstyp.]]
[[Datei:ImageAuswertungenCockpitFilter2.png|zentriert|mini|742x742px|Das Reporting bietet die Möglichkeit auch mehrere verschiedene Diagrammtypen auf einem Dashboard darzustellen. Diese können von Mandanten-Administratoren konfiguriert und freigegeben werden. Hier ein Beispiel mit integrierten Filtern am oberen Rand des Dashboards.]]

== Download der Auswertungen ==
Neben jeder Auswertungsgrafik (jedem Diagramm) finden sich drei Punkte, welche bei Klick ein Drop-Down Menü öffnen. Durch '''Mouseover auf "Herunterladen"''' öffnet sich das Menü zum Download des Diagramms in verschiedenen auswählbaren Formaten. Hier sind folgende Punkte zu beachten:

* '''Der Download entspricht immer der Filterung:''' Wird eine Grafik durch eine Filterung angepasst und dann ein Download gestartet, so entsprechen die heruntergeladenen Daten immer genau der Filterung, das heißt es sind nicht alle Daten vorhanden. Je nach Grafik ist in den heruntergeladenen Dateien nicht selbsterklärend, dass eine Filterung angewendet wurde und es ist wichtig das Downloadergebnis bei der weiteren Verwendung in den richtigen Kontext zu setzen. Laden Sie sich alternativ die Daten ohne Filterung herunter und filtern Sie zum Beispiel bei Bedarf gesondert in MS Excel.
* '''Die Rollen der Sachbearbeitenden sehen nur die eigene Zuständigkeit:''' Je nach Rolle der Nutzenden werden unter Umständen nicht alle Daten auf den Dashboards dargestellt. Sachbearbeitende können nur Daten der eigenen Zuständigkeit sehen. Siehe dazu auch das nächste Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Rechte_und_Rollen Rechte und Rollen].
[[Datei:ImageAuswertungenHerunterladen.png|zentriert|mini|581x581px|Das vertikale Dreipunktemenü in den Diagrammen beinhaltet die Herunterladen-Funktion.]]

== Rechte und Rollen ==
Alle Rollen aus dem DiPlan Cockpit werden gemäß ihrer Berechtigungen mit einer entsprechenden Rolle in Superset versehen. Prinzipiell gibt es zwei relevante Rollen, denen die Nutzenden in Superset zugeordnet werden. Dies passiert automatisch und regelt ob die Nutzenden berechtigt sind Auswertungen selbst anzulegen, freizugeben und zu veröffentlichen oder ob sie ausschließlich die freigegebenen Auswertungen gemäß ihrer Zuständigkeit im DiPlan Cockpit sehen können. Nachfolgend sehen Sie eine Übersicht über die verschiedenen Berechtigungen:
<table border="1" cellspacing="0" cellpadding="8">
<tr>
<th>Rolle DiPlan Cockpit</th>
<th>Rolle Superset</th>
<th>Berechtigungen</th>
</tr>
<tr>
<td valign="top">
EfA Cockpit Pro
<ul>
<li>M‑A = Mandanten‑Administration</li>
<li>FP‑A = Fachplanung‑Administration</li> 
</ul>
EfA Cockpit Basis 
<ul>
<li>M-A-Basis = Mandanten-Administration-Basis</li>
<li>FP-A-Basis = Fachplanung-Administration Basis</li></ul>
</td>
<td valign="top">
Reporting-Administrator
</td>
<td valign="top">
<ul>
<li>Kann direkt aus dem DiPlan Cockpit zu Superset abspringen und ist dort automatisch eingeloggt (SSO).</li>
<li>Kann Datensätze (Superset-spezifische Zwischenschicht zwischen DB-Tabelle und Abfrage) erstellen.</li>
<li>Kann Auswertungen/Diagramme in Superset erstellen.</li>
<li>Kann Dashboards mit verschiedenen Auswertungen/Diagramme zusammenstellen.</li>
<li>Kann Dashboards freigeben für den ganzen Mandanten (z.B. ganz Hamburg).</li>
<li>Kann alle Daten im Dashboard eines Mandanten sehen.</li>
<li>Kann Abfragen filtern, also z.B. in Hamburg nach Belieben nach Bezirk (Zuständigkeit) z.B. Altona oder Senat.
<li>Kann Auswertungen in verschiedenen Formaten herunterladen.</li>
<li>Kann andere Reporting-Administratoren für die eigenen Dashboards/Diagramme als Besitzer eintragen, um diese für die Bearbeitung, Freischaltung und Veröffentlichung zu berechtigen.</li>
<ul/>
</td>
</tr>
<tr>
<td valign="top">
EfA Cockpit Pro 
<ul>
<li>FP-VM = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)</li>
<li>FP-SB = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)</li> 
</ul>
EfA Cockpit Basis 
<ul>
<li>FP-VM-Basis = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)</li>
<li>FP-SB-Basis = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)</li>
</ul>
</td>
<td valign="top">
Sachbearbeiter
</td>
<td valign="top">
<ul>
<li>Sieht ausschließlich die vorgefilterten Daten der eigenen Zuständigkeit (also z.B. Altona).</li>
<li>Kann Auswertungen herunterladen, aber nur mit den Daten der eigenen Zuständigkeit.</li>
<li>Kann freigegebene Dashboards betrachten. </li>
<li>Kann Auswertungen filtern, wenn Filter eingerichtet wurden.</li>
<li>Kann Auswertungen in verschiedenen Formaten herunterladen.</li>
</ul>
</td>
</tr>
</table>

== Superset als zentrales Tool für Reporting-Administratoren ==

=== Übergreifende Informationen zu Superset ===
Für die Erstellung und Darstellung des Reportings wurde das Open-Source-Tool Apache Superset in das DiPlan Cockpit implementiert. Superset ist eine Reporting- und Monitoring-Technologie, die es ermöglicht komplexe Daten auf Dashboards in leicht verständlichen Visualisierungen darzustellen. Die Erstellung der Dashboards erfolgt dabei direkt in der Superset-Anwendung. Dort wird auch gesteuert, welche Dashboards mit welchen Auswertungen im DiPlan Cockpit veröffentlicht werden sollen.

=== Absprung aus dem DiPlan Cockpit zu Superset ===
Sobald eine Rolle für die Erstellung von Auswertungen berechtigt ist (zum Beispiel M-A oder FP-A), findet sich im Reiter Auswertungen automatisch der Button '''"Auswertungen konfigurieren"'''. Bei Klick öffnet sich ein weiteres Browserfenster mit der Superset-Plattform. Eine gesonderte Anmeldung in Superset ist nicht erforderlich, da die Anmeldung durch das Cockpit erfolgt (auch Single Sign-On (SSO) genannt).

'''Bitte beachten:''' Nach 4 Stunden erfolgt aus Sicherheitsgründen ein automatischer Logout aus Superset - unabhängig davon ob Sie gerade in Superset arbeiten oder nicht aktiv waren. Sie erhalten keine Warnung vor dem Logout. Deshalb empfiehlt es sich, Änderungen regelmäßig zu speichern, um zu verhindern, dass ungesicherte Abfragen verloren gehen.
[[Datei:ImageButtonAuswertungenKonfigurieren.png|zentriert|mini|766x766px|Berechtigte Personen sehen über den Dashboards im DiPlan Cockpit einen Absprungbutton zu Superset mit der Bezeichnung "Auswertungen konfigurieren."]]
[[Datei:ImageStartbildschirmSuperset.png|zentriert|mini|777x777px|Startbildschirm in Superset mit einer Vorschau auf Dashboards und Diagrammen. Die Hauptmenüpunkte zur Navigation sind am oberen Bildschirmrand zu sehen.]]

=== Auswertungen erstellen, veröffentlichen und freigeben ===
Datenvisualisierungen von Abfragen werden in Superset als '''"Diagramme"''' bezeichnet. Sobald mindestens ein Diagramm erstellt ist, kann dieses auf einem Dashboard integriert werden und mit weiteren Filtermöglichkeiten versehen werden. Wie bereits erwähnt, können Sie als '''Reporting-Administrator''' selbst nach Belieben Diagramme erstellen. Nachfolgend wird beispielhaft die Erstellung und Freigabe des Dashboards mit dem Diagramm "Verfahrensstand aller Verfahren" beschrieben, um einige der Grundfunktionalitäten in Superset zu verdeutlichen (siehe dazu das Kapitel: "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]").

=== Datensätze erstellen ===
Um ein Diagramm zu erstellen wird zunächst ein Datensatz benötigt. Für einfache Abfragen reicht der '''Verfahrensdatensatz''' aus, der bereits standardmäßig enthalten ist. Dieser entspricht der '''Tabelle "Verfahren"''' mit den '''zugehörigen Datenfeldern (Stammdaten)'''.

Für Abfragen auf dem Verfahrensdatensatz können Sie direkt zum Abschnitt "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]" springen.

Für komplexere '''Abfragen über mehrere Tabellen hinweg, eigene Metriken oder eigene berechnete Spalten''' ist die Erstellung eines eigene Datensatzes mithilfe von SQL-Abfragen notwendig. Folgende Informationen sind in gesonderten Tabellen enthalten:

* Gebietseinheiten
* Kontakte
* Nutzer
* Parallelverfahren
* Termine
* Veränderungssperren
* Vertragsarten
* Vorgesehene Nutzungen
* Zurückstellungen

'''Bitte beachten:''' Bei der Erstellung von eigenen Datensätzen, muss die Spalte "'''''zustaendigkeit_code"''''' aus der Tabelle "'''''verfahren"'' immer enthalten sein,''' da hierüber die Ansicht für Sachbearbeiter standardmäßig gefiltert wird.

'''Um eigene Datensätze zu erstellen gehen Sie bitte wie folgt vor:'''

* Klick im Hauptmenü auf den '''Reiter "SQL"''' und im zugehörigen Dropdown-Menü auf '''"SQL Lab".'''
[[Datei:ImageStartSQLLab.png|zentriert|mini|854x854px|Startansicht SQL Lab]]
* Erstellen Sie Ihre '''SQL-Abfrage''' und klicken Sie auf den '''Button "Ausführen"''', um eine Vorschau auf die Ergebnisse der Abfrage zu erhalten. Ein rotes Kreuzchen links vom SQL-Editor weist auf Fehler im SQL hin.
[[Datei:ImageAusfuehrenSQLLab.png|zentriert|mini|846x846px|Ausführen einer SQL Abfrage im SQL Lab]]
'''Typische Anwendungsfälle und die dazugehörigen SQL Abfragen könnten z.B. sein:'''

* Sie möchten, dass Ihre Abfragen z.B. nach "Gebietseinheiten" und "Vorgesehenen Nutzungen" gefiltert werden können:

{| class="wikitable"
|
SELECT v.*, g.gebietseinheit, vn.vorgesehene_nutzungen
FROM verfahren v
LEFT JOIN gebietseinheiten g ON g.verfahren_id = v.id
LEFT JOIN vorgesehene_nutzungen vn ON vn.verfahren_id = v.id;
|}

* Sie möchten, dass Ihr Datensatz bestimmte Termine enthält (z.B. Grobabstimmungsdatum, Vorweggenehmigungsreife):

{| class="wikitable"
|
WITH grobabstimmung_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Grobabstimmung'
),
vorweggenehmigungsreife_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Vorweggenehmigungsreife'
)
SELECT
v.*,
t1.beginn AS grobabstimmung,
t2.beginn AS vorweggenehmigungsreife
FROM verfahren v
LEFT JOIN grobabstimmung_termin t1 ON t1.verfahren_id = v.id
LEFT JOIN vorweggenehmigungsreife_termin t2 ON t2.verfahren_id = v.id;
|}

* '''Speichern Sie Ihre Abfrage als Datensatz''' ab, indem Sie auf den '''Dropdown-Pfeil neben dem Button "Speichern"''' klicken und dann '''"Datensatz speichern"''' auswählen. Es öffnet sich ein Dialogfeld, in dem Sie einen Namen für Ihren Datensatz vergeben können.
** Hinweis: Wenn Sie statt auf "Datensatz speichern" auf "Speichern" klicken, finden Sie Ihre SQL Abfrage unter dem Reiter '''"Gespeicherte Abfragen"''' wieder.
[[Datei:ImageSpeichernDatensatzSuperset.png|zentriert|mini|891x891px|Speichern eines neuen Datensatzes]]
Nach der Erstellung eines Datensatzes können Sie diesen noch weiter bearbeiten und Labels, eigene Metriken oder berechnete Spalten hinzufügen. Gehen Sie dazu wie folgt vor:
* Klick im Hauptmenü auf den '''Reiter "Datensätze"'''. Hier sind die verfügbaren Datensätze aufgelistet.
* Klicken Sie ganz rechts neben dem Datensatz, den Sie bearbeiten wollen, auf das '''Stift-Symbol.''' Es öffnet sich eine Bearbeitungsmaske.
[[Datei:ImageBearbeitungDatensatzSuperset.png|zentriert|mini|890x890px|Öffnen Sie den Bearbeitungsmodus durch Klick auf das Stiftsymbol]]
*'''Reiter "Quelle":''' Hier kann die zugrundeliegende SQL Abfrage nachträglich angepasst werden. Klicken Sie hierfür auf das Schloss-Symbol.
[[Datei:ImageReiterQuelleSuperset.png|zentriert|mini|879x879px|Im Reiter "Quelle" kann das SQL nachträglich angepasst werden]]
*'''Reiter "Metriken":''' Hier können eigene Metriken angelegt werden.
[[Datei:ImageReiterMetrikenSuperset.png|zentriert|mini|878x878px|Eine neue Metrik "Anzahl Verfahren" wird hinzugefügt]]
*'''Reiter "Spalten":''' Hier sind alle im Datensatz enthaltenen Spalten aufgeführt. An den Werten in der Tabelle ("Datentyp", "Ist zeitlich" etc.) sollte in der Regel nichts geändert werden, dies wird von Superset automatisch richtig erkannt. Beim '''Klick auf das "Plus"''' neben jeder Spalte kann unter "Beschriftung" ein sprechendes Label hinzugefügt werden. Dieses wird später in den Diagrammen angezeigt.
[[Datei:ImageReiterSpaltenSuperset.png|zentriert|mini|877x877px|Im Reiter "Spalten" wird ein Label hinzugefügt]]
*'''Reiter "Berechnete Spalten":''' Hier können dem Datensatz weitere Spalten hinzugefügt werden, die Werte enthalten, die aus anderen Spalten errechnet werden. Verwenden Sie für die Berechnung SQL-Syntax.
[[Datei:ImageReiterBerechneteSpaltenSuperset.png|zentriert|mini|851x851px|Eine berechnete Spalte wird hinzugefügt]]
* Speichern Sie Ihre Änderungen am Datensatz durch das '''Klicken auf den "Speichern"-Button'''. Um die Änderungen zu prüfen, empfiehlt es sich ein Diagramm mit dem Datensatz anzulegen (z.B. eine Tabelle).

=== Beispiel-Diagramm erstellen ===
Nachfolgend soll beispielhaft ein Diagramm "Verfahrensstand aller Verfahren" erstellt werden. Dazu gehen Sie wie folgt vor:

# Klick auf den '''Menüpunkt "Diagramme":''' Auf dieser Seite findet sich eine Liste mit allen bereits erstellten Diagrammen. Innerhalb dieser Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Diagramm-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageUebersichtDiagrammeSuperset.png|zentriert|mini|860x860px|Im Menüpunkt "Diagramme" findet sich eine Übersicht über die bisher erstellten Diagramme (Abfragen) mit vielen Zusatzinformationen.]]
# Um ein neues Diagramm zu erstellen klicken Sie auf den '''Button "+Diagramm"''' rechts oben. Es öffnet sich der Dialog '''"Neues Diagramm erstellen".'''[[Datei:ImageNeuesDiagrammSuperset.png|zentriert|mini|860x860px|Dialog um ein neues Diagramm zu erstellen]]
# Zunächst muss der '''passende Datensatz für die Auswertung ausgewählt''' werden. Für dieses Beispiel wählen wir unter '''"1- Datensatz auswählen"''' den Datensatz '''"verfahren"''' im Dropdownmenü aus.
# Im nächsten Schritt wird der '''passende Diagrammtyp ausgewählt'''. Hier werden Ihnen viele verschiedene Visualisierungsmöglichkeiten geboten. Im genannten Beispiel passt ein "Kreisdiagramm" am besten zu der Visualisierung der Verfahrensstände aller Verfahren. Sie finden das Kreisdiagramm unter dem Hauptmenü "Teil des Ganzen". Klicken Sie '''auf das Kreisdiagramm''' und anschließend auf '''"Neues Diagramm erstellen"'''.
# Nun geht es um die '''Detailkonfiguration''' des Diagramms. Grundsätzlich ist der Arbeitsbereich wie folgt aufgebaut:
#* Die linke Spalte enthält einen '''Überblick''' über die '''zur Verfügung stehenden Daten'''.
#* Die mittlere Spalte enthält die '''Werkzeuge''', um das '''Diagramm zu konfigurieren.'''
#* Im rechten Bereich kann man sich jeweils eine '''Vorschau des Diagramms''' anzeigen lassen.
'''Wir gehen für unser Beispiel wie folgt vor:'''

* Im Feld '''"Name des Diagramms hinzufügen"''' das Diagramm mit einer passenden Bezeichnung versehen.
* Um die Dimensionen des Diagramms festzulegen im Tab '''"Daten"''' unter der Überschrift '''"Abfrage > Dimensionen"''' die Spalte '''"verfahrensstand"''' von links per Drag & Drop herüberziehen.
* Der dazustellende Wert soll hier die Anzahl sein, weshalb nun unter '''"Metrik"''' das Feld '''"Anzahl"''' Button "+Diagramm" per Drag & Drop von links herübergezogen wird. Je nach Fragestellung bzw. welche Daten auf dem Diagramm dargestellt werden sollen, können verschiedenste Kombinationen in der selben Art und Weise über Drag & Drop zusammengestellt werden.
* Unter dem '''Punkt "Filter"''' kann eine Vorabfilterung eingebaut werden, also beispielsweise könnten Sie simulierte Verfahren standardmäßig herausfiltern, so dass die Nutzenden diese gar nicht auswerten können. Anmerkung: "imported_at" kann nicht gelöscht werden. Dieser Wert wird von Superset standardmäßig gesetzt und hat keine Auswirkung auf Ihre Auswertungen.
* Das für die Berechnung zugrundeliegende Zeilenlimit kann bei Bedarf verändert werden.
* Ein Klick auf den '''blauen Button "Diagramm erstellen"''' zeigt eine '''Vorschau''' des erstellten Diagrammes auf der rechten Bildschirmhälfte. Das Diagramm kann nun jederzeit mit einem '''Klick auf "Speichern"''' rechts oben gesichert werden.[[Datei:ImageDiagrammErstellenSuperset.png|zentriert|mini|880x880px|Dialog zur Detaildefinition des neuen Diagramms. Hier beispielhaft zusammengestellt für die Darstellung "Verfahrenstand aller Verfahren".]]

* Unter dem '''Tab "Anpassen"''' finden sich zahlreiche Möglichkeiten, das Diagramm weiter zu verfeinern (zum Beispiel in Farbe und Layout). Hier kann ganz nach Belieben ausprobiert werden. Mit '''Klick auf''' '''"Diagramm aktualisieren"''' kann die Vorschau des Diagramms zur Überprüfung mit den neu gewählten Einstellungen geladen werden.[[Datei:ImageDiagrammAnpassenSuperset.png|zentriert|mini|900x900px|Diagramm kann nach Belieben im Tab "Anpassen" verändert und verfeinert werden.]]
* '''Speichern nicht vergessen:''' Das Diagramm wird erst gespeichert durch '''Klick auf "Speichern" rechts oben'''. Es öffnet sich ein Dialog zu weiteren Speicheroptionen, der mit '''einer weiteren Speicherbestätigung''' abgeschlossen werden kann.[[Datei:ImageDiagrammSpeichernSuperset.png|zentriert|mini|874x874px|Speichern-Dialog für das erstellte Diagramm]]

=== Beispiel-Dashboard erstellen ===

# '''Klick auf den Menüpunkt "Dashboards":''' Unter der Überschrift "Dashboards" findet sich eine Liste mit allen bereits erstellten Dashboards. Diese Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Dashboard-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageDashboardsSuperset.png|zentriert|mini|866x866px|Unter dem Menüpunkt "Dashboards" finden sich alle bereits angelegten Dashboards, sowie die Möglichkeit neue Dashboards zu erstellen.]]
# Mit Klick auf den Button '''"+Dashboard"''' rechts oben öffnet sich ein neuer, leerer Dashboard -Entwurf.
# Der Titel des Dashboards ist standardmäßig als "untitled dashboard" angeben und kann durch '''Klick auf den Namen''' geändert werden.
# Auf der Seitenleiste am rechten Bildschirmrand finden sich alle bereits erstellten Diagramme. Das gewünschte Diagramm kann einfach durch '''Drag & Drop mit der Maus auf das Dashboard gezogen''' werden. Auch die Größe kann leicht geändert werden indem sie die Ränder oder Ecken des Diagramms klicken, gedrückt halten und auf die gewünschte Größe ziehen. Sie können ein oder auch mehrere Diagramme auf einem Dashboard platzieren.
# Zu guter Letzt oben rechts auf den '''Button "Speichern"''' klicken um Ihre Arbeit zu sichern. Nach dem Speichern können Sie jederzeit am Dashboard weiter arbeiten indem Sie auf den nun erscheinenden Button '''"Dashboard bearbeiten"''' klicken.
# Sollten Sie ein Diagramm wieder vom Dashboard löschen wollen, können Sie einfach das '''Mülleimer-Symbol''' klicken, welches bei Mouseover über das jeweilige Diagramm erscheint.[[Datei:ImageDragDropDiagrammSuperset.png|zentriert|mini|804x804px|Das gewünschte Diagramm kann mit der Maus einfach auf das Dashboard gezogen und platziert werden.]]
[[Datei:ImageDiagrammGroesseSuperset.png|zentriert|mini|761x761px|Die Größe des Diagramms lässt sich einfach durch Ziehen der Maus an Ecken oder Rändern verändern.]]

=== Einen oder mehrere Filter zu einem Dashboard zufügen ===
Es ist möglich Ihre Auswertungsdiagramme mit Filtermöglichkeiten zu versehen. Im folgenden wird beispielhaft ein Filter nach der Zuständigkeit auf dem Dashboard "Verfahrensstand aller Verfahren" hinzugefügt:

# Öffnen Sie das Dashboard oder legen Sie sich ein entsprechendes neues Dashboard an und speichern dieses.
# An der linken Bildschirmkante den '''kleinen Pfeil klicken''', um das Filtermenü auszuklappen. '''Wichtig:''' Der Pfeil ist nur sichtbar, wenn das Dashboard bereits gespeichert ist und sich nicht gerade im offenen Bearbeitungsmodus befindet. Sprich: Klicken Sie '''nicht''' "Dashboard bearbeiten" bevor Sie den Filter hinzufügen.
# Klicken Sie auf das '''kleine Zahnrad''' um das Untermenü zu öffnen.
# Ein Klick auf '''"Hinzufügen und Bearbeiten von Filtern"''' öffnet das Menü um die Filter zu konfigurieren.[[Datei:ImageDashboardFilterMenueSuperset.png|zentriert|mini|800x800px|Durch Klick auf den kleinen Pfeil öffnet sich das Menü, mit dem Filter hinzugefügt und konfiguriert werden können.]]
# Um nach der Zuständigkeit zu filtern muss im '''Menü Filtertyp die Option "Wert"''' ausgewählt sein.
# Im Menüpunkt Tabellenname '''"Zuständigkeit"''' als '''Namen des Filters''' eintragen.
# Im '''Feld Datensatz''' wird in diesem Fall '''"verfahren"''' ausgewählt.
# Im '''Feld "Spalte"''' den Filter auswählen, nach dem gefiltert werden soll: in diesem Fall '''"zustaendigkeit".'''
# Das Menü '''"Filterwerte sortieren"''' durch einen Haken aktivieren und absteigend sortieren und mit der '''Sortiermetrik "Anzahl"''' versehen.
# Im '''Reiter "Auswahlverfahren"''' kann der Filter durch eine Auswahl außerdem auf '''einzelne Diagramme oder auf alles bezogen''' werden.
# Durch '''Klick auf "Speichern"''' rechts unten wird der Filter in das Dashboard integriert.[[Datei:ImageFilteroptionenDashboardSuperset.png|zentriert|mini|712x712px|Sie können einen oder mehrere Filteroptionen auf einem Dashboard integrieren und in diesem Menü konfigurieren.]]
'''Übergeordnete Filtereinstellungen:'''

Nach '''Klick auf das Zahnrad''', im geöffneten Filter-Untermenü, können Sie außerdem entscheiden, ob der Filter '''oben''' über dem Diagramm '''oder seitlich links einklappbar''' angezeigt werden soll.

Es gibt dort außerdem die Möglichkeit für ein oder mehrere Diagramme eine '''Kreuzfilterung zu aktivieren.''' Diese erlaubt es Ihnen, direkt '''in einem Diagramm auf ein Element zu klicken''', um damit automatisch eines oder alle Diagramme im Dashboard zu filtern. So können Daten intuitiv und interaktiv erkundet werden, ohne separate Filtersteuerungen zu verwenden.
[[Datei:ImageFilterUntermenueSuperset.png|zentriert|mini|767x767px|Im Filter-Untermenü können bestehende Filter bearbeitet oder weitere Filter hinzugefügt werden. Außerdem kann die Kreuzfilterung aktiviert und die Darstellung der Filterleiste verändert werden.]]

=== Dashboards veröffentlichen ===
Dashboards werden erst im DiPlan Cockpit sichtbar, nachdem diese veröffentlicht und für die Sachbearbeitenden und Reporting-Administratoren freigeschalten wurden. Dabei gilt es zu beachten, dass Sie nur Dashboards veröffentlichen und freischalten können, die Sie selbst erstellt haben oder für die Sie berechtigt worden sind. Siehe hierzu auch das Kapitel "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Diagramme_und_Dashboards_f.C3.BCr_andere_Reporting-Administratoren_zur_Bearbeitung_freigeben Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben]".

'''Zur Veröffentlichung und Freischaltung gehen Sie wie folgt vor:'''

# Öffnen Sie das Dashboard, welches veröffentlicht werden soll.
# Durch Klick auf das '''graue Feld "Entwurf"''' neben dem Dashboard Namen, ändert sich die Bezeichnung auf '''"Veröffentlicht".'''[[Datei:ImageStatusVeroeffentlichtSuperset.png|zentriert|mini|911x911px|Durch Klick ändert sich der Status von "Entwurf" auf "Veröffentlicht".]]
# Öffnen Sie rechts oben das '''Dreipunktemenü''' und wählen Sie dort den Unterpunkt '''"Dashboard einbetten"''' aus.[[Datei:ImageDashboardEinbettenSuperset.png|zentriert|mini|942x942px|Im Dreipunktemenü muss im nächsten Schritt der Punkt "Dashboard einbetten" geklickt werden.]]
# Im Einbetten-Dialog lassen Sie das Feld für "Zulässige Domänen" bitte einfach frei und klicken lediglich den '''Button "Einbettung aktivieren".''' Dann kann das Menü durch Klick auf das '''X-Symbol''' geschlossen werden.[[Datei:ImageEinbettungAktivierenSuperset.png|zentriert|mini|869x869px|Im Menü "Einbetten" klicken Sie auf "Einbettung aktivieren" und dann einfach auf das X um das Fenster zu schließen.]]
# Um das Dashboard nun für die '''Rolle der Sachbearbeitenden und Mandanten-Administratoren''' im DiPlan Cockpit '''freizugeben''' öffnen Sie bitte erneut den Reiter '''"Dashboards",''' um auf die Liste mit allen Dashboards zu gelangen.
# Klicken Sie auf das '''Stift-Symbol''' neben dem Dashboard, welches freigeschalten werden soll.[[Datei:ImageDashboardEigenschaftenOeffnenSuperset.png|zentriert|mini|843x843px|Durch Klick auf das Stiftsymbol neben dem Dashboard werden die Dashboardeigenschaften geöffnet. Dort können auch die einzelnen Rollen freigeschaltet werden.]]
# In den '''Dashboardeigenschaften''' können nun die Rollen eingetragen werden, für die das Dashboard freigeschalten werden soll. Die Rollenbezeichnungen in Superset fassen mehrere Rollen aus dem DiPlan Cockpit zusammen, was die Freigabe von Dashboards vereinfacht. Bitte tragen Sie im Feld "Rollen" deshalb '''"Reporting-Administrator"''' und '''"Sachbearbeiter" in der Liste ein.''' Dies ist durch Tippen in das Feld möglich, so wird die auszuwählende Rolle schneller sichtbar. Sie können jedoch auch manuell durch die Liste scrollen und die Rolle auswählen. Klicken Sie anschließend den '''"Speichern"-Button'''. Die Auswertungen sind nun im DiPlan Cockpit für alle berechtigten Rollen sichtbar.[[Datei:ImageDashboardEigenschaftenRollenSuperset.png|zentriert|mini|695x695px|In den Dashboardeigenschaften müssen die Rollen, für die das Dashboard freigegeben werden soll, ausgewählt werden.]]
'''Hinweis: Veröffentlichung zurücknehmen'''

Sollten Sie ein Dashboard im DiPlan Cockpit unsichtbar machen wollen, so klicken Sie wie im Punkt 2 beschrieben wieder auf die graue Schaltfläche und setzen Sie den Status von '''"Veröffentlicht"''' zurück auf '''"Entwurf".'''

=== Bestehendes Dashboard oder Diagramm bearbeiten oder löschen ===
'''Wie lösche ich ein eingebettetes Diagramm von einem bereits veröffentlichten und freigegebenen Dashboard?'''

* Öffnen Sie das Dashboard und '''klicken Sie "Dashboard bearbeiten"''' auf der rechten Bildschirmseite.
* Im geöffneten Bearbeitungsmodus können Sie nun die Maus über das nicht mehr erwünschte Diagramm bewegen und durch '''Klick auf das erscheinende Mülleimersymbol''' löschen. Das Diagramm bleibt in der Liste der Diagramme weiterhin erhalten und wird lediglich vom Dashboard genommen.
* Sie können ein '''weiteres/neues Diagramm''' jederzeit wieder aus der Liste rechts auf das Dashboard ziehen.
* Bestätigen Sie das veränderte Dashboard durch Klick auf den "'''Speichern"-Button''' rechts oben.
* '''Bitte beachten:''' Änderungen an bereits veröffentlichten und freigegebenen Dashboards werden nach dem '''Speichern direkt auf dem DiPlan Cockpit sichtbar'''.
[[Datei:ImageDashboardDiagrammLoeschenSuperset.png|zentriert|mini|736x736px|Per Mouseover und Klick auf das Mülleimer Symbol lassen sich Diagramme auf Dashboards einfach wieder löschen.]]
'''Wie bearbeite ich ein bestehendes Diagramm?'''

Ein Diagramm unabhängig vom Dashboard ändern:

* Öffnen Sie das zu bearbeitende Diagramm in der '''Liste der Diagramme''' durch einen '''Klick auf den Namen'''.
* Das Diagramm öffnet sich direkt im Bearbeitungsmodus und kann nach '''Belieben angepasst werden'''.
* Ist das Diagramm bereits auf einem veröffentlichten und freigegebenen Dashboard eingebettet, so werden alle Änderungen nach dem Speichern direkt übernommen und im '''DiPlan Cockpit sichtbar'''.

Ein Diagramm direkt auf einem Dashboard ändern:

* Öffnen Sie das Dashboard und klicken Sie '''"Dashboard bearbeiten"'''.
* Bewegen Sie die Maus über die entsprechende Grafik, öffnen Sie das Dreipunktemenü rechts und klicken '''"Diagramm bearbeiten".'''
* Nachdem Sie das Diagramm bearbeitet haben klicken Sie '''"Speichern"'''.

'''Bitte beachten:''' Im Speichern-Dialog können Sie entscheiden, ob sie das bestehende '''Diagramm überschreiben''' oder ein '''neues Diagramm speichern''' wollen. Dies kann hilfreich sein, wenn Sie das Diagramm nicht generell, sondern nur auf einem bereits bestehenden Dashboard ändern wollen.
[[Datei:ImageDiagrammSpeichernÜberschreibenSuperset.png|zentriert|mini|792x792px|Es ist möglich direkt beim Speichern ein neues Diagramm zu erstellen oder das bereits bestehende zu überschreiben.]]

'''Wie lösche ich ein Dashboard oder Diagramm dauerhaft?'''

Sie können ein Dashboard unabhängig vom Status (also veröffentlicht oder auch als Entwurf) in der Liste der Dashboards wie folgt löschen:

* Bewegen Sie die Maus über den entsprechenden '''Listeneintrag.'''
* Klicken Sie das in der Zeile rechts erscheinende '''Papierkorb-Symbol''' und folgen den Anweisungen im erscheinenden Löschdialog.
* Die Originaldiagramme auf dem Dashboard bleiben dabei weiterhin in der Liste "Diagramme" erhalten.
* Sollten Sie ein Diagramm dauerhaft löschen wollen, so gehen Sie genauso wie beim Dashboard vor, jedoch im '''Reiter "Diagramme"'''.

=== Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Bitte beachten:''' Solange Reporting-Administratoren nicht als Besitzer eingetragen sind, haben diese nur Zugriff auf die eigenen erstellten Daten.

'''Das bedeutet konkret für die erstellten Daten von anderen Reporting-Administratoren:'''

* Unveröffentlichte Dashboards sind nicht sichtbar.
* Veröffentlichte Dashboards sind sichtbar, aber nicht bearbeitbar.
* Alle Diagramme sind sichtbar, Änderungen können jedoch nur als neue Diagramme gespeichert werden.
* Datensätze sind sichtbar und können verwendet, aber nicht bearbeitet werden.
* Gespeicherte Abfragen sind nicht sichtbar (Berechtigungen können hier grundsätzlich nicht vergeben werden).

Sie haben grundsätzlich keine Rechte ein Dashboard zu bearbeiten oder ein Diagramm zu überschreiben, welches nicht von Ihnen erstellt wurde, außer Sie wurden als '''"Besitzende/r"''' dazu ermächtigt.

Das bedeutet beispielsweise, dass Sie ein Diagramm, welches jemand anders erstellt hat, zwar bearbeiten, dies aber nur als neues Diagramm abspeichern können. Das Originaldiagramm wird hier nicht verändert. Um jemanden für die '''Mitarbeit an Ihrem Diagramm oder Dashboard zu ermächtigen''' gehen Sie wie folgt vor:

* Klicken Sie in der Liste der Diagramme oder Dashboards auf das '''Stift-Symbol "Bearbeiten".''' Der Dialog '''"Diagrammeigenschaften bearbeiten"''' öffnet sich.
* Unter der '''Überschrift "Zugang"''' können weitere '''"Besitzende" eingetragen''' werden. Klicken Sie hierzu in das Eingabefeld und fangen Sie an den Namen zu tippen oder scrollen Sie durch die Liste bis zum gewünschten Namen.
* '''Wählen Sie einen oder mehrere Namen aus,''' um diese in das Feld zu übernehmen und klicken Sie dann auf '''"Speichern"'''. Die eingetragene Person hat nun die gleichen '''Rechte zur Bearbeitung wie der/die ursprüngliche Ersteller/in'''.[[Datei:ImageDiagrammZugangBesitzendeSuperset.png|zentriert|mini|677x677px|Unter "Zugang" können Sie andere Mandanten-Administratoren für die Bearbeitung Ihrer Dashboards oder Diagramme berechtigen.]]

=== Datensätze für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Um Datensätze für andere Reporting-Administratoren zur Bearbeitung freizugeben, gehen Sie wie folgt vor:'''

* Klick auf den '''Reiter "Datensätze"'''
* In der Übersicht-Liste klicken Sie bitte das '''Stift- Symbol''' neben dem gewünschten Datensatz.
* Klicken Sie den '''Reiter "Einstellungen"''' ganz rechts und scrollen Sie ganz nach unten.
* Dort können Sie im '''Feld "Besitzende"''' auch andere Reporting-Administratoren zur Bearbeitung berechtigen.
[[Datei:ImageDatensatzBesitzendeSuperset.png|zentriert|mini|810x810px|Auch Datensätze können zur Bearbeitung an andere Mandanten-Administratoren freigegeben werden.]]

== Weiterführende Informationen ==
Unter folgendem Link können Sie weitere Informationen zu Superset in englischer Sprache finden. Bitte beachten Sie, dass Ihre Datenbank bereits angebunden ist und der Punkt "Connecting to a new database" in der Dokumentation somit nicht beachtet werden sollte: '''[https://superset.apache.org/docs/6.0.0/using-superset/creating-your-first-dashboard#creating-your-first-dashboard Englische Dokumentation des Open-Source-Tools Superset]'''

Reporting: Auswertungen im DiPlan Cockpit

2026-03-18T12:44:42Z

Diplanung:

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

'''> Zurück zur Hauptseite [[DiPlanCockpit Basis als EfA-Lösung|DiPlanCockpit Basis für Fachplanung-Sachbearbeitung (FP-SB)]]'''

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

'''> Zurück zur Hauptseite [[DiPlanCockpit Pro für Fachplanung-Sachbearbeitung (FP-SB)]]'''

⚠️ '''Bitte beachten: Die Reporting-Funktionalität wird nach und nach Mandanten spezifisch freigeschaltet. Informationen zur Funktionsweise finden Sie hier vorab.'''

== Einleitung ==
Die Auswertungskomponente für das DiPlan Cockpit ermöglicht das Abrufen, Filtern und Downloaden von Reports und Auswertungen aus Planungs- und Genehmigungsverfahren. Die Auswertungsdiagramme zu individuellen Fragestellungen werden in dem externen BI-Tool Superset von berechtigten Personen auf Basis grundlegender SQL- und Datenmodell-Kenntnisse erstellt, verwaltet, auf Dashboards zusammengestellt und schließlich für die Darstellung im DiPlan Cockpit freigegeben.

== Aufruf der Auswertungen ==
Die Auswertungen sind in dem gleichnamigen Reiter im DiPlan Cockpit zu finden.

In der linken Bildschirmhälfte sind die Namen der jeweiligen zur Verfügung stehenden Dashboards zu finden. Ein Dashboard ist eine Zusammenstellung von einem oder mehreren Auswertungsdiagrammen auf einer Seite. Standardmäßig wird das Dashboard "Verfahrensstand aller Verfahren" für jeden Mandant initial mit ausgerollt. Alle weiteren Dashboards können je nach Bedarf individuell durch berechtigte Personen je Mandant erstellt werden. Mehr dazu findet sich im Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Auswertungen_erstellen.2C_ver.C3.B6ffentlichen_und_freigeben Auswertungen erstellen, veröffentlichen und freigeben].

'''Gut zu wissen:'''

* '''Datengrundlage:''' Grundsätzlich fließen gelöschte Verfahren nicht in die Auswertungen ein.
* '''Aktualität der Daten:''' Die Daten werden jede Nacht einmal mit der DiPlan Cockpit Datenbank synchronisiert.
* '''Darstellung:''' Das Reporting wird mit dem Tool Superset umgesetzt, welches in das DiPlan Cockpit eingebunden wird. Für eine optimale Darstellung nutzen Sie bitte den Browser Microsoft Edge.
[[Datei:ImageAuswertungenCockpit.png|zentriert|mini|717x717px|Ansicht des Reiters "Auswertungen" im DiPlan Cockpit mit dem Standarddashboard "Verfahrensstand aller Verfahren".]]

== Filtern der Dashboards bzw. Auswertungen ==
Je nach Art der dargestellten Auswertungen können Sie weitere Aktionen in den einzelnen Diagrammen vornehmen. Oftmals sind zum Beispiel verschiedene Filterungsmöglichkeiten hinterlegt. Zum Öffnen der Filter gehen Sie bitte folgendermaßen vor:

* Aufklappen der Filter durch Klick auf den kleinen blauen Pfeil links neben den Diagrammen. Alternativ können die Filter auch am oberen Rand des Dashboards eingebunden sein.
* Auswählen der gewünschten Filter.
* Klick auf "Filter anwenden".
* Bei Klick auf "Alles löschen" werden sämtliche gesetzte Filter wieder zurückgesetzt.
[[Datei:ImageAuswertungenCockpitFilter.png|zentriert|mini|742x742px|Falls eine Filterung im Dashboard integriert wurde, so lässt diese sich über den kleinen Pfeil ausklappen oder befindet sich am oberen Rand des Dashboards. Hier zu sehen eine Filterung auf dem Dashboard nach Zuständigkeit oder Verfahrenstyp.]]
[[Datei:ImageAuswertungenCockpitFilter2.png|zentriert|mini|742x742px|Das Reporting bietet die Möglichkeit auch mehrere verschiedene Diagrammtypen auf einem Dashboard darzustellen. Diese können von Mandanten-Administratoren konfiguriert und freigegeben werden. Hier ein Beispiel mit integrierten Filtern am oberen Rand des Dashboards.]]

== Download der Auswertungen ==
Neben jeder Auswertungsgrafik (jedem Diagramm) finden sich drei Punkte, welche bei Klick ein Drop-Down Menü öffnen. Durch '''Mouseover auf "Herunterladen"''' öffnet sich das Menü zum Download des Diagramms in verschiedenen auswählbaren Formaten. Hier sind folgende Punkte zu beachten:

* '''Der Download entspricht immer der Filterung:''' Wird eine Grafik durch eine Filterung angepasst und dann ein Download gestartet, so entsprechen die heruntergeladenen Daten immer genau der Filterung, das heißt es sind nicht alle Daten vorhanden. Je nach Grafik ist in den heruntergeladenen Dateien nicht selbsterklärend, dass eine Filterung angewendet wurde und es ist wichtig das Downloadergebnis bei der weiteren Verwendung in den richtigen Kontext zu setzen. Laden Sie sich alternativ die Daten ohne Filterung herunter und filtern Sie zum Beispiel bei Bedarf gesondert in MS Excel.
* '''Die Rollen der Sachbearbeitenden sehen nur die eigene Zuständigkeit:''' Je nach Rolle der Nutzenden werden unter Umständen nicht alle Daten auf den Dashboards dargestellt. Sachbearbeitende können nur Daten der eigenen Zuständigkeit sehen. Siehe dazu auch das nächste Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Rechte_und_Rollen Rechte und Rollen].
[[Datei:ImageAuswertungenHerunterladen.png|zentriert|mini|581x581px|Das vertikale Dreipunktemenü in den Diagrammen beinhaltet die Herunterladen-Funktion.]]

== Rechte und Rollen ==
Alle Rollen aus dem DiPlan Cockpit werden gemäß ihrer Berechtigungen mit einer entsprechenden Rolle in Superset versehen. Prinzipiell gibt es zwei relevante Rollen, denen die Nutzenden in Superset zugeordnet werden. Dies passiert automatisch und regelt ob die Nutzenden berechtigt sind Auswertungen selbst anzulegen, freizugeben und zu veröffentlichen oder ob sie ausschließlich die freigegebenen Auswertungen gemäß ihrer Zuständigkeit im DiPlan Cockpit sehen können. Nachfolgend sehen Sie eine Übersicht über die verschiedenen Berechtigungen:
{| class="wikitable"
|'''Rolle DiPlan Cockpit'''
|'''Rolle Superset'''
|'''Berechtigungen'''
|-
|'''EfA Cockpit Pro'''
* M-A = Mandanten-Administration
* FP-A = Fachplanung-Administration

'''EfA Cockpit Basis'''

* M-A-Basis = Mandanten-Administration-Basis
* FP-A-Basis = Fachplanung-Administration Basis
|'''Reporting-Administrator'''
|
* Kann direkt aus dem DiPlan Cockpit zu Superset abspringen und ist dort automatisch eingeloggt (SSO).
* Kann Datensätze (Superset-spezifische Zwischenschicht zwischen DB-Tabelle und Abfrage) erstellen.
* Kann Auswertungen/Diagramme in Superset erstellen.
* Kann Dashboards mit verschiedenen Auswertungen/Diagramme zusammenstellen.
* Kann Dashboards freigeben für den ganzen Mandanten (z.B. ganz Hamburg).
* Kann alle Daten im Dashboard eines Mandanten sehen.
* Kann Abfragen filtern, also z.B. in Hamburg nach Belieben nach Bezirk (Zuständigkeit) z.B. Altona oder Senat.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
* Kann andere Reporting-Administratoren für die eigenen Dashboards/Diagramme als Besitzer eintragen, um diese für die Bearbeitung, Freischaltung und Veröffentlichung zu berechtigen.
|-
|'''EfA Cockpit Pro'''
* FP-VM = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)

'''EfA Cockpit Basis'''

* FP-VM-Basis = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB-Basis = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)
|'''Sachbearbeiter'''
|
* Sieht ausschließlich die vorgefilterten Daten entsprechend der eigenen Zuständigkeit (also z.B. Altona).
* Kann Auswertungen herunterladen, aber nur mit den Daten der eigenen Zuständigkeit.
* Kann freigegebene Dashboards betrachten.
* Kann Auswertungen filtern, wenn Filter eingerichtet wurden.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
|}

== Superset als zentrales Tool für Reporting-Administratoren ==

=== Übergreifende Informationen zu Superset ===
Für die Erstellung und Darstellung des Reportings wurde das Open-Source-Tool Apache Superset in das DiPlan Cockpit implementiert. Superset ist eine Reporting- und Monitoring-Technologie, die es ermöglicht komplexe Daten auf Dashboards in leicht verständlichen Visualisierungen darzustellen. Die Erstellung der Dashboards erfolgt dabei direkt in der Superset-Anwendung. Dort wird auch gesteuert, welche Dashboards mit welchen Auswertungen im DiPlan Cockpit veröffentlicht werden sollen.

=== Absprung aus dem DiPlan Cockpit zu Superset ===
Sobald eine Rolle für die Erstellung von Auswertungen berechtigt ist (zum Beispiel M-A oder FP-A), findet sich im Reiter Auswertungen automatisch der Button '''"Auswertungen konfigurieren"'''. Bei Klick öffnet sich ein weiteres Browserfenster mit der Superset-Plattform. Eine gesonderte Anmeldung in Superset ist nicht erforderlich, da die Anmeldung durch das Cockpit erfolgt (auch Single Sign-On (SSO) genannt).

'''Bitte beachten:''' Nach 4 Stunden erfolgt aus Sicherheitsgründen ein automatischer Logout aus Superset - unabhängig davon ob Sie gerade in Superset arbeiten oder nicht aktiv waren. Sie erhalten keine Warnung vor dem Logout. Deshalb empfiehlt es sich, Änderungen regelmäßig zu speichern, um zu verhindern, dass ungesicherte Abfragen verloren gehen.
[[Datei:ImageButtonAuswertungenKonfigurieren.png|zentriert|mini|766x766px|Berechtigte Personen sehen über den Dashboards im DiPlan Cockpit einen Absprungbutton zu Superset mit der Bezeichnung "Auswertungen konfigurieren."]]
[[Datei:ImageStartbildschirmSuperset.png|zentriert|mini|777x777px|Startbildschirm in Superset mit einer Vorschau auf Dashboards und Diagrammen. Die Hauptmenüpunkte zur Navigation sind am oberen Bildschirmrand zu sehen.]]

=== Auswertungen erstellen, veröffentlichen und freigeben ===
Datenvisualisierungen von Abfragen werden in Superset als '''"Diagramme"''' bezeichnet. Sobald mindestens ein Diagramm erstellt ist, kann dieses auf einem Dashboard integriert werden und mit weiteren Filtermöglichkeiten versehen werden. Wie bereits erwähnt, können Sie als '''Reporting-Administrator''' selbst nach Belieben Diagramme erstellen. Nachfolgend wird beispielhaft die Erstellung und Freigabe des Dashboards mit dem Diagramm "Verfahrensstand aller Verfahren" beschrieben, um einige der Grundfunktionalitäten in Superset zu verdeutlichen (siehe dazu das Kapitel: "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]").

=== Datensätze erstellen ===
Um ein Diagramm zu erstellen wird zunächst ein Datensatz benötigt. Für einfache Abfragen reicht der '''Verfahrensdatensatz''' aus, der bereits standardmäßig enthalten ist. Dieser entspricht der '''Tabelle "Verfahren"''' mit den '''zugehörigen Datenfeldern (Stammdaten)'''.

Für Abfragen auf dem Verfahrensdatensatz können Sie direkt zum Abschnitt "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]" springen.

Für komplexere '''Abfragen über mehrere Tabellen hinweg, eigene Metriken oder eigene berechnete Spalten''' ist die Erstellung eines eigene Datensatzes mithilfe von SQL-Abfragen notwendig. Folgende Informationen sind in gesonderten Tabellen enthalten:

* Gebietseinheiten
* Kontakte
* Nutzer
* Parallelverfahren
* Termine
* Veränderungssperren
* Vertragsarten
* Vorgesehene Nutzungen
* Zurückstellungen

'''Bitte beachten:''' Bei der Erstellung von eigenen Datensätzen, muss die Spalte "'''''zustaendigkeit_code"''''' aus der Tabelle "'''''verfahren"'' immer enthalten sein,''' da hierüber die Ansicht für Sachbearbeiter standardmäßig gefiltert wird.

'''Um eigene Datensätze zu erstellen gehen Sie bitte wie folgt vor:'''

* Klick im Hauptmenü auf den '''Reiter "SQL"''' und im zugehörigen Dropdown-Menü auf '''"SQL Lab".'''
[[Datei:ImageStartSQLLab.png|zentriert|mini|854x854px|Startansicht SQL Lab]]
* Erstellen Sie Ihre '''SQL-Abfrage''' und klicken Sie auf den '''Button "Ausführen"''', um eine Vorschau auf die Ergebnisse der Abfrage zu erhalten. Ein rotes Kreuzchen links vom SQL-Editor weist auf Fehler im SQL hin.
[[Datei:ImageAusfuehrenSQLLab.png|zentriert|mini|846x846px|Ausführen einer SQL Abfrage im SQL Lab]]
'''Typische Anwendungsfälle und die dazugehörigen SQL Abfragen könnten z.B. sein:'''

* Sie möchten, dass Ihre Abfragen z.B. nach "Gebietseinheiten" und "Vorgesehenen Nutzungen" gefiltert werden können:

{| class="wikitable"
|
SELECT v.*, g.gebietseinheit, vn.vorgesehene_nutzungen
FROM verfahren v
LEFT JOIN gebietseinheiten g ON g.verfahren_id = v.id
LEFT JOIN vorgesehene_nutzungen vn ON vn.verfahren_id = v.id;
|}

* Sie möchten, dass Ihr Datensatz bestimmte Termine enthält (z.B. Grobabstimmungsdatum, Vorweggenehmigungsreife):

{| class="wikitable"
|
WITH grobabstimmung_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Grobabstimmung'
),
vorweggenehmigungsreife_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Vorweggenehmigungsreife'
)
SELECT
v.*,
t1.beginn AS grobabstimmung,
t2.beginn AS vorweggenehmigungsreife
FROM verfahren v
LEFT JOIN grobabstimmung_termin t1 ON t1.verfahren_id = v.id
LEFT JOIN vorweggenehmigungsreife_termin t2 ON t2.verfahren_id = v.id;
|}

* '''Speichern Sie Ihre Abfrage als Datensatz''' ab, indem Sie auf den '''Dropdown-Pfeil neben dem Button "Speichern"''' klicken und dann '''"Datensatz speichern"''' auswählen. Es öffnet sich ein Dialogfeld, in dem Sie einen Namen für Ihren Datensatz vergeben können.
** Hinweis: Wenn Sie statt auf "Datensatz speichern" auf "Speichern" klicken, finden Sie Ihre SQL Abfrage unter dem Reiter '''"Gespeicherte Abfragen"''' wieder.
[[Datei:ImageSpeichernDatensatzSuperset.png|zentriert|mini|891x891px|Speichern eines neuen Datensatzes]]
Nach der Erstellung eines Datensatzes können Sie diesen noch weiter bearbeiten und Labels, eigene Metriken oder berechnete Spalten hinzufügen. Gehen Sie dazu wie folgt vor:
* Klick im Hauptmenü auf den '''Reiter "Datensätze"'''. Hier sind die verfügbaren Datensätze aufgelistet.
* Klicken Sie ganz rechts neben dem Datensatz, den Sie bearbeiten wollen, auf das '''Stift-Symbol.''' Es öffnet sich eine Bearbeitungsmaske.
[[Datei:ImageBearbeitungDatensatzSuperset.png|zentriert|mini|890x890px|Öffnen Sie den Bearbeitungsmodus durch Klick auf das Stiftsymbol]]
*'''Reiter "Quelle":''' Hier kann die zugrundeliegende SQL Abfrage nachträglich angepasst werden. Klicken Sie hierfür auf das Schloss-Symbol.
[[Datei:ImageReiterQuelleSuperset.png|zentriert|mini|879x879px|Im Reiter "Quelle" kann das SQL nachträglich angepasst werden]]
*'''Reiter "Metriken":''' Hier können eigene Metriken angelegt werden.
[[Datei:ImageReiterMetrikenSuperset.png|zentriert|mini|878x878px|Eine neue Metrik "Anzahl Verfahren" wird hinzugefügt]]
*'''Reiter "Spalten":''' Hier sind alle im Datensatz enthaltenen Spalten aufgeführt. An den Werten in der Tabelle ("Datentyp", "Ist zeitlich" etc.) sollte in der Regel nichts geändert werden, dies wird von Superset automatisch richtig erkannt. Beim '''Klick auf das "Plus"''' neben jeder Spalte kann unter "Beschriftung" ein sprechendes Label hinzugefügt werden. Dieses wird später in den Diagrammen angezeigt.
[[Datei:ImageReiterSpaltenSuperset.png|zentriert|mini|877x877px|Im Reiter "Spalten" wird ein Label hinzugefügt]]
*'''Reiter "Berechnete Spalten":''' Hier können dem Datensatz weitere Spalten hinzugefügt werden, die Werte enthalten, die aus anderen Spalten errechnet werden. Verwenden Sie für die Berechnung SQL-Syntax.
[[Datei:ImageReiterBerechneteSpaltenSuperset.png|zentriert|mini|851x851px|Eine berechnete Spalte wird hinzugefügt]]
* Speichern Sie Ihre Änderungen am Datensatz durch das '''Klicken auf den "Speichern"-Button'''. Um die Änderungen zu prüfen, empfiehlt es sich ein Diagramm mit dem Datensatz anzulegen (z.B. eine Tabelle).

=== Beispiel-Diagramm erstellen ===
Nachfolgend soll beispielhaft ein Diagramm "Verfahrensstand aller Verfahren" erstellt werden. Dazu gehen Sie wie folgt vor:

# Klick auf den '''Menüpunkt "Diagramme":''' Auf dieser Seite findet sich eine Liste mit allen bereits erstellten Diagrammen. Innerhalb dieser Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Diagramm-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageUebersichtDiagrammeSuperset.png|zentriert|mini|860x860px|Im Menüpunkt "Diagramme" findet sich eine Übersicht über die bisher erstellten Diagramme (Abfragen) mit vielen Zusatzinformationen.]]
# Um ein neues Diagramm zu erstellen klicken Sie auf den '''Button "+Diagramm"''' rechts oben. Es öffnet sich der Dialog '''"Neues Diagramm erstellen".'''[[Datei:ImageNeuesDiagrammSuperset.png|zentriert|mini|860x860px|Dialog um ein neues Diagramm zu erstellen]]
# Zunächst muss der '''passende Datensatz für die Auswertung ausgewählt''' werden. Für dieses Beispiel wählen wir unter '''"1- Datensatz auswählen"''' den Datensatz '''"verfahren"''' im Dropdownmenü aus.
# Im nächsten Schritt wird der '''passende Diagrammtyp ausgewählt'''. Hier werden Ihnen viele verschiedene Visualisierungsmöglichkeiten geboten. Im genannten Beispiel passt ein "Kreisdiagramm" am besten zu der Visualisierung der Verfahrensstände aller Verfahren. Sie finden das Kreisdiagramm unter dem Hauptmenü "Teil des Ganzen". Klicken Sie '''auf das Kreisdiagramm''' und anschließend auf '''"Neues Diagramm erstellen"'''.
# Nun geht es um die '''Detailkonfiguration''' des Diagramms. Grundsätzlich ist der Arbeitsbereich wie folgt aufgebaut:
#* Die linke Spalte enthält einen '''Überblick''' über die '''zur Verfügung stehenden Daten'''.
#* Die mittlere Spalte enthält die '''Werkzeuge''', um das '''Diagramm zu konfigurieren.'''
#* Im rechten Bereich kann man sich jeweils eine '''Vorschau des Diagramms''' anzeigen lassen.
'''Wir gehen für unser Beispiel wie folgt vor:'''

* Im Feld '''"Name des Diagramms hinzufügen"''' das Diagramm mit einer passenden Bezeichnung versehen.
* Um die Dimensionen des Diagramms festzulegen im Tab '''"Daten"''' unter der Überschrift '''"Abfrage > Dimensionen"''' die Spalte '''"verfahrensstand"''' von links per Drag & Drop herüberziehen.
* Der dazustellende Wert soll hier die Anzahl sein, weshalb nun unter '''"Metrik"''' das Feld '''"Anzahl"''' Button "+Diagramm" per Drag & Drop von links herübergezogen wird. Je nach Fragestellung bzw. welche Daten auf dem Diagramm dargestellt werden sollen, können verschiedenste Kombinationen in der selben Art und Weise über Drag & Drop zusammengestellt werden.
* Unter dem '''Punkt "Filter"''' kann eine Vorabfilterung eingebaut werden, also beispielsweise könnten Sie simulierte Verfahren standardmäßig herausfiltern, so dass die Nutzenden diese gar nicht auswerten können. Anmerkung: "imported_at" kann nicht gelöscht werden. Dieser Wert wird von Superset standardmäßig gesetzt und hat keine Auswirkung auf Ihre Auswertungen.
* Das für die Berechnung zugrundeliegende Zeilenlimit kann bei Bedarf verändert werden.
* Ein Klick auf den '''blauen Button "Diagramm erstellen"''' zeigt eine '''Vorschau''' des erstellten Diagrammes auf der rechten Bildschirmhälfte. Das Diagramm kann nun jederzeit mit einem '''Klick auf "Speichern"''' rechts oben gesichert werden.[[Datei:ImageDiagrammErstellenSuperset.png|zentriert|mini|880x880px|Dialog zur Detaildefinition des neuen Diagramms. Hier beispielhaft zusammengestellt für die Darstellung "Verfahrenstand aller Verfahren".]]

* Unter dem '''Tab "Anpassen"''' finden sich zahlreiche Möglichkeiten, das Diagramm weiter zu verfeinern (zum Beispiel in Farbe und Layout). Hier kann ganz nach Belieben ausprobiert werden. Mit '''Klick auf''' '''"Diagramm aktualisieren"''' kann die Vorschau des Diagramms zur Überprüfung mit den neu gewählten Einstellungen geladen werden.[[Datei:ImageDiagrammAnpassenSuperset.png|zentriert|mini|900x900px|Diagramm kann nach Belieben im Tab "Anpassen" verändert und verfeinert werden.]]
* '''Speichern nicht vergessen:''' Das Diagramm wird erst gespeichert durch '''Klick auf "Speichern" rechts oben'''. Es öffnet sich ein Dialog zu weiteren Speicheroptionen, der mit '''einer weiteren Speicherbestätigung''' abgeschlossen werden kann.[[Datei:ImageDiagrammSpeichernSuperset.png|zentriert|mini|874x874px|Speichern-Dialog für das erstellte Diagramm]]

=== Beispiel-Dashboard erstellen ===

# '''Klick auf den Menüpunkt "Dashboards":''' Unter der Überschrift "Dashboards" findet sich eine Liste mit allen bereits erstellten Dashboards. Diese Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Dashboard-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageDashboardsSuperset.png|zentriert|mini|866x866px|Unter dem Menüpunkt "Dashboards" finden sich alle bereits angelegten Dashboards, sowie die Möglichkeit neue Dashboards zu erstellen.]]
# Mit Klick auf den Button '''"+Dashboard"''' rechts oben öffnet sich ein neuer, leerer Dashboard -Entwurf.
# Der Titel des Dashboards ist standardmäßig als "untitled dashboard" angeben und kann durch '''Klick auf den Namen''' geändert werden.
# Auf der Seitenleiste am rechten Bildschirmrand finden sich alle bereits erstellten Diagramme. Das gewünschte Diagramm kann einfach durch '''Drag & Drop mit der Maus auf das Dashboard gezogen''' werden. Auch die Größe kann leicht geändert werden indem sie die Ränder oder Ecken des Diagramms klicken, gedrückt halten und auf die gewünschte Größe ziehen. Sie können ein oder auch mehrere Diagramme auf einem Dashboard platzieren.
# Zu guter Letzt oben rechts auf den '''Button "Speichern"''' klicken um Ihre Arbeit zu sichern. Nach dem Speichern können Sie jederzeit am Dashboard weiter arbeiten indem Sie auf den nun erscheinenden Button '''"Dashboard bearbeiten"''' klicken.
# Sollten Sie ein Diagramm wieder vom Dashboard löschen wollen, können Sie einfach das '''Mülleimer-Symbol''' klicken, welches bei Mouseover über das jeweilige Diagramm erscheint.[[Datei:ImageDragDropDiagrammSuperset.png|zentriert|mini|804x804px|Das gewünschte Diagramm kann mit der Maus einfach auf das Dashboard gezogen und platziert werden.]]
[[Datei:ImageDiagrammGroesseSuperset.png|zentriert|mini|761x761px|Die Größe des Diagramms lässt sich einfach durch Ziehen der Maus an Ecken oder Rändern verändern.]]

=== Einen oder mehrere Filter zu einem Dashboard zufügen ===
Es ist möglich Ihre Auswertungsdiagramme mit Filtermöglichkeiten zu versehen. Im folgenden wird beispielhaft ein Filter nach der Zuständigkeit auf dem Dashboard "Verfahrensstand aller Verfahren" hinzugefügt:

# Öffnen Sie das Dashboard oder legen Sie sich ein entsprechendes neues Dashboard an und speichern dieses.
# An der linken Bildschirmkante den '''kleinen Pfeil klicken''', um das Filtermenü auszuklappen. '''Wichtig:''' Der Pfeil ist nur sichtbar, wenn das Dashboard bereits gespeichert ist und sich nicht gerade im offenen Bearbeitungsmodus befindet. Sprich: Klicken Sie '''nicht''' "Dashboard bearbeiten" bevor Sie den Filter hinzufügen.
# Klicken Sie auf das '''kleine Zahnrad''' um das Untermenü zu öffnen.
# Ein Klick auf '''"Hinzufügen und Bearbeiten von Filtern"''' öffnet das Menü um die Filter zu konfigurieren.[[Datei:ImageDashboardFilterMenueSuperset.png|zentriert|mini|800x800px|Durch Klick auf den kleinen Pfeil öffnet sich das Menü, mit dem Filter hinzugefügt und konfiguriert werden können.]]
# Um nach der Zuständigkeit zu filtern muss im '''Menü Filtertyp die Option "Wert"''' ausgewählt sein.
# Im Menüpunkt Tabellenname '''"Zuständigkeit"''' als '''Namen des Filters''' eintragen.
# Im '''Feld Datensatz''' wird in diesem Fall '''"verfahren"''' ausgewählt.
# Im '''Feld "Spalte"''' den Filter auswählen, nach dem gefiltert werden soll: in diesem Fall '''"zustaendigkeit".'''
# Das Menü '''"Filterwerte sortieren"''' durch einen Haken aktivieren und absteigend sortieren und mit der '''Sortiermetrik "Anzahl"''' versehen.
# Im '''Reiter "Auswahlverfahren"''' kann der Filter durch eine Auswahl außerdem auf '''einzelne Diagramme oder auf alles bezogen''' werden.
# Durch '''Klick auf "Speichern"''' rechts unten wird der Filter in das Dashboard integriert.[[Datei:ImageFilteroptionenDashboardSuperset.png|zentriert|mini|712x712px|Sie können einen oder mehrere Filteroptionen auf einem Dashboard integrieren und in diesem Menü konfigurieren.]]
'''Übergeordnete Filtereinstellungen:'''

Nach '''Klick auf das Zahnrad''', im geöffneten Filter-Untermenü, können Sie außerdem entscheiden, ob der Filter '''oben''' über dem Diagramm '''oder seitlich links einklappbar''' angezeigt werden soll.

Es gibt dort außerdem die Möglichkeit für ein oder mehrere Diagramme eine '''Kreuzfilterung zu aktivieren.''' Diese erlaubt es Ihnen, direkt '''in einem Diagramm auf ein Element zu klicken''', um damit automatisch eines oder alle Diagramme im Dashboard zu filtern. So können Daten intuitiv und interaktiv erkundet werden, ohne separate Filtersteuerungen zu verwenden.
[[Datei:ImageFilterUntermenueSuperset.png|zentriert|mini|767x767px|Im Filter-Untermenü können bestehende Filter bearbeitet oder weitere Filter hinzugefügt werden. Außerdem kann die Kreuzfilterung aktiviert und die Darstellung der Filterleiste verändert werden.]]

=== Dashboards veröffentlichen ===
Dashboards werden erst im DiPlan Cockpit sichtbar, nachdem diese veröffentlicht und für die Sachbearbeitenden und Reporting-Administratoren freigeschalten wurden. Dabei gilt es zu beachten, dass Sie nur Dashboards veröffentlichen und freischalten können, die Sie selbst erstellt haben oder für die Sie berechtigt worden sind. Siehe hierzu auch das Kapitel "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Diagramme_und_Dashboards_f.C3.BCr_andere_Reporting-Administratoren_zur_Bearbeitung_freigeben Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben]".

'''Zur Veröffentlichung und Freischaltung gehen Sie wie folgt vor:'''

# Öffnen Sie das Dashboard, welches veröffentlicht werden soll.
# Durch Klick auf das '''graue Feld "Entwurf"''' neben dem Dashboard Namen, ändert sich die Bezeichnung auf '''"Veröffentlicht".'''[[Datei:ImageStatusVeroeffentlichtSuperset.png|zentriert|mini|911x911px|Durch Klick ändert sich der Status von "Entwurf" auf "Veröffentlicht".]]
# Öffnen Sie rechts oben das '''Dreipunktemenü''' und wählen Sie dort den Unterpunkt '''"Dashboard einbetten"''' aus.[[Datei:ImageDashboardEinbettenSuperset.png|zentriert|mini|942x942px|Im Dreipunktemenü muss im nächsten Schritt der Punkt "Dashboard einbetten" geklickt werden.]]
# Im Einbetten-Dialog lassen Sie das Feld für "Zulässige Domänen" bitte einfach frei und klicken lediglich den '''Button "Einbettung aktivieren".''' Dann kann das Menü durch Klick auf das '''X-Symbol''' geschlossen werden.[[Datei:ImageEinbettungAktivierenSuperset.png|zentriert|mini|869x869px|Im Menü "Einbetten" klicken Sie auf "Einbettung aktivieren" und dann einfach auf das X um das Fenster zu schließen.]]
# Um das Dashboard nun für die '''Rolle der Sachbearbeitenden und Mandanten-Administratoren''' im DiPlan Cockpit '''freizugeben''' öffnen Sie bitte erneut den Reiter '''"Dashboards",''' um auf die Liste mit allen Dashboards zu gelangen.
# Klicken Sie auf das '''Stift-Symbol''' neben dem Dashboard, welches freigeschalten werden soll.[[Datei:ImageDashboardEigenschaftenOeffnenSuperset.png|zentriert|mini|843x843px|Durch Klick auf das Stiftsymbol neben dem Dashboard werden die Dashboardeigenschaften geöffnet. Dort können auch die einzelnen Rollen freigeschaltet werden.]]
# In den '''Dashboardeigenschaften''' können nun die Rollen eingetragen werden, für die das Dashboard freigeschalten werden soll. Die Rollenbezeichnungen in Superset fassen mehrere Rollen aus dem DiPlan Cockpit zusammen, was die Freigabe von Dashboards vereinfacht. Bitte tragen Sie im Feld "Rollen" deshalb '''"Reporting-Administrator"''' und '''"Sachbearbeiter" in der Liste ein.''' Dies ist durch Tippen in das Feld möglich, so wird die auszuwählende Rolle schneller sichtbar. Sie können jedoch auch manuell durch die Liste scrollen und die Rolle auswählen. Klicken Sie anschließend den '''"Speichern"-Button'''. Die Auswertungen sind nun im DiPlan Cockpit für alle berechtigten Rollen sichtbar.[[Datei:ImageDashboardEigenschaftenRollenSuperset.png|zentriert|mini|695x695px|In den Dashboardeigenschaften müssen die Rollen, für die das Dashboard freigegeben werden soll, ausgewählt werden.]]
'''Hinweis: Veröffentlichung zurücknehmen'''

Sollten Sie ein Dashboard im DiPlan Cockpit unsichtbar machen wollen, so klicken Sie wie im Punkt 2 beschrieben wieder auf die graue Schaltfläche und setzen Sie den Status von '''"Veröffentlicht"''' zurück auf '''"Entwurf".'''

=== Bestehendes Dashboard oder Diagramm bearbeiten oder löschen ===
'''Wie lösche ich ein eingebettetes Diagramm von einem bereits veröffentlichten und freigegebenen Dashboard?'''

* Öffnen Sie das Dashboard und '''klicken Sie "Dashboard bearbeiten"''' auf der rechten Bildschirmseite.
* Im geöffneten Bearbeitungsmodus können Sie nun die Maus über das nicht mehr erwünschte Diagramm bewegen und durch '''Klick auf das erscheinende Mülleimersymbol''' löschen. Das Diagramm bleibt in der Liste der Diagramme weiterhin erhalten und wird lediglich vom Dashboard genommen.
* Sie können ein '''weiteres/neues Diagramm''' jederzeit wieder aus der Liste rechts auf das Dashboard ziehen.
* Bestätigen Sie das veränderte Dashboard durch Klick auf den "'''Speichern"-Button''' rechts oben.
* '''Bitte beachten:''' Änderungen an bereits veröffentlichten und freigegebenen Dashboards werden nach dem '''Speichern direkt auf dem DiPlan Cockpit sichtbar'''.
[[Datei:ImageDashboardDiagrammLoeschenSuperset.png|zentriert|mini|736x736px|Per Mouseover und Klick auf das Mülleimer Symbol lassen sich Diagramme auf Dashboards einfach wieder löschen.]]
'''Wie bearbeite ich ein bestehendes Diagramm?'''

Ein Diagramm unabhängig vom Dashboard ändern:

* Öffnen Sie das zu bearbeitende Diagramm in der '''Liste der Diagramme''' durch einen '''Klick auf den Namen'''.
* Das Diagramm öffnet sich direkt im Bearbeitungsmodus und kann nach '''Belieben angepasst werden'''.
* Ist das Diagramm bereits auf einem veröffentlichten und freigegebenen Dashboard eingebettet, so werden alle Änderungen nach dem Speichern direkt übernommen und im '''DiPlan Cockpit sichtbar'''.

Ein Diagramm direkt auf einem Dashboard ändern:

* Öffnen Sie das Dashboard und klicken Sie '''"Dashboard bearbeiten"'''.
* Bewegen Sie die Maus über die entsprechende Grafik, öffnen Sie das Dreipunktemenü rechts und klicken '''"Diagramm bearbeiten".'''
* Nachdem Sie das Diagramm bearbeitet haben klicken Sie '''"Speichern"'''.

'''Bitte beachten:''' Im Speichern-Dialog können Sie entscheiden, ob sie das bestehende '''Diagramm überschreiben''' oder ein '''neues Diagramm speichern''' wollen. Dies kann hilfreich sein, wenn Sie das Diagramm nicht generell, sondern nur auf einem bereits bestehenden Dashboard ändern wollen.
[[Datei:ImageDiagrammSpeichernÜberschreibenSuperset.png|zentriert|mini|792x792px|Es ist möglich direkt beim Speichern ein neues Diagramm zu erstellen oder das bereits bestehende zu überschreiben.]]

'''Wie lösche ich ein Dashboard oder Diagramm dauerhaft?'''

Sie können ein Dashboard unabhängig vom Status (also veröffentlicht oder auch als Entwurf) in der Liste der Dashboards wie folgt löschen:

* Bewegen Sie die Maus über den entsprechenden '''Listeneintrag.'''
* Klicken Sie das in der Zeile rechts erscheinende '''Papierkorb-Symbol''' und folgen den Anweisungen im erscheinenden Löschdialog.
* Die Originaldiagramme auf dem Dashboard bleiben dabei weiterhin in der Liste "Diagramme" erhalten.
* Sollten Sie ein Diagramm dauerhaft löschen wollen, so gehen Sie genauso wie beim Dashboard vor, jedoch im '''Reiter "Diagramme"'''.

=== Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Bitte beachten:''' Solange Reporting-Administratoren nicht als Besitzer eingetragen sind, haben diese nur Zugriff auf die eigenen erstellten Daten.

'''Das bedeutet konkret für die erstellten Daten von anderen Reporting-Administratoren:'''

* Unveröffentlichte Dashboards sind nicht sichtbar.
* Veröffentlichte Dashboards sind sichtbar, aber nicht bearbeitbar.
* Alle Diagramme sind sichtbar, Änderungen können jedoch nur als neue Diagramme gespeichert werden.
* Datensätze sind sichtbar und können verwendet, aber nicht bearbeitet werden.
* Gespeicherte Abfragen sind nicht sichtbar (Berechtigungen können hier grundsätzlich nicht vergeben werden).

Sie haben grundsätzlich keine Rechte ein Dashboard zu bearbeiten oder ein Diagramm zu überschreiben, welches nicht von Ihnen erstellt wurde, außer Sie wurden als '''"Besitzende/r"''' dazu ermächtigt.

Das bedeutet beispielsweise, dass Sie ein Diagramm, welches jemand anders erstellt hat, zwar bearbeiten, dies aber nur als neues Diagramm abspeichern können. Das Originaldiagramm wird hier nicht verändert. Um jemanden für die '''Mitarbeit an Ihrem Diagramm oder Dashboard zu ermächtigen''' gehen Sie wie folgt vor:

* Klicken Sie in der Liste der Diagramme oder Dashboards auf das '''Stift-Symbol "Bearbeiten".''' Der Dialog '''"Diagrammeigenschaften bearbeiten"''' öffnet sich.
* Unter der '''Überschrift "Zugang"''' können weitere '''"Besitzende" eingetragen''' werden. Klicken Sie hierzu in das Eingabefeld und fangen Sie an den Namen zu tippen oder scrollen Sie durch die Liste bis zum gewünschten Namen.
* '''Wählen Sie einen oder mehrere Namen aus,''' um diese in das Feld zu übernehmen und klicken Sie dann auf '''"Speichern"'''. Die eingetragene Person hat nun die gleichen '''Rechte zur Bearbeitung wie der/die ursprüngliche Ersteller/in'''.[[Datei:ImageDiagrammZugangBesitzendeSuperset.png|zentriert|mini|677x677px|Unter "Zugang" können Sie andere Mandanten-Administratoren für die Bearbeitung Ihrer Dashboards oder Diagramme berechtigen.]]

=== Datensätze für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Um Datensätze für andere Reporting-Administratoren zur Bearbeitung freizugeben, gehen Sie wie folgt vor:'''

* Klick auf den '''Reiter "Datensätze"'''
* In der Übersicht-Liste klicken Sie bitte das '''Stift- Symbol''' neben dem gewünschten Datensatz.
* Klicken Sie den '''Reiter "Einstellungen"''' ganz rechts und scrollen Sie ganz nach unten.
* Dort können Sie im '''Feld "Besitzende"''' auch andere Reporting-Administratoren zur Bearbeitung berechtigen.
[[Datei:ImageDatensatzBesitzendeSuperset.png|zentriert|mini|810x810px|Auch Datensätze können zur Bearbeitung an andere Mandanten-Administratoren freigegeben werden.]]

== Weiterführende Informationen ==
Unter folgendem Link können Sie weitere Informationen zu Superset in englischer Sprache finden. Bitte beachten Sie, dass Ihre Datenbank bereits angebunden ist und der Punkt "Connecting to a new database" in der Dokumentation somit nicht beachtet werden sollte: '''[https://superset.apache.org/docs/6.0.0/using-superset/creating-your-first-dashboard#creating-your-first-dashboard Englische Dokumentation des Open-Source-Tools Superset]'''

Reporting: Auswertungen im DiPlan Cockpit

2026-03-18T10:56:40Z

Diplanung:

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

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

⚠️ '''Bitte beachten: Die Reporting-Funktionalität wird nach und nach Mandanten spezifisch freigeschaltet. Informationen zur Funktionsweise finden Sie hier vorab.'''

== Einleitung ==
Die Auswertungskomponente für das DiPlan Cockpit ermöglicht das Abrufen, Filtern und Downloaden von Reports und Auswertungen aus Planungs- und Genehmigungsverfahren. Die Auswertungsdiagramme zu individuellen Fragestellungen werden in dem externen BI-Tool Superset von berechtigten Personen auf Basis grundlegender SQL- und Datenmodell-Kenntnisse erstellt, verwaltet, auf Dashboards zusammengestellt und schließlich für die Darstellung im DiPlan Cockpit freigegeben.

== Aufruf der Auswertungen ==
Die Auswertungen sind in dem gleichnamigen Reiter im DiPlan Cockpit zu finden.

In der linken Bildschirmhälfte sind die Namen der jeweiligen zur Verfügung stehenden Dashboards zu finden. Ein Dashboard ist eine Zusammenstellung von einem oder mehreren Auswertungsdiagrammen auf einer Seite. Standardmäßig wird das Dashboard "Verfahrensstand aller Verfahren" für jeden Mandant initial mit ausgerollt. Alle weiteren Dashboards können je nach Bedarf individuell durch berechtigte Personen je Mandant erstellt werden. Mehr dazu findet sich im Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Auswertungen_erstellen.2C_ver.C3.B6ffentlichen_und_freigeben Auswertungen erstellen, veröffentlichen und freigeben].

'''Gut zu wissen:'''

* '''Datengrundlage:''' Grundsätzlich fließen gelöschte Verfahren nicht in die Auswertungen ein.
* '''Aktualität der Daten:''' Die Daten werden jede Nacht einmal mit der DiPlan Cockpit Datenbank synchronisiert.
* '''Darstellung:''' Das Reporting wird mit dem Tool Superset umgesetzt, welches in das DiPlan Cockpit eingebunden wird. Für eine optimale Darstellung nutzen Sie bitte den Browser Microsoft Edge.
[[Datei:ImageAuswertungenCockpit.png|zentriert|mini|717x717px|Ansicht des Reiters "Auswertungen" im DiPlan Cockpit mit dem Standarddashboard "Verfahrensstand aller Verfahren".]]

== Filtern der Dashboards bzw. Auswertungen ==
Je nach Art der dargestellten Auswertungen können Sie weitere Aktionen in den einzelnen Diagrammen vornehmen. Oftmals sind zum Beispiel verschiedene Filterungsmöglichkeiten hinterlegt. Zum Öffnen der Filter gehen Sie bitte folgendermaßen vor:

* Aufklappen der Filter durch Klick auf den kleinen blauen Pfeil links neben den Diagrammen. Alternativ können die Filter auch am oberen Rand des Dashboards eingebunden sein.
* Auswählen der gewünschten Filter.
* Klick auf "Filter anwenden".
* Bei Klick auf "Alles löschen" werden sämtliche gesetzte Filter wieder zurückgesetzt.
[[Datei:ImageAuswertungenCockpitFilter.png|zentriert|mini|742x742px|Falls eine Filterung im Dashboard integriert wurde, so lässt diese sich über den kleinen Pfeil ausklappen oder befindet sich am oberen Rand des Dashboards. Hier zu sehen eine Filterung auf dem Dashboard nach Zuständigkeit oder Verfahrenstyp.]]
[[Datei:ImageAuswertungenCockpitFilter2.png|zentriert|mini|742x742px|Das Reporting bietet die Möglichkeit auch mehrere verschiedene Diagrammtypen auf einem Dashboard darzustellen. Diese können von Mandanten-Administratoren konfiguriert und freigegeben werden. Hier ein Beispiel mit integrierten Filtern am oberen Rand des Dashboards.]]

== Download der Auswertungen ==
Neben jeder Auswertungsgrafik (jedem Diagramm) finden sich drei Punkte, welche bei Klick ein Drop-Down Menü öffnen. Durch '''Mouseover auf "Herunterladen"''' öffnet sich das Menü zum Download des Diagramms in verschiedenen auswählbaren Formaten. Hier sind folgende Punkte zu beachten:

* '''Der Download entspricht immer der Filterung:''' Wird eine Grafik durch eine Filterung angepasst und dann ein Download gestartet, so entsprechen die heruntergeladenen Daten immer genau der Filterung, das heißt es sind nicht alle Daten vorhanden. Je nach Grafik ist in den heruntergeladenen Dateien nicht selbsterklärend, dass eine Filterung angewendet wurde und es ist wichtig das Downloadergebnis bei der weiteren Verwendung in den richtigen Kontext zu setzen. Laden Sie sich alternativ die Daten ohne Filterung herunter und filtern Sie zum Beispiel bei Bedarf gesondert in MS Excel.
* '''Die Rollen der Sachbearbeitenden sehen nur die eigene Zuständigkeit:''' Je nach Rolle der Nutzenden werden unter Umständen nicht alle Daten auf den Dashboards dargestellt. Sachbearbeitende können nur Daten der eigenen Zuständigkeit sehen. Siehe dazu auch das nächste Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Rechte_und_Rollen Rechte und Rollen].
[[Datei:ImageAuswertungenHerunterladen.png|zentriert|mini|581x581px|Das vertikale Dreipunktemenü in den Diagrammen beinhaltet die Herunterladen-Funktion.]]

== Rechte und Rollen ==
Alle Rollen aus dem DiPlan Cockpit werden gemäß ihrer Berechtigungen mit einer entsprechenden Rolle in Superset versehen. Prinzipiell gibt es zwei relevante Rollen, denen die Nutzenden in Superset zugeordnet werden. Dies passiert automatisch und regelt ob die Nutzenden berechtigt sind Auswertungen selbst anzulegen, freizugeben und zu veröffentlichen oder ob sie ausschließlich die freigegebenen Auswertungen gemäß ihrer Zuständigkeit im DiPlan Cockpit sehen können. Nachfolgend sehen Sie eine Übersicht über die verschiedenen Berechtigungen:
{| class="wikitable"
|'''Rolle DiPlan Cockpit'''
|'''Rolle Superset'''
|'''Berechtigungen'''
|-
|'''EfA Cockpit Pro'''
* M-A = Mandanten-Administration
* FP-A = Fachplanung-Administration

'''EfA Cockpit Basis'''

* M-A-Basis = Mandanten-Administration-Basis
* FP-A-Basis = Fachplanung-Administration Basis
|'''Reporting-Administrator'''
|
* Kann direkt aus dem DiPlan Cockpit zu Superset abspringen und ist dort automatisch eingeloggt (SSO).
* Kann Datensätze (Superset-spezifische Zwischenschicht zwischen DB-Tabelle und Abfrage) erstellen.
* Kann Auswertungen/Diagramme in Superset erstellen.
* Kann Dashboards mit verschiedenen Auswertungen/Diagramme zusammenstellen.
* Kann Dashboards freigeben für den ganzen Mandanten (z.B. ganz Hamburg).
* Kann alle Daten im Dashboard eines Mandanten sehen.
* Kann Abfragen filtern, also z.B. in Hamburg nach Belieben nach Bezirk (Zuständigkeit) z.B. Altona oder Senat.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
* Kann andere Reporting-Administratoren für die eigenen Dashboards/Diagramme als Besitzer eintragen, um diese für die Bearbeitung, Freischaltung und Veröffentlichung zu berechtigen.
|-
|'''EfA Cockpit Pro'''
* FP-VM = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)

'''EfA Cockpit Basis'''

* FP-VM-Basis = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB-Basis = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)
|'''Sachbearbeiter'''
|
* Sieht ausschließlich die vorgefilterten Daten entsprechend der eigenen Zuständigkeit (also z.B. Altona).
* Kann Auswertungen herunterladen, aber nur mit den Daten der eigenen Zuständigkeit.
* Kann freigegebene Dashboards betrachten.
* Kann Auswertungen filtern, wenn Filter eingerichtet wurden.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
|}

== Superset als zentrales Tool für Reporting-Administratoren ==

=== Übergreifende Informationen zu Superset ===
Für die Erstellung und Darstellung des Reportings wurde das Open-Source-Tool Apache Superset in das DiPlan Cockpit implementiert. Superset ist eine Reporting- und Monitoring-Technologie, die es ermöglicht komplexe Daten auf Dashboards in leicht verständlichen Visualisierungen darzustellen. Die Erstellung der Dashboards erfolgt dabei direkt in der Superset-Anwendung. Dort wird auch gesteuert, welche Dashboards mit welchen Auswertungen im DiPlan Cockpit veröffentlicht werden sollen.

=== Absprung aus dem DiPlan Cockpit zu Superset ===
Sobald eine Rolle für die Erstellung von Auswertungen berechtigt ist (zum Beispiel M-A oder FP-A), findet sich im Reiter Auswertungen automatisch der Button '''"Auswertungen konfigurieren"'''. Bei Klick öffnet sich ein weiteres Browserfenster mit der Superset-Plattform. Eine gesonderte Anmeldung in Superset ist nicht erforderlich, da die Anmeldung durch das Cockpit erfolgt (auch Single Sign-On (SSO) genannt).

'''Bitte beachten:''' Nach 4 Stunden erfolgt aus Sicherheitsgründen ein automatischer Logout aus Superset - unabhängig davon ob Sie gerade in Superset arbeiten oder nicht aktiv waren. Sie erhalten keine Warnung vor dem Logout. Deshalb empfiehlt es sich, Änderungen regelmäßig zu speichern, um zu verhindern, dass ungesicherte Abfragen verloren gehen.
[[Datei:ImageButtonAuswertungenKonfigurieren.png|zentriert|mini|766x766px|Berechtigte Personen sehen über den Dashboards im DiPlan Cockpit einen Absprungbutton zu Superset mit der Bezeichnung "Auswertungen konfigurieren."]]
[[Datei:ImageStartbildschirmSuperset.png|zentriert|mini|777x777px|Startbildschirm in Superset mit einer Vorschau auf Dashboards und Diagrammen. Die Hauptmenüpunkte zur Navigation sind am oberen Bildschirmrand zu sehen.]]

=== Auswertungen erstellen, veröffentlichen und freigeben ===
Datenvisualisierungen von Abfragen werden in Superset als '''"Diagramme"''' bezeichnet. Sobald mindestens ein Diagramm erstellt ist, kann dieses auf einem Dashboard integriert werden und mit weiteren Filtermöglichkeiten versehen werden. Wie bereits erwähnt, können Sie als '''Reporting-Administrator''' selbst nach Belieben Diagramme erstellen. Nachfolgend wird beispielhaft die Erstellung und Freigabe des Dashboards mit dem Diagramm "Verfahrensstand aller Verfahren" beschrieben, um einige der Grundfunktionalitäten in Superset zu verdeutlichen (siehe dazu das Kapitel: "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]").

=== Datensätze erstellen ===
Um ein Diagramm zu erstellen wird zunächst ein Datensatz benötigt. Für einfache Abfragen reicht der '''Verfahrensdatensatz''' aus, der bereits standardmäßig enthalten ist. Dieser entspricht der '''Tabelle "Verfahren"''' mit den '''zugehörigen Datenfeldern (Stammdaten)'''.

Für Abfragen auf dem Verfahrensdatensatz können Sie direkt zum Abschnitt "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]" springen.

Für komplexere '''Abfragen über mehrere Tabellen hinweg, eigene Metriken oder eigene berechnete Spalten''' ist die Erstellung eines eigene Datensatzes mithilfe von SQL-Abfragen notwendig. Folgende Informationen sind in gesonderten Tabellen enthalten:

* Gebietseinheiten
* Kontakte
* Nutzer
* Parallelverfahren
* Termine
* Veränderungssperren
* Vertragsarten
* Vorgesehene Nutzungen
* Zurückstellungen

'''Bitte beachten:''' Bei der Erstellung von eigenen Datensätzen, muss die Spalte "'''''zustaendigkeit_code"''''' aus der Tabelle "'''''verfahren"'' immer enthalten sein,''' da hierüber die Ansicht für Sachbearbeiter standardmäßig gefiltert wird.

'''Um eigene Datensätze zu erstellen gehen Sie bitte wie folgt vor:'''

* Klick im Hauptmenü auf den '''Reiter "SQL"''' und im zugehörigen Dropdown-Menü auf '''"SQL Lab".'''
[[Datei:ImageStartSQLLab.png|zentriert|mini|854x854px|Startansicht SQL Lab]]
* Erstellen Sie Ihre '''SQL-Abfrage''' und klicken Sie auf den '''Button "Ausführen"''', um eine Vorschau auf die Ergebnisse der Abfrage zu erhalten. Ein rotes Kreuzchen links vom SQL-Editor weist auf Fehler im SQL hin.
[[Datei:ImageAusfuehrenSQLLab.png|zentriert|mini|846x846px|Ausführen einer SQL Abfrage im SQL Lab]]
'''Typische Anwendungsfälle und die dazugehörigen SQL Abfragen könnten z.B. sein:'''

* Sie möchten, dass Ihre Abfragen z.B. nach "Gebietseinheiten" und "Vorgesehenen Nutzungen" gefiltert werden können:

{| class="wikitable"
|
SELECT v.*, g.gebietseinheit, vn.vorgesehene_nutzungen
FROM verfahren v
LEFT JOIN gebietseinheiten g ON g.verfahren_id = v.id
LEFT JOIN vorgesehene_nutzungen vn ON vn.verfahren_id = v.id;
|}

* Sie möchten, dass Ihr Datensatz bestimmte Termine enthält (z.B. Grobabstimmungsdatum, Vorweggenehmigungsreife):

{| class="wikitable"
|
WITH grobabstimmung_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Grobabstimmung'
),
vorweggenehmigungsreife_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Vorweggenehmigungsreife'
)
SELECT
v.*,
t1.beginn AS grobabstimmung,
t2.beginn AS vorweggenehmigungsreife
FROM verfahren v
LEFT JOIN grobabstimmung_termin t1 ON t1.verfahren_id = v.id
LEFT JOIN vorweggenehmigungsreife_termin t2 ON t2.verfahren_id = v.id;
|}

* '''Speichern Sie Ihre Abfrage als Datensatz''' ab, indem Sie auf den '''Dropdown-Pfeil neben dem Button "Speichern"''' klicken und dann '''"Datensatz speichern"''' auswählen. Es öffnet sich ein Dialogfeld, in dem Sie einen Namen für Ihren Datensatz vergeben können.
** Hinweis: Wenn Sie statt auf "Datensatz speichern" auf "Speichern" klicken, finden Sie Ihre SQL Abfrage unter dem Reiter '''"Gespeicherte Abfragen"''' wieder.
[[Datei:ImageSpeichernDatensatzSuperset.png|zentriert|mini|891x891px|Speichern eines neuen Datensatzes]]
Nach der Erstellung eines Datensatzes können Sie diesen noch weiter bearbeiten und Labels, eigene Metriken oder berechnete Spalten hinzufügen. Gehen Sie dazu wie folgt vor:
* Klick im Hauptmenü auf den '''Reiter "Datensätze"'''. Hier sind die verfügbaren Datensätze aufgelistet.
* Klicken Sie ganz rechts neben dem Datensatz, den Sie bearbeiten wollen, auf das '''Stift-Symbol.''' Es öffnet sich eine Bearbeitungsmaske.
[[Datei:ImageBearbeitungDatensatzSuperset.png|zentriert|mini|890x890px|Öffnen Sie den Bearbeitungsmodus durch Klick auf das Stiftsymbol]]
*'''Reiter "Quelle":''' Hier kann die zugrundeliegende SQL Abfrage nachträglich angepasst werden. Klicken Sie hierfür auf das Schloss-Symbol.
[[Datei:ImageReiterQuelleSuperset.png|zentriert|mini|879x879px|Im Reiter "Quelle" kann das SQL nachträglich angepasst werden]]
*'''Reiter "Metriken":''' Hier können eigene Metriken angelegt werden.
[[Datei:ImageReiterMetrikenSuperset.png|zentriert|mini|878x878px|Eine neue Metrik "Anzahl Verfahren" wird hinzugefügt]]
*'''Reiter "Spalten":''' Hier sind alle im Datensatz enthaltenen Spalten aufgeführt. An den Werten in der Tabelle ("Datentyp", "Ist zeitlich" etc.) sollte in der Regel nichts geändert werden, dies wird von Superset automatisch richtig erkannt. Beim '''Klick auf das "Plus"''' neben jeder Spalte kann unter "Beschriftung" ein sprechendes Label hinzugefügt werden. Dieses wird später in den Diagrammen angezeigt.
[[Datei:ImageReiterSpaltenSuperset.png|zentriert|mini|877x877px|Im Reiter "Spalten" wird ein Label hinzugefügt]]
*'''Reiter "Berechnete Spalten":''' Hier können dem Datensatz weitere Spalten hinzugefügt werden, die Werte enthalten, die aus anderen Spalten errechnet werden. Verwenden Sie für die Berechnung SQL-Syntax.
[[Datei:ImageReiterBerechneteSpaltenSuperset.png|zentriert|mini|851x851px|Eine berechnete Spalte wird hinzugefügt]]
* Speichern Sie Ihre Änderungen am Datensatz durch das '''Klicken auf den "Speichern"-Button'''. Um die Änderungen zu prüfen, empfiehlt es sich ein Diagramm mit dem Datensatz anzulegen (z.B. eine Tabelle).

=== Beispiel-Diagramm erstellen ===
Nachfolgend soll beispielhaft ein Diagramm "Verfahrensstand aller Verfahren" erstellt werden. Dazu gehen Sie wie folgt vor:

# Klick auf den '''Menüpunkt "Diagramme":''' Auf dieser Seite findet sich eine Liste mit allen bereits erstellten Diagrammen. Innerhalb dieser Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Diagramm-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageUebersichtDiagrammeSuperset.png|zentriert|mini|860x860px|Im Menüpunkt "Diagramme" findet sich eine Übersicht über die bisher erstellten Diagramme (Abfragen) mit vielen Zusatzinformationen.]]
# Um ein neues Diagramm zu erstellen klicken Sie auf den '''Button "+Diagramm"''' rechts oben. Es öffnet sich der Dialog '''"Neues Diagramm erstellen".'''[[Datei:ImageNeuesDiagrammSuperset.png|zentriert|mini|860x860px|Dialog um ein neues Diagramm zu erstellen]]
# Zunächst muss der '''passende Datensatz für die Auswertung ausgewählt''' werden. Für dieses Beispiel wählen wir unter '''"1- Datensatz auswählen"''' den Datensatz '''"verfahren"''' im Dropdownmenü aus.
# Im nächsten Schritt wird der '''passende Diagrammtyp ausgewählt'''. Hier werden Ihnen viele verschiedene Visualisierungsmöglichkeiten geboten. Im genannten Beispiel passt ein "Kreisdiagramm" am besten zu der Visualisierung der Verfahrensstände aller Verfahren. Sie finden das Kreisdiagramm unter dem Hauptmenü "Teil des Ganzen". Klicken Sie '''auf das Kreisdiagramm''' und anschließend auf '''"Neues Diagramm erstellen"'''.
# Nun geht es um die '''Detailkonfiguration''' des Diagramms. Grundsätzlich ist der Arbeitsbereich wie folgt aufgebaut:
#* Die linke Spalte enthält einen '''Überblick''' über die '''zur Verfügung stehenden Daten'''.
#* Die mittlere Spalte enthält die '''Werkzeuge''', um das '''Diagramm zu konfigurieren.'''
#* Im rechten Bereich kann man sich jeweils eine '''Vorschau des Diagramms''' anzeigen lassen.
'''Wir gehen für unser Beispiel wie folgt vor:'''

* Im Feld '''"Name des Diagramms hinzufügen"''' das Diagramm mit einer passenden Bezeichnung versehen.
* Um die Dimensionen des Diagramms festzulegen im Tab '''"Daten"''' unter der Überschrift '''"Abfrage > Dimensionen"''' die Spalte '''"verfahrensstand"''' von links per Drag & Drop herüberziehen.
* Der dazustellende Wert soll hier die Anzahl sein, weshalb nun unter '''"Metrik"''' das Feld '''"Anzahl"''' Button "+Diagramm" per Drag & Drop von links herübergezogen wird. Je nach Fragestellung bzw. welche Daten auf dem Diagramm dargestellt werden sollen, können verschiedenste Kombinationen in der selben Art und Weise über Drag & Drop zusammengestellt werden.
* Unter dem '''Punkt "Filter"''' kann eine Vorabfilterung eingebaut werden, also beispielsweise könnten Sie simulierte Verfahren standardmäßig herausfiltern, so dass die Nutzenden diese gar nicht auswerten können. Anmerkung: "imported_at" kann nicht gelöscht werden. Dieser Wert wird von Superset standardmäßig gesetzt und hat keine Auswirkung auf Ihre Auswertungen.
* Das für die Berechnung zugrundeliegende Zeilenlimit kann bei Bedarf verändert werden.
* Ein Klick auf den '''blauen Button "Diagramm erstellen"''' zeigt eine '''Vorschau''' des erstellten Diagrammes auf der rechten Bildschirmhälfte. Das Diagramm kann nun jederzeit mit einem '''Klick auf "Speichern"''' rechts oben gesichert werden.[[Datei:ImageDiagrammErstellenSuperset.png|zentriert|mini|880x880px|Dialog zur Detaildefinition des neuen Diagramms. Hier beispielhaft zusammengestellt für die Darstellung "Verfahrenstand aller Verfahren".]]

* Unter dem '''Tab "Anpassen"''' finden sich zahlreiche Möglichkeiten, das Diagramm weiter zu verfeinern (zum Beispiel in Farbe und Layout). Hier kann ganz nach Belieben ausprobiert werden. Mit '''Klick auf''' '''"Diagramm aktualisieren"''' kann die Vorschau des Diagramms zur Überprüfung mit den neu gewählten Einstellungen geladen werden.[[Datei:ImageDiagrammAnpassenSuperset.png|zentriert|mini|900x900px|Diagramm kann nach Belieben im Tab "Anpassen" verändert und verfeinert werden.]]
* '''Speichern nicht vergessen:''' Das Diagramm wird erst gespeichert durch '''Klick auf "Speichern" rechts oben'''. Es öffnet sich ein Dialog zu weiteren Speicheroptionen, der mit '''einer weiteren Speicherbestätigung''' abgeschlossen werden kann.[[Datei:ImageDiagrammSpeichernSuperset.png|zentriert|mini|874x874px|Speichern-Dialog für das erstellte Diagramm]]

=== Beispiel-Dashboard erstellen ===

# '''Klick auf den Menüpunkt "Dashboards":''' Unter der Überschrift "Dashboards" findet sich eine Liste mit allen bereits erstellten Dashboards. Diese Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Dashboard-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageDashboardsSuperset.png|zentriert|mini|866x866px|Unter dem Menüpunkt "Dashboards" finden sich alle bereits angelegten Dashboards, sowie die Möglichkeit neue Dashboards zu erstellen.]]
# Mit Klick auf den Button '''"+Dashboard"''' rechts oben öffnet sich ein neuer, leerer Dashboard -Entwurf.
# Der Titel des Dashboards ist standardmäßig als "untitled dashboard" angeben und kann durch '''Klick auf den Namen''' geändert werden.
# Auf der Seitenleiste am rechten Bildschirmrand finden sich alle bereits erstellten Diagramme. Das gewünschte Diagramm kann einfach durch '''Drag & Drop mit der Maus auf das Dashboard gezogen''' werden. Auch die Größe kann leicht geändert werden indem sie die Ränder oder Ecken des Diagramms klicken, gedrückt halten und auf die gewünschte Größe ziehen. Sie können ein oder auch mehrere Diagramme auf einem Dashboard platzieren.
# Zu guter Letzt oben rechts auf den '''Button "Speichern"''' klicken um Ihre Arbeit zu sichern. Nach dem Speichern können Sie jederzeit am Dashboard weiter arbeiten indem Sie auf den nun erscheinenden Button '''"Dashboard bearbeiten"''' klicken.
# Sollten Sie ein Diagramm wieder vom Dashboard löschen wollen, können Sie einfach das '''Mülleimer-Symbol''' klicken, welches bei Mouseover über das jeweilige Diagramm erscheint.[[Datei:ImageDragDropDiagrammSuperset.png|zentriert|mini|804x804px|Das gewünschte Diagramm kann mit der Maus einfach auf das Dashboard gezogen und platziert werden.]]
[[Datei:ImageDiagrammGroesseSuperset.png|zentriert|mini|761x761px|Die Größe des Diagramms lässt sich einfach durch Ziehen der Maus an Ecken oder Rändern verändern.]]

=== Einen oder mehrere Filter zu einem Dashboard zufügen ===
Es ist möglich Ihre Auswertungsdiagramme mit Filtermöglichkeiten zu versehen. Im folgenden wird beispielhaft ein Filter nach der Zuständigkeit auf dem Dashboard "Verfahrensstand aller Verfahren" hinzugefügt:

# Öffnen Sie das Dashboard oder legen Sie sich ein entsprechendes neues Dashboard an und speichern dieses.
# An der linken Bildschirmkante den '''kleinen Pfeil klicken''', um das Filtermenü auszuklappen. '''Wichtig:''' Der Pfeil ist nur sichtbar, wenn das Dashboard bereits gespeichert ist und sich nicht gerade im offenen Bearbeitungsmodus befindet. Sprich: Klicken Sie '''nicht''' "Dashboard bearbeiten" bevor Sie den Filter hinzufügen.
# Klicken Sie auf das '''kleine Zahnrad''' um das Untermenü zu öffnen.
# Ein Klick auf '''"Hinzufügen und Bearbeiten von Filtern"''' öffnet das Menü um die Filter zu konfigurieren.[[Datei:ImageDashboardFilterMenueSuperset.png|zentriert|mini|800x800px|Durch Klick auf den kleinen Pfeil öffnet sich das Menü, mit dem Filter hinzugefügt und konfiguriert werden können.]]
# Um nach der Zuständigkeit zu filtern muss im '''Menü Filtertyp die Option "Wert"''' ausgewählt sein.
# Im Menüpunkt Tabellenname '''"Zuständigkeit"''' als '''Namen des Filters''' eintragen.
# Im '''Feld Datensatz''' wird in diesem Fall '''"verfahren"''' ausgewählt.
# Im '''Feld "Spalte"''' den Filter auswählen, nach dem gefiltert werden soll: in diesem Fall '''"zustaendigkeit".'''
# Das Menü '''"Filterwerte sortieren"''' durch einen Haken aktivieren und absteigend sortieren und mit der '''Sortiermetrik "Anzahl"''' versehen.
# Im '''Reiter "Auswahlverfahren"''' kann der Filter durch eine Auswahl außerdem auf '''einzelne Diagramme oder auf alles bezogen''' werden.
# Durch '''Klick auf "Speichern"''' rechts unten wird der Filter in das Dashboard integriert.[[Datei:ImageFilteroptionenDashboardSuperset.png|zentriert|mini|712x712px|Sie können einen oder mehrere Filteroptionen auf einem Dashboard integrieren und in diesem Menü konfigurieren.]]
'''Übergeordnete Filtereinstellungen:'''

Nach '''Klick auf das Zahnrad''', im geöffneten Filter-Untermenü, können Sie außerdem entscheiden, ob der Filter '''oben''' über dem Diagramm '''oder seitlich links einklappbar''' angezeigt werden soll.

Es gibt dort außerdem die Möglichkeit für ein oder mehrere Diagramme eine '''Kreuzfilterung zu aktivieren.''' Diese erlaubt es Ihnen, direkt '''in einem Diagramm auf ein Element zu klicken''', um damit automatisch eines oder alle Diagramme im Dashboard zu filtern. So können Daten intuitiv und interaktiv erkundet werden, ohne separate Filtersteuerungen zu verwenden.
[[Datei:ImageFilterUntermenueSuperset.png|zentriert|mini|767x767px|Im Filter-Untermenü können bestehende Filter bearbeitet oder weitere Filter hinzugefügt werden. Außerdem kann die Kreuzfilterung aktiviert und die Darstellung der Filterleiste verändert werden.]]

=== Dashboards veröffentlichen ===
Dashboards werden erst im DiPlan Cockpit sichtbar, nachdem diese veröffentlicht und für die Sachbearbeitenden und Reporting-Administratoren freigeschalten wurden. Dabei gilt es zu beachten, dass Sie nur Dashboards veröffentlichen und freischalten können, die Sie selbst erstellt haben oder für die Sie berechtigt worden sind. Siehe hierzu auch das Kapitel "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Diagramme_und_Dashboards_f.C3.BCr_andere_Reporting-Administratoren_zur_Bearbeitung_freigeben Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben]".

'''Zur Veröffentlichung und Freischaltung gehen Sie wie folgt vor:'''

# Öffnen Sie das Dashboard, welches veröffentlicht werden soll.
# Durch Klick auf das '''graue Feld "Entwurf"''' neben dem Dashboard Namen, ändert sich die Bezeichnung auf '''"Veröffentlicht".'''[[Datei:ImageStatusVeroeffentlichtSuperset.png|zentriert|mini|911x911px|Durch Klick ändert sich der Status von "Entwurf" auf "Veröffentlicht".]]
# Öffnen Sie rechts oben das '''Dreipunktemenü''' und wählen Sie dort den Unterpunkt '''"Dashboard einbetten"''' aus.[[Datei:ImageDashboardEinbettenSuperset.png|zentriert|mini|942x942px|Im Dreipunktemenü muss im nächsten Schritt der Punkt "Dashboard einbetten" geklickt werden.]]
# Im Einbetten-Dialog lassen Sie das Feld für "Zulässige Domänen" bitte einfach frei und klicken lediglich den '''Button "Einbettung aktivieren".''' Dann kann das Menü durch Klick auf das '''X-Symbol''' geschlossen werden.[[Datei:ImageEinbettungAktivierenSuperset.png|zentriert|mini|869x869px|Im Menü "Einbetten" klicken Sie auf "Einbettung aktivieren" und dann einfach auf das X um das Fenster zu schließen.]]
# Um das Dashboard nun für die '''Rolle der Sachbearbeitenden und Mandanten-Administratoren''' im DiPlan Cockpit '''freizugeben''' öffnen Sie bitte erneut den Reiter '''"Dashboards",''' um auf die Liste mit allen Dashboards zu gelangen.
# Klicken Sie auf das '''Stift-Symbol''' neben dem Dashboard, welches freigeschalten werden soll.[[Datei:ImageDashboardEigenschaftenOeffnenSuperset.png|zentriert|mini|843x843px|Durch Klick auf das Stiftsymbol neben dem Dashboard werden die Dashboardeigenschaften geöffnet. Dort können auch die einzelnen Rollen freigeschaltet werden.]]
# In den '''Dashboardeigenschaften''' können nun die Rollen eingetragen werden, für die das Dashboard freigeschalten werden soll. Die Rollenbezeichnungen in Superset fassen mehrere Rollen aus dem DiPlan Cockpit zusammen, was die Freigabe von Dashboards vereinfacht. Bitte tragen Sie im Feld "Rollen" deshalb '''"Reporting-Administrator"''' und '''"Sachbearbeiter" in der Liste ein.''' Dies ist durch Tippen in das Feld möglich, so wird die auszuwählende Rolle schneller sichtbar. Sie können jedoch auch manuell durch die Liste scrollen und die Rolle auswählen. Klicken Sie anschließend den '''"Speichern"-Button'''. Die Auswertungen sind nun im DiPlan Cockpit für alle berechtigten Rollen sichtbar.[[Datei:ImageDashboardEigenschaftenRollenSuperset.png|zentriert|mini|695x695px|In den Dashboardeigenschaften müssen die Rollen, für die das Dashboard freigegeben werden soll, ausgewählt werden.]]
'''Hinweis: Veröffentlichung zurücknehmen'''

Sollten Sie ein Dashboard im DiPlan Cockpit unsichtbar machen wollen, so klicken Sie wie im Punkt 2 beschrieben wieder auf die graue Schaltfläche und setzen Sie den Status von '''"Veröffentlicht"''' zurück auf '''"Entwurf".'''

=== Bestehendes Dashboard oder Diagramm bearbeiten oder löschen ===
'''Wie lösche ich ein eingebettetes Diagramm von einem bereits veröffentlichten und freigegebenen Dashboard?'''

* Öffnen Sie das Dashboard und '''klicken Sie "Dashboard bearbeiten"''' auf der rechten Bildschirmseite.
* Im geöffneten Bearbeitungsmodus können Sie nun die Maus über das nicht mehr erwünschte Diagramm bewegen und durch '''Klick auf das erscheinende Mülleimersymbol''' löschen. Das Diagramm bleibt in der Liste der Diagramme weiterhin erhalten und wird lediglich vom Dashboard genommen.
* Sie können ein '''weiteres/neues Diagramm''' jederzeit wieder aus der Liste rechts auf das Dashboard ziehen.
* Bestätigen Sie das veränderte Dashboard durch Klick auf den "'''Speichern"-Button''' rechts oben.
* '''Bitte beachten:''' Änderungen an bereits veröffentlichten und freigegebenen Dashboards werden nach dem '''Speichern direkt auf dem DiPlan Cockpit sichtbar'''.
[[Datei:ImageDashboardDiagrammLoeschenSuperset.png|zentriert|mini|736x736px|Per Mouseover und Klick auf das Mülleimer Symbol lassen sich Diagramme auf Dashboards einfach wieder löschen.]]
'''Wie bearbeite ich ein bestehendes Diagramm?'''

Ein Diagramm unabhängig vom Dashboard ändern:

* Öffnen Sie das zu bearbeitende Diagramm in der '''Liste der Diagramme''' durch einen '''Klick auf den Namen'''.
* Das Diagramm öffnet sich direkt im Bearbeitungsmodus und kann nach '''Belieben angepasst werden'''.
* Ist das Diagramm bereits auf einem veröffentlichten und freigegebenen Dashboard eingebettet, so werden alle Änderungen nach dem Speichern direkt übernommen und im '''DiPlan Cockpit sichtbar'''.

Ein Diagramm direkt auf einem Dashboard ändern:

* Öffnen Sie das Dashboard und klicken Sie '''"Dashboard bearbeiten"'''.
* Bewegen Sie die Maus über die entsprechende Grafik, öffnen Sie das Dreipunktemenü rechts und klicken '''"Diagramm bearbeiten".'''
* Nachdem Sie das Diagramm bearbeitet haben klicken Sie '''"Speichern"'''.

'''Bitte beachten:''' Im Speichern-Dialog können Sie entscheiden, ob sie das bestehende '''Diagramm überschreiben''' oder ein '''neues Diagramm speichern''' wollen. Dies kann hilfreich sein, wenn Sie das Diagramm nicht generell, sondern nur auf einem bereits bestehenden Dashboard ändern wollen.
[[Datei:ImageDiagrammSpeichernÜberschreibenSuperset.png|zentriert|mini|792x792px|Es ist möglich direkt beim Speichern ein neues Diagramm zu erstellen oder das bereits bestehende zu überschreiben.]]

'''Wie lösche ich ein Dashboard oder Diagramm dauerhaft?'''

Sie können ein Dashboard unabhängig vom Status (also veröffentlicht oder auch als Entwurf) in der Liste der Dashboards wie folgt löschen:

* Bewegen Sie die Maus über den entsprechenden '''Listeneintrag.'''
* Klicken Sie das in der Zeile rechts erscheinende '''Papierkorb-Symbol''' und folgen den Anweisungen im erscheinenden Löschdialog.
* Die Originaldiagramme auf dem Dashboard bleiben dabei weiterhin in der Liste "Diagramme" erhalten.
* Sollten Sie ein Diagramm dauerhaft löschen wollen, so gehen Sie genauso wie beim Dashboard vor, jedoch im '''Reiter "Diagramme"'''.

=== Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Bitte beachten:''' Solange Reporting-Administratoren nicht als Besitzer eingetragen sind, haben diese nur Zugriff auf die eigenen erstellten Daten.

'''Das bedeutet konkret für die erstellten Daten von anderen Reporting-Administratoren:'''

* Unveröffentlichte Dashboards sind nicht sichtbar.
* Veröffentlichte Dashboards sind sichtbar, aber nicht bearbeitbar.
* Alle Diagramme sind sichtbar, Änderungen können jedoch nur als neue Diagramme gespeichert werden.
* Datensätze sind sichtbar und können verwendet, aber nicht bearbeitet werden.
* Gespeicherte Abfragen sind nicht sichtbar (Berechtigungen können hier grundsätzlich nicht vergeben werden).

Sie haben grundsätzlich keine Rechte ein Dashboard zu bearbeiten oder ein Diagramm zu überschreiben, welches nicht von Ihnen erstellt wurde, außer Sie wurden als '''"Besitzende/r"''' dazu ermächtigt.

Das bedeutet beispielsweise, dass Sie ein Diagramm, welches jemand anders erstellt hat, zwar bearbeiten, dies aber nur als neues Diagramm abspeichern können. Das Originaldiagramm wird hier nicht verändert. Um jemanden für die '''Mitarbeit an Ihrem Diagramm oder Dashboard zu ermächtigen''' gehen Sie wie folgt vor:

* Klicken Sie in der Liste der Diagramme oder Dashboards auf das '''Stift-Symbol "Bearbeiten".''' Der Dialog '''"Diagrammeigenschaften bearbeiten"''' öffnet sich.
* Unter der '''Überschrift "Zugang"''' können weitere '''"Besitzende" eingetragen''' werden. Klicken Sie hierzu in das Eingabefeld und fangen Sie an den Namen zu tippen oder scrollen Sie durch die Liste bis zum gewünschten Namen.
* '''Wählen Sie einen oder mehrere Namen aus,''' um diese in das Feld zu übernehmen und klicken Sie dann auf '''"Speichern"'''. Die eingetragene Person hat nun die gleichen '''Rechte zur Bearbeitung wie der/die ursprüngliche Ersteller/in'''.[[Datei:ImageDiagrammZugangBesitzendeSuperset.png|zentriert|mini|677x677px|Unter "Zugang" können Sie andere Mandanten-Administratoren für die Bearbeitung Ihrer Dashboards oder Diagramme berechtigen.]]

=== Datensätze für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Um Datensätze für andere Reporting-Administratoren zur Bearbeitung freizugeben, gehen Sie wie folgt vor:'''

* Klick auf den '''Reiter "Datensätze"'''
* In der Übersicht-Liste klicken Sie bitte das '''Stift- Symbol''' neben dem gewünschten Datensatz.
* Klicken Sie den '''Reiter "Einstellungen"''' ganz rechts und scrollen Sie ganz nach unten.
* Dort können Sie im '''Feld "Besitzende"''' auch andere Reporting-Administratoren zur Bearbeitung berechtigen.
[[Datei:ImageDatensatzBesitzendeSuperset.png|zentriert|mini|810x810px|Auch Datensätze können zur Bearbeitung an andere Mandanten-Administratoren freigegeben werden.]]

== Weiterführende Informationen ==
Unter folgendem Link können Sie weitere Informationen zu Superset in englischer Sprache finden. Bitte beachten Sie, dass Ihre Datenbank bereits angebunden ist und der Punkt "Connecting to a new database" in der Dokumentation somit nicht beachtet werden sollte: '''[https://superset.apache.org/docs/6.0.0/using-superset/creating-your-first-dashboard#creating-your-first-dashboard Englische Dokumentation des Open-Source-Tools Superset]'''

Reporting: Auswertungen im DiPlan Cockpit

2026-03-16T14:35:46Z

Diplanung: /* Datensätze für andere Reporting-Administratoren zur Bearbeitung freigeben */

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

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

⚠️ '''Bitte beachten: Die Reporting-Funktionalität wird nach und nach Mandanten spezifisch freigeschaltet. Informationen zur Funktionsweise finden Sie hier vorab.'''

== Einleitung ==
Die Auswertungskomponente für das DiPlan Cockpit ermöglicht das Abrufen, Filtern und Downloaden von Reports und Auswertungen aus Planungs- und Genehmigungsverfahren. Die Auswertungsdiagramme zu individuellen Fragestellungen werden in dem externen BI-Tool Superset von berechtigten Personen auf Basis grundlegender SQL- und Datenmodell-Kenntnisse erstellt, verwaltet, auf Dashboards zusammengestellt und schließlich für die Darstellung im DiPlan Cockpit freigegeben.

== Aufruf der Auswertungen ==
Die Auswertungen sind in dem gleichnamigen Reiter im DiPlan Cockpit zu finden.

In der linken Bildschirmhälfte sind die Namen der jeweiligen zur Verfügung stehenden Dashboards zu finden. Ein Dashboard ist eine Zusammenstellung von einem oder mehreren Auswertungsdiagrammen auf einer Seite. Standardmäßig wird das Dashboard "Verfahrensstand aller Verfahren" für jeden Mandant initial mit ausgerollt. Alle weiteren Dashboards können je nach Bedarf individuell durch berechtigte Personen je Mandant erstellt werden. Mehr dazu findet sich im Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Auswertungen_erstellen.2C_ver.C3.B6ffentlichen_und_freigeben Auswertungen erstellen, veröffentlichen und freigeben].

'''Gut zu wissen:'''

* '''Datengrundlage:''' Grundsätzlich fließen gelöschte Verfahren nicht in die Auswertungen ein.
* '''Aktualität der Daten:''' Die Daten werden jede Nacht einmal mit der DiPlan Cockpit Datenbank synchronisiert.
* '''Darstellung:''' Das Reporting wird mit dem Tool Superset umgesetzt, welches in das DiPlan Cockpit eingebunden wird. Für eine optimale Darstellung nutzen Sie bitte den Browser Microsoft Edge.
[[Datei:ImageAuswertungenCockpit.png|zentriert|mini|717x717px|Ansicht des Reiters "Auswertungen" im DiPlan Cockpit mit dem Standarddashboard "Verfahrensstand aller Verfahren".]]

== Filtern der Dashboards bzw. Auswertungen ==
Je nach Art der dargestellten Auswertungen können Sie weitere Aktionen in den einzelnen Diagrammen vornehmen. Oftmals sind zum Beispiel verschiedene Filterungsmöglichkeiten hinterlegt. Zum Öffnen der Filter gehen Sie bitte folgendermaßen vor:

* Aufklappen der Filter durch Klick auf den kleinen blauen Pfeil links neben den Diagrammen. Alternativ können die Filter auch am oberen Rand des Dashboards eingebunden sein.
* Auswählen der gewünschten Filter.
* Klick auf "Filter anwenden".
* Bei Klick auf "Alles löschen" werden sämtliche gesetzte Filter wieder zurückgesetzt.
[[Datei:ImageAuswertungenCockpitFilter.png|zentriert|mini|742x742px|Falls eine Filterung im Dashboard integriert wurde, so lässt diese sich über den kleinen Pfeil ausklappen oder befindet sich am oberen Rand des Dashboards. Hier zu sehen eine Filterung auf dem Dashboard nach Zuständigkeit oder Verfahrenstyp.]]
[[Datei:ImageAuswertungenCockpitFilter2.png|zentriert|mini|742x742px|Das Reporting bietet die Möglichkeit auch mehrere verschiedene Diagrammtypen auf einem Dashboard darzustellen. Diese können von Mandanten-Administratoren konfiguriert und freigegeben werden. Hier ein Beispiel mit integrierten Filtern am oberen Rand des Dashboards.]]

== Download der Auswertungen ==
Neben jeder Auswertungsgrafik (jedem Diagramm) finden sich drei Punkte, welche bei Klick ein Drop-Down Menü öffnen. Durch '''Mouseover auf "Herunterladen"''' öffnet sich das Menü zum Download des Diagramms in verschiedenen auswählbaren Formaten. Hier sind folgende Punkte zu beachten:

* '''Der Download entspricht immer der Filterung:''' Wird eine Grafik durch eine Filterung angepasst und dann ein Download gestartet, so entsprechen die heruntergeladenen Daten immer genau der Filterung, das heißt es sind nicht alle Daten vorhanden. Je nach Grafik ist in den heruntergeladenen Dateien nicht selbsterklärend, dass eine Filterung angewendet wurde und es ist wichtig das Downloadergebnis bei der weiteren Verwendung in den richtigen Kontext zu setzen. Laden Sie sich alternativ die Daten ohne Filterung herunter und filtern Sie zum Beispiel bei Bedarf gesondert in MS Excel.
* '''Die Rollen der Sachbearbeitenden sehen nur die eigene Zuständigkeit:''' Je nach Rolle der Nutzenden werden unter Umständen nicht alle Daten auf den Dashboards dargestellt. Sachbearbeitende können nur Daten der eigenen Zuständigkeit sehen. Siehe dazu auch das nächste Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Rechte_und_Rollen Rechte und Rollen].
[[Datei:ImageAuswertungenHerunterladen.png|zentriert|mini|327x327px|Das vertikale Dreipunktemenü in den Diagrammen beinhaltet die Herunterladen-Funktion.]]

== Rechte und Rollen ==
Alle Rollen aus dem DiPlan Cockpit werden gemäß ihrer Berechtigungen mit einer entsprechenden Rolle in Superset versehen. Prinzipiell gibt es zwei relevante Rollen, denen die Nutzenden in Superset zugeordnet werden. Dies passiert automatisch und regelt ob die Nutzenden berechtigt sind Auswertungen selbst anzulegen, freizugeben und zu veröffentlichen oder ob sie ausschließlich die freigegebenen Auswertungen gemäß ihrer Zuständigkeit im DiPlan Cockpit sehen können. Nachfolgend sehen Sie eine Übersicht über die verschiedenen Berechtigungen:
{| class="wikitable"
|'''Rolle DiPlan Cockpit'''
|'''Rolle Superset'''
|'''Berechtigungen'''
|-
|'''EfA Cockpit Pro'''
* M-A = Mandanten-Administration
* FP-A = Fachplanung-Administration

'''EfA Cockpit Basis'''

* M-A-Basis = Mandanten-Administration-Basis
* FP-A-Basis = Fachplanung-Administration Basis
|'''Reporting-Administrator'''
|
* Kann direkt aus dem DiPlan Cockpit zu Superset abspringen und ist dort automatisch eingeloggt (SSO).
* Kann Datensätze (Superset-spezifische Zwischenschicht zwischen DB-Tabelle und Abfrage) erstellen.
* Kann Auswertungen/Diagramme in Superset erstellen.
* Kann Dashboards mit verschiedenen Auswertungen/Diagramme zusammenstellen.
* Kann Dashboards freigeben für den ganzen Mandanten (z.B. ganz Hamburg).
* Kann alle Daten im Dashboard eines Mandanten sehen.
* Kann Abfragen filtern, also z.B. in Hamburg nach Belieben nach Bezirk (Zuständigkeit) z.B. Altona oder Senat.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
* Kann andere Reporting-Administratoren für die eigenen Dashboards/Diagramme als Besitzer eintragen, um diese für die Bearbeitung, Freischaltung und Veröffentlichung zu berechtigen.
|-
|''''''EfA Cockpit Pro''''''
* FP-VM = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)

'''EfA Cockpit Basis'''

* FP-VM-Basis = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB-Basis = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)
|'''Sachbearbeiter'''
|
* Sieht ausschließlich die vorgefilterten Daten entsprechend der eigenen Zuständigkeit (also z.B. Altona).
* Kann Auswertungen herunterladen, aber nur mit den Daten der eigenen Zuständigkeit.
* Kann freigegebene Dashboards betrachten.
* Kann Auswertungen filtern, wenn Filter eingerichtet wurden.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
|}

== Superset als zentrales Tool für Reporting-Administratoren ==

=== Übergreifende Informationen zu Superset ===
Für die Erstellung und Darstellung des Reportings wurde das Open-Source-Tool Apache Superset in das DiPlan Cockpit implementiert. Superset ist eine Reporting- und Monitoring-Technologie, die es ermöglicht komplexe Daten auf Dashboards in leicht verständlichen Visualisierungen darzustellen. Die Erstellung der Dashboards erfolgt dabei direkt in der Superset-Anwendung. Dort wird auch gesteuert, welche Dashboards mit welchen Auswertungen im DiPlan Cockpit veröffentlicht werden sollen.

=== Absprung aus dem DiPlan Cockpit zu Superset ===
Sobald eine Rolle für die Erstellung von Auswertungen berechtigt ist (zum Beispiel M-A oder FP-A), findet sich im Reiter Auswertungen automatisch der Button '''"Auswertungen konfigurieren"'''. Bei Klick öffnet sich ein weiteres Browserfenster mit der Superset-Plattform. Eine gesonderte Anmeldung in Superset ist nicht erforderlich, da die Anmeldung durch das Cockpit erfolgt (auch Single Sign-On (SSO) genannt).

'''Bitte beachten:''' Nach 4 Stunden erfolgt aus Sicherheitsgründen ein automatischer Logout aus Superset - unabhängig davon ob Sie gerade in Superset arbeiten oder nicht aktiv waren. Sie erhalten keine Warnung vor dem Logout. Deshalb empfiehlt es sich, Änderungen regelmäßig zu speichern, um zu verhindern, dass ungesicherte Abfragen verloren gehen.
[[Datei:ImageButtonAuswertungenKonfigurieren.png|zentriert|mini|491x491px|Berechtigte Personen sehen über den Dashboards im DiPlan Cockpit einen Absprungbutton zu Superset mit der Bezeichnung "Auswertungen konfigurieren."]]
[[Datei:ImageStartbildschirmSuperset.png|zentriert|mini|508x508px|Startbildschirm in Superset mit einer Vorschau auf Dashboards und Diagrammen. Die Hauptmenüpunkte zur Navigation sind am oberen Bildschirmrand zu sehen.]]

=== Auswertungen erstellen, veröffentlichen und freigeben ===
Datenvisualisierungen von Abfragen werden in Superset als '''"Diagramme"''' bezeichnet. Sobald mindestens ein Diagramm erstellt ist, kann dieses auf einem Dashboard integriert werden und mit weiteren Filtermöglichkeiten versehen werden. Wie bereits erwähnt, können Sie als '''Reporting-Administrator''' selbst nach Belieben Diagramme erstellen. Nachfolgend wird beispielhaft die Erstellung und Freigabe des Dashboards mit dem Diagramm "Verfahrensstand aller Verfahren" beschrieben, um einige der Grundfunktionalitäten in Superset zu verdeutlichen (siehe dazu das Kapitel: "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]").

=== Datensätze erstellen ===
Um ein Diagramm zu erstellen wird zunächst ein Datensatz benötigt. Für einfache Abfragen reicht der '''Verfahrensdatensatz''' aus, der bereits standardmäßig enthalten ist. Dieser entspricht der '''Tabelle "Verfahren"''' mit den '''zugehörigen Datenfeldern (Stammdaten)'''.

Für Abfragen auf dem Verfahrensdatensatz können Sie direkt zum Abschnitt "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]" springen.

Für komplexere '''Abfragen über mehrere Tabellen hinweg, eigene Metriken oder eigene berechnete Spalten''' ist die Erstellung eines eigene Datensatzes mithilfe von SQL-Abfragen notwendig. Folgende Informationen sind in gesonderten Tabellen enthalten:

* Gebietseinheiten
* Kontakte
* Nutzer
* Parallelverfahren
* Termine
* Veränderungssperren
* Vertragsarten
* Vorgesehene Nutzungen
* Zurückstellungen

'''Bitte beachten:''' Bei der Erstellung von eigenen Datensätzen, muss die Spalte "'''''zustaendigkeit_code"''''' aus der Tabelle "'''''verfahren"'' immer enthalten sein,''' da hierüber die Ansicht für Sachbearbeiter standardmäßig gefiltert wird.

'''Um eigene Datensätze zu erstellen gehen Sie bitte wie folgt vor:'''

* Klick im Hauptmenü auf den '''Reiter "SQL"''' und im zugehörigen Dropdown-Menü auf '''"SQL Lab".'''
[[Datei:ImageStartSQLLab.png|zentriert|mini|576x576px|Startansicht SQL Lab]]
* Erstellen Sie Ihre '''SQL-Abfrage''' und klicken Sie auf den '''Button "Ausführen"''', um eine Vorschau auf die Ergebnisse der Abfrage zu erhalten. Ein rotes Kreuzchen links vom SQL-Editor weist auf Fehler im SQL hin.
[[Datei:ImageAusfuehrenSQLLab.png|zentriert|mini|576x576px|Ausführen einer SQL Abfrage im SQL Lab]]
'''Typische Anwendungsfälle und die dazugehörigen SQL Abfragen könnten z.B. sein:'''

* Sie möchten, dass Ihre Abfragen z.B. nach "Gebietseinheiten" und "Vorgesehenen Nutzungen" gefiltert werden können:

{| class="wikitable"
|
SELECT v.*, g.gebietseinheit, vn.vorgesehene_nutzungen
FROM verfahren v
LEFT JOIN gebietseinheiten g ON g.verfahren_id = v.id
LEFT JOIN vorgesehene_nutzungen vn ON vn.verfahren_id = v.id;
|}

* Sie möchten, dass Ihr Datensatz bestimmte Termine enthält (z.B. Grobabstimmungsdatum, Vorweggenehmigungsreife):

{| class="wikitable"
|
WITH grobabstimmung_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Grobabstimmung'
),
vorweggenehmigungsreife_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Vorweggenehmigungsreife'
)
SELECT
v.*,
t1.beginn AS grobabstimmung,
t2.beginn AS vorweggenehmigungsreife
FROM verfahren v
LEFT JOIN grobabstimmung_termin t1 ON t1.verfahren_id = v.id
LEFT JOIN vorweggenehmigungsreife_termin t2 ON t2.verfahren_id = v.id;
|}

* '''Speichern Sie Ihre Abfrage als Datensatz''' ab, indem Sie auf den '''Dropdown-Pfeil neben dem Button "Speichern"''' klicken und dann '''"Datensatz speichern"''' auswählen. Es öffnet sich ein Dialogfeld, in dem Sie einen Namen für Ihren Datensatz vergeben können.
** Hinweis: Wenn Sie statt auf "Datensatz speichern" auf "Speichern" klicken, finden Sie Ihre SQL Abfrage unter dem Reiter '''"Gespeicherte Abfragen"''' wieder.
[[Datei:ImageSpeichernDatensatzSuperset.png|zentriert|mini|581x581px|Speichern eines neuen Datensatzes]]
Nach der Erstellung eines Datensatzes können Sie diesen noch weiter bearbeiten und Labels, eigene Metriken oder berechnete Spalten hinzufügen. Gehen Sie dazu wie folgt vor:
* Klick im Hauptmenü auf den '''Reiter "Datensätze"'''. Hier sind die verfügbaren Datensätze aufgelistet.
* Klicken Sie ganz rechts neben dem Datensatz, den Sie bearbeiten wollen, auf das '''Stift-Symbol.''' Es öffnet sich eine Bearbeitungsmaske.
[[Datei:ImageBearbeitungDatensatzSuperset.png|zentriert|mini|427x427px|Öffnen Sie den Bearbeitungsmodus durch Klick auf das Stiftsymbol]]
*'''Reiter "Quelle":''' Hier kann die zugrundeliegende SQL Abfrage nachträglich angepasst werden. Klicken Sie hierfür auf das Schloss-Symbol.
[[Datei:ImageReiterQuelleSuperset.png|zentriert|mini|411x411px|Im Reiter "Quelle" kann das SQL nachträglich angepasst werden]]
*'''Reiter "Metriken":''' Hier können eigene Metriken angelegt werden.
[[Datei:ImageReiterMetrikenSuperset.png|zentriert|mini|350x350px|Eine neue Metrik "Anzahl Verfahren" wird hinzugefügt]]
*'''Reiter "Spalten":''' Hier sind alle im Datensatz enthaltenen Spalten aufgeführt. An den Werten in der Tabelle ("Datentyp", "Ist zeitlich" etc.) sollte in der Regel nichts geändert werden, dies wird von Superset automatisch richtig erkannt. Beim '''Klick auf das "Plus"''' neben jeder Spalte kann unter "Beschriftung" ein sprechendes Label hinzugefügt werden. Dieses wird später in den Diagrammen angezeigt.
[[Datei:ImageReiterSpaltenSuperset.png|zentriert|mini|470x470px|Im Reiter "Spalten" wird ein Label hinzugefügt]]
*'''Reiter "Berechnete Spalten":''' Hier können dem Datensatz weitere Spalten hinzugefügt werden, die Werte enthalten, die aus anderen Spalten errechnet werden. Verwenden Sie für die Berechnung SQL-Syntax.
[[Datei:ImageReiterBerechneteSpaltenSuperset.png|zentriert|mini|416x416px|Eine berechnete Spalte wird hinzugefügt]]
* Speichern Sie Ihre Änderungen am Datensatz durch das '''Klicken auf den "Speichern"-Button'''. Um die Änderungen zu prüfen, empfiehlt es sich ein Diagramm mit dem Datensatz anzulegen (z.B. eine Tabelle).

=== Beispiel-Diagramm erstellen ===
Nachfolgend soll beispielhaft ein Diagramm "Verfahrensstand aller Verfahren" erstellt werden. Dazu gehen Sie wie folgt vor:

# Klick auf den '''Menüpunkt "Diagramme":''' Auf dieser Seite findet sich eine Liste mit allen bereits erstellten Diagrammen. Innerhalb dieser Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Diagramm-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageUebersichtDiagrammeSuperset.png|zentriert|mini|501x501px|Im Menüpunkt "Diagramme" findet sich eine Übersicht über die bisher erstellten Diagramme (Abfragen) mit vielen Zusatzinformationen.]]
# Um ein neues Diagramm zu erstellen klicken Sie auf den '''Button "+Diagramm"''' rechts oben. Es öffnet sich der Dialog '''"Neues Diagramm erstellen".'''[[Datei:ImageNeuesDiagrammSuperset.png|zentriert|mini|487x487px|Dialog um ein neues Diagramm zu erstellen]]
# Zunächst muss der '''passende Datensatz für die Auswertung ausgewählt''' werden. Für dieses Beispiel wählen wir unter '''"1- Datensatz auswählen"''' den Datensatz '''"verfahren"''' im Dropdownmenü aus.
# Im nächsten Schritt wird der '''passende Diagrammtyp ausgewählt'''. Hier werden Ihnen viele verschiedene Visualisierungsmöglichkeiten geboten. Im genannten Beispiel passt ein "Kreisdiagramm" am besten zu der Visualisierung der Verfahrensstände aller Verfahren. Sie finden das Kreisdiagramm unter dem Hauptmenü "Teil des Ganzen". Klicken Sie '''auf das Kreisdiagramm''' und anschließend auf '''"Neues Diagramm erstellen"'''.
# Nun geht es um die '''Detailkonfiguration''' des Diagramms. Grundsätzlich ist der Arbeitsbereich wie folgt aufgebaut:
#* Die linke Spalte enthält einen '''Überblick''' über die '''zur Verfügung stehenden Daten'''.
#* Die mittlere Spalte enthält die '''Werkzeuge''', um das '''Diagramm zu konfigurieren.'''
#* Im rechten Bereich kann man sich jeweils eine '''Vorschau des Diagramms''' anzeigen lassen.
'''Wir gehen für unser Beispiel wie folgt vor:'''

* Im Feld '''"Name des Diagramms hinzufügen"''' das Diagramm mit einer passenden Bezeichnung versehen.
* Um die Dimensionen des Diagramms festzulegen im Tab '''"Daten"''' unter der Überschrift '''"Abfrage > Dimensionen"''' die Spalte '''"verfahrensstand"''' von links per Drag & Drop herüberziehen.
* Der dazustellende Wert soll hier die Anzahl sein, weshalb nun unter '''"Metrik"''' das Feld '''"Anzahl"''' Button "+Diagramm" per Drag & Drop von links herübergezogen wird. Je nach Fragestellung bzw. welche Daten auf dem Diagramm dargestellt werden sollen, können verschiedenste Kombinationen in der selben Art und Weise über Drag & Drop zusammengestellt werden.
* Unter dem '''Punkt "Filter"''' kann eine Vorabfilterung eingebaut werden, also beispielsweise könnten Sie simulierte Verfahren standardmäßig herausfiltern, so dass die Nutzenden diese gar nicht auswerten können. Anmerkung: "imported_at" kann nicht gelöscht werden. Dieser Wert wird von Superset standardmäßig gesetzt und hat keine Auswirkung auf Ihre Auswertungen.
* Das für die Berechnung zugrundeliegende Zeilenlimit kann bei Bedarf verändert werden.
* Ein Klick auf den '''blauen Button "Diagramm erstellen"''' zeigt eine '''Vorschau''' des erstellten Diagrammes auf der rechten Bildschirmhälfte. Das Diagramm kann nun jederzeit mit einem '''Klick auf "Speichern"''' rechts oben gesichert werden.[[Datei:ImageDiagrammErstellenSuperset.png|zentriert|mini|426x426px|Dialog zur Detaildefinition des neuen Diagramms. Hier beispielhaft zusammengestellt für die Darstellung "Verfahrenstand aller Verfahren".]]

* Unter dem '''Tab "Anpassen"''' finden sich zahlreiche Möglichkeiten, das Diagramm weiter zu verfeinern (zum Beispiel in Farbe und Layout). Hier kann ganz nach Belieben ausprobiert werden. Mit '''Klick auf''' '''"Diagramm aktualisieren"''' kann die Vorschau des Diagramms zur Überprüfung mit den neu gewählten Einstellungen geladen werden.[[Datei:ImageDiagrammAnpassenSuperset.png|zentriert|mini|421x421px|Diagramm kann nach Belieben im Tab "Anpassen" verändert und verfeinert werden.]]
* '''Speichern nicht vergessen:''' Das Diagramm wird erst gespeichert durch '''Klick auf "Speichern" rechts oben'''. Es öffnet sich ein Dialog zu weiteren Speicheroptionen, der mit '''einer weiteren Speicherbestätigung''' abgeschlossen werden kann.[[Datei:ImageDiagrammSpeichernSuperset.png|zentriert|mini|427x427px|Speichern-Dialog für das erstellte Diagramm]]

=== Beispiel-Dashboard erstellen ===

# '''Klick auf den Menüpunkt "Dashboards":''' Unter der Überschrift "Dashboards" findet sich eine Liste mit allen bereits erstellten Dashboards. Diese Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Dashboard-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageDashboardsSuperset.png|zentriert|mini|452x452px|Unter dem Menüpunkt "Dashboards" finden sich alle bereits angelegten Dashboards, sowie die Möglichkeit neue Dashboards zu erstellen.]]
# Mit Klick auf den Button '''"+Dashboard"''' rechts oben öffnet sich ein neuer, leerer Dashboard -Entwurf.
# Der Titel des Dashboards ist standardmäßig als "untitled dashboard" angeben und kann durch '''Klick auf den Namen''' geändert werden.
# Auf der Seitenleiste am rechten Bildschirmrand finden sich alle bereits erstellten Diagramme. Das gewünschte Diagramm kann einfach durch '''Drag & Drop mit der Maus auf das Dashboard gezogen''' werden. Auch die Größe kann leicht geändert werden indem sie die Ränder oder Ecken des Diagramms klicken, gedrückt halten und auf die gewünschte Größe ziehen. Sie können ein oder auch mehrere Diagramme auf einem Dashboard platzieren.
# Zu guter Letzt oben rechts auf den '''Button "Speichern"''' klicken um Ihre Arbeit zu sichern. Nach dem Speichern können Sie jederzeit am Dashboard weiter arbeiten indem Sie auf den nun erscheinenden Button '''"Dashboard bearbeiten"''' klicken.
# Sollten Sie ein Diagramm wieder vom Dashboard löschen wollen, können Sie einfach das '''Mülleimer-Symbol''' klicken, welches bei Mouseover über das jeweilige Diagramm erscheint.[[Datei:ImageDragDropDiagrammSuperset.png|zentriert|mini|351x351px|Das gewünschte Diagramm kann mit der Maus einfach auf das Dashboard gezogen und platziert werden.]]
[[Datei:ImageDiagrammGroesseSuperset.png|zentriert|mini|325x325px|Die Größe des Diagramms lässt sich einfach durch Ziehen der Maus an Ecken oder Rändern verändern.]]

=== Einen oder mehrere Filter zu einem Dashboard zufügen ===
Es ist möglich Ihre Auswertungsdiagramme mit Filtermöglichkeiten zu versehen. Im folgenden wird beispielhaft ein Filter nach der Zuständigkeit auf dem Dashboard "Verfahrensstand aller Verfahren" hinzugefügt:

# Öffnen Sie das Dashboard oder legen Sie sich ein entsprechendes neues Dashboard an und speichern dieses.
# An der linken Bildschirmkante den '''kleinen Pfeil klicken''', um das Filtermenü auszuklappen. '''Wichtig:''' Der Pfeil ist nur sichtbar, wenn das Dashboard bereits gespeichert ist und sich nicht gerade im offenen Bearbeitungsmodus befindet. Sprich: Klicken Sie '''nicht''' "Dashboard bearbeiten" bevor Sie den Filter hinzufügen.
# Klicken Sie auf das '''kleine Zahnrad''' um das Untermenü zu öffnen.
# Ein Klick auf '''"Hinzufügen und Bearbeiten von Filtern"''' öffnet das Menü um die Filter zu konfigurieren.[[Datei:ImageDashboardFilterMenueSuperset.png|zentriert|mini|372x372px|Durch Klick auf den kleinen Pfeil öffnet sich das Menü, mit dem Filter hinzugefügt und konfiguriert werden können.]]
# Um nach der Zuständigkeit zu filtern muss im '''Menü Filtertyp die Option "Wert"''' ausgewählt sein.
# Im Menüpunkt Tabellenname '''"Zuständigkeit"''' als '''Namen des Filters''' eintragen.
# Im '''Feld Datensatz''' wird in diesem Fall '''"verfahren"''' ausgewählt.
# Im '''Feld "Spalte"''' den Filter auswählen, nach dem gefiltert werden soll: in diesem Fall '''"zustaendigkeit".'''
# Das Menü '''"Filterwerte sortieren"''' durch einen Haken aktivieren und absteigend sortieren und mit der '''Sortiermetrik "Anzahl"''' versehen.
# Im '''Reiter "Auswahlverfahren"''' kann der Filter durch eine Auswahl außerdem auf '''einzelne Diagramme oder auf alles bezogen''' werden.
# Durch '''Klick auf "Speichern"''' rechts unten wird der Filter in das Dashboard integriert.[[Datei:ImageFilteroptionenDashboardSuperset.png|zentriert|mini|431x431px|Sie können einen oder mehrere Filteroptionen auf einem Dashboard integrieren und in diesem Menü konfigurieren.]]
'''Übergeordnete Filtereinstellungen:'''

Nach '''Klick auf das Zahnrad''', im geöffneten Filter-Untermenü, können Sie außerdem entscheiden, ob der Filter '''oben''' über dem Diagramm '''oder seitlich links einklappbar''' angezeigt werden soll.

Es gibt dort außerdem die Möglichkeit für ein oder mehrere Diagramme eine '''Kreuzfilterung zu aktivieren.''' Diese erlaubt es Ihnen, direkt '''in einem Diagramm auf ein Element zu klicken''', um damit automatisch eines oder alle Diagramme im Dashboard zu filtern. So können Daten intuitiv und interaktiv erkundet werden, ohne separate Filtersteuerungen zu verwenden.
[[Datei:ImageFilterUntermenueSuperset.png|zentriert|mini|440x440px|Im Filter-Untermenü können bestehende Filter bearbeitet oder weitere Filter hinzugefügt werden. Außerdem kann die Kreuzfilterung aktiviert und die Darstellung der Filterleiste verändert werden.]]

=== Dashboards veröffentlichen ===
Dashboards werden erst im DiPlan Cockpit sichtbar, nachdem diese veröffentlicht und für die Sachbearbeitenden und Reporting-Administratoren freigeschalten wurden. Dabei gilt es zu beachten, dass Sie nur Dashboards veröffentlichen und freischalten können, die Sie selbst erstellt haben oder für die Sie berechtigt worden sind. Siehe hierzu auch das Kapitel "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Diagramme_und_Dashboards_f.C3.BCr_andere_Reporting-Administratoren_zur_Bearbeitung_freigeben Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben]".

'''Zur Veröffentlichung und Freischaltung gehen Sie wie folgt vor:'''

# Öffnen Sie das Dashboard, welches veröffentlicht werden soll.
# Durch Klick auf das '''graue Feld "Entwurf"''' neben dem Dashboard Namen, ändert sich die Bezeichnung auf '''"Veröffentlicht".'''[[Datei:ImageStatusVeroeffentlichtSuperset.png|zentriert|mini|435x435px|Durch Klick ändert sich der Status von "Entwurf" auf "Veröffentlicht".]]
# Öffnen Sie rechts oben das '''Dreipunktemenü''' und wählen Sie dort den Unterpunkt '''"Dashboard einbetten"''' aus.[[Datei:ImageDashboardEinbettenSuperset.png|zentriert|mini|317x317px|Im Dreipunktemenü muss im nächsten Schritt der Punkt "Dashboard einbetten" geklickt werden.]]
# Im Einbetten-Dialog lassen Sie das Feld für "Zulässige Domänen" bitte einfach frei und klicken lediglich den '''Button "Einbettung aktivieren".''' Dann kann das Menü durch Klick auf das '''X-Symbol''' geschlossen werden.[[Datei:ImageEinbettungAktivierenSuperset.png|zentriert|mini|378x378px|Im Menü "Einbetten" klicken Sie auf "Einbettung aktivieren" und dann einfach auf das X um das Fenster zu schließen.]]
# Um das Dashboard nun für die '''Rolle der Sachbearbeitenden und Mandanten-Administratoren''' im DiPlan Cockpit '''freizugeben''' öffnen Sie bitte erneut den Reiter '''"Dashboards",''' um auf die Liste mit allen Dashboards zu gelangen.
# Klicken Sie auf das '''Stift-Symbol''' neben dem Dashboard, welches freigeschalten werden soll.[[Datei:ImageDashboardEigenschaftenOeffnenSuperset.png|zentriert|mini|398x398px|Durch Klick auf das Stiftsymbol neben dem Dashboard werden die Dashboardeigenschaften geöffnet. Dort können auch die einzelnen Rollen freigeschaltet werden.]]
# In den '''Dashboardeigenschaften''' können nun die Rollen eingetragen werden, für die das Dashboard freigeschalten werden soll. Die Rollenbezeichnungen in Superset fassen mehrere Rollen aus dem DiPlan Cockpit zusammen, was die Freigabe von Dashboards vereinfacht. Bitte tragen Sie im Feld "Rollen" deshalb '''"Reporting-Administrator"''' und '''"Sachbearbeiter" in der Liste ein.''' Dies ist durch Tippen in das Feld möglich, so wird die auszuwählende Rolle schneller sichtbar. Sie können jedoch auch manuell durch die Liste scrollen und die Rolle auswählen. Klicken Sie anschließend den '''"Speichern"-Button'''. Die Auswertungen sind nun im DiPlan Cockpit für alle berechtigten Rollen sichtbar.[[Datei:ImageDashboardEigenschaftenRollenSuperset.png|zentriert|mini|395x395px|In den Dashboardeigenschaften müssen die Rollen, für die das Dashboard freigegeben werden soll, ausgewählt werden.]]
'''Hinweis: Veröffentlichung zurücknehmen'''

Sollten Sie ein Dashboard im DiPlan Cockpit unsichtbar machen wollen, so klicken Sie wie im Punkt 2 beschrieben wieder auf die graue Schaltfläche und setzen Sie den Status von '''"Veröffentlicht"''' zurück auf '''"Entwurf".'''

=== Bestehendes Dashboard oder Diagramm bearbeiten oder löschen ===
'''Wie lösche ich ein eingebettetes Diagramm von einem bereits veröffentlichten und freigegebenen Dashboard?'''

* Öffnen Sie das Dashboard und '''klicken Sie "Dashboard bearbeiten"''' auf der rechten Bildschirmseite.
* Im geöffneten Bearbeitungsmodus können Sie nun die Maus über das nicht mehr erwünschte Diagramm bewegen und durch '''Klick auf das erscheinende Mülleimersymbol''' löschen. Das Diagramm bleibt in der Liste der Diagramme weiterhin erhalten und wird lediglich vom Dashboard genommen.
* Sie können ein '''weiteres/neues Diagramm''' jederzeit wieder aus der Liste rechts auf das Dashboard ziehen.
* Bestätigen Sie das veränderte Dashboard durch Klick auf den "'''Speichern"-Button''' rechts oben.
* '''Bitte beachten:''' Änderungen an bereits veröffentlichten und freigegebenen Dashboards werden nach dem '''Speichern direkt auf dem DiPlan Cockpit sichtbar'''.
[[Datei:ImageDashboardDiagrammLoeschenSuperset.png|zentriert|mini|370x370px|Per Mouseover und Klick auf das Mülleimer Symbol lassen sich Diagramme auf Dashboards einfach wieder löschen.]]
'''Wie bearbeite ich ein bestehendes Diagramm?'''

Ein Diagramm unabhängig vom Dashboard ändern:

* Öffnen Sie das zu bearbeitende Diagramm in der '''Liste der Diagramme''' durch einen '''Klick auf den Namen'''.
* Das Diagramm öffnet sich direkt im Bearbeitungsmodus und kann nach '''Belieben angepasst werden'''.
* Ist das Diagramm bereits auf einem veröffentlichten und freigegebenen Dashboard eingebettet, so werden alle Änderungen nach dem Speichern direkt übernommen und im '''DiPlan Cockpit sichtbar'''.

Ein Diagramm direkt auf einem Dashboard ändern:

* Öffnen Sie das Dashboard und klicken Sie '''"Dashboard bearbeiten"'''.
* Bewegen Sie die Maus über die entsprechende Grafik, öffnen Sie das Dreipunktemenü rechts und klicken '''"Diagramm bearbeiten".'''
* Nachdem Sie das Diagramm bearbeitet haben klicken Sie '''"Speichern"'''.

'''Bitte beachten:''' Im Speichern-Dialog können Sie entscheiden, ob sie das bestehende '''Diagramm überschreiben''' oder ein '''neues Diagramm speichern''' wollen. Dies kann hilfreich sein, wenn Sie das Diagramm nicht generell, sondern nur auf einem bereits bestehenden Dashboard ändern wollen.
[[Datei:ImageDiagrammSpeichernÜberschreibenSuperset.png|zentriert|mini|383x383px|Es ist möglich direkt beim Speichern ein neues Diagramm zu erstellen oder das bereits bestehende zu überschreiben.]]

'''Wie lösche ich ein Dashboard oder Diagramm dauerhaft?'''

Sie können ein Dashboard unabhängig vom Status (also veröffentlicht oder auch als Entwurf) in der Liste der Dashboards wie folgt löschen:

* Bewegen Sie die Maus über den entsprechenden '''Listeneintrag.'''
* Klicken Sie das in der Zeile rechts erscheinende '''Papierkorb-Symbol''' und folgen den Anweisungen im erscheinenden Löschdialog.
* Die Originaldiagramme auf dem Dashboard bleiben dabei weiterhin in der Liste "Diagramme" erhalten.
* Sollten Sie ein Diagramm dauerhaft löschen wollen, so gehen Sie genauso wie beim Dashboard vor, jedoch im '''Reiter "Diagramme"'''.

=== Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Bitte beachten:''' Solange Reporting-Administratoren nicht als Besitzer eingetragen sind, haben diese nur Zugriff auf die eigenen erstellten Daten.

'''Das bedeutet konkret für die erstellten Daten von anderen Reporting-Administratoren:'''

* Unveröffentlichte Dashboards sind nicht sichtbar.
* Veröffentlichte Dashboards sind sichtbar, aber nicht bearbeitbar.
* Alle Diagramme sind sichtbar, Änderungen können jedoch nur als neue Diagramme gespeichert werden.
* Datensätze sind sichtbar und können verwendet, aber nicht bearbeitet werden.
* Gespeicherte Abfragen sind nicht sichtbar (Berechtigungen können hier grundsätzlich nicht vergeben werden).

Sie haben grundsätzlich keine Rechte ein Dashboard zu bearbeiten oder ein Diagramm zu überschreiben, welches nicht von Ihnen erstellt wurde, außer Sie wurden als '''"Besitzende/r"''' dazu ermächtigt.

Das bedeutet beispielsweise, dass Sie ein Diagramm, welches jemand anders erstellt hat, zwar bearbeiten, dies aber nur als neues Diagramm abspeichern können. Das Originaldiagramm wird hier nicht verändert. Um jemanden für die '''Mitarbeit an Ihrem Diagramm oder Dashboard zu ermächtigen''' gehen Sie wie folgt vor:

* Klicken Sie in der Liste der Diagramme oder Dashboards auf das '''Stift-Symbol "Bearbeiten".''' Der Dialog '''"Diagrammeigenschaften bearbeiten"''' öffnet sich.
* Unter der '''Überschrift "Zugang"''' können weitere '''"Besitzende" eingetragen''' werden. Klicken Sie hierzu in das Eingabefeld und fangen Sie an den Namen zu tippen oder scrollen Sie durch die Liste bis zum gewünschten Namen.
* '''Wählen Sie einen oder mehrere Namen aus,''' um diese in das Feld zu übernehmen und klicken Sie dann auf '''"Speichern"'''. Die eingetragene Person hat nun die gleichen '''Rechte zur Bearbeitung wie der/die ursprüngliche Ersteller/in'''.[[Datei:ImageDiagrammZugangBesitzendeSuperset.png|zentriert|mini|425x425px|Unter "Zugang" können Sie andere Mandanten-Administratoren für die Bearbeitung Ihrer Dashboards oder Diagramme berechtigen.]]

=== Datensätze für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Um Datensätze für andere Reporting-Administratoren zur Bearbeitung freizugeben, gehen Sie wie folgt vor:'''

* Klick auf den '''Reiter "Datensätze"'''
* In der Übersicht-Liste klicken Sie bitte das '''Stift- Symbol''' neben dem gewünschten Datensatz.
* Klicken Sie den '''Reiter "Einstellungen"''' ganz rechts und scrollen Sie ganz nach unten.
* Dort können Sie im '''Feld "Besitzende"''' auch andere Reporting-Administratoren zur Bearbeitung berechtigen.
[[Datei:ImageDatensatzBesitzendeSuperset.png|zentriert|mini|338x338px|Auch Datensätze können zur Bearbeitung an andere Mandanten-Administratoren freigegeben werden.]]

== Weiterführende Informationen ==
Unter folgendem Link können Sie weitere Informationen zu Superset in englischer Sprache finden. Bitte beachten Sie, dass Ihre Datenbank bereits angebunden ist und der Punkt "Connecting to a new database" in der Dokumentation somit nicht beachtet werden sollte: '''[https://superset.apache.org/docs/6.0.0/using-superset/creating-your-first-dashboard#creating-your-first-dashboard Englische Dokumentation des Open-Source-Tools Superset]'''

Datei:ImageDatensatzBesitzendeSuperset.png

2026-03-16T14:27:08Z

Diplanung:

ImageDatensatzBesitzendeSuperset

Reporting: Auswertungen im DiPlan Cockpit

2026-03-16T14:04:59Z

Diplanung: /* Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben */

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

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

⚠️ '''Bitte beachten: Die Reporting-Funktionalität wird nach und nach Mandanten spezifisch freigeschaltet. Informationen zur Funktionsweise finden Sie hier vorab.'''

== Einleitung ==
Die Auswertungskomponente für das DiPlan Cockpit ermöglicht das Abrufen, Filtern und Downloaden von Reports und Auswertungen aus Planungs- und Genehmigungsverfahren. Die Auswertungsdiagramme zu individuellen Fragestellungen werden in dem externen BI-Tool Superset von berechtigten Personen auf Basis grundlegender SQL- und Datenmodell-Kenntnisse erstellt, verwaltet, auf Dashboards zusammengestellt und schließlich für die Darstellung im DiPlan Cockpit freigegeben.

== Aufruf der Auswertungen ==
Die Auswertungen sind in dem gleichnamigen Reiter im DiPlan Cockpit zu finden.

In der linken Bildschirmhälfte sind die Namen der jeweiligen zur Verfügung stehenden Dashboards zu finden. Ein Dashboard ist eine Zusammenstellung von einem oder mehreren Auswertungsdiagrammen auf einer Seite. Standardmäßig wird das Dashboard "Verfahrensstand aller Verfahren" für jeden Mandant initial mit ausgerollt. Alle weiteren Dashboards können je nach Bedarf individuell durch berechtigte Personen je Mandant erstellt werden. Mehr dazu findet sich im Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Auswertungen_erstellen.2C_ver.C3.B6ffentlichen_und_freigeben Auswertungen erstellen, veröffentlichen und freigeben].

'''Gut zu wissen:'''

* '''Datengrundlage:''' Grundsätzlich fließen gelöschte Verfahren nicht in die Auswertungen ein.
* '''Aktualität der Daten:''' Die Daten werden jede Nacht einmal mit der DiPlan Cockpit Datenbank synchronisiert.
* '''Darstellung:''' Das Reporting wird mit dem Tool Superset umgesetzt, welches in das DiPlan Cockpit eingebunden wird. Für eine optimale Darstellung nutzen Sie bitte den Browser Microsoft Edge.
[[Datei:ImageAuswertungenCockpit.png|zentriert|mini|717x717px|Ansicht des Reiters "Auswertungen" im DiPlan Cockpit mit dem Standarddashboard "Verfahrensstand aller Verfahren".]]

== Filtern der Dashboards bzw. Auswertungen ==
Je nach Art der dargestellten Auswertungen können Sie weitere Aktionen in den einzelnen Diagrammen vornehmen. Oftmals sind zum Beispiel verschiedene Filterungsmöglichkeiten hinterlegt. Zum Öffnen der Filter gehen Sie bitte folgendermaßen vor:

* Aufklappen der Filter durch Klick auf den kleinen blauen Pfeil links neben den Diagrammen. Alternativ können die Filter auch am oberen Rand des Dashboards eingebunden sein.
* Auswählen der gewünschten Filter.
* Klick auf "Filter anwenden".
* Bei Klick auf "Alles löschen" werden sämtliche gesetzte Filter wieder zurückgesetzt.
[[Datei:ImageAuswertungenCockpitFilter.png|zentriert|mini|742x742px|Falls eine Filterung im Dashboard integriert wurde, so lässt diese sich über den kleinen Pfeil ausklappen oder befindet sich am oberen Rand des Dashboards. Hier zu sehen eine Filterung auf dem Dashboard nach Zuständigkeit oder Verfahrenstyp.]]
[[Datei:ImageAuswertungenCockpitFilter2.png|zentriert|mini|742x742px|Das Reporting bietet die Möglichkeit auch mehrere verschiedene Diagrammtypen auf einem Dashboard darzustellen. Diese können von Mandanten-Administratoren konfiguriert und freigegeben werden. Hier ein Beispiel mit integrierten Filtern am oberen Rand des Dashboards.]]

== Download der Auswertungen ==
Neben jeder Auswertungsgrafik (jedem Diagramm) finden sich drei Punkte, welche bei Klick ein Drop-Down Menü öffnen. Durch '''Mouseover auf "Herunterladen"''' öffnet sich das Menü zum Download des Diagramms in verschiedenen auswählbaren Formaten. Hier sind folgende Punkte zu beachten:

* '''Der Download entspricht immer der Filterung:''' Wird eine Grafik durch eine Filterung angepasst und dann ein Download gestartet, so entsprechen die heruntergeladenen Daten immer genau der Filterung, das heißt es sind nicht alle Daten vorhanden. Je nach Grafik ist in den heruntergeladenen Dateien nicht selbsterklärend, dass eine Filterung angewendet wurde und es ist wichtig das Downloadergebnis bei der weiteren Verwendung in den richtigen Kontext zu setzen. Laden Sie sich alternativ die Daten ohne Filterung herunter und filtern Sie zum Beispiel bei Bedarf gesondert in MS Excel.
* '''Die Rollen der Sachbearbeitenden sehen nur die eigene Zuständigkeit:''' Je nach Rolle der Nutzenden werden unter Umständen nicht alle Daten auf den Dashboards dargestellt. Sachbearbeitende können nur Daten der eigenen Zuständigkeit sehen. Siehe dazu auch das nächste Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Rechte_und_Rollen Rechte und Rollen].
[[Datei:ImageAuswertungenHerunterladen.png|zentriert|mini|327x327px|Das vertikale Dreipunktemenü in den Diagrammen beinhaltet die Herunterladen-Funktion.]]

== Rechte und Rollen ==
Alle Rollen aus dem DiPlan Cockpit werden gemäß ihrer Berechtigungen mit einer entsprechenden Rolle in Superset versehen. Prinzipiell gibt es zwei relevante Rollen, denen die Nutzenden in Superset zugeordnet werden. Dies passiert automatisch und regelt ob die Nutzenden berechtigt sind Auswertungen selbst anzulegen, freizugeben und zu veröffentlichen oder ob sie ausschließlich die freigegebenen Auswertungen gemäß ihrer Zuständigkeit im DiPlan Cockpit sehen können. Nachfolgend sehen Sie eine Übersicht über die verschiedenen Berechtigungen:
{| class="wikitable"
|'''Rolle DiPlan Cockpit'''
|'''Rolle Superset'''
|'''Berechtigungen'''
|-
|'''EfA Cockpit Pro'''
* M-A = Mandanten-Administration
* FP-A = Fachplanung-Administration

'''EfA Cockpit Basis'''

* M-A-Basis = Mandanten-Administration-Basis
* FP-A-Basis = Fachplanung-Administration Basis
|'''Reporting-Administrator'''
|
* Kann direkt aus dem DiPlan Cockpit zu Superset abspringen und ist dort automatisch eingeloggt (SSO).
* Kann Datensätze (Superset-spezifische Zwischenschicht zwischen DB-Tabelle und Abfrage) erstellen.
* Kann Auswertungen/Diagramme in Superset erstellen.
* Kann Dashboards mit verschiedenen Auswertungen/Diagramme zusammenstellen.
* Kann Dashboards freigeben für den ganzen Mandanten (z.B. ganz Hamburg).
* Kann alle Daten im Dashboard eines Mandanten sehen.
* Kann Abfragen filtern, also z.B. in Hamburg nach Belieben nach Bezirk (Zuständigkeit) z.B. Altona oder Senat.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
* Kann andere Reporting-Administratoren für die eigenen Dashboards/Diagramme als Besitzer eintragen, um diese für die Bearbeitung, Freischaltung und Veröffentlichung zu berechtigen.
|-
|''''''EfA Cockpit Pro''''''
* FP-VM = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)

'''EfA Cockpit Basis'''

* FP-VM-Basis = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB-Basis = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)
|'''Sachbearbeiter'''
|
* Sieht ausschließlich die vorgefilterten Daten entsprechend der eigenen Zuständigkeit (also z.B. Altona).
* Kann Auswertungen herunterladen, aber nur mit den Daten der eigenen Zuständigkeit.
* Kann freigegebene Dashboards betrachten.
* Kann Auswertungen filtern, wenn Filter eingerichtet wurden.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
|}

== Superset als zentrales Tool für Reporting-Administratoren ==

=== Übergreifende Informationen zu Superset ===
Für die Erstellung und Darstellung des Reportings wurde das Open-Source-Tool Apache Superset in das DiPlan Cockpit implementiert. Superset ist eine Reporting- und Monitoring-Technologie, die es ermöglicht komplexe Daten auf Dashboards in leicht verständlichen Visualisierungen darzustellen. Die Erstellung der Dashboards erfolgt dabei direkt in der Superset-Anwendung. Dort wird auch gesteuert, welche Dashboards mit welchen Auswertungen im DiPlan Cockpit veröffentlicht werden sollen.

=== Absprung aus dem DiPlan Cockpit zu Superset ===
Sobald eine Rolle für die Erstellung von Auswertungen berechtigt ist (zum Beispiel M-A oder FP-A), findet sich im Reiter Auswertungen automatisch der Button '''"Auswertungen konfigurieren"'''. Bei Klick öffnet sich ein weiteres Browserfenster mit der Superset-Plattform. Eine gesonderte Anmeldung in Superset ist nicht erforderlich, da die Anmeldung durch das Cockpit erfolgt (auch Single Sign-On (SSO) genannt).

'''Bitte beachten:''' Nach 4 Stunden erfolgt aus Sicherheitsgründen ein automatischer Logout aus Superset - unabhängig davon ob Sie gerade in Superset arbeiten oder nicht aktiv waren. Sie erhalten keine Warnung vor dem Logout. Deshalb empfiehlt es sich, Änderungen regelmäßig zu speichern, um zu verhindern, dass ungesicherte Abfragen verloren gehen.
[[Datei:ImageButtonAuswertungenKonfigurieren.png|zentriert|mini|491x491px|Berechtigte Personen sehen über den Dashboards im DiPlan Cockpit einen Absprungbutton zu Superset mit der Bezeichnung "Auswertungen konfigurieren."]]
[[Datei:ImageStartbildschirmSuperset.png|zentriert|mini|508x508px|Startbildschirm in Superset mit einer Vorschau auf Dashboards und Diagrammen. Die Hauptmenüpunkte zur Navigation sind am oberen Bildschirmrand zu sehen.]]

=== Auswertungen erstellen, veröffentlichen und freigeben ===
Datenvisualisierungen von Abfragen werden in Superset als '''"Diagramme"''' bezeichnet. Sobald mindestens ein Diagramm erstellt ist, kann dieses auf einem Dashboard integriert werden und mit weiteren Filtermöglichkeiten versehen werden. Wie bereits erwähnt, können Sie als '''Reporting-Administrator''' selbst nach Belieben Diagramme erstellen. Nachfolgend wird beispielhaft die Erstellung und Freigabe des Dashboards mit dem Diagramm "Verfahrensstand aller Verfahren" beschrieben, um einige der Grundfunktionalitäten in Superset zu verdeutlichen (siehe dazu das Kapitel: "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]").

=== Datensätze erstellen ===
Um ein Diagramm zu erstellen wird zunächst ein Datensatz benötigt. Für einfache Abfragen reicht der '''Verfahrensdatensatz''' aus, der bereits standardmäßig enthalten ist. Dieser entspricht der '''Tabelle "Verfahren"''' mit den '''zugehörigen Datenfeldern (Stammdaten)'''.

Für Abfragen auf dem Verfahrensdatensatz können Sie direkt zum Abschnitt "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]" springen.

Für komplexere '''Abfragen über mehrere Tabellen hinweg, eigene Metriken oder eigene berechnete Spalten''' ist die Erstellung eines eigene Datensatzes mithilfe von SQL-Abfragen notwendig. Folgende Informationen sind in gesonderten Tabellen enthalten:

* Gebietseinheiten
* Kontakte
* Nutzer
* Parallelverfahren
* Termine
* Veränderungssperren
* Vertragsarten
* Vorgesehene Nutzungen
* Zurückstellungen

'''Bitte beachten:''' Bei der Erstellung von eigenen Datensätzen, muss die Spalte "'''''zustaendigkeit_code"''''' aus der Tabelle "'''''verfahren"'' immer enthalten sein,''' da hierüber die Ansicht für Sachbearbeiter standardmäßig gefiltert wird.

'''Um eigene Datensätze zu erstellen gehen Sie bitte wie folgt vor:'''

* Klick im Hauptmenü auf den '''Reiter "SQL"''' und im zugehörigen Dropdown-Menü auf '''"SQL Lab".'''
[[Datei:ImageStartSQLLab.png|zentriert|mini|576x576px|Startansicht SQL Lab]]
* Erstellen Sie Ihre '''SQL-Abfrage''' und klicken Sie auf den '''Button "Ausführen"''', um eine Vorschau auf die Ergebnisse der Abfrage zu erhalten. Ein rotes Kreuzchen links vom SQL-Editor weist auf Fehler im SQL hin.
[[Datei:ImageAusfuehrenSQLLab.png|zentriert|mini|576x576px|Ausführen einer SQL Abfrage im SQL Lab]]
'''Typische Anwendungsfälle und die dazugehörigen SQL Abfragen könnten z.B. sein:'''

* Sie möchten, dass Ihre Abfragen z.B. nach "Gebietseinheiten" und "Vorgesehenen Nutzungen" gefiltert werden können:

{| class="wikitable"
|
SELECT v.*, g.gebietseinheit, vn.vorgesehene_nutzungen
FROM verfahren v
LEFT JOIN gebietseinheiten g ON g.verfahren_id = v.id
LEFT JOIN vorgesehene_nutzungen vn ON vn.verfahren_id = v.id;
|}

* Sie möchten, dass Ihr Datensatz bestimmte Termine enthält (z.B. Grobabstimmungsdatum, Vorweggenehmigungsreife):

{| class="wikitable"
|
WITH grobabstimmung_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Grobabstimmung'
),
vorweggenehmigungsreife_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Vorweggenehmigungsreife'
)
SELECT
v.*,
t1.beginn AS grobabstimmung,
t2.beginn AS vorweggenehmigungsreife
FROM verfahren v
LEFT JOIN grobabstimmung_termin t1 ON t1.verfahren_id = v.id
LEFT JOIN vorweggenehmigungsreife_termin t2 ON t2.verfahren_id = v.id;
|}

* '''Speichern Sie Ihre Abfrage als Datensatz''' ab, indem Sie auf den '''Dropdown-Pfeil neben dem Button "Speichern"''' klicken und dann '''"Datensatz speichern"''' auswählen. Es öffnet sich ein Dialogfeld, in dem Sie einen Namen für Ihren Datensatz vergeben können.
** Hinweis: Wenn Sie statt auf "Datensatz speichern" auf "Speichern" klicken, finden Sie Ihre SQL Abfrage unter dem Reiter '''"Gespeicherte Abfragen"''' wieder.
[[Datei:ImageSpeichernDatensatzSuperset.png|zentriert|mini|581x581px|Speichern eines neuen Datensatzes]]
Nach der Erstellung eines Datensatzes können Sie diesen noch weiter bearbeiten und Labels, eigene Metriken oder berechnete Spalten hinzufügen. Gehen Sie dazu wie folgt vor:
* Klick im Hauptmenü auf den '''Reiter "Datensätze"'''. Hier sind die verfügbaren Datensätze aufgelistet.
* Klicken Sie ganz rechts neben dem Datensatz, den Sie bearbeiten wollen, auf das '''Stift-Symbol.''' Es öffnet sich eine Bearbeitungsmaske.
[[Datei:ImageBearbeitungDatensatzSuperset.png|zentriert|mini|427x427px|Öffnen Sie den Bearbeitungsmodus durch Klick auf das Stiftsymbol]]
*'''Reiter "Quelle":''' Hier kann die zugrundeliegende SQL Abfrage nachträglich angepasst werden. Klicken Sie hierfür auf das Schloss-Symbol.
[[Datei:ImageReiterQuelleSuperset.png|zentriert|mini|411x411px|Im Reiter "Quelle" kann das SQL nachträglich angepasst werden]]
*'''Reiter "Metriken":''' Hier können eigene Metriken angelegt werden.
[[Datei:ImageReiterMetrikenSuperset.png|zentriert|mini|350x350px|Eine neue Metrik "Anzahl Verfahren" wird hinzugefügt]]
*'''Reiter "Spalten":''' Hier sind alle im Datensatz enthaltenen Spalten aufgeführt. An den Werten in der Tabelle ("Datentyp", "Ist zeitlich" etc.) sollte in der Regel nichts geändert werden, dies wird von Superset automatisch richtig erkannt. Beim '''Klick auf das "Plus"''' neben jeder Spalte kann unter "Beschriftung" ein sprechendes Label hinzugefügt werden. Dieses wird später in den Diagrammen angezeigt.
[[Datei:ImageReiterSpaltenSuperset.png|zentriert|mini|470x470px|Im Reiter "Spalten" wird ein Label hinzugefügt]]
*'''Reiter "Berechnete Spalten":''' Hier können dem Datensatz weitere Spalten hinzugefügt werden, die Werte enthalten, die aus anderen Spalten errechnet werden. Verwenden Sie für die Berechnung SQL-Syntax.
[[Datei:ImageReiterBerechneteSpaltenSuperset.png|zentriert|mini|416x416px|Eine berechnete Spalte wird hinzugefügt]]
* Speichern Sie Ihre Änderungen am Datensatz durch das '''Klicken auf den "Speichern"-Button'''. Um die Änderungen zu prüfen, empfiehlt es sich ein Diagramm mit dem Datensatz anzulegen (z.B. eine Tabelle).

=== Beispiel-Diagramm erstellen ===
Nachfolgend soll beispielhaft ein Diagramm "Verfahrensstand aller Verfahren" erstellt werden. Dazu gehen Sie wie folgt vor:

# Klick auf den '''Menüpunkt "Diagramme":''' Auf dieser Seite findet sich eine Liste mit allen bereits erstellten Diagrammen. Innerhalb dieser Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Diagramm-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageUebersichtDiagrammeSuperset.png|zentriert|mini|501x501px|Im Menüpunkt "Diagramme" findet sich eine Übersicht über die bisher erstellten Diagramme (Abfragen) mit vielen Zusatzinformationen.]]
# Um ein neues Diagramm zu erstellen klicken Sie auf den '''Button "+Diagramm"''' rechts oben. Es öffnet sich der Dialog '''"Neues Diagramm erstellen".'''[[Datei:ImageNeuesDiagrammSuperset.png|zentriert|mini|487x487px|Dialog um ein neues Diagramm zu erstellen]]
# Zunächst muss der '''passende Datensatz für die Auswertung ausgewählt''' werden. Für dieses Beispiel wählen wir unter '''"1- Datensatz auswählen"''' den Datensatz '''"verfahren"''' im Dropdownmenü aus.
# Im nächsten Schritt wird der '''passende Diagrammtyp ausgewählt'''. Hier werden Ihnen viele verschiedene Visualisierungsmöglichkeiten geboten. Im genannten Beispiel passt ein "Kreisdiagramm" am besten zu der Visualisierung der Verfahrensstände aller Verfahren. Sie finden das Kreisdiagramm unter dem Hauptmenü "Teil des Ganzen". Klicken Sie '''auf das Kreisdiagramm''' und anschließend auf '''"Neues Diagramm erstellen"'''.
# Nun geht es um die '''Detailkonfiguration''' des Diagramms. Grundsätzlich ist der Arbeitsbereich wie folgt aufgebaut:
#* Die linke Spalte enthält einen '''Überblick''' über die '''zur Verfügung stehenden Daten'''.
#* Die mittlere Spalte enthält die '''Werkzeuge''', um das '''Diagramm zu konfigurieren.'''
#* Im rechten Bereich kann man sich jeweils eine '''Vorschau des Diagramms''' anzeigen lassen.
'''Wir gehen für unser Beispiel wie folgt vor:'''

* Im Feld '''"Name des Diagramms hinzufügen"''' das Diagramm mit einer passenden Bezeichnung versehen.
* Um die Dimensionen des Diagramms festzulegen im Tab '''"Daten"''' unter der Überschrift '''"Abfrage > Dimensionen"''' die Spalte '''"verfahrensstand"''' von links per Drag & Drop herüberziehen.
* Der dazustellende Wert soll hier die Anzahl sein, weshalb nun unter '''"Metrik"''' das Feld '''"Anzahl"''' Button "+Diagramm" per Drag & Drop von links herübergezogen wird. Je nach Fragestellung bzw. welche Daten auf dem Diagramm dargestellt werden sollen, können verschiedenste Kombinationen in der selben Art und Weise über Drag & Drop zusammengestellt werden.
* Unter dem '''Punkt "Filter"''' kann eine Vorabfilterung eingebaut werden, also beispielsweise könnten Sie simulierte Verfahren standardmäßig herausfiltern, so dass die Nutzenden diese gar nicht auswerten können. Anmerkung: "imported_at" kann nicht gelöscht werden. Dieser Wert wird von Superset standardmäßig gesetzt und hat keine Auswirkung auf Ihre Auswertungen.
* Das für die Berechnung zugrundeliegende Zeilenlimit kann bei Bedarf verändert werden.
* Ein Klick auf den '''blauen Button "Diagramm erstellen"''' zeigt eine '''Vorschau''' des erstellten Diagrammes auf der rechten Bildschirmhälfte. Das Diagramm kann nun jederzeit mit einem '''Klick auf "Speichern"''' rechts oben gesichert werden.[[Datei:ImageDiagrammErstellenSuperset.png|zentriert|mini|426x426px|Dialog zur Detaildefinition des neuen Diagramms. Hier beispielhaft zusammengestellt für die Darstellung "Verfahrenstand aller Verfahren".]]

* Unter dem '''Tab "Anpassen"''' finden sich zahlreiche Möglichkeiten, das Diagramm weiter zu verfeinern (zum Beispiel in Farbe und Layout). Hier kann ganz nach Belieben ausprobiert werden. Mit '''Klick auf''' '''"Diagramm aktualisieren"''' kann die Vorschau des Diagramms zur Überprüfung mit den neu gewählten Einstellungen geladen werden.[[Datei:ImageDiagrammAnpassenSuperset.png|zentriert|mini|421x421px|Diagramm kann nach Belieben im Tab "Anpassen" verändert und verfeinert werden.]]
* '''Speichern nicht vergessen:''' Das Diagramm wird erst gespeichert durch '''Klick auf "Speichern" rechts oben'''. Es öffnet sich ein Dialog zu weiteren Speicheroptionen, der mit '''einer weiteren Speicherbestätigung''' abgeschlossen werden kann.[[Datei:ImageDiagrammSpeichernSuperset.png|zentriert|mini|427x427px|Speichern-Dialog für das erstellte Diagramm]]

=== Beispiel-Dashboard erstellen ===

# '''Klick auf den Menüpunkt "Dashboards":''' Unter der Überschrift "Dashboards" findet sich eine Liste mit allen bereits erstellten Dashboards. Diese Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Dashboard-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageDashboardsSuperset.png|zentriert|mini|452x452px|Unter dem Menüpunkt "Dashboards" finden sich alle bereits angelegten Dashboards, sowie die Möglichkeit neue Dashboards zu erstellen.]]
# Mit Klick auf den Button '''"+Dashboard"''' rechts oben öffnet sich ein neuer, leerer Dashboard -Entwurf.
# Der Titel des Dashboards ist standardmäßig als "untitled dashboard" angeben und kann durch '''Klick auf den Namen''' geändert werden.
# Auf der Seitenleiste am rechten Bildschirmrand finden sich alle bereits erstellten Diagramme. Das gewünschte Diagramm kann einfach durch '''Drag & Drop mit der Maus auf das Dashboard gezogen''' werden. Auch die Größe kann leicht geändert werden indem sie die Ränder oder Ecken des Diagramms klicken, gedrückt halten und auf die gewünschte Größe ziehen. Sie können ein oder auch mehrere Diagramme auf einem Dashboard platzieren.
# Zu guter Letzt oben rechts auf den '''Button "Speichern"''' klicken um Ihre Arbeit zu sichern. Nach dem Speichern können Sie jederzeit am Dashboard weiter arbeiten indem Sie auf den nun erscheinenden Button '''"Dashboard bearbeiten"''' klicken.
# Sollten Sie ein Diagramm wieder vom Dashboard löschen wollen, können Sie einfach das '''Mülleimer-Symbol''' klicken, welches bei Mouseover über das jeweilige Diagramm erscheint.[[Datei:ImageDragDropDiagrammSuperset.png|zentriert|mini|351x351px|Das gewünschte Diagramm kann mit der Maus einfach auf das Dashboard gezogen und platziert werden.]]
[[Datei:ImageDiagrammGroesseSuperset.png|zentriert|mini|325x325px|Die Größe des Diagramms lässt sich einfach durch Ziehen der Maus an Ecken oder Rändern verändern.]]

=== Einen oder mehrere Filter zu einem Dashboard zufügen ===
Es ist möglich Ihre Auswertungsdiagramme mit Filtermöglichkeiten zu versehen. Im folgenden wird beispielhaft ein Filter nach der Zuständigkeit auf dem Dashboard "Verfahrensstand aller Verfahren" hinzugefügt:

# Öffnen Sie das Dashboard oder legen Sie sich ein entsprechendes neues Dashboard an und speichern dieses.
# An der linken Bildschirmkante den '''kleinen Pfeil klicken''', um das Filtermenü auszuklappen. '''Wichtig:''' Der Pfeil ist nur sichtbar, wenn das Dashboard bereits gespeichert ist und sich nicht gerade im offenen Bearbeitungsmodus befindet. Sprich: Klicken Sie '''nicht''' "Dashboard bearbeiten" bevor Sie den Filter hinzufügen.
# Klicken Sie auf das '''kleine Zahnrad''' um das Untermenü zu öffnen.
# Ein Klick auf '''"Hinzufügen und Bearbeiten von Filtern"''' öffnet das Menü um die Filter zu konfigurieren.[[Datei:ImageDashboardFilterMenueSuperset.png|zentriert|mini|372x372px|Durch Klick auf den kleinen Pfeil öffnet sich das Menü, mit dem Filter hinzugefügt und konfiguriert werden können.]]
# Um nach der Zuständigkeit zu filtern muss im '''Menü Filtertyp die Option "Wert"''' ausgewählt sein.
# Im Menüpunkt Tabellenname '''"Zuständigkeit"''' als '''Namen des Filters''' eintragen.
# Im '''Feld Datensatz''' wird in diesem Fall '''"verfahren"''' ausgewählt.
# Im '''Feld "Spalte"''' den Filter auswählen, nach dem gefiltert werden soll: in diesem Fall '''"zustaendigkeit".'''
# Das Menü '''"Filterwerte sortieren"''' durch einen Haken aktivieren und absteigend sortieren und mit der '''Sortiermetrik "Anzahl"''' versehen.
# Im '''Reiter "Auswahlverfahren"''' kann der Filter durch eine Auswahl außerdem auf '''einzelne Diagramme oder auf alles bezogen''' werden.
# Durch '''Klick auf "Speichern"''' rechts unten wird der Filter in das Dashboard integriert.[[Datei:ImageFilteroptionenDashboardSuperset.png|zentriert|mini|431x431px|Sie können einen oder mehrere Filteroptionen auf einem Dashboard integrieren und in diesem Menü konfigurieren.]]
'''Übergeordnete Filtereinstellungen:'''

Nach '''Klick auf das Zahnrad''', im geöffneten Filter-Untermenü, können Sie außerdem entscheiden, ob der Filter '''oben''' über dem Diagramm '''oder seitlich links einklappbar''' angezeigt werden soll.

Es gibt dort außerdem die Möglichkeit für ein oder mehrere Diagramme eine '''Kreuzfilterung zu aktivieren.''' Diese erlaubt es Ihnen, direkt '''in einem Diagramm auf ein Element zu klicken''', um damit automatisch eines oder alle Diagramme im Dashboard zu filtern. So können Daten intuitiv und interaktiv erkundet werden, ohne separate Filtersteuerungen zu verwenden.
[[Datei:ImageFilterUntermenueSuperset.png|zentriert|mini|440x440px|Im Filter-Untermenü können bestehende Filter bearbeitet oder weitere Filter hinzugefügt werden. Außerdem kann die Kreuzfilterung aktiviert und die Darstellung der Filterleiste verändert werden.]]

=== Dashboards veröffentlichen ===
Dashboards werden erst im DiPlan Cockpit sichtbar, nachdem diese veröffentlicht und für die Sachbearbeitenden und Reporting-Administratoren freigeschalten wurden. Dabei gilt es zu beachten, dass Sie nur Dashboards veröffentlichen und freischalten können, die Sie selbst erstellt haben oder für die Sie berechtigt worden sind. Siehe hierzu auch das Kapitel "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Diagramme_und_Dashboards_f.C3.BCr_andere_Reporting-Administratoren_zur_Bearbeitung_freigeben Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben]".

'''Zur Veröffentlichung und Freischaltung gehen Sie wie folgt vor:'''

# Öffnen Sie das Dashboard, welches veröffentlicht werden soll.
# Durch Klick auf das '''graue Feld "Entwurf"''' neben dem Dashboard Namen, ändert sich die Bezeichnung auf '''"Veröffentlicht".'''[[Datei:ImageStatusVeroeffentlichtSuperset.png|zentriert|mini|435x435px|Durch Klick ändert sich der Status von "Entwurf" auf "Veröffentlicht".]]
# Öffnen Sie rechts oben das '''Dreipunktemenü''' und wählen Sie dort den Unterpunkt '''"Dashboard einbetten"''' aus.[[Datei:ImageDashboardEinbettenSuperset.png|zentriert|mini|317x317px|Im Dreipunktemenü muss im nächsten Schritt der Punkt "Dashboard einbetten" geklickt werden.]]
# Im Einbetten-Dialog lassen Sie das Feld für "Zulässige Domänen" bitte einfach frei und klicken lediglich den '''Button "Einbettung aktivieren".''' Dann kann das Menü durch Klick auf das '''X-Symbol''' geschlossen werden.[[Datei:ImageEinbettungAktivierenSuperset.png|zentriert|mini|378x378px|Im Menü "Einbetten" klicken Sie auf "Einbettung aktivieren" und dann einfach auf das X um das Fenster zu schließen.]]
# Um das Dashboard nun für die '''Rolle der Sachbearbeitenden und Mandanten-Administratoren''' im DiPlan Cockpit '''freizugeben''' öffnen Sie bitte erneut den Reiter '''"Dashboards",''' um auf die Liste mit allen Dashboards zu gelangen.
# Klicken Sie auf das '''Stift-Symbol''' neben dem Dashboard, welches freigeschalten werden soll.[[Datei:ImageDashboardEigenschaftenOeffnenSuperset.png|zentriert|mini|398x398px|Durch Klick auf das Stiftsymbol neben dem Dashboard werden die Dashboardeigenschaften geöffnet. Dort können auch die einzelnen Rollen freigeschaltet werden.]]
# In den '''Dashboardeigenschaften''' können nun die Rollen eingetragen werden, für die das Dashboard freigeschalten werden soll. Die Rollenbezeichnungen in Superset fassen mehrere Rollen aus dem DiPlan Cockpit zusammen, was die Freigabe von Dashboards vereinfacht. Bitte tragen Sie im Feld "Rollen" deshalb '''"Reporting-Administrator"''' und '''"Sachbearbeiter" in der Liste ein.''' Dies ist durch Tippen in das Feld möglich, so wird die auszuwählende Rolle schneller sichtbar. Sie können jedoch auch manuell durch die Liste scrollen und die Rolle auswählen. Klicken Sie anschließend den '''"Speichern"-Button'''. Die Auswertungen sind nun im DiPlan Cockpit für alle berechtigten Rollen sichtbar.[[Datei:ImageDashboardEigenschaftenRollenSuperset.png|zentriert|mini|395x395px|In den Dashboardeigenschaften müssen die Rollen, für die das Dashboard freigegeben werden soll, ausgewählt werden.]]
'''Hinweis: Veröffentlichung zurücknehmen'''

Sollten Sie ein Dashboard im DiPlan Cockpit unsichtbar machen wollen, so klicken Sie wie im Punkt 2 beschrieben wieder auf die graue Schaltfläche und setzen Sie den Status von '''"Veröffentlicht"''' zurück auf '''"Entwurf".'''

=== Bestehendes Dashboard oder Diagramm bearbeiten oder löschen ===
'''Wie lösche ich ein eingebettetes Diagramm von einem bereits veröffentlichten und freigegebenen Dashboard?'''

* Öffnen Sie das Dashboard und '''klicken Sie "Dashboard bearbeiten"''' auf der rechten Bildschirmseite.
* Im geöffneten Bearbeitungsmodus können Sie nun die Maus über das nicht mehr erwünschte Diagramm bewegen und durch '''Klick auf das erscheinende Mülleimersymbol''' löschen. Das Diagramm bleibt in der Liste der Diagramme weiterhin erhalten und wird lediglich vom Dashboard genommen.
* Sie können ein '''weiteres/neues Diagramm''' jederzeit wieder aus der Liste rechts auf das Dashboard ziehen.
* Bestätigen Sie das veränderte Dashboard durch Klick auf den "'''Speichern"-Button''' rechts oben.
* '''Bitte beachten:''' Änderungen an bereits veröffentlichten und freigegebenen Dashboards werden nach dem '''Speichern direkt auf dem DiPlan Cockpit sichtbar'''.
[[Datei:ImageDashboardDiagrammLoeschenSuperset.png|zentriert|mini|370x370px|Per Mouseover und Klick auf das Mülleimer Symbol lassen sich Diagramme auf Dashboards einfach wieder löschen.]]
'''Wie bearbeite ich ein bestehendes Diagramm?'''

Ein Diagramm unabhängig vom Dashboard ändern:

* Öffnen Sie das zu bearbeitende Diagramm in der '''Liste der Diagramme''' durch einen '''Klick auf den Namen'''.
* Das Diagramm öffnet sich direkt im Bearbeitungsmodus und kann nach '''Belieben angepasst werden'''.
* Ist das Diagramm bereits auf einem veröffentlichten und freigegebenen Dashboard eingebettet, so werden alle Änderungen nach dem Speichern direkt übernommen und im '''DiPlan Cockpit sichtbar'''.

Ein Diagramm direkt auf einem Dashboard ändern:

* Öffnen Sie das Dashboard und klicken Sie '''"Dashboard bearbeiten"'''.
* Bewegen Sie die Maus über die entsprechende Grafik, öffnen Sie das Dreipunktemenü rechts und klicken '''"Diagramm bearbeiten".'''
* Nachdem Sie das Diagramm bearbeitet haben klicken Sie '''"Speichern"'''.

'''Bitte beachten:''' Im Speichern-Dialog können Sie entscheiden, ob sie das bestehende '''Diagramm überschreiben''' oder ein '''neues Diagramm speichern''' wollen. Dies kann hilfreich sein, wenn Sie das Diagramm nicht generell, sondern nur auf einem bereits bestehenden Dashboard ändern wollen.
[[Datei:ImageDiagrammSpeichernÜberschreibenSuperset.png|zentriert|mini|383x383px|Es ist möglich direkt beim Speichern ein neues Diagramm zu erstellen oder das bereits bestehende zu überschreiben.]]

'''Wie lösche ich ein Dashboard oder Diagramm dauerhaft?'''

Sie können ein Dashboard unabhängig vom Status (also veröffentlicht oder auch als Entwurf) in der Liste der Dashboards wie folgt löschen:

* Bewegen Sie die Maus über den entsprechenden '''Listeneintrag.'''
* Klicken Sie das in der Zeile rechts erscheinende '''Papierkorb-Symbol''' und folgen den Anweisungen im erscheinenden Löschdialog.
* Die Originaldiagramme auf dem Dashboard bleiben dabei weiterhin in der Liste "Diagramme" erhalten.
* Sollten Sie ein Diagramm dauerhaft löschen wollen, so gehen Sie genauso wie beim Dashboard vor, jedoch im '''Reiter "Diagramme"'''.

=== Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Bitte beachten:''' Solange Reporting-Administratoren nicht als Besitzer eingetragen sind, haben diese nur Zugriff auf die eigenen erstellten Daten.

'''Das bedeutet konkret für die erstellten Daten von anderen Reporting-Administratoren:'''

* Unveröffentlichte Dashboards sind nicht sichtbar.
* Veröffentlichte Dashboards sind sichtbar, aber nicht bearbeitbar.
* Alle Diagramme sind sichtbar, Änderungen können jedoch nur als neue Diagramme gespeichert werden.
* Datensätze sind sichtbar und können verwendet, aber nicht bearbeitet werden.
* Gespeicherte Abfragen sind nicht sichtbar (Berechtigungen können hier grundsätzlich nicht vergeben werden).

Sie haben grundsätzlich keine Rechte ein Dashboard zu bearbeiten oder ein Diagramm zu überschreiben, welches nicht von Ihnen erstellt wurde, außer Sie wurden als '''"Besitzende/r"''' dazu ermächtigt.

Das bedeutet beispielsweise, dass Sie ein Diagramm, welches jemand anders erstellt hat, zwar bearbeiten, dies aber nur als neues Diagramm abspeichern können. Das Originaldiagramm wird hier nicht verändert. Um jemanden für die '''Mitarbeit an Ihrem Diagramm oder Dashboard zu ermächtigen''' gehen Sie wie folgt vor:

* Klicken Sie in der Liste der Diagramme oder Dashboards auf das '''Stift-Symbol "Bearbeiten".''' Der Dialog '''"Diagrammeigenschaften bearbeiten"''' öffnet sich.
* Unter der '''Überschrift "Zugang"''' können weitere '''"Besitzende" eingetragen''' werden. Klicken Sie hierzu in das Eingabefeld und fangen Sie an den Namen zu tippen oder scrollen Sie durch die Liste bis zum gewünschten Namen.
* '''Wählen Sie einen oder mehrere Namen aus,''' um diese in das Feld zu übernehmen und klicken Sie dann auf '''"Speichern"'''. Die eingetragene Person hat nun die gleichen '''Rechte zur Bearbeitung wie der/die ursprüngliche Ersteller/in'''.[[Datei:ImageDiagrammZugangBesitzendeSuperset.png|zentriert|mini|425x425px|Unter "Zugang" können Sie andere Mandanten-Administratoren für die Bearbeitung Ihrer Dashboards oder Diagramme berechtigen.]]

=== Datensätze für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Um Datensätze für andere Reporting-Administratoren zur Bearbeitung freizugeben, gehen Sie wie folgt vor:'''

* Klick auf den '''Reiter "Datensätze"'''
* In der Übersicht-Liste klicken Sie bitte das '''Stift- Symbol''' neben dem gewünschten Datensatz.
* Klicken Sie den '''Reiter "Einstellungen"''' ganz rechts und scrollen Sie ganz nach unten.
* Dort können Sie im '''Feld "Besitzende"''' auch andere Reporting-Administratoren zur Bearbeitung berechtigen.

== Weiterführende Informationen ==
Unter folgendem Link können Sie weitere Informationen zu Superset in englischer Sprache finden. Bitte beachten Sie, dass Ihre Datenbank bereits angebunden ist und der Punkt "Connecting to a new database" in der Dokumentation somit nicht beachtet werden sollte: '''[https://superset.apache.org/docs/6.0.0/using-superset/creating-your-first-dashboard#creating-your-first-dashboard Englische Dokumentation des Open-Source-Tools Superset]'''

Datei:ImageDiagrammZugangBesitzendeSuperset.png

2026-03-16T11:29:00Z

Diplanung:

ImageDiagrammZugangBesitzendeSuperset

Reporting: Auswertungen im DiPlan Cockpit

2026-03-16T11:26:45Z

Diplanung: /* Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben */

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

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

⚠️ '''Bitte beachten: Die Reporting-Funktionalität wird nach und nach Mandanten spezifisch freigeschaltet. Informationen zur Funktionsweise finden Sie hier vorab.'''

== Einleitung ==
Die Auswertungskomponente für das DiPlan Cockpit ermöglicht das Abrufen, Filtern und Downloaden von Reports und Auswertungen aus Planungs- und Genehmigungsverfahren. Die Auswertungsdiagramme zu individuellen Fragestellungen werden in dem externen BI-Tool Superset von berechtigten Personen auf Basis grundlegender SQL- und Datenmodell-Kenntnisse erstellt, verwaltet, auf Dashboards zusammengestellt und schließlich für die Darstellung im DiPlan Cockpit freigegeben.

== Aufruf der Auswertungen ==
Die Auswertungen sind in dem gleichnamigen Reiter im DiPlan Cockpit zu finden.

In der linken Bildschirmhälfte sind die Namen der jeweiligen zur Verfügung stehenden Dashboards zu finden. Ein Dashboard ist eine Zusammenstellung von einem oder mehreren Auswertungsdiagrammen auf einer Seite. Standardmäßig wird das Dashboard "Verfahrensstand aller Verfahren" für jeden Mandant initial mit ausgerollt. Alle weiteren Dashboards können je nach Bedarf individuell durch berechtigte Personen je Mandant erstellt werden. Mehr dazu findet sich im Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Auswertungen_erstellen.2C_ver.C3.B6ffentlichen_und_freigeben Auswertungen erstellen, veröffentlichen und freigeben].

'''Gut zu wissen:'''

* '''Datengrundlage:''' Grundsätzlich fließen gelöschte Verfahren nicht in die Auswertungen ein.
* '''Aktualität der Daten:''' Die Daten werden jede Nacht einmal mit der DiPlan Cockpit Datenbank synchronisiert.
* '''Darstellung:''' Das Reporting wird mit dem Tool Superset umgesetzt, welches in das DiPlan Cockpit eingebunden wird. Für eine optimale Darstellung nutzen Sie bitte den Browser Microsoft Edge.
[[Datei:ImageAuswertungenCockpit.png|zentriert|mini|717x717px|Ansicht des Reiters "Auswertungen" im DiPlan Cockpit mit dem Standarddashboard "Verfahrensstand aller Verfahren".]]

== Filtern der Dashboards bzw. Auswertungen ==
Je nach Art der dargestellten Auswertungen können Sie weitere Aktionen in den einzelnen Diagrammen vornehmen. Oftmals sind zum Beispiel verschiedene Filterungsmöglichkeiten hinterlegt. Zum Öffnen der Filter gehen Sie bitte folgendermaßen vor:

* Aufklappen der Filter durch Klick auf den kleinen blauen Pfeil links neben den Diagrammen. Alternativ können die Filter auch am oberen Rand des Dashboards eingebunden sein.
* Auswählen der gewünschten Filter.
* Klick auf "Filter anwenden".
* Bei Klick auf "Alles löschen" werden sämtliche gesetzte Filter wieder zurückgesetzt.
[[Datei:ImageAuswertungenCockpitFilter.png|zentriert|mini|742x742px|Falls eine Filterung im Dashboard integriert wurde, so lässt diese sich über den kleinen Pfeil ausklappen oder befindet sich am oberen Rand des Dashboards. Hier zu sehen eine Filterung auf dem Dashboard nach Zuständigkeit oder Verfahrenstyp.]]
[[Datei:ImageAuswertungenCockpitFilter2.png|zentriert|mini|742x742px|Das Reporting bietet die Möglichkeit auch mehrere verschiedene Diagrammtypen auf einem Dashboard darzustellen. Diese können von Mandanten-Administratoren konfiguriert und freigegeben werden. Hier ein Beispiel mit integrierten Filtern am oberen Rand des Dashboards.]]

== Download der Auswertungen ==
Neben jeder Auswertungsgrafik (jedem Diagramm) finden sich drei Punkte, welche bei Klick ein Drop-Down Menü öffnen. Durch '''Mouseover auf "Herunterladen"''' öffnet sich das Menü zum Download des Diagramms in verschiedenen auswählbaren Formaten. Hier sind folgende Punkte zu beachten:

* '''Der Download entspricht immer der Filterung:''' Wird eine Grafik durch eine Filterung angepasst und dann ein Download gestartet, so entsprechen die heruntergeladenen Daten immer genau der Filterung, das heißt es sind nicht alle Daten vorhanden. Je nach Grafik ist in den heruntergeladenen Dateien nicht selbsterklärend, dass eine Filterung angewendet wurde und es ist wichtig das Downloadergebnis bei der weiteren Verwendung in den richtigen Kontext zu setzen. Laden Sie sich alternativ die Daten ohne Filterung herunter und filtern Sie zum Beispiel bei Bedarf gesondert in MS Excel.
* '''Die Rollen der Sachbearbeitenden sehen nur die eigene Zuständigkeit:''' Je nach Rolle der Nutzenden werden unter Umständen nicht alle Daten auf den Dashboards dargestellt. Sachbearbeitende können nur Daten der eigenen Zuständigkeit sehen. Siehe dazu auch das nächste Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Rechte_und_Rollen Rechte und Rollen].
[[Datei:ImageAuswertungenHerunterladen.png|zentriert|mini|327x327px|Das vertikale Dreipunktemenü in den Diagrammen beinhaltet die Herunterladen-Funktion.]]

== Rechte und Rollen ==
Alle Rollen aus dem DiPlan Cockpit werden gemäß ihrer Berechtigungen mit einer entsprechenden Rolle in Superset versehen. Prinzipiell gibt es zwei relevante Rollen, denen die Nutzenden in Superset zugeordnet werden. Dies passiert automatisch und regelt ob die Nutzenden berechtigt sind Auswertungen selbst anzulegen, freizugeben und zu veröffentlichen oder ob sie ausschließlich die freigegebenen Auswertungen gemäß ihrer Zuständigkeit im DiPlan Cockpit sehen können. Nachfolgend sehen Sie eine Übersicht über die verschiedenen Berechtigungen:
{| class="wikitable"
|'''Rolle DiPlan Cockpit'''
|'''Rolle Superset'''
|'''Berechtigungen'''
|-
|'''EfA Cockpit Pro'''
* M-A = Mandanten-Administration
* FP-A = Fachplanung-Administration

'''EfA Cockpit Basis'''

* M-A-Basis = Mandanten-Administration-Basis
* FP-A-Basis = Fachplanung-Administration Basis
|'''Reporting-Administrator'''
|
* Kann direkt aus dem DiPlan Cockpit zu Superset abspringen und ist dort automatisch eingeloggt (SSO).
* Kann Datensätze (Superset-spezifische Zwischenschicht zwischen DB-Tabelle und Abfrage) erstellen.
* Kann Auswertungen/Diagramme in Superset erstellen.
* Kann Dashboards mit verschiedenen Auswertungen/Diagramme zusammenstellen.
* Kann Dashboards freigeben für den ganzen Mandanten (z.B. ganz Hamburg).
* Kann alle Daten im Dashboard eines Mandanten sehen.
* Kann Abfragen filtern, also z.B. in Hamburg nach Belieben nach Bezirk (Zuständigkeit) z.B. Altona oder Senat.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
* Kann andere Reporting-Administratoren für die eigenen Dashboards/Diagramme als Besitzer eintragen, um diese für die Bearbeitung, Freischaltung und Veröffentlichung zu berechtigen.
|-
|''''''EfA Cockpit Pro''''''
* FP-VM = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)

'''EfA Cockpit Basis'''

* FP-VM-Basis = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB-Basis = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)
|'''Sachbearbeiter'''
|
* Sieht ausschließlich die vorgefilterten Daten entsprechend der eigenen Zuständigkeit (also z.B. Altona).
* Kann Auswertungen herunterladen, aber nur mit den Daten der eigenen Zuständigkeit.
* Kann freigegebene Dashboards betrachten.
* Kann Auswertungen filtern, wenn Filter eingerichtet wurden.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
|}

== Superset als zentrales Tool für Reporting-Administratoren ==

=== Übergreifende Informationen zu Superset ===
Für die Erstellung und Darstellung des Reportings wurde das Open-Source-Tool Apache Superset in das DiPlan Cockpit implementiert. Superset ist eine Reporting- und Monitoring-Technologie, die es ermöglicht komplexe Daten auf Dashboards in leicht verständlichen Visualisierungen darzustellen. Die Erstellung der Dashboards erfolgt dabei direkt in der Superset-Anwendung. Dort wird auch gesteuert, welche Dashboards mit welchen Auswertungen im DiPlan Cockpit veröffentlicht werden sollen.

=== Absprung aus dem DiPlan Cockpit zu Superset ===
Sobald eine Rolle für die Erstellung von Auswertungen berechtigt ist (zum Beispiel M-A oder FP-A), findet sich im Reiter Auswertungen automatisch der Button '''"Auswertungen konfigurieren"'''. Bei Klick öffnet sich ein weiteres Browserfenster mit der Superset-Plattform. Eine gesonderte Anmeldung in Superset ist nicht erforderlich, da die Anmeldung durch das Cockpit erfolgt (auch Single Sign-On (SSO) genannt).

'''Bitte beachten:''' Nach 4 Stunden erfolgt aus Sicherheitsgründen ein automatischer Logout aus Superset - unabhängig davon ob Sie gerade in Superset arbeiten oder nicht aktiv waren. Sie erhalten keine Warnung vor dem Logout. Deshalb empfiehlt es sich, Änderungen regelmäßig zu speichern, um zu verhindern, dass ungesicherte Abfragen verloren gehen.
[[Datei:ImageButtonAuswertungenKonfigurieren.png|zentriert|mini|491x491px|Berechtigte Personen sehen über den Dashboards im DiPlan Cockpit einen Absprungbutton zu Superset mit der Bezeichnung "Auswertungen konfigurieren."]]
[[Datei:ImageStartbildschirmSuperset.png|zentriert|mini|508x508px|Startbildschirm in Superset mit einer Vorschau auf Dashboards und Diagrammen. Die Hauptmenüpunkte zur Navigation sind am oberen Bildschirmrand zu sehen.]]

=== Auswertungen erstellen, veröffentlichen und freigeben ===
Datenvisualisierungen von Abfragen werden in Superset als '''"Diagramme"''' bezeichnet. Sobald mindestens ein Diagramm erstellt ist, kann dieses auf einem Dashboard integriert werden und mit weiteren Filtermöglichkeiten versehen werden. Wie bereits erwähnt, können Sie als '''Reporting-Administrator''' selbst nach Belieben Diagramme erstellen. Nachfolgend wird beispielhaft die Erstellung und Freigabe des Dashboards mit dem Diagramm "Verfahrensstand aller Verfahren" beschrieben, um einige der Grundfunktionalitäten in Superset zu verdeutlichen (siehe dazu das Kapitel: "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]").

=== Datensätze erstellen ===
Um ein Diagramm zu erstellen wird zunächst ein Datensatz benötigt. Für einfache Abfragen reicht der '''Verfahrensdatensatz''' aus, der bereits standardmäßig enthalten ist. Dieser entspricht der '''Tabelle "Verfahren"''' mit den '''zugehörigen Datenfeldern (Stammdaten)'''.

Für Abfragen auf dem Verfahrensdatensatz können Sie direkt zum Abschnitt "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]" springen.

Für komplexere '''Abfragen über mehrere Tabellen hinweg, eigene Metriken oder eigene berechnete Spalten''' ist die Erstellung eines eigene Datensatzes mithilfe von SQL-Abfragen notwendig. Folgende Informationen sind in gesonderten Tabellen enthalten:

* Gebietseinheiten
* Kontakte
* Nutzer
* Parallelverfahren
* Termine
* Veränderungssperren
* Vertragsarten
* Vorgesehene Nutzungen
* Zurückstellungen

'''Bitte beachten:''' Bei der Erstellung von eigenen Datensätzen, muss die Spalte "'''''zustaendigkeit_code"''''' aus der Tabelle "'''''verfahren"'' immer enthalten sein,''' da hierüber die Ansicht für Sachbearbeiter standardmäßig gefiltert wird.

'''Um eigene Datensätze zu erstellen gehen Sie bitte wie folgt vor:'''

* Klick im Hauptmenü auf den '''Reiter "SQL"''' und im zugehörigen Dropdown-Menü auf '''"SQL Lab".'''
[[Datei:ImageStartSQLLab.png|zentriert|mini|576x576px|Startansicht SQL Lab]]
* Erstellen Sie Ihre '''SQL-Abfrage''' und klicken Sie auf den '''Button "Ausführen"''', um eine Vorschau auf die Ergebnisse der Abfrage zu erhalten. Ein rotes Kreuzchen links vom SQL-Editor weist auf Fehler im SQL hin.
[[Datei:ImageAusfuehrenSQLLab.png|zentriert|mini|576x576px|Ausführen einer SQL Abfrage im SQL Lab]]
'''Typische Anwendungsfälle und die dazugehörigen SQL Abfragen könnten z.B. sein:'''

* Sie möchten, dass Ihre Abfragen z.B. nach "Gebietseinheiten" und "Vorgesehenen Nutzungen" gefiltert werden können:

{| class="wikitable"
|
SELECT v.*, g.gebietseinheit, vn.vorgesehene_nutzungen
FROM verfahren v
LEFT JOIN gebietseinheiten g ON g.verfahren_id = v.id
LEFT JOIN vorgesehene_nutzungen vn ON vn.verfahren_id = v.id;
|}

* Sie möchten, dass Ihr Datensatz bestimmte Termine enthält (z.B. Grobabstimmungsdatum, Vorweggenehmigungsreife):

{| class="wikitable"
|
WITH grobabstimmung_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Grobabstimmung'
),
vorweggenehmigungsreife_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Vorweggenehmigungsreife'
)
SELECT
v.*,
t1.beginn AS grobabstimmung,
t2.beginn AS vorweggenehmigungsreife
FROM verfahren v
LEFT JOIN grobabstimmung_termin t1 ON t1.verfahren_id = v.id
LEFT JOIN vorweggenehmigungsreife_termin t2 ON t2.verfahren_id = v.id;
|}

* '''Speichern Sie Ihre Abfrage als Datensatz''' ab, indem Sie auf den '''Dropdown-Pfeil neben dem Button "Speichern"''' klicken und dann '''"Datensatz speichern"''' auswählen. Es öffnet sich ein Dialogfeld, in dem Sie einen Namen für Ihren Datensatz vergeben können.
** Hinweis: Wenn Sie statt auf "Datensatz speichern" auf "Speichern" klicken, finden Sie Ihre SQL Abfrage unter dem Reiter '''"Gespeicherte Abfragen"''' wieder.
[[Datei:ImageSpeichernDatensatzSuperset.png|zentriert|mini|581x581px|Speichern eines neuen Datensatzes]]
Nach der Erstellung eines Datensatzes können Sie diesen noch weiter bearbeiten und Labels, eigene Metriken oder berechnete Spalten hinzufügen. Gehen Sie dazu wie folgt vor:
* Klick im Hauptmenü auf den '''Reiter "Datensätze"'''. Hier sind die verfügbaren Datensätze aufgelistet.
* Klicken Sie ganz rechts neben dem Datensatz, den Sie bearbeiten wollen, auf das '''Stift-Symbol.''' Es öffnet sich eine Bearbeitungsmaske.
[[Datei:ImageBearbeitungDatensatzSuperset.png|zentriert|mini|427x427px|Öffnen Sie den Bearbeitungsmodus durch Klick auf das Stiftsymbol]]
*'''Reiter "Quelle":''' Hier kann die zugrundeliegende SQL Abfrage nachträglich angepasst werden. Klicken Sie hierfür auf das Schloss-Symbol.
[[Datei:ImageReiterQuelleSuperset.png|zentriert|mini|411x411px|Im Reiter "Quelle" kann das SQL nachträglich angepasst werden]]
*'''Reiter "Metriken":''' Hier können eigene Metriken angelegt werden.
[[Datei:ImageReiterMetrikenSuperset.png|zentriert|mini|350x350px|Eine neue Metrik "Anzahl Verfahren" wird hinzugefügt]]
*'''Reiter "Spalten":''' Hier sind alle im Datensatz enthaltenen Spalten aufgeführt. An den Werten in der Tabelle ("Datentyp", "Ist zeitlich" etc.) sollte in der Regel nichts geändert werden, dies wird von Superset automatisch richtig erkannt. Beim '''Klick auf das "Plus"''' neben jeder Spalte kann unter "Beschriftung" ein sprechendes Label hinzugefügt werden. Dieses wird später in den Diagrammen angezeigt.
[[Datei:ImageReiterSpaltenSuperset.png|zentriert|mini|470x470px|Im Reiter "Spalten" wird ein Label hinzugefügt]]
*'''Reiter "Berechnete Spalten":''' Hier können dem Datensatz weitere Spalten hinzugefügt werden, die Werte enthalten, die aus anderen Spalten errechnet werden. Verwenden Sie für die Berechnung SQL-Syntax.
[[Datei:ImageReiterBerechneteSpaltenSuperset.png|zentriert|mini|416x416px|Eine berechnete Spalte wird hinzugefügt]]
* Speichern Sie Ihre Änderungen am Datensatz durch das '''Klicken auf den "Speichern"-Button'''. Um die Änderungen zu prüfen, empfiehlt es sich ein Diagramm mit dem Datensatz anzulegen (z.B. eine Tabelle).

=== Beispiel-Diagramm erstellen ===
Nachfolgend soll beispielhaft ein Diagramm "Verfahrensstand aller Verfahren" erstellt werden. Dazu gehen Sie wie folgt vor:

# Klick auf den '''Menüpunkt "Diagramme":''' Auf dieser Seite findet sich eine Liste mit allen bereits erstellten Diagrammen. Innerhalb dieser Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Diagramm-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageUebersichtDiagrammeSuperset.png|zentriert|mini|501x501px|Im Menüpunkt "Diagramme" findet sich eine Übersicht über die bisher erstellten Diagramme (Abfragen) mit vielen Zusatzinformationen.]]
# Um ein neues Diagramm zu erstellen klicken Sie auf den '''Button "+Diagramm"''' rechts oben. Es öffnet sich der Dialog '''"Neues Diagramm erstellen".'''[[Datei:ImageNeuesDiagrammSuperset.png|zentriert|mini|487x487px|Dialog um ein neues Diagramm zu erstellen]]
# Zunächst muss der '''passende Datensatz für die Auswertung ausgewählt''' werden. Für dieses Beispiel wählen wir unter '''"1- Datensatz auswählen"''' den Datensatz '''"verfahren"''' im Dropdownmenü aus.
# Im nächsten Schritt wird der '''passende Diagrammtyp ausgewählt'''. Hier werden Ihnen viele verschiedene Visualisierungsmöglichkeiten geboten. Im genannten Beispiel passt ein "Kreisdiagramm" am besten zu der Visualisierung der Verfahrensstände aller Verfahren. Sie finden das Kreisdiagramm unter dem Hauptmenü "Teil des Ganzen". Klicken Sie '''auf das Kreisdiagramm''' und anschließend auf '''"Neues Diagramm erstellen"'''.
# Nun geht es um die '''Detailkonfiguration''' des Diagramms. Grundsätzlich ist der Arbeitsbereich wie folgt aufgebaut:
#* Die linke Spalte enthält einen '''Überblick''' über die '''zur Verfügung stehenden Daten'''.
#* Die mittlere Spalte enthält die '''Werkzeuge''', um das '''Diagramm zu konfigurieren.'''
#* Im rechten Bereich kann man sich jeweils eine '''Vorschau des Diagramms''' anzeigen lassen.
'''Wir gehen für unser Beispiel wie folgt vor:'''

* Im Feld '''"Name des Diagramms hinzufügen"''' das Diagramm mit einer passenden Bezeichnung versehen.
* Um die Dimensionen des Diagramms festzulegen im Tab '''"Daten"''' unter der Überschrift '''"Abfrage > Dimensionen"''' die Spalte '''"verfahrensstand"''' von links per Drag & Drop herüberziehen.
* Der dazustellende Wert soll hier die Anzahl sein, weshalb nun unter '''"Metrik"''' das Feld '''"Anzahl"''' Button "+Diagramm" per Drag & Drop von links herübergezogen wird. Je nach Fragestellung bzw. welche Daten auf dem Diagramm dargestellt werden sollen, können verschiedenste Kombinationen in der selben Art und Weise über Drag & Drop zusammengestellt werden.
* Unter dem '''Punkt "Filter"''' kann eine Vorabfilterung eingebaut werden, also beispielsweise könnten Sie simulierte Verfahren standardmäßig herausfiltern, so dass die Nutzenden diese gar nicht auswerten können. Anmerkung: "imported_at" kann nicht gelöscht werden. Dieser Wert wird von Superset standardmäßig gesetzt und hat keine Auswirkung auf Ihre Auswertungen.
* Das für die Berechnung zugrundeliegende Zeilenlimit kann bei Bedarf verändert werden.
* Ein Klick auf den '''blauen Button "Diagramm erstellen"''' zeigt eine '''Vorschau''' des erstellten Diagrammes auf der rechten Bildschirmhälfte. Das Diagramm kann nun jederzeit mit einem '''Klick auf "Speichern"''' rechts oben gesichert werden.[[Datei:ImageDiagrammErstellenSuperset.png|zentriert|mini|426x426px|Dialog zur Detaildefinition des neuen Diagramms. Hier beispielhaft zusammengestellt für die Darstellung "Verfahrenstand aller Verfahren".]]

* Unter dem '''Tab "Anpassen"''' finden sich zahlreiche Möglichkeiten, das Diagramm weiter zu verfeinern (zum Beispiel in Farbe und Layout). Hier kann ganz nach Belieben ausprobiert werden. Mit '''Klick auf''' '''"Diagramm aktualisieren"''' kann die Vorschau des Diagramms zur Überprüfung mit den neu gewählten Einstellungen geladen werden.[[Datei:ImageDiagrammAnpassenSuperset.png|zentriert|mini|421x421px|Diagramm kann nach Belieben im Tab "Anpassen" verändert und verfeinert werden.]]
* '''Speichern nicht vergessen:''' Das Diagramm wird erst gespeichert durch '''Klick auf "Speichern" rechts oben'''. Es öffnet sich ein Dialog zu weiteren Speicheroptionen, der mit '''einer weiteren Speicherbestätigung''' abgeschlossen werden kann.[[Datei:ImageDiagrammSpeichernSuperset.png|zentriert|mini|427x427px|Speichern-Dialog für das erstellte Diagramm]]

=== Beispiel-Dashboard erstellen ===

# '''Klick auf den Menüpunkt "Dashboards":''' Unter der Überschrift "Dashboards" findet sich eine Liste mit allen bereits erstellten Dashboards. Diese Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Dashboard-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageDashboardsSuperset.png|zentriert|mini|452x452px|Unter dem Menüpunkt "Dashboards" finden sich alle bereits angelegten Dashboards, sowie die Möglichkeit neue Dashboards zu erstellen.]]
# Mit Klick auf den Button '''"+Dashboard"''' rechts oben öffnet sich ein neuer, leerer Dashboard -Entwurf.
# Der Titel des Dashboards ist standardmäßig als "untitled dashboard" angeben und kann durch '''Klick auf den Namen''' geändert werden.
# Auf der Seitenleiste am rechten Bildschirmrand finden sich alle bereits erstellten Diagramme. Das gewünschte Diagramm kann einfach durch '''Drag & Drop mit der Maus auf das Dashboard gezogen''' werden. Auch die Größe kann leicht geändert werden indem sie die Ränder oder Ecken des Diagramms klicken, gedrückt halten und auf die gewünschte Größe ziehen. Sie können ein oder auch mehrere Diagramme auf einem Dashboard platzieren.
# Zu guter Letzt oben rechts auf den '''Button "Speichern"''' klicken um Ihre Arbeit zu sichern. Nach dem Speichern können Sie jederzeit am Dashboard weiter arbeiten indem Sie auf den nun erscheinenden Button '''"Dashboard bearbeiten"''' klicken.
# Sollten Sie ein Diagramm wieder vom Dashboard löschen wollen, können Sie einfach das '''Mülleimer-Symbol''' klicken, welches bei Mouseover über das jeweilige Diagramm erscheint.[[Datei:ImageDragDropDiagrammSuperset.png|zentriert|mini|351x351px|Das gewünschte Diagramm kann mit der Maus einfach auf das Dashboard gezogen und platziert werden.]]
[[Datei:ImageDiagrammGroesseSuperset.png|zentriert|mini|325x325px|Die Größe des Diagramms lässt sich einfach durch Ziehen der Maus an Ecken oder Rändern verändern.]]

=== Einen oder mehrere Filter zu einem Dashboard zufügen ===
Es ist möglich Ihre Auswertungsdiagramme mit Filtermöglichkeiten zu versehen. Im folgenden wird beispielhaft ein Filter nach der Zuständigkeit auf dem Dashboard "Verfahrensstand aller Verfahren" hinzugefügt:

# Öffnen Sie das Dashboard oder legen Sie sich ein entsprechendes neues Dashboard an und speichern dieses.
# An der linken Bildschirmkante den '''kleinen Pfeil klicken''', um das Filtermenü auszuklappen. '''Wichtig:''' Der Pfeil ist nur sichtbar, wenn das Dashboard bereits gespeichert ist und sich nicht gerade im offenen Bearbeitungsmodus befindet. Sprich: Klicken Sie '''nicht''' "Dashboard bearbeiten" bevor Sie den Filter hinzufügen.
# Klicken Sie auf das '''kleine Zahnrad''' um das Untermenü zu öffnen.
# Ein Klick auf '''"Hinzufügen und Bearbeiten von Filtern"''' öffnet das Menü um die Filter zu konfigurieren.[[Datei:ImageDashboardFilterMenueSuperset.png|zentriert|mini|372x372px|Durch Klick auf den kleinen Pfeil öffnet sich das Menü, mit dem Filter hinzugefügt und konfiguriert werden können.]]
# Um nach der Zuständigkeit zu filtern muss im '''Menü Filtertyp die Option "Wert"''' ausgewählt sein.
# Im Menüpunkt Tabellenname '''"Zuständigkeit"''' als '''Namen des Filters''' eintragen.
# Im '''Feld Datensatz''' wird in diesem Fall '''"verfahren"''' ausgewählt.
# Im '''Feld "Spalte"''' den Filter auswählen, nach dem gefiltert werden soll: in diesem Fall '''"zustaendigkeit".'''
# Das Menü '''"Filterwerte sortieren"''' durch einen Haken aktivieren und absteigend sortieren und mit der '''Sortiermetrik "Anzahl"''' versehen.
# Im '''Reiter "Auswahlverfahren"''' kann der Filter durch eine Auswahl außerdem auf '''einzelne Diagramme oder auf alles bezogen''' werden.
# Durch '''Klick auf "Speichern"''' rechts unten wird der Filter in das Dashboard integriert.[[Datei:ImageFilteroptionenDashboardSuperset.png|zentriert|mini|431x431px|Sie können einen oder mehrere Filteroptionen auf einem Dashboard integrieren und in diesem Menü konfigurieren.]]
'''Übergeordnete Filtereinstellungen:'''

Nach '''Klick auf das Zahnrad''', im geöffneten Filter-Untermenü, können Sie außerdem entscheiden, ob der Filter '''oben''' über dem Diagramm '''oder seitlich links einklappbar''' angezeigt werden soll.

Es gibt dort außerdem die Möglichkeit für ein oder mehrere Diagramme eine '''Kreuzfilterung zu aktivieren.''' Diese erlaubt es Ihnen, direkt '''in einem Diagramm auf ein Element zu klicken''', um damit automatisch eines oder alle Diagramme im Dashboard zu filtern. So können Daten intuitiv und interaktiv erkundet werden, ohne separate Filtersteuerungen zu verwenden.
[[Datei:ImageFilterUntermenueSuperset.png|zentriert|mini|440x440px|Im Filter-Untermenü können bestehende Filter bearbeitet oder weitere Filter hinzugefügt werden. Außerdem kann die Kreuzfilterung aktiviert und die Darstellung der Filterleiste verändert werden.]]

=== Dashboards veröffentlichen ===
Dashboards werden erst im DiPlan Cockpit sichtbar, nachdem diese veröffentlicht und für die Sachbearbeitenden und Reporting-Administratoren freigeschalten wurden. Dabei gilt es zu beachten, dass Sie nur Dashboards veröffentlichen und freischalten können, die Sie selbst erstellt haben oder für die Sie berechtigt worden sind. Siehe hierzu auch das Kapitel "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Diagramme_und_Dashboards_f.C3.BCr_andere_Reporting-Administratoren_zur_Bearbeitung_freigeben Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben]".

'''Zur Veröffentlichung und Freischaltung gehen Sie wie folgt vor:'''

# Öffnen Sie das Dashboard, welches veröffentlicht werden soll.
# Durch Klick auf das '''graue Feld "Entwurf"''' neben dem Dashboard Namen, ändert sich die Bezeichnung auf '''"Veröffentlicht".'''[[Datei:ImageStatusVeroeffentlichtSuperset.png|zentriert|mini|435x435px|Durch Klick ändert sich der Status von "Entwurf" auf "Veröffentlicht".]]
# Öffnen Sie rechts oben das '''Dreipunktemenü''' und wählen Sie dort den Unterpunkt '''"Dashboard einbetten"''' aus.[[Datei:ImageDashboardEinbettenSuperset.png|zentriert|mini|317x317px|Im Dreipunktemenü muss im nächsten Schritt der Punkt "Dashboard einbetten" geklickt werden.]]
# Im Einbetten-Dialog lassen Sie das Feld für "Zulässige Domänen" bitte einfach frei und klicken lediglich den '''Button "Einbettung aktivieren".''' Dann kann das Menü durch Klick auf das '''X-Symbol''' geschlossen werden.[[Datei:ImageEinbettungAktivierenSuperset.png|zentriert|mini|378x378px|Im Menü "Einbetten" klicken Sie auf "Einbettung aktivieren" und dann einfach auf das X um das Fenster zu schließen.]]
# Um das Dashboard nun für die '''Rolle der Sachbearbeitenden und Mandanten-Administratoren''' im DiPlan Cockpit '''freizugeben''' öffnen Sie bitte erneut den Reiter '''"Dashboards",''' um auf die Liste mit allen Dashboards zu gelangen.
# Klicken Sie auf das '''Stift-Symbol''' neben dem Dashboard, welches freigeschalten werden soll.[[Datei:ImageDashboardEigenschaftenOeffnenSuperset.png|zentriert|mini|398x398px|Durch Klick auf das Stiftsymbol neben dem Dashboard werden die Dashboardeigenschaften geöffnet. Dort können auch die einzelnen Rollen freigeschaltet werden.]]
# In den '''Dashboardeigenschaften''' können nun die Rollen eingetragen werden, für die das Dashboard freigeschalten werden soll. Die Rollenbezeichnungen in Superset fassen mehrere Rollen aus dem DiPlan Cockpit zusammen, was die Freigabe von Dashboards vereinfacht. Bitte tragen Sie im Feld "Rollen" deshalb '''"Reporting-Administrator"''' und '''"Sachbearbeiter" in der Liste ein.''' Dies ist durch Tippen in das Feld möglich, so wird die auszuwählende Rolle schneller sichtbar. Sie können jedoch auch manuell durch die Liste scrollen und die Rolle auswählen. Klicken Sie anschließend den '''"Speichern"-Button'''. Die Auswertungen sind nun im DiPlan Cockpit für alle berechtigten Rollen sichtbar.[[Datei:ImageDashboardEigenschaftenRollenSuperset.png|zentriert|mini|395x395px|In den Dashboardeigenschaften müssen die Rollen, für die das Dashboard freigegeben werden soll, ausgewählt werden.]]
'''Hinweis: Veröffentlichung zurücknehmen'''

Sollten Sie ein Dashboard im DiPlan Cockpit unsichtbar machen wollen, so klicken Sie wie im Punkt 2 beschrieben wieder auf die graue Schaltfläche und setzen Sie den Status von '''"Veröffentlicht"''' zurück auf '''"Entwurf".'''

=== Bestehendes Dashboard oder Diagramm bearbeiten oder löschen ===
'''Wie lösche ich ein eingebettetes Diagramm von einem bereits veröffentlichten und freigegebenen Dashboard?'''

* Öffnen Sie das Dashboard und '''klicken Sie "Dashboard bearbeiten"''' auf der rechten Bildschirmseite.
* Im geöffneten Bearbeitungsmodus können Sie nun die Maus über das nicht mehr erwünschte Diagramm bewegen und durch '''Klick auf das erscheinende Mülleimersymbol''' löschen. Das Diagramm bleibt in der Liste der Diagramme weiterhin erhalten und wird lediglich vom Dashboard genommen.
* Sie können ein '''weiteres/neues Diagramm''' jederzeit wieder aus der Liste rechts auf das Dashboard ziehen.
* Bestätigen Sie das veränderte Dashboard durch Klick auf den "'''Speichern"-Button''' rechts oben.
* '''Bitte beachten:''' Änderungen an bereits veröffentlichten und freigegebenen Dashboards werden nach dem '''Speichern direkt auf dem DiPlan Cockpit sichtbar'''.
[[Datei:ImageDashboardDiagrammLoeschenSuperset.png|zentriert|mini|370x370px|Per Mouseover und Klick auf das Mülleimer Symbol lassen sich Diagramme auf Dashboards einfach wieder löschen.]]
'''Wie bearbeite ich ein bestehendes Diagramm?'''

Ein Diagramm unabhängig vom Dashboard ändern:

* Öffnen Sie das zu bearbeitende Diagramm in der '''Liste der Diagramme''' durch einen '''Klick auf den Namen'''.
* Das Diagramm öffnet sich direkt im Bearbeitungsmodus und kann nach '''Belieben angepasst werden'''.
* Ist das Diagramm bereits auf einem veröffentlichten und freigegebenen Dashboard eingebettet, so werden alle Änderungen nach dem Speichern direkt übernommen und im '''DiPlan Cockpit sichtbar'''.

Ein Diagramm direkt auf einem Dashboard ändern:

* Öffnen Sie das Dashboard und klicken Sie '''"Dashboard bearbeiten"'''.
* Bewegen Sie die Maus über die entsprechende Grafik, öffnen Sie das Dreipunktemenü rechts und klicken '''"Diagramm bearbeiten".'''
* Nachdem Sie das Diagramm bearbeitet haben klicken Sie '''"Speichern"'''.

'''Bitte beachten:''' Im Speichern-Dialog können Sie entscheiden, ob sie das bestehende '''Diagramm überschreiben''' oder ein '''neues Diagramm speichern''' wollen. Dies kann hilfreich sein, wenn Sie das Diagramm nicht generell, sondern nur auf einem bereits bestehenden Dashboard ändern wollen.
[[Datei:ImageDiagrammSpeichernÜberschreibenSuperset.png|zentriert|mini|383x383px|Es ist möglich direkt beim Speichern ein neues Diagramm zu erstellen oder das bereits bestehende zu überschreiben.]]

'''Wie lösche ich ein Dashboard oder Diagramm dauerhaft?'''

Sie können ein Dashboard unabhängig vom Status (also veröffentlicht oder auch als Entwurf) in der Liste der Dashboards wie folgt löschen:

* Bewegen Sie die Maus über den entsprechenden '''Listeneintrag.'''
* Klicken Sie das in der Zeile rechts erscheinende '''Papierkorb-Symbol''' und folgen den Anweisungen im erscheinenden Löschdialog.
* Die Originaldiagramme auf dem Dashboard bleiben dabei weiterhin in der Liste "Diagramme" erhalten.
* Sollten Sie ein Diagramm dauerhaft löschen wollen, so gehen Sie genauso wie beim Dashboard vor, jedoch im '''Reiter "Diagramme"'''.

=== Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Bitte beachten:''' Solange Reporting-Administratoren nicht als Besitzer eingetragen sind, haben diese nur Zugriff auf die eigenen erstellten Daten.

'''Das bedeutet konkret für die erstellten Daten von anderen Reporting-Administratoren:'''

* Unveröffentlichte Dashboards sind nicht sichtbar.
* Veröffentlichte Dashboards sind sichtbar, aber nicht bearbeitbar.
* Alle Diagramme sind sichtbar, Änderungen können jedoch nur als neue Diagramme gespeichert werden.
* Datensätze sind sichtbar und können verwendet, aber nicht bearbeitet werden.
* Gespeicherte Abfragen sind nicht sichtbar (Berechtigungen können hier grundsätzlich nicht vergeben werden).

Sie haben grundsätzlich keine Rechte ein Dashboard zu bearbeiten oder ein Diagramm zu überschreiben, welches nicht von Ihnen erstellt wurde, außer Sie wurden als '''"Besitzende/r"''' dazu ermächtigt.

Das bedeutet beispielsweise, dass Sie ein Diagramm, welches jemand anders erstellt hat, zwar bearbeiten, dies aber nur als neues Diagramm abspeichern können. Das Originaldiagramm wird hier nicht verändert. Um jemanden für die '''Mitarbeit an Ihrem Diagramm oder Dashboard zu ermächtigen''' gehen Sie wie folgt vor:

* Klicken Sie in der Liste der Diagramme oder Dashboards auf das '''Stift-Symbol "Bearbeiten".''' Der Dialog '''"Diagrammeigenschaften bearbeiten"''' öffnet sich.
* Unter der '''Überschrift "Zugang"''' können weitere '''"Besitzende" eingetragen''' werden. Klicken Sie hierzu in das Eingabefeld und fangen Sie an den Namen zu tippen oder scrollen Sie durch die Liste bis zum gewünschten Namen.
* '''Wählen Sie einen oder mehrere Namen aus,''' um diese in das Feld zu übernehmen und klicken Sie dann auf '''"Speichern"'''. Die eingetragene Person hat nun die gleichen '''Rechte zur Bearbeitung wie der/die ursprüngliche Ersteller/in'''.

=== Datensätze für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Um Datensätze für andere Reporting-Administratoren zur Bearbeitung freizugeben, gehen Sie wie folgt vor:'''

* Klick auf den '''Reiter "Datensätze"'''
* In der Übersicht-Liste klicken Sie bitte das '''Stift- Symbol''' neben dem gewünschten Datensatz.
* Klicken Sie den '''Reiter "Einstellungen"''' ganz rechts und scrollen Sie ganz nach unten.
* Dort können Sie im '''Feld "Besitzende"''' auch andere Reporting-Administratoren zur Bearbeitung berechtigen.

== Weiterführende Informationen ==
Unter folgendem Link können Sie weitere Informationen zu Superset in englischer Sprache finden. Bitte beachten Sie, dass Ihre Datenbank bereits angebunden ist und der Punkt "Connecting to a new database" in der Dokumentation somit nicht beachtet werden sollte: '''[https://superset.apache.org/docs/6.0.0/using-superset/creating-your-first-dashboard#creating-your-first-dashboard Englische Dokumentation des Open-Source-Tools Superset]'''

Datei:ImageDiagrammSpeichernÜberschreibenSuperset.png

2026-03-16T11:26:06Z

Diplanung:

ImageDiagrammSpeichernÜberschreibenSuperset

Reporting: Auswertungen im DiPlan Cockpit

2026-03-16T11:05:26Z

Diplanung: /* Bestehendes Dashboard oder Diagramm bearbeiten oder löschen */

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

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

⚠️ '''Bitte beachten: Die Reporting-Funktionalität wird nach und nach Mandanten spezifisch freigeschaltet. Informationen zur Funktionsweise finden Sie hier vorab.'''

== Einleitung ==
Die Auswertungskomponente für das DiPlan Cockpit ermöglicht das Abrufen, Filtern und Downloaden von Reports und Auswertungen aus Planungs- und Genehmigungsverfahren. Die Auswertungsdiagramme zu individuellen Fragestellungen werden in dem externen BI-Tool Superset von berechtigten Personen auf Basis grundlegender SQL- und Datenmodell-Kenntnisse erstellt, verwaltet, auf Dashboards zusammengestellt und schließlich für die Darstellung im DiPlan Cockpit freigegeben.

== Aufruf der Auswertungen ==
Die Auswertungen sind in dem gleichnamigen Reiter im DiPlan Cockpit zu finden.

In der linken Bildschirmhälfte sind die Namen der jeweiligen zur Verfügung stehenden Dashboards zu finden. Ein Dashboard ist eine Zusammenstellung von einem oder mehreren Auswertungsdiagrammen auf einer Seite. Standardmäßig wird das Dashboard "Verfahrensstand aller Verfahren" für jeden Mandant initial mit ausgerollt. Alle weiteren Dashboards können je nach Bedarf individuell durch berechtigte Personen je Mandant erstellt werden. Mehr dazu findet sich im Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Auswertungen_erstellen.2C_ver.C3.B6ffentlichen_und_freigeben Auswertungen erstellen, veröffentlichen und freigeben].

'''Gut zu wissen:'''

* '''Datengrundlage:''' Grundsätzlich fließen gelöschte Verfahren nicht in die Auswertungen ein.
* '''Aktualität der Daten:''' Die Daten werden jede Nacht einmal mit der DiPlan Cockpit Datenbank synchronisiert.
* '''Darstellung:''' Das Reporting wird mit dem Tool Superset umgesetzt, welches in das DiPlan Cockpit eingebunden wird. Für eine optimale Darstellung nutzen Sie bitte den Browser Microsoft Edge.
[[Datei:ImageAuswertungenCockpit.png|zentriert|mini|717x717px|Ansicht des Reiters "Auswertungen" im DiPlan Cockpit mit dem Standarddashboard "Verfahrensstand aller Verfahren".]]

== Filtern der Dashboards bzw. Auswertungen ==
Je nach Art der dargestellten Auswertungen können Sie weitere Aktionen in den einzelnen Diagrammen vornehmen. Oftmals sind zum Beispiel verschiedene Filterungsmöglichkeiten hinterlegt. Zum Öffnen der Filter gehen Sie bitte folgendermaßen vor:

* Aufklappen der Filter durch Klick auf den kleinen blauen Pfeil links neben den Diagrammen. Alternativ können die Filter auch am oberen Rand des Dashboards eingebunden sein.
* Auswählen der gewünschten Filter.
* Klick auf "Filter anwenden".
* Bei Klick auf "Alles löschen" werden sämtliche gesetzte Filter wieder zurückgesetzt.
[[Datei:ImageAuswertungenCockpitFilter.png|zentriert|mini|742x742px|Falls eine Filterung im Dashboard integriert wurde, so lässt diese sich über den kleinen Pfeil ausklappen oder befindet sich am oberen Rand des Dashboards. Hier zu sehen eine Filterung auf dem Dashboard nach Zuständigkeit oder Verfahrenstyp.]]
[[Datei:ImageAuswertungenCockpitFilter2.png|zentriert|mini|742x742px|Das Reporting bietet die Möglichkeit auch mehrere verschiedene Diagrammtypen auf einem Dashboard darzustellen. Diese können von Mandanten-Administratoren konfiguriert und freigegeben werden. Hier ein Beispiel mit integrierten Filtern am oberen Rand des Dashboards.]]

== Download der Auswertungen ==
Neben jeder Auswertungsgrafik (jedem Diagramm) finden sich drei Punkte, welche bei Klick ein Drop-Down Menü öffnen. Durch '''Mouseover auf "Herunterladen"''' öffnet sich das Menü zum Download des Diagramms in verschiedenen auswählbaren Formaten. Hier sind folgende Punkte zu beachten:

* '''Der Download entspricht immer der Filterung:''' Wird eine Grafik durch eine Filterung angepasst und dann ein Download gestartet, so entsprechen die heruntergeladenen Daten immer genau der Filterung, das heißt es sind nicht alle Daten vorhanden. Je nach Grafik ist in den heruntergeladenen Dateien nicht selbsterklärend, dass eine Filterung angewendet wurde und es ist wichtig das Downloadergebnis bei der weiteren Verwendung in den richtigen Kontext zu setzen. Laden Sie sich alternativ die Daten ohne Filterung herunter und filtern Sie zum Beispiel bei Bedarf gesondert in MS Excel.
* '''Die Rollen der Sachbearbeitenden sehen nur die eigene Zuständigkeit:''' Je nach Rolle der Nutzenden werden unter Umständen nicht alle Daten auf den Dashboards dargestellt. Sachbearbeitende können nur Daten der eigenen Zuständigkeit sehen. Siehe dazu auch das nächste Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Rechte_und_Rollen Rechte und Rollen].
[[Datei:ImageAuswertungenHerunterladen.png|zentriert|mini|327x327px|Das vertikale Dreipunktemenü in den Diagrammen beinhaltet die Herunterladen-Funktion.]]

== Rechte und Rollen ==
Alle Rollen aus dem DiPlan Cockpit werden gemäß ihrer Berechtigungen mit einer entsprechenden Rolle in Superset versehen. Prinzipiell gibt es zwei relevante Rollen, denen die Nutzenden in Superset zugeordnet werden. Dies passiert automatisch und regelt ob die Nutzenden berechtigt sind Auswertungen selbst anzulegen, freizugeben und zu veröffentlichen oder ob sie ausschließlich die freigegebenen Auswertungen gemäß ihrer Zuständigkeit im DiPlan Cockpit sehen können. Nachfolgend sehen Sie eine Übersicht über die verschiedenen Berechtigungen:
{| class="wikitable"
|'''Rolle DiPlan Cockpit'''
|'''Rolle Superset'''
|'''Berechtigungen'''
|-
|'''EfA Cockpit Pro'''
* M-A = Mandanten-Administration
* FP-A = Fachplanung-Administration

'''EfA Cockpit Basis'''

* M-A-Basis = Mandanten-Administration-Basis
* FP-A-Basis = Fachplanung-Administration Basis
|'''Reporting-Administrator'''
|
* Kann direkt aus dem DiPlan Cockpit zu Superset abspringen und ist dort automatisch eingeloggt (SSO).
* Kann Datensätze (Superset-spezifische Zwischenschicht zwischen DB-Tabelle und Abfrage) erstellen.
* Kann Auswertungen/Diagramme in Superset erstellen.
* Kann Dashboards mit verschiedenen Auswertungen/Diagramme zusammenstellen.
* Kann Dashboards freigeben für den ganzen Mandanten (z.B. ganz Hamburg).
* Kann alle Daten im Dashboard eines Mandanten sehen.
* Kann Abfragen filtern, also z.B. in Hamburg nach Belieben nach Bezirk (Zuständigkeit) z.B. Altona oder Senat.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
* Kann andere Reporting-Administratoren für die eigenen Dashboards/Diagramme als Besitzer eintragen, um diese für die Bearbeitung, Freischaltung und Veröffentlichung zu berechtigen.
|-
|''''''EfA Cockpit Pro''''''
* FP-VM = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)

'''EfA Cockpit Basis'''

* FP-VM-Basis = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB-Basis = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)
|'''Sachbearbeiter'''
|
* Sieht ausschließlich die vorgefilterten Daten entsprechend der eigenen Zuständigkeit (also z.B. Altona).
* Kann Auswertungen herunterladen, aber nur mit den Daten der eigenen Zuständigkeit.
* Kann freigegebene Dashboards betrachten.
* Kann Auswertungen filtern, wenn Filter eingerichtet wurden.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
|}

== Superset als zentrales Tool für Reporting-Administratoren ==

=== Übergreifende Informationen zu Superset ===
Für die Erstellung und Darstellung des Reportings wurde das Open-Source-Tool Apache Superset in das DiPlan Cockpit implementiert. Superset ist eine Reporting- und Monitoring-Technologie, die es ermöglicht komplexe Daten auf Dashboards in leicht verständlichen Visualisierungen darzustellen. Die Erstellung der Dashboards erfolgt dabei direkt in der Superset-Anwendung. Dort wird auch gesteuert, welche Dashboards mit welchen Auswertungen im DiPlan Cockpit veröffentlicht werden sollen.

=== Absprung aus dem DiPlan Cockpit zu Superset ===
Sobald eine Rolle für die Erstellung von Auswertungen berechtigt ist (zum Beispiel M-A oder FP-A), findet sich im Reiter Auswertungen automatisch der Button '''"Auswertungen konfigurieren"'''. Bei Klick öffnet sich ein weiteres Browserfenster mit der Superset-Plattform. Eine gesonderte Anmeldung in Superset ist nicht erforderlich, da die Anmeldung durch das Cockpit erfolgt (auch Single Sign-On (SSO) genannt).

'''Bitte beachten:''' Nach 4 Stunden erfolgt aus Sicherheitsgründen ein automatischer Logout aus Superset - unabhängig davon ob Sie gerade in Superset arbeiten oder nicht aktiv waren. Sie erhalten keine Warnung vor dem Logout. Deshalb empfiehlt es sich, Änderungen regelmäßig zu speichern, um zu verhindern, dass ungesicherte Abfragen verloren gehen.
[[Datei:ImageButtonAuswertungenKonfigurieren.png|zentriert|mini|491x491px|Berechtigte Personen sehen über den Dashboards im DiPlan Cockpit einen Absprungbutton zu Superset mit der Bezeichnung "Auswertungen konfigurieren."]]
[[Datei:ImageStartbildschirmSuperset.png|zentriert|mini|508x508px|Startbildschirm in Superset mit einer Vorschau auf Dashboards und Diagrammen. Die Hauptmenüpunkte zur Navigation sind am oberen Bildschirmrand zu sehen.]]

=== Auswertungen erstellen, veröffentlichen und freigeben ===
Datenvisualisierungen von Abfragen werden in Superset als '''"Diagramme"''' bezeichnet. Sobald mindestens ein Diagramm erstellt ist, kann dieses auf einem Dashboard integriert werden und mit weiteren Filtermöglichkeiten versehen werden. Wie bereits erwähnt, können Sie als '''Reporting-Administrator''' selbst nach Belieben Diagramme erstellen. Nachfolgend wird beispielhaft die Erstellung und Freigabe des Dashboards mit dem Diagramm "Verfahrensstand aller Verfahren" beschrieben, um einige der Grundfunktionalitäten in Superset zu verdeutlichen (siehe dazu das Kapitel: "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]").

=== Datensätze erstellen ===
Um ein Diagramm zu erstellen wird zunächst ein Datensatz benötigt. Für einfache Abfragen reicht der '''Verfahrensdatensatz''' aus, der bereits standardmäßig enthalten ist. Dieser entspricht der '''Tabelle "Verfahren"''' mit den '''zugehörigen Datenfeldern (Stammdaten)'''.

Für Abfragen auf dem Verfahrensdatensatz können Sie direkt zum Abschnitt "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]" springen.

Für komplexere '''Abfragen über mehrere Tabellen hinweg, eigene Metriken oder eigene berechnete Spalten''' ist die Erstellung eines eigene Datensatzes mithilfe von SQL-Abfragen notwendig. Folgende Informationen sind in gesonderten Tabellen enthalten:

* Gebietseinheiten
* Kontakte
* Nutzer
* Parallelverfahren
* Termine
* Veränderungssperren
* Vertragsarten
* Vorgesehene Nutzungen
* Zurückstellungen

'''Bitte beachten:''' Bei der Erstellung von eigenen Datensätzen, muss die Spalte "'''''zustaendigkeit_code"''''' aus der Tabelle "'''''verfahren"'' immer enthalten sein,''' da hierüber die Ansicht für Sachbearbeiter standardmäßig gefiltert wird.

'''Um eigene Datensätze zu erstellen gehen Sie bitte wie folgt vor:'''

* Klick im Hauptmenü auf den '''Reiter "SQL"''' und im zugehörigen Dropdown-Menü auf '''"SQL Lab".'''
[[Datei:ImageStartSQLLab.png|zentriert|mini|576x576px|Startansicht SQL Lab]]
* Erstellen Sie Ihre '''SQL-Abfrage''' und klicken Sie auf den '''Button "Ausführen"''', um eine Vorschau auf die Ergebnisse der Abfrage zu erhalten. Ein rotes Kreuzchen links vom SQL-Editor weist auf Fehler im SQL hin.
[[Datei:ImageAusfuehrenSQLLab.png|zentriert|mini|576x576px|Ausführen einer SQL Abfrage im SQL Lab]]
'''Typische Anwendungsfälle und die dazugehörigen SQL Abfragen könnten z.B. sein:'''

* Sie möchten, dass Ihre Abfragen z.B. nach "Gebietseinheiten" und "Vorgesehenen Nutzungen" gefiltert werden können:

{| class="wikitable"
|
SELECT v.*, g.gebietseinheit, vn.vorgesehene_nutzungen
FROM verfahren v
LEFT JOIN gebietseinheiten g ON g.verfahren_id = v.id
LEFT JOIN vorgesehene_nutzungen vn ON vn.verfahren_id = v.id;
|}

* Sie möchten, dass Ihr Datensatz bestimmte Termine enthält (z.B. Grobabstimmungsdatum, Vorweggenehmigungsreife):

{| class="wikitable"
|
WITH grobabstimmung_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Grobabstimmung'
),
vorweggenehmigungsreife_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Vorweggenehmigungsreife'
)
SELECT
v.*,
t1.beginn AS grobabstimmung,
t2.beginn AS vorweggenehmigungsreife
FROM verfahren v
LEFT JOIN grobabstimmung_termin t1 ON t1.verfahren_id = v.id
LEFT JOIN vorweggenehmigungsreife_termin t2 ON t2.verfahren_id = v.id;
|}

* '''Speichern Sie Ihre Abfrage als Datensatz''' ab, indem Sie auf den '''Dropdown-Pfeil neben dem Button "Speichern"''' klicken und dann '''"Datensatz speichern"''' auswählen. Es öffnet sich ein Dialogfeld, in dem Sie einen Namen für Ihren Datensatz vergeben können.
** Hinweis: Wenn Sie statt auf "Datensatz speichern" auf "Speichern" klicken, finden Sie Ihre SQL Abfrage unter dem Reiter '''"Gespeicherte Abfragen"''' wieder.
[[Datei:ImageSpeichernDatensatzSuperset.png|zentriert|mini|581x581px|Speichern eines neuen Datensatzes]]
Nach der Erstellung eines Datensatzes können Sie diesen noch weiter bearbeiten und Labels, eigene Metriken oder berechnete Spalten hinzufügen. Gehen Sie dazu wie folgt vor:
* Klick im Hauptmenü auf den '''Reiter "Datensätze"'''. Hier sind die verfügbaren Datensätze aufgelistet.
* Klicken Sie ganz rechts neben dem Datensatz, den Sie bearbeiten wollen, auf das '''Stift-Symbol.''' Es öffnet sich eine Bearbeitungsmaske.
[[Datei:ImageBearbeitungDatensatzSuperset.png|zentriert|mini|427x427px|Öffnen Sie den Bearbeitungsmodus durch Klick auf das Stiftsymbol]]
*'''Reiter "Quelle":''' Hier kann die zugrundeliegende SQL Abfrage nachträglich angepasst werden. Klicken Sie hierfür auf das Schloss-Symbol.
[[Datei:ImageReiterQuelleSuperset.png|zentriert|mini|411x411px|Im Reiter "Quelle" kann das SQL nachträglich angepasst werden]]
*'''Reiter "Metriken":''' Hier können eigene Metriken angelegt werden.
[[Datei:ImageReiterMetrikenSuperset.png|zentriert|mini|350x350px|Eine neue Metrik "Anzahl Verfahren" wird hinzugefügt]]
*'''Reiter "Spalten":''' Hier sind alle im Datensatz enthaltenen Spalten aufgeführt. An den Werten in der Tabelle ("Datentyp", "Ist zeitlich" etc.) sollte in der Regel nichts geändert werden, dies wird von Superset automatisch richtig erkannt. Beim '''Klick auf das "Plus"''' neben jeder Spalte kann unter "Beschriftung" ein sprechendes Label hinzugefügt werden. Dieses wird später in den Diagrammen angezeigt.
[[Datei:ImageReiterSpaltenSuperset.png|zentriert|mini|470x470px|Im Reiter "Spalten" wird ein Label hinzugefügt]]
*'''Reiter "Berechnete Spalten":''' Hier können dem Datensatz weitere Spalten hinzugefügt werden, die Werte enthalten, die aus anderen Spalten errechnet werden. Verwenden Sie für die Berechnung SQL-Syntax.
[[Datei:ImageReiterBerechneteSpaltenSuperset.png|zentriert|mini|416x416px|Eine berechnete Spalte wird hinzugefügt]]
* Speichern Sie Ihre Änderungen am Datensatz durch das '''Klicken auf den "Speichern"-Button'''. Um die Änderungen zu prüfen, empfiehlt es sich ein Diagramm mit dem Datensatz anzulegen (z.B. eine Tabelle).

=== Beispiel-Diagramm erstellen ===
Nachfolgend soll beispielhaft ein Diagramm "Verfahrensstand aller Verfahren" erstellt werden. Dazu gehen Sie wie folgt vor:

# Klick auf den '''Menüpunkt "Diagramme":''' Auf dieser Seite findet sich eine Liste mit allen bereits erstellten Diagrammen. Innerhalb dieser Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Diagramm-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageUebersichtDiagrammeSuperset.png|zentriert|mini|501x501px|Im Menüpunkt "Diagramme" findet sich eine Übersicht über die bisher erstellten Diagramme (Abfragen) mit vielen Zusatzinformationen.]]
# Um ein neues Diagramm zu erstellen klicken Sie auf den '''Button "+Diagramm"''' rechts oben. Es öffnet sich der Dialog '''"Neues Diagramm erstellen".'''[[Datei:ImageNeuesDiagrammSuperset.png|zentriert|mini|487x487px|Dialog um ein neues Diagramm zu erstellen]]
# Zunächst muss der '''passende Datensatz für die Auswertung ausgewählt''' werden. Für dieses Beispiel wählen wir unter '''"1- Datensatz auswählen"''' den Datensatz '''"verfahren"''' im Dropdownmenü aus.
# Im nächsten Schritt wird der '''passende Diagrammtyp ausgewählt'''. Hier werden Ihnen viele verschiedene Visualisierungsmöglichkeiten geboten. Im genannten Beispiel passt ein "Kreisdiagramm" am besten zu der Visualisierung der Verfahrensstände aller Verfahren. Sie finden das Kreisdiagramm unter dem Hauptmenü "Teil des Ganzen". Klicken Sie '''auf das Kreisdiagramm''' und anschließend auf '''"Neues Diagramm erstellen"'''.
# Nun geht es um die '''Detailkonfiguration''' des Diagramms. Grundsätzlich ist der Arbeitsbereich wie folgt aufgebaut:
#* Die linke Spalte enthält einen '''Überblick''' über die '''zur Verfügung stehenden Daten'''.
#* Die mittlere Spalte enthält die '''Werkzeuge''', um das '''Diagramm zu konfigurieren.'''
#* Im rechten Bereich kann man sich jeweils eine '''Vorschau des Diagramms''' anzeigen lassen.
'''Wir gehen für unser Beispiel wie folgt vor:'''

* Im Feld '''"Name des Diagramms hinzufügen"''' das Diagramm mit einer passenden Bezeichnung versehen.
* Um die Dimensionen des Diagramms festzulegen im Tab '''"Daten"''' unter der Überschrift '''"Abfrage > Dimensionen"''' die Spalte '''"verfahrensstand"''' von links per Drag & Drop herüberziehen.
* Der dazustellende Wert soll hier die Anzahl sein, weshalb nun unter '''"Metrik"''' das Feld '''"Anzahl"''' Button "+Diagramm" per Drag & Drop von links herübergezogen wird. Je nach Fragestellung bzw. welche Daten auf dem Diagramm dargestellt werden sollen, können verschiedenste Kombinationen in der selben Art und Weise über Drag & Drop zusammengestellt werden.
* Unter dem '''Punkt "Filter"''' kann eine Vorabfilterung eingebaut werden, also beispielsweise könnten Sie simulierte Verfahren standardmäßig herausfiltern, so dass die Nutzenden diese gar nicht auswerten können. Anmerkung: "imported_at" kann nicht gelöscht werden. Dieser Wert wird von Superset standardmäßig gesetzt und hat keine Auswirkung auf Ihre Auswertungen.
* Das für die Berechnung zugrundeliegende Zeilenlimit kann bei Bedarf verändert werden.
* Ein Klick auf den '''blauen Button "Diagramm erstellen"''' zeigt eine '''Vorschau''' des erstellten Diagrammes auf der rechten Bildschirmhälfte. Das Diagramm kann nun jederzeit mit einem '''Klick auf "Speichern"''' rechts oben gesichert werden.[[Datei:ImageDiagrammErstellenSuperset.png|zentriert|mini|426x426px|Dialog zur Detaildefinition des neuen Diagramms. Hier beispielhaft zusammengestellt für die Darstellung "Verfahrenstand aller Verfahren".]]

* Unter dem '''Tab "Anpassen"''' finden sich zahlreiche Möglichkeiten, das Diagramm weiter zu verfeinern (zum Beispiel in Farbe und Layout). Hier kann ganz nach Belieben ausprobiert werden. Mit '''Klick auf''' '''"Diagramm aktualisieren"''' kann die Vorschau des Diagramms zur Überprüfung mit den neu gewählten Einstellungen geladen werden.[[Datei:ImageDiagrammAnpassenSuperset.png|zentriert|mini|421x421px|Diagramm kann nach Belieben im Tab "Anpassen" verändert und verfeinert werden.]]
* '''Speichern nicht vergessen:''' Das Diagramm wird erst gespeichert durch '''Klick auf "Speichern" rechts oben'''. Es öffnet sich ein Dialog zu weiteren Speicheroptionen, der mit '''einer weiteren Speicherbestätigung''' abgeschlossen werden kann.[[Datei:ImageDiagrammSpeichernSuperset.png|zentriert|mini|427x427px|Speichern-Dialog für das erstellte Diagramm]]

=== Beispiel-Dashboard erstellen ===

# '''Klick auf den Menüpunkt "Dashboards":''' Unter der Überschrift "Dashboards" findet sich eine Liste mit allen bereits erstellten Dashboards. Diese Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Dashboard-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageDashboardsSuperset.png|zentriert|mini|452x452px|Unter dem Menüpunkt "Dashboards" finden sich alle bereits angelegten Dashboards, sowie die Möglichkeit neue Dashboards zu erstellen.]]
# Mit Klick auf den Button '''"+Dashboard"''' rechts oben öffnet sich ein neuer, leerer Dashboard -Entwurf.
# Der Titel des Dashboards ist standardmäßig als "untitled dashboard" angeben und kann durch '''Klick auf den Namen''' geändert werden.
# Auf der Seitenleiste am rechten Bildschirmrand finden sich alle bereits erstellten Diagramme. Das gewünschte Diagramm kann einfach durch '''Drag & Drop mit der Maus auf das Dashboard gezogen''' werden. Auch die Größe kann leicht geändert werden indem sie die Ränder oder Ecken des Diagramms klicken, gedrückt halten und auf die gewünschte Größe ziehen. Sie können ein oder auch mehrere Diagramme auf einem Dashboard platzieren.
# Zu guter Letzt oben rechts auf den '''Button "Speichern"''' klicken um Ihre Arbeit zu sichern. Nach dem Speichern können Sie jederzeit am Dashboard weiter arbeiten indem Sie auf den nun erscheinenden Button '''"Dashboard bearbeiten"''' klicken.
# Sollten Sie ein Diagramm wieder vom Dashboard löschen wollen, können Sie einfach das '''Mülleimer-Symbol''' klicken, welches bei Mouseover über das jeweilige Diagramm erscheint.[[Datei:ImageDragDropDiagrammSuperset.png|zentriert|mini|351x351px|Das gewünschte Diagramm kann mit der Maus einfach auf das Dashboard gezogen und platziert werden.]]
[[Datei:ImageDiagrammGroesseSuperset.png|zentriert|mini|325x325px|Die Größe des Diagramms lässt sich einfach durch Ziehen der Maus an Ecken oder Rändern verändern.]]

=== Einen oder mehrere Filter zu einem Dashboard zufügen ===
Es ist möglich Ihre Auswertungsdiagramme mit Filtermöglichkeiten zu versehen. Im folgenden wird beispielhaft ein Filter nach der Zuständigkeit auf dem Dashboard "Verfahrensstand aller Verfahren" hinzugefügt:

# Öffnen Sie das Dashboard oder legen Sie sich ein entsprechendes neues Dashboard an und speichern dieses.
# An der linken Bildschirmkante den '''kleinen Pfeil klicken''', um das Filtermenü auszuklappen. '''Wichtig:''' Der Pfeil ist nur sichtbar, wenn das Dashboard bereits gespeichert ist und sich nicht gerade im offenen Bearbeitungsmodus befindet. Sprich: Klicken Sie '''nicht''' "Dashboard bearbeiten" bevor Sie den Filter hinzufügen.
# Klicken Sie auf das '''kleine Zahnrad''' um das Untermenü zu öffnen.
# Ein Klick auf '''"Hinzufügen und Bearbeiten von Filtern"''' öffnet das Menü um die Filter zu konfigurieren.[[Datei:ImageDashboardFilterMenueSuperset.png|zentriert|mini|372x372px|Durch Klick auf den kleinen Pfeil öffnet sich das Menü, mit dem Filter hinzugefügt und konfiguriert werden können.]]
# Um nach der Zuständigkeit zu filtern muss im '''Menü Filtertyp die Option "Wert"''' ausgewählt sein.
# Im Menüpunkt Tabellenname '''"Zuständigkeit"''' als '''Namen des Filters''' eintragen.
# Im '''Feld Datensatz''' wird in diesem Fall '''"verfahren"''' ausgewählt.
# Im '''Feld "Spalte"''' den Filter auswählen, nach dem gefiltert werden soll: in diesem Fall '''"zustaendigkeit".'''
# Das Menü '''"Filterwerte sortieren"''' durch einen Haken aktivieren und absteigend sortieren und mit der '''Sortiermetrik "Anzahl"''' versehen.
# Im '''Reiter "Auswahlverfahren"''' kann der Filter durch eine Auswahl außerdem auf '''einzelne Diagramme oder auf alles bezogen''' werden.
# Durch '''Klick auf "Speichern"''' rechts unten wird der Filter in das Dashboard integriert.[[Datei:ImageFilteroptionenDashboardSuperset.png|zentriert|mini|431x431px|Sie können einen oder mehrere Filteroptionen auf einem Dashboard integrieren und in diesem Menü konfigurieren.]]
'''Übergeordnete Filtereinstellungen:'''

Nach '''Klick auf das Zahnrad''', im geöffneten Filter-Untermenü, können Sie außerdem entscheiden, ob der Filter '''oben''' über dem Diagramm '''oder seitlich links einklappbar''' angezeigt werden soll.

Es gibt dort außerdem die Möglichkeit für ein oder mehrere Diagramme eine '''Kreuzfilterung zu aktivieren.''' Diese erlaubt es Ihnen, direkt '''in einem Diagramm auf ein Element zu klicken''', um damit automatisch eines oder alle Diagramme im Dashboard zu filtern. So können Daten intuitiv und interaktiv erkundet werden, ohne separate Filtersteuerungen zu verwenden.
[[Datei:ImageFilterUntermenueSuperset.png|zentriert|mini|440x440px|Im Filter-Untermenü können bestehende Filter bearbeitet oder weitere Filter hinzugefügt werden. Außerdem kann die Kreuzfilterung aktiviert und die Darstellung der Filterleiste verändert werden.]]

=== Dashboards veröffentlichen ===
Dashboards werden erst im DiPlan Cockpit sichtbar, nachdem diese veröffentlicht und für die Sachbearbeitenden und Reporting-Administratoren freigeschalten wurden. Dabei gilt es zu beachten, dass Sie nur Dashboards veröffentlichen und freischalten können, die Sie selbst erstellt haben oder für die Sie berechtigt worden sind. Siehe hierzu auch das Kapitel "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Diagramme_und_Dashboards_f.C3.BCr_andere_Reporting-Administratoren_zur_Bearbeitung_freigeben Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben]".

'''Zur Veröffentlichung und Freischaltung gehen Sie wie folgt vor:'''

# Öffnen Sie das Dashboard, welches veröffentlicht werden soll.
# Durch Klick auf das '''graue Feld "Entwurf"''' neben dem Dashboard Namen, ändert sich die Bezeichnung auf '''"Veröffentlicht".'''[[Datei:ImageStatusVeroeffentlichtSuperset.png|zentriert|mini|435x435px|Durch Klick ändert sich der Status von "Entwurf" auf "Veröffentlicht".]]
# Öffnen Sie rechts oben das '''Dreipunktemenü''' und wählen Sie dort den Unterpunkt '''"Dashboard einbetten"''' aus.[[Datei:ImageDashboardEinbettenSuperset.png|zentriert|mini|317x317px|Im Dreipunktemenü muss im nächsten Schritt der Punkt "Dashboard einbetten" geklickt werden.]]
# Im Einbetten-Dialog lassen Sie das Feld für "Zulässige Domänen" bitte einfach frei und klicken lediglich den '''Button "Einbettung aktivieren".''' Dann kann das Menü durch Klick auf das '''X-Symbol''' geschlossen werden.[[Datei:ImageEinbettungAktivierenSuperset.png|zentriert|mini|378x378px|Im Menü "Einbetten" klicken Sie auf "Einbettung aktivieren" und dann einfach auf das X um das Fenster zu schließen.]]
# Um das Dashboard nun für die '''Rolle der Sachbearbeitenden und Mandanten-Administratoren''' im DiPlan Cockpit '''freizugeben''' öffnen Sie bitte erneut den Reiter '''"Dashboards",''' um auf die Liste mit allen Dashboards zu gelangen.
# Klicken Sie auf das '''Stift-Symbol''' neben dem Dashboard, welches freigeschalten werden soll.[[Datei:ImageDashboardEigenschaftenOeffnenSuperset.png|zentriert|mini|398x398px|Durch Klick auf das Stiftsymbol neben dem Dashboard werden die Dashboardeigenschaften geöffnet. Dort können auch die einzelnen Rollen freigeschaltet werden.]]
# In den '''Dashboardeigenschaften''' können nun die Rollen eingetragen werden, für die das Dashboard freigeschalten werden soll. Die Rollenbezeichnungen in Superset fassen mehrere Rollen aus dem DiPlan Cockpit zusammen, was die Freigabe von Dashboards vereinfacht. Bitte tragen Sie im Feld "Rollen" deshalb '''"Reporting-Administrator"''' und '''"Sachbearbeiter" in der Liste ein.''' Dies ist durch Tippen in das Feld möglich, so wird die auszuwählende Rolle schneller sichtbar. Sie können jedoch auch manuell durch die Liste scrollen und die Rolle auswählen. Klicken Sie anschließend den '''"Speichern"-Button'''. Die Auswertungen sind nun im DiPlan Cockpit für alle berechtigten Rollen sichtbar.[[Datei:ImageDashboardEigenschaftenRollenSuperset.png|zentriert|mini|395x395px|In den Dashboardeigenschaften müssen die Rollen, für die das Dashboard freigegeben werden soll, ausgewählt werden.]]
'''Hinweis: Veröffentlichung zurücknehmen'''

Sollten Sie ein Dashboard im DiPlan Cockpit unsichtbar machen wollen, so klicken Sie wie im Punkt 2 beschrieben wieder auf die graue Schaltfläche und setzen Sie den Status von '''"Veröffentlicht"''' zurück auf '''"Entwurf".'''

=== Bestehendes Dashboard oder Diagramm bearbeiten oder löschen ===
'''Wie lösche ich ein eingebettetes Diagramm von einem bereits veröffentlichten und freigegebenen Dashboard?'''

* Öffnen Sie das Dashboard und '''klicken Sie "Dashboard bearbeiten"''' auf der rechten Bildschirmseite.
* Im geöffneten Bearbeitungsmodus können Sie nun die Maus über das nicht mehr erwünschte Diagramm bewegen und durch '''Klick auf das erscheinende Mülleimersymbol''' löschen. Das Diagramm bleibt in der Liste der Diagramme weiterhin erhalten und wird lediglich vom Dashboard genommen.
* Sie können ein '''weiteres/neues Diagramm''' jederzeit wieder aus der Liste rechts auf das Dashboard ziehen.
* Bestätigen Sie das veränderte Dashboard durch Klick auf den "'''Speichern"-Button''' rechts oben.
* '''Bitte beachten:''' Änderungen an bereits veröffentlichten und freigegebenen Dashboards werden nach dem '''Speichern direkt auf dem DiPlan Cockpit sichtbar'''.
[[Datei:ImageDashboardDiagrammLoeschenSuperset.png|zentriert|mini|370x370px|Per Mouseover und Klick auf das Mülleimer Symbol lassen sich Diagramme auf Dashboards einfach wieder löschen.]]
'''Wie bearbeite ich ein bestehendes Diagramm?'''

Ein Diagramm unabhängig vom Dashboard ändern:

* Öffnen Sie das zu bearbeitende Diagramm in der '''Liste der Diagramme''' durch einen '''Klick auf den Namen'''.
* Das Diagramm öffnet sich direkt im Bearbeitungsmodus und kann nach '''Belieben angepasst werden'''.
* Ist das Diagramm bereits auf einem veröffentlichten und freigegebenen Dashboard eingebettet, so werden alle Änderungen nach dem Speichern direkt übernommen und im '''DiPlan Cockpit sichtbar'''.

Ein Diagramm direkt auf einem Dashboard ändern:

* Öffnen Sie das Dashboard und klicken Sie '''"Dashboard bearbeiten"'''.
* Bewegen Sie die Maus über die entsprechende Grafik, öffnen Sie das Dreipunktemenü rechts und klicken '''"Diagramm bearbeiten".'''
* Nachdem Sie das Diagramm bearbeitet haben klicken Sie '''"Speichern"'''.

'''Bitte beachten:''' Im Speichern-Dialog können Sie entscheiden, ob sie das bestehende '''Diagramm überschreiben''' oder ein '''neues Diagramm speichern''' wollen. Dies kann hilfreich sein, wenn Sie das Diagramm nicht generell, sondern nur auf einem bereits bestehenden Dashboard ändern wollen.

'''Wie lösche ich ein Dashboard oder Diagramm dauerhaft?'''

Sie können ein Dashboard unabhängig vom Status (also veröffentlicht oder auch als Entwurf) in der Liste der Dashboards wie folgt löschen:

* Bewegen Sie die Maus über den entsprechenden '''Listeneintrag.'''
* Klicken Sie das in der Zeile rechts erscheinende '''Papierkorb-Symbol''' und folgen den Anweisungen im erscheinenden Löschdialog.
* Die Originaldiagramme auf dem Dashboard bleiben dabei weiterhin in der Liste "Diagramme" erhalten.
* Sollten Sie ein Diagramm dauerhaft löschen wollen, so gehen Sie genauso wie beim Dashboard vor, jedoch im '''Reiter "Diagramme"'''.

=== Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Bitte beachten:''' Solange Reporting-Administratoren nicht als Besitzer eingetragen sind, haben diese nur Zugriff auf die eigenen erstellten Daten.

'''Das bedeutet konkret für die erstellten Daten von anderen Reporting-Administratoren:'''

* Unveröffentlichte Dashboards sind nicht sichtbar.
* Veröffentlichte Dashboards sind sichtbar, aber nicht bearbeitbar.
* Alle Diagramme sind sichtbar, Änderungen können jedoch nur als neue Diagramme gespeichert werden.
* Datensätze sind sichtbar und können verwendet, aber nicht bearbeitet werden.
* Gespeicherte Abfragen sind nicht sichtbar (Berechtigungen können hier grundsätzlich nicht vergeben werden).

Sie haben grundsätzlich keine Rechte ein Dashboard zu bearbeiten oder ein Diagramm zu überschreiben, welches nicht von Ihnen erstellt wurde, außer Sie wurden als '''"Besitzende/r"''' dazu ermächtigt.

Das bedeutet beispielsweise, dass Sie ein Diagramm, welches jemand anders erstellt hat, zwar bearbeiten, dies aber nur als neues Diagramm abspeichern können. Das Originaldiagramm wird hier nicht verändert. Um jemanden für die '''Mitarbeit an Ihrem Diagramm oder Dashboard zu ermächtigen''' gehen Sie wie folgt vor:

* Klicken Sie in der Liste der Diagramme oder Dashboards auf das '''Stift-Symbol "Bearbeiten".''' Der Dialog '''"Diagrammeigenschaften bearbeiten"''' öffnet sich.
* Unter der '''Überschrift "Zugang"''' können weitere '''"Besitzende" eingetragen''' werden. Klicken Sie hierzu in das Eingabefeld und fangen Sie an den Namen zu tippen oder scrollen Sie durch die Liste bis zum gewünschten Namen.
* '''Wählen Sie einen oder mehrere Namen aus,''' um diese in das Feld zu übernehmen und klicken Sie dann auf '''"Speichern"'''. Die eingetragene Person hat nun die gleichen '''Rechte zur Bearbeitung wie der/die ursprüngliche Ersteller/in'''.

=== Datensätze für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Um Datensätze für andere Reporting-Administratoren zur Bearbeitung freizugeben, gehen Sie wie folgt vor:'''

* Klick auf den '''Reiter "Datensätze"'''
* In der Übersicht-Liste klicken Sie bitte das '''Stift- Symbol''' neben dem gewünschten Datensatz.
* Klicken Sie den '''Reiter "Einstellungen"''' ganz rechts und scrollen Sie ganz nach unten.
* Dort können Sie im '''Feld "Besitzende"''' auch andere Reporting-Administratoren zur Bearbeitung berechtigen.

== Weiterführende Informationen ==
Unter folgendem Link können Sie weitere Informationen zu Superset in englischer Sprache finden. Bitte beachten Sie, dass Ihre Datenbank bereits angebunden ist und der Punkt "Connecting to a new database" in der Dokumentation somit nicht beachtet werden sollte: '''[https://superset.apache.org/docs/6.0.0/using-superset/creating-your-first-dashboard#creating-your-first-dashboard Englische Dokumentation des Open-Source-Tools Superset]'''

Datei:ImageDashboardDiagrammLoeschenSuperset.png

2026-03-16T11:02:11Z

Diplanung:

ImageDashboardDiagrammLoeschenSuperset

Reporting: Auswertungen im DiPlan Cockpit

2026-03-16T10:30:26Z

Diplanung: /* Dashboards veröffentlichen */

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

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

⚠️ '''Bitte beachten: Die Reporting-Funktionalität wird nach und nach Mandanten spezifisch freigeschaltet. Informationen zur Funktionsweise finden Sie hier vorab.'''

== Einleitung ==
Die Auswertungskomponente für das DiPlan Cockpit ermöglicht das Abrufen, Filtern und Downloaden von Reports und Auswertungen aus Planungs- und Genehmigungsverfahren. Die Auswertungsdiagramme zu individuellen Fragestellungen werden in dem externen BI-Tool Superset von berechtigten Personen auf Basis grundlegender SQL- und Datenmodell-Kenntnisse erstellt, verwaltet, auf Dashboards zusammengestellt und schließlich für die Darstellung im DiPlan Cockpit freigegeben.

== Aufruf der Auswertungen ==
Die Auswertungen sind in dem gleichnamigen Reiter im DiPlan Cockpit zu finden.

In der linken Bildschirmhälfte sind die Namen der jeweiligen zur Verfügung stehenden Dashboards zu finden. Ein Dashboard ist eine Zusammenstellung von einem oder mehreren Auswertungsdiagrammen auf einer Seite. Standardmäßig wird das Dashboard "Verfahrensstand aller Verfahren" für jeden Mandant initial mit ausgerollt. Alle weiteren Dashboards können je nach Bedarf individuell durch berechtigte Personen je Mandant erstellt werden. Mehr dazu findet sich im Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Auswertungen_erstellen.2C_ver.C3.B6ffentlichen_und_freigeben Auswertungen erstellen, veröffentlichen und freigeben].

'''Gut zu wissen:'''

* '''Datengrundlage:''' Grundsätzlich fließen gelöschte Verfahren nicht in die Auswertungen ein.
* '''Aktualität der Daten:''' Die Daten werden jede Nacht einmal mit der DiPlan Cockpit Datenbank synchronisiert.
* '''Darstellung:''' Das Reporting wird mit dem Tool Superset umgesetzt, welches in das DiPlan Cockpit eingebunden wird. Für eine optimale Darstellung nutzen Sie bitte den Browser Microsoft Edge.
[[Datei:ImageAuswertungenCockpit.png|zentriert|mini|717x717px|Ansicht des Reiters "Auswertungen" im DiPlan Cockpit mit dem Standarddashboard "Verfahrensstand aller Verfahren".]]

== Filtern der Dashboards bzw. Auswertungen ==
Je nach Art der dargestellten Auswertungen können Sie weitere Aktionen in den einzelnen Diagrammen vornehmen. Oftmals sind zum Beispiel verschiedene Filterungsmöglichkeiten hinterlegt. Zum Öffnen der Filter gehen Sie bitte folgendermaßen vor:

* Aufklappen der Filter durch Klick auf den kleinen blauen Pfeil links neben den Diagrammen. Alternativ können die Filter auch am oberen Rand des Dashboards eingebunden sein.
* Auswählen der gewünschten Filter.
* Klick auf "Filter anwenden".
* Bei Klick auf "Alles löschen" werden sämtliche gesetzte Filter wieder zurückgesetzt.
[[Datei:ImageAuswertungenCockpitFilter.png|zentriert|mini|742x742px|Falls eine Filterung im Dashboard integriert wurde, so lässt diese sich über den kleinen Pfeil ausklappen oder befindet sich am oberen Rand des Dashboards. Hier zu sehen eine Filterung auf dem Dashboard nach Zuständigkeit oder Verfahrenstyp.]]
[[Datei:ImageAuswertungenCockpitFilter2.png|zentriert|mini|742x742px|Das Reporting bietet die Möglichkeit auch mehrere verschiedene Diagrammtypen auf einem Dashboard darzustellen. Diese können von Mandanten-Administratoren konfiguriert und freigegeben werden. Hier ein Beispiel mit integrierten Filtern am oberen Rand des Dashboards.]]

== Download der Auswertungen ==
Neben jeder Auswertungsgrafik (jedem Diagramm) finden sich drei Punkte, welche bei Klick ein Drop-Down Menü öffnen. Durch '''Mouseover auf "Herunterladen"''' öffnet sich das Menü zum Download des Diagramms in verschiedenen auswählbaren Formaten. Hier sind folgende Punkte zu beachten:

* '''Der Download entspricht immer der Filterung:''' Wird eine Grafik durch eine Filterung angepasst und dann ein Download gestartet, so entsprechen die heruntergeladenen Daten immer genau der Filterung, das heißt es sind nicht alle Daten vorhanden. Je nach Grafik ist in den heruntergeladenen Dateien nicht selbsterklärend, dass eine Filterung angewendet wurde und es ist wichtig das Downloadergebnis bei der weiteren Verwendung in den richtigen Kontext zu setzen. Laden Sie sich alternativ die Daten ohne Filterung herunter und filtern Sie zum Beispiel bei Bedarf gesondert in MS Excel.
* '''Die Rollen der Sachbearbeitenden sehen nur die eigene Zuständigkeit:''' Je nach Rolle der Nutzenden werden unter Umständen nicht alle Daten auf den Dashboards dargestellt. Sachbearbeitende können nur Daten der eigenen Zuständigkeit sehen. Siehe dazu auch das nächste Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Rechte_und_Rollen Rechte und Rollen].
[[Datei:ImageAuswertungenHerunterladen.png|zentriert|mini|327x327px|Das vertikale Dreipunktemenü in den Diagrammen beinhaltet die Herunterladen-Funktion.]]

== Rechte und Rollen ==
Alle Rollen aus dem DiPlan Cockpit werden gemäß ihrer Berechtigungen mit einer entsprechenden Rolle in Superset versehen. Prinzipiell gibt es zwei relevante Rollen, denen die Nutzenden in Superset zugeordnet werden. Dies passiert automatisch und regelt ob die Nutzenden berechtigt sind Auswertungen selbst anzulegen, freizugeben und zu veröffentlichen oder ob sie ausschließlich die freigegebenen Auswertungen gemäß ihrer Zuständigkeit im DiPlan Cockpit sehen können. Nachfolgend sehen Sie eine Übersicht über die verschiedenen Berechtigungen:
{| class="wikitable"
|'''Rolle DiPlan Cockpit'''
|'''Rolle Superset'''
|'''Berechtigungen'''
|-
|'''EfA Cockpit Pro'''
* M-A = Mandanten-Administration
* FP-A = Fachplanung-Administration

'''EfA Cockpit Basis'''

* M-A-Basis = Mandanten-Administration-Basis
* FP-A-Basis = Fachplanung-Administration Basis
|'''Reporting-Administrator'''
|
* Kann direkt aus dem DiPlan Cockpit zu Superset abspringen und ist dort automatisch eingeloggt (SSO).
* Kann Datensätze (Superset-spezifische Zwischenschicht zwischen DB-Tabelle und Abfrage) erstellen.
* Kann Auswertungen/Diagramme in Superset erstellen.
* Kann Dashboards mit verschiedenen Auswertungen/Diagramme zusammenstellen.
* Kann Dashboards freigeben für den ganzen Mandanten (z.B. ganz Hamburg).
* Kann alle Daten im Dashboard eines Mandanten sehen.
* Kann Abfragen filtern, also z.B. in Hamburg nach Belieben nach Bezirk (Zuständigkeit) z.B. Altona oder Senat.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
* Kann andere Reporting-Administratoren für die eigenen Dashboards/Diagramme als Besitzer eintragen, um diese für die Bearbeitung, Freischaltung und Veröffentlichung zu berechtigen.
|-
|''''''EfA Cockpit Pro''''''
* FP-VM = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)

'''EfA Cockpit Basis'''

* FP-VM-Basis = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB-Basis = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)
|'''Sachbearbeiter'''
|
* Sieht ausschließlich die vorgefilterten Daten entsprechend der eigenen Zuständigkeit (also z.B. Altona).
* Kann Auswertungen herunterladen, aber nur mit den Daten der eigenen Zuständigkeit.
* Kann freigegebene Dashboards betrachten.
* Kann Auswertungen filtern, wenn Filter eingerichtet wurden.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
|}

== Superset als zentrales Tool für Reporting-Administratoren ==

=== Übergreifende Informationen zu Superset ===
Für die Erstellung und Darstellung des Reportings wurde das Open-Source-Tool Apache Superset in das DiPlan Cockpit implementiert. Superset ist eine Reporting- und Monitoring-Technologie, die es ermöglicht komplexe Daten auf Dashboards in leicht verständlichen Visualisierungen darzustellen. Die Erstellung der Dashboards erfolgt dabei direkt in der Superset-Anwendung. Dort wird auch gesteuert, welche Dashboards mit welchen Auswertungen im DiPlan Cockpit veröffentlicht werden sollen.

=== Absprung aus dem DiPlan Cockpit zu Superset ===
Sobald eine Rolle für die Erstellung von Auswertungen berechtigt ist (zum Beispiel M-A oder FP-A), findet sich im Reiter Auswertungen automatisch der Button '''"Auswertungen konfigurieren"'''. Bei Klick öffnet sich ein weiteres Browserfenster mit der Superset-Plattform. Eine gesonderte Anmeldung in Superset ist nicht erforderlich, da die Anmeldung durch das Cockpit erfolgt (auch Single Sign-On (SSO) genannt).

'''Bitte beachten:''' Nach 4 Stunden erfolgt aus Sicherheitsgründen ein automatischer Logout aus Superset - unabhängig davon ob Sie gerade in Superset arbeiten oder nicht aktiv waren. Sie erhalten keine Warnung vor dem Logout. Deshalb empfiehlt es sich, Änderungen regelmäßig zu speichern, um zu verhindern, dass ungesicherte Abfragen verloren gehen.
[[Datei:ImageButtonAuswertungenKonfigurieren.png|zentriert|mini|491x491px|Berechtigte Personen sehen über den Dashboards im DiPlan Cockpit einen Absprungbutton zu Superset mit der Bezeichnung "Auswertungen konfigurieren."]]
[[Datei:ImageStartbildschirmSuperset.png|zentriert|mini|508x508px|Startbildschirm in Superset mit einer Vorschau auf Dashboards und Diagrammen. Die Hauptmenüpunkte zur Navigation sind am oberen Bildschirmrand zu sehen.]]

=== Auswertungen erstellen, veröffentlichen und freigeben ===
Datenvisualisierungen von Abfragen werden in Superset als '''"Diagramme"''' bezeichnet. Sobald mindestens ein Diagramm erstellt ist, kann dieses auf einem Dashboard integriert werden und mit weiteren Filtermöglichkeiten versehen werden. Wie bereits erwähnt, können Sie als '''Reporting-Administrator''' selbst nach Belieben Diagramme erstellen. Nachfolgend wird beispielhaft die Erstellung und Freigabe des Dashboards mit dem Diagramm "Verfahrensstand aller Verfahren" beschrieben, um einige der Grundfunktionalitäten in Superset zu verdeutlichen (siehe dazu das Kapitel: "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]").

=== Datensätze erstellen ===
Um ein Diagramm zu erstellen wird zunächst ein Datensatz benötigt. Für einfache Abfragen reicht der '''Verfahrensdatensatz''' aus, der bereits standardmäßig enthalten ist. Dieser entspricht der '''Tabelle "Verfahren"''' mit den '''zugehörigen Datenfeldern (Stammdaten)'''.

Für Abfragen auf dem Verfahrensdatensatz können Sie direkt zum Abschnitt "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]" springen.

Für komplexere '''Abfragen über mehrere Tabellen hinweg, eigene Metriken oder eigene berechnete Spalten''' ist die Erstellung eines eigene Datensatzes mithilfe von SQL-Abfragen notwendig. Folgende Informationen sind in gesonderten Tabellen enthalten:

* Gebietseinheiten
* Kontakte
* Nutzer
* Parallelverfahren
* Termine
* Veränderungssperren
* Vertragsarten
* Vorgesehene Nutzungen
* Zurückstellungen

'''Bitte beachten:''' Bei der Erstellung von eigenen Datensätzen, muss die Spalte "'''''zustaendigkeit_code"''''' aus der Tabelle "'''''verfahren"'' immer enthalten sein,''' da hierüber die Ansicht für Sachbearbeiter standardmäßig gefiltert wird.

'''Um eigene Datensätze zu erstellen gehen Sie bitte wie folgt vor:'''

* Klick im Hauptmenü auf den '''Reiter "SQL"''' und im zugehörigen Dropdown-Menü auf '''"SQL Lab".'''
[[Datei:ImageStartSQLLab.png|zentriert|mini|576x576px|Startansicht SQL Lab]]
* Erstellen Sie Ihre '''SQL-Abfrage''' und klicken Sie auf den '''Button "Ausführen"''', um eine Vorschau auf die Ergebnisse der Abfrage zu erhalten. Ein rotes Kreuzchen links vom SQL-Editor weist auf Fehler im SQL hin.
[[Datei:ImageAusfuehrenSQLLab.png|zentriert|mini|576x576px|Ausführen einer SQL Abfrage im SQL Lab]]
'''Typische Anwendungsfälle und die dazugehörigen SQL Abfragen könnten z.B. sein:'''

* Sie möchten, dass Ihre Abfragen z.B. nach "Gebietseinheiten" und "Vorgesehenen Nutzungen" gefiltert werden können:

{| class="wikitable"
|
SELECT v.*, g.gebietseinheit, vn.vorgesehene_nutzungen
FROM verfahren v
LEFT JOIN gebietseinheiten g ON g.verfahren_id = v.id
LEFT JOIN vorgesehene_nutzungen vn ON vn.verfahren_id = v.id;
|}

* Sie möchten, dass Ihr Datensatz bestimmte Termine enthält (z.B. Grobabstimmungsdatum, Vorweggenehmigungsreife):

{| class="wikitable"
|
WITH grobabstimmung_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Grobabstimmung'
),
vorweggenehmigungsreife_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Vorweggenehmigungsreife'
)
SELECT
v.*,
t1.beginn AS grobabstimmung,
t2.beginn AS vorweggenehmigungsreife
FROM verfahren v
LEFT JOIN grobabstimmung_termin t1 ON t1.verfahren_id = v.id
LEFT JOIN vorweggenehmigungsreife_termin t2 ON t2.verfahren_id = v.id;
|}

* '''Speichern Sie Ihre Abfrage als Datensatz''' ab, indem Sie auf den '''Dropdown-Pfeil neben dem Button "Speichern"''' klicken und dann '''"Datensatz speichern"''' auswählen. Es öffnet sich ein Dialogfeld, in dem Sie einen Namen für Ihren Datensatz vergeben können.
** Hinweis: Wenn Sie statt auf "Datensatz speichern" auf "Speichern" klicken, finden Sie Ihre SQL Abfrage unter dem Reiter '''"Gespeicherte Abfragen"''' wieder.
[[Datei:ImageSpeichernDatensatzSuperset.png|zentriert|mini|581x581px|Speichern eines neuen Datensatzes]]
Nach der Erstellung eines Datensatzes können Sie diesen noch weiter bearbeiten und Labels, eigene Metriken oder berechnete Spalten hinzufügen. Gehen Sie dazu wie folgt vor:
* Klick im Hauptmenü auf den '''Reiter "Datensätze"'''. Hier sind die verfügbaren Datensätze aufgelistet.
* Klicken Sie ganz rechts neben dem Datensatz, den Sie bearbeiten wollen, auf das '''Stift-Symbol.''' Es öffnet sich eine Bearbeitungsmaske.
[[Datei:ImageBearbeitungDatensatzSuperset.png|zentriert|mini|427x427px|Öffnen Sie den Bearbeitungsmodus durch Klick auf das Stiftsymbol]]
*'''Reiter "Quelle":''' Hier kann die zugrundeliegende SQL Abfrage nachträglich angepasst werden. Klicken Sie hierfür auf das Schloss-Symbol.
[[Datei:ImageReiterQuelleSuperset.png|zentriert|mini|411x411px|Im Reiter "Quelle" kann das SQL nachträglich angepasst werden]]
*'''Reiter "Metriken":''' Hier können eigene Metriken angelegt werden.
[[Datei:ImageReiterMetrikenSuperset.png|zentriert|mini|350x350px|Eine neue Metrik "Anzahl Verfahren" wird hinzugefügt]]
*'''Reiter "Spalten":''' Hier sind alle im Datensatz enthaltenen Spalten aufgeführt. An den Werten in der Tabelle ("Datentyp", "Ist zeitlich" etc.) sollte in der Regel nichts geändert werden, dies wird von Superset automatisch richtig erkannt. Beim '''Klick auf das "Plus"''' neben jeder Spalte kann unter "Beschriftung" ein sprechendes Label hinzugefügt werden. Dieses wird später in den Diagrammen angezeigt.
[[Datei:ImageReiterSpaltenSuperset.png|zentriert|mini|470x470px|Im Reiter "Spalten" wird ein Label hinzugefügt]]
*'''Reiter "Berechnete Spalten":''' Hier können dem Datensatz weitere Spalten hinzugefügt werden, die Werte enthalten, die aus anderen Spalten errechnet werden. Verwenden Sie für die Berechnung SQL-Syntax.
[[Datei:ImageReiterBerechneteSpaltenSuperset.png|zentriert|mini|416x416px|Eine berechnete Spalte wird hinzugefügt]]
* Speichern Sie Ihre Änderungen am Datensatz durch das '''Klicken auf den "Speichern"-Button'''. Um die Änderungen zu prüfen, empfiehlt es sich ein Diagramm mit dem Datensatz anzulegen (z.B. eine Tabelle).

=== Beispiel-Diagramm erstellen ===
Nachfolgend soll beispielhaft ein Diagramm "Verfahrensstand aller Verfahren" erstellt werden. Dazu gehen Sie wie folgt vor:

# Klick auf den '''Menüpunkt "Diagramme":''' Auf dieser Seite findet sich eine Liste mit allen bereits erstellten Diagrammen. Innerhalb dieser Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Diagramm-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageUebersichtDiagrammeSuperset.png|zentriert|mini|501x501px|Im Menüpunkt "Diagramme" findet sich eine Übersicht über die bisher erstellten Diagramme (Abfragen) mit vielen Zusatzinformationen.]]
# Um ein neues Diagramm zu erstellen klicken Sie auf den '''Button "+Diagramm"''' rechts oben. Es öffnet sich der Dialog '''"Neues Diagramm erstellen".'''[[Datei:ImageNeuesDiagrammSuperset.png|zentriert|mini|487x487px|Dialog um ein neues Diagramm zu erstellen]]
# Zunächst muss der '''passende Datensatz für die Auswertung ausgewählt''' werden. Für dieses Beispiel wählen wir unter '''"1- Datensatz auswählen"''' den Datensatz '''"verfahren"''' im Dropdownmenü aus.
# Im nächsten Schritt wird der '''passende Diagrammtyp ausgewählt'''. Hier werden Ihnen viele verschiedene Visualisierungsmöglichkeiten geboten. Im genannten Beispiel passt ein "Kreisdiagramm" am besten zu der Visualisierung der Verfahrensstände aller Verfahren. Sie finden das Kreisdiagramm unter dem Hauptmenü "Teil des Ganzen". Klicken Sie '''auf das Kreisdiagramm''' und anschließend auf '''"Neues Diagramm erstellen"'''.
# Nun geht es um die '''Detailkonfiguration''' des Diagramms. Grundsätzlich ist der Arbeitsbereich wie folgt aufgebaut:
#* Die linke Spalte enthält einen '''Überblick''' über die '''zur Verfügung stehenden Daten'''.
#* Die mittlere Spalte enthält die '''Werkzeuge''', um das '''Diagramm zu konfigurieren.'''
#* Im rechten Bereich kann man sich jeweils eine '''Vorschau des Diagramms''' anzeigen lassen.
'''Wir gehen für unser Beispiel wie folgt vor:'''

* Im Feld '''"Name des Diagramms hinzufügen"''' das Diagramm mit einer passenden Bezeichnung versehen.
* Um die Dimensionen des Diagramms festzulegen im Tab '''"Daten"''' unter der Überschrift '''"Abfrage > Dimensionen"''' die Spalte '''"verfahrensstand"''' von links per Drag & Drop herüberziehen.
* Der dazustellende Wert soll hier die Anzahl sein, weshalb nun unter '''"Metrik"''' das Feld '''"Anzahl"''' Button "+Diagramm" per Drag & Drop von links herübergezogen wird. Je nach Fragestellung bzw. welche Daten auf dem Diagramm dargestellt werden sollen, können verschiedenste Kombinationen in der selben Art und Weise über Drag & Drop zusammengestellt werden.
* Unter dem '''Punkt "Filter"''' kann eine Vorabfilterung eingebaut werden, also beispielsweise könnten Sie simulierte Verfahren standardmäßig herausfiltern, so dass die Nutzenden diese gar nicht auswerten können. Anmerkung: "imported_at" kann nicht gelöscht werden. Dieser Wert wird von Superset standardmäßig gesetzt und hat keine Auswirkung auf Ihre Auswertungen.
* Das für die Berechnung zugrundeliegende Zeilenlimit kann bei Bedarf verändert werden.
* Ein Klick auf den '''blauen Button "Diagramm erstellen"''' zeigt eine '''Vorschau''' des erstellten Diagrammes auf der rechten Bildschirmhälfte. Das Diagramm kann nun jederzeit mit einem '''Klick auf "Speichern"''' rechts oben gesichert werden.[[Datei:ImageDiagrammErstellenSuperset.png|zentriert|mini|426x426px|Dialog zur Detaildefinition des neuen Diagramms. Hier beispielhaft zusammengestellt für die Darstellung "Verfahrenstand aller Verfahren".]]

* Unter dem '''Tab "Anpassen"''' finden sich zahlreiche Möglichkeiten, das Diagramm weiter zu verfeinern (zum Beispiel in Farbe und Layout). Hier kann ganz nach Belieben ausprobiert werden. Mit '''Klick auf''' '''"Diagramm aktualisieren"''' kann die Vorschau des Diagramms zur Überprüfung mit den neu gewählten Einstellungen geladen werden.[[Datei:ImageDiagrammAnpassenSuperset.png|zentriert|mini|421x421px|Diagramm kann nach Belieben im Tab "Anpassen" verändert und verfeinert werden.]]
* '''Speichern nicht vergessen:''' Das Diagramm wird erst gespeichert durch '''Klick auf "Speichern" rechts oben'''. Es öffnet sich ein Dialog zu weiteren Speicheroptionen, der mit '''einer weiteren Speicherbestätigung''' abgeschlossen werden kann.[[Datei:ImageDiagrammSpeichernSuperset.png|zentriert|mini|427x427px|Speichern-Dialog für das erstellte Diagramm]]

=== Beispiel-Dashboard erstellen ===

# '''Klick auf den Menüpunkt "Dashboards":''' Unter der Überschrift "Dashboards" findet sich eine Liste mit allen bereits erstellten Dashboards. Diese Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Dashboard-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageDashboardsSuperset.png|zentriert|mini|452x452px|Unter dem Menüpunkt "Dashboards" finden sich alle bereits angelegten Dashboards, sowie die Möglichkeit neue Dashboards zu erstellen.]]
# Mit Klick auf den Button '''"+Dashboard"''' rechts oben öffnet sich ein neuer, leerer Dashboard -Entwurf.
# Der Titel des Dashboards ist standardmäßig als "untitled dashboard" angeben und kann durch '''Klick auf den Namen''' geändert werden.
# Auf der Seitenleiste am rechten Bildschirmrand finden sich alle bereits erstellten Diagramme. Das gewünschte Diagramm kann einfach durch '''Drag & Drop mit der Maus auf das Dashboard gezogen''' werden. Auch die Größe kann leicht geändert werden indem sie die Ränder oder Ecken des Diagramms klicken, gedrückt halten und auf die gewünschte Größe ziehen. Sie können ein oder auch mehrere Diagramme auf einem Dashboard platzieren.
# Zu guter Letzt oben rechts auf den '''Button "Speichern"''' klicken um Ihre Arbeit zu sichern. Nach dem Speichern können Sie jederzeit am Dashboard weiter arbeiten indem Sie auf den nun erscheinenden Button '''"Dashboard bearbeiten"''' klicken.
# Sollten Sie ein Diagramm wieder vom Dashboard löschen wollen, können Sie einfach das '''Mülleimer-Symbol''' klicken, welches bei Mouseover über das jeweilige Diagramm erscheint.[[Datei:ImageDragDropDiagrammSuperset.png|zentriert|mini|351x351px|Das gewünschte Diagramm kann mit der Maus einfach auf das Dashboard gezogen und platziert werden.]]
[[Datei:ImageDiagrammGroesseSuperset.png|zentriert|mini|325x325px|Die Größe des Diagramms lässt sich einfach durch Ziehen der Maus an Ecken oder Rändern verändern.]]

=== Einen oder mehrere Filter zu einem Dashboard zufügen ===
Es ist möglich Ihre Auswertungsdiagramme mit Filtermöglichkeiten zu versehen. Im folgenden wird beispielhaft ein Filter nach der Zuständigkeit auf dem Dashboard "Verfahrensstand aller Verfahren" hinzugefügt:

# Öffnen Sie das Dashboard oder legen Sie sich ein entsprechendes neues Dashboard an und speichern dieses.
# An der linken Bildschirmkante den '''kleinen Pfeil klicken''', um das Filtermenü auszuklappen. '''Wichtig:''' Der Pfeil ist nur sichtbar, wenn das Dashboard bereits gespeichert ist und sich nicht gerade im offenen Bearbeitungsmodus befindet. Sprich: Klicken Sie '''nicht''' "Dashboard bearbeiten" bevor Sie den Filter hinzufügen.
# Klicken Sie auf das '''kleine Zahnrad''' um das Untermenü zu öffnen.
# Ein Klick auf '''"Hinzufügen und Bearbeiten von Filtern"''' öffnet das Menü um die Filter zu konfigurieren.[[Datei:ImageDashboardFilterMenueSuperset.png|zentriert|mini|372x372px|Durch Klick auf den kleinen Pfeil öffnet sich das Menü, mit dem Filter hinzugefügt und konfiguriert werden können.]]
# Um nach der Zuständigkeit zu filtern muss im '''Menü Filtertyp die Option "Wert"''' ausgewählt sein.
# Im Menüpunkt Tabellenname '''"Zuständigkeit"''' als '''Namen des Filters''' eintragen.
# Im '''Feld Datensatz''' wird in diesem Fall '''"verfahren"''' ausgewählt.
# Im '''Feld "Spalte"''' den Filter auswählen, nach dem gefiltert werden soll: in diesem Fall '''"zustaendigkeit".'''
# Das Menü '''"Filterwerte sortieren"''' durch einen Haken aktivieren und absteigend sortieren und mit der '''Sortiermetrik "Anzahl"''' versehen.
# Im '''Reiter "Auswahlverfahren"''' kann der Filter durch eine Auswahl außerdem auf '''einzelne Diagramme oder auf alles bezogen''' werden.
# Durch '''Klick auf "Speichern"''' rechts unten wird der Filter in das Dashboard integriert.[[Datei:ImageFilteroptionenDashboardSuperset.png|zentriert|mini|431x431px|Sie können einen oder mehrere Filteroptionen auf einem Dashboard integrieren und in diesem Menü konfigurieren.]]
'''Übergeordnete Filtereinstellungen:'''

Nach '''Klick auf das Zahnrad''', im geöffneten Filter-Untermenü, können Sie außerdem entscheiden, ob der Filter '''oben''' über dem Diagramm '''oder seitlich links einklappbar''' angezeigt werden soll.

Es gibt dort außerdem die Möglichkeit für ein oder mehrere Diagramme eine '''Kreuzfilterung zu aktivieren.''' Diese erlaubt es Ihnen, direkt '''in einem Diagramm auf ein Element zu klicken''', um damit automatisch eines oder alle Diagramme im Dashboard zu filtern. So können Daten intuitiv und interaktiv erkundet werden, ohne separate Filtersteuerungen zu verwenden.
[[Datei:ImageFilterUntermenueSuperset.png|zentriert|mini|440x440px|Im Filter-Untermenü können bestehende Filter bearbeitet oder weitere Filter hinzugefügt werden. Außerdem kann die Kreuzfilterung aktiviert und die Darstellung der Filterleiste verändert werden.]]

=== Dashboards veröffentlichen ===
Dashboards werden erst im DiPlan Cockpit sichtbar, nachdem diese veröffentlicht und für die Sachbearbeitenden und Reporting-Administratoren freigeschalten wurden. Dabei gilt es zu beachten, dass Sie nur Dashboards veröffentlichen und freischalten können, die Sie selbst erstellt haben oder für die Sie berechtigt worden sind. Siehe hierzu auch das Kapitel "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Diagramme_und_Dashboards_f.C3.BCr_andere_Reporting-Administratoren_zur_Bearbeitung_freigeben Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben]".

'''Zur Veröffentlichung und Freischaltung gehen Sie wie folgt vor:'''

# Öffnen Sie das Dashboard, welches veröffentlicht werden soll.
# Durch Klick auf das '''graue Feld "Entwurf"''' neben dem Dashboard Namen, ändert sich die Bezeichnung auf '''"Veröffentlicht".'''[[Datei:ImageStatusVeroeffentlichtSuperset.png|zentriert|mini|435x435px|Durch Klick ändert sich der Status von "Entwurf" auf "Veröffentlicht".]]
# Öffnen Sie rechts oben das '''Dreipunktemenü''' und wählen Sie dort den Unterpunkt '''"Dashboard einbetten"''' aus.[[Datei:ImageDashboardEinbettenSuperset.png|zentriert|mini|317x317px|Im Dreipunktemenü muss im nächsten Schritt der Punkt "Dashboard einbetten" geklickt werden.]]
# Im Einbetten-Dialog lassen Sie das Feld für "Zulässige Domänen" bitte einfach frei und klicken lediglich den '''Button "Einbettung aktivieren".''' Dann kann das Menü durch Klick auf das '''X-Symbol''' geschlossen werden.[[Datei:ImageEinbettungAktivierenSuperset.png|zentriert|mini|378x378px|Im Menü "Einbetten" klicken Sie auf "Einbettung aktivieren" und dann einfach auf das X um das Fenster zu schließen.]]
# Um das Dashboard nun für die '''Rolle der Sachbearbeitenden und Mandanten-Administratoren''' im DiPlan Cockpit '''freizugeben''' öffnen Sie bitte erneut den Reiter '''"Dashboards",''' um auf die Liste mit allen Dashboards zu gelangen.
# Klicken Sie auf das '''Stift-Symbol''' neben dem Dashboard, welches freigeschalten werden soll.[[Datei:ImageDashboardEigenschaftenOeffnenSuperset.png|zentriert|mini|398x398px|Durch Klick auf das Stiftsymbol neben dem Dashboard werden die Dashboardeigenschaften geöffnet. Dort können auch die einzelnen Rollen freigeschaltet werden.]]
# In den '''Dashboardeigenschaften''' können nun die Rollen eingetragen werden, für die das Dashboard freigeschalten werden soll. Die Rollenbezeichnungen in Superset fassen mehrere Rollen aus dem DiPlan Cockpit zusammen, was die Freigabe von Dashboards vereinfacht. Bitte tragen Sie im Feld "Rollen" deshalb '''"Reporting-Administrator"''' und '''"Sachbearbeiter" in der Liste ein.''' Dies ist durch Tippen in das Feld möglich, so wird die auszuwählende Rolle schneller sichtbar. Sie können jedoch auch manuell durch die Liste scrollen und die Rolle auswählen. Klicken Sie anschließend den '''"Speichern"-Button'''. Die Auswertungen sind nun im DiPlan Cockpit für alle berechtigten Rollen sichtbar.[[Datei:ImageDashboardEigenschaftenRollenSuperset.png|zentriert|mini|395x395px|In den Dashboardeigenschaften müssen die Rollen, für die das Dashboard freigegeben werden soll, ausgewählt werden.]]
'''Hinweis: Veröffentlichung zurücknehmen'''

Sollten Sie ein Dashboard im DiPlan Cockpit unsichtbar machen wollen, so klicken Sie wie im Punkt 2 beschrieben wieder auf die graue Schaltfläche und setzen Sie den Status von '''"Veröffentlicht"''' zurück auf '''"Entwurf".'''

=== Bestehendes Dashboard oder Diagramm bearbeiten oder löschen ===
'''Wie lösche ich ein eingebettetes Diagramm von einem bereits veröffentlichten und freigegebenen Dashboard?'''

* Öffnen Sie das Dashboard und '''klicken Sie "Dashboard bearbeiten"''' auf der rechten Bildschirmseite.
* Im geöffneten Bearbeitungsmodus können Sie nun die Maus über das nicht mehr erwünschte Diagramm bewegen und durch '''Klick auf das erscheinende Mülleimersymbol''' löschen. Das Diagramm bleibt in der Liste der Diagramme weiterhin erhalten und wird lediglich vom Dashboard genommen.
* Sie können ein '''weiteres/neues Diagramm''' jederzeit wieder aus der Liste rechts auf das Dashboard ziehen.
* Bestätigen Sie das veränderte Dashboard durch Klick auf den "'''Speichern"-Button''' rechts oben.
* '''Bitte beachten:''' Änderungen an bereits veröffentlichten und freigegebenen Dashboards werden nach dem '''Speichern direkt auf dem DiPlan Cockpit sichtbar'''.

'''Wie bearbeite ich ein bestehendes Diagramm?'''

Ein Diagramm unabhängig vom Dashboard ändern:

* Öffnen Sie das zu bearbeitende Diagramm in der '''Liste der Diagramme''' durch einen '''Klick auf den Namen'''.
* Das Diagramm öffnet sich direkt im Bearbeitungsmodus und kann nach '''Belieben angepasst werden'''.
* Ist das Diagramm bereits auf einem veröffentlichten und freigegebenen Dashboard eingebettet, so werden alle Änderungen nach dem Speichern direkt übernommen und im '''DiPlan Cockpit sichtbar'''.

Ein Diagramm direkt auf einem Dashboard ändern:

* Öffnen Sie das Dashboard und klicken Sie '''"Dashboard bearbeiten"'''.
* Bewegen Sie die Maus über die entsprechende Grafik, öffnen Sie das Dreipunktemenü rechts und klicken '''"Diagramm bearbeiten".'''
* Nachdem Sie das Diagramm bearbeitet haben klicken Sie '''"Speichern"'''.

'''Bitte beachten:''' Im Speichern-Dialog können Sie entscheiden, ob sie das bestehende '''Diagramm überschreiben''' oder ein '''neues Diagramm speichern''' wollen. Dies kann hilfreich sein, wenn Sie das Diagramm nicht generell, sondern nur auf einem bereits bestehenden Dashboard ändern wollen.

'''Wie lösche ich ein Dashboard oder Diagramm dauerhaft?'''

Sie können ein Dashboard unabhängig vom Status (also veröffentlicht oder auch als Entwurf) in der Liste der Dashboards wie folgt löschen:

* Bewegen Sie die Maus über den entsprechenden '''Listeneintrag.'''
* Klicken Sie das in der Zeile rechts erscheinende '''Papierkorb-Symbol''' und folgen den Anweisungen im erscheinenden Löschdialog.
* Die Originaldiagramme auf dem Dashboard bleiben dabei weiterhin in der Liste "Diagramme" erhalten.
* Sollten Sie ein Diagramm dauerhaft löschen wollen, so gehen Sie genauso wie beim Dashboard vor, jedoch im '''Reiter "Diagramme"'''.

=== Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Bitte beachten:''' Solange Reporting-Administratoren nicht als Besitzer eingetragen sind, haben diese nur Zugriff auf die eigenen erstellten Daten.

'''Das bedeutet konkret für die erstellten Daten von anderen Reporting-Administratoren:'''

* Unveröffentlichte Dashboards sind nicht sichtbar.
* Veröffentlichte Dashboards sind sichtbar, aber nicht bearbeitbar.
* Alle Diagramme sind sichtbar, Änderungen können jedoch nur als neue Diagramme gespeichert werden.
* Datensätze sind sichtbar und können verwendet, aber nicht bearbeitet werden.
* Gespeicherte Abfragen sind nicht sichtbar (Berechtigungen können hier grundsätzlich nicht vergeben werden).

Sie haben grundsätzlich keine Rechte ein Dashboard zu bearbeiten oder ein Diagramm zu überschreiben, welches nicht von Ihnen erstellt wurde, außer Sie wurden als '''"Besitzende/r"''' dazu ermächtigt.

Das bedeutet beispielsweise, dass Sie ein Diagramm, welches jemand anders erstellt hat, zwar bearbeiten, dies aber nur als neues Diagramm abspeichern können. Das Originaldiagramm wird hier nicht verändert. Um jemanden für die '''Mitarbeit an Ihrem Diagramm oder Dashboard zu ermächtigen''' gehen Sie wie folgt vor:

* Klicken Sie in der Liste der Diagramme oder Dashboards auf das '''Stift-Symbol "Bearbeiten".''' Der Dialog '''"Diagrammeigenschaften bearbeiten"''' öffnet sich.
* Unter der '''Überschrift "Zugang"''' können weitere '''"Besitzende" eingetragen''' werden. Klicken Sie hierzu in das Eingabefeld und fangen Sie an den Namen zu tippen oder scrollen Sie durch die Liste bis zum gewünschten Namen.
* '''Wählen Sie einen oder mehrere Namen aus,''' um diese in das Feld zu übernehmen und klicken Sie dann auf '''"Speichern"'''. Die eingetragene Person hat nun die gleichen '''Rechte zur Bearbeitung wie der/die ursprüngliche Ersteller/in'''.

=== Datensätze für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Um Datensätze für andere Reporting-Administratoren zur Bearbeitung freizugeben, gehen Sie wie folgt vor:'''

* Klick auf den '''Reiter "Datensätze"'''
* In der Übersicht-Liste klicken Sie bitte das '''Stift- Symbol''' neben dem gewünschten Datensatz.
* Klicken Sie den '''Reiter "Einstellungen"''' ganz rechts und scrollen Sie ganz nach unten.
* Dort können Sie im '''Feld "Besitzende"''' auch andere Reporting-Administratoren zur Bearbeitung berechtigen.

== Weiterführende Informationen ==
Unter folgendem Link können Sie weitere Informationen zu Superset in englischer Sprache finden. Bitte beachten Sie, dass Ihre Datenbank bereits angebunden ist und der Punkt "Connecting to a new database" in der Dokumentation somit nicht beachtet werden sollte: '''[https://superset.apache.org/docs/6.0.0/using-superset/creating-your-first-dashboard#creating-your-first-dashboard Englische Dokumentation des Open-Source-Tools Superset]'''

Datei:ImageDashboardEigenschaftenRollenSuperset.png

2026-03-16T10:29:40Z

Diplanung:

ImageDashboardEigenschaftenRollenSuperset

Reporting: Auswertungen im DiPlan Cockpit

2026-03-16T10:28:31Z

Diplanung: /* Dashboards veröffentlichen */

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

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

⚠️ '''Bitte beachten: Die Reporting-Funktionalität wird nach und nach Mandanten spezifisch freigeschaltet. Informationen zur Funktionsweise finden Sie hier vorab.'''

== Einleitung ==
Die Auswertungskomponente für das DiPlan Cockpit ermöglicht das Abrufen, Filtern und Downloaden von Reports und Auswertungen aus Planungs- und Genehmigungsverfahren. Die Auswertungsdiagramme zu individuellen Fragestellungen werden in dem externen BI-Tool Superset von berechtigten Personen auf Basis grundlegender SQL- und Datenmodell-Kenntnisse erstellt, verwaltet, auf Dashboards zusammengestellt und schließlich für die Darstellung im DiPlan Cockpit freigegeben.

== Aufruf der Auswertungen ==
Die Auswertungen sind in dem gleichnamigen Reiter im DiPlan Cockpit zu finden.

In der linken Bildschirmhälfte sind die Namen der jeweiligen zur Verfügung stehenden Dashboards zu finden. Ein Dashboard ist eine Zusammenstellung von einem oder mehreren Auswertungsdiagrammen auf einer Seite. Standardmäßig wird das Dashboard "Verfahrensstand aller Verfahren" für jeden Mandant initial mit ausgerollt. Alle weiteren Dashboards können je nach Bedarf individuell durch berechtigte Personen je Mandant erstellt werden. Mehr dazu findet sich im Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Auswertungen_erstellen.2C_ver.C3.B6ffentlichen_und_freigeben Auswertungen erstellen, veröffentlichen und freigeben].

'''Gut zu wissen:'''

* '''Datengrundlage:''' Grundsätzlich fließen gelöschte Verfahren nicht in die Auswertungen ein.
* '''Aktualität der Daten:''' Die Daten werden jede Nacht einmal mit der DiPlan Cockpit Datenbank synchronisiert.
* '''Darstellung:''' Das Reporting wird mit dem Tool Superset umgesetzt, welches in das DiPlan Cockpit eingebunden wird. Für eine optimale Darstellung nutzen Sie bitte den Browser Microsoft Edge.
[[Datei:ImageAuswertungenCockpit.png|zentriert|mini|717x717px|Ansicht des Reiters "Auswertungen" im DiPlan Cockpit mit dem Standarddashboard "Verfahrensstand aller Verfahren".]]

== Filtern der Dashboards bzw. Auswertungen ==
Je nach Art der dargestellten Auswertungen können Sie weitere Aktionen in den einzelnen Diagrammen vornehmen. Oftmals sind zum Beispiel verschiedene Filterungsmöglichkeiten hinterlegt. Zum Öffnen der Filter gehen Sie bitte folgendermaßen vor:

* Aufklappen der Filter durch Klick auf den kleinen blauen Pfeil links neben den Diagrammen. Alternativ können die Filter auch am oberen Rand des Dashboards eingebunden sein.
* Auswählen der gewünschten Filter.
* Klick auf "Filter anwenden".
* Bei Klick auf "Alles löschen" werden sämtliche gesetzte Filter wieder zurückgesetzt.
[[Datei:ImageAuswertungenCockpitFilter.png|zentriert|mini|742x742px|Falls eine Filterung im Dashboard integriert wurde, so lässt diese sich über den kleinen Pfeil ausklappen oder befindet sich am oberen Rand des Dashboards. Hier zu sehen eine Filterung auf dem Dashboard nach Zuständigkeit oder Verfahrenstyp.]]
[[Datei:ImageAuswertungenCockpitFilter2.png|zentriert|mini|742x742px|Das Reporting bietet die Möglichkeit auch mehrere verschiedene Diagrammtypen auf einem Dashboard darzustellen. Diese können von Mandanten-Administratoren konfiguriert und freigegeben werden. Hier ein Beispiel mit integrierten Filtern am oberen Rand des Dashboards.]]

== Download der Auswertungen ==
Neben jeder Auswertungsgrafik (jedem Diagramm) finden sich drei Punkte, welche bei Klick ein Drop-Down Menü öffnen. Durch '''Mouseover auf "Herunterladen"''' öffnet sich das Menü zum Download des Diagramms in verschiedenen auswählbaren Formaten. Hier sind folgende Punkte zu beachten:

* '''Der Download entspricht immer der Filterung:''' Wird eine Grafik durch eine Filterung angepasst und dann ein Download gestartet, so entsprechen die heruntergeladenen Daten immer genau der Filterung, das heißt es sind nicht alle Daten vorhanden. Je nach Grafik ist in den heruntergeladenen Dateien nicht selbsterklärend, dass eine Filterung angewendet wurde und es ist wichtig das Downloadergebnis bei der weiteren Verwendung in den richtigen Kontext zu setzen. Laden Sie sich alternativ die Daten ohne Filterung herunter und filtern Sie zum Beispiel bei Bedarf gesondert in MS Excel.
* '''Die Rollen der Sachbearbeitenden sehen nur die eigene Zuständigkeit:''' Je nach Rolle der Nutzenden werden unter Umständen nicht alle Daten auf den Dashboards dargestellt. Sachbearbeitende können nur Daten der eigenen Zuständigkeit sehen. Siehe dazu auch das nächste Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Rechte_und_Rollen Rechte und Rollen].
[[Datei:ImageAuswertungenHerunterladen.png|zentriert|mini|327x327px|Das vertikale Dreipunktemenü in den Diagrammen beinhaltet die Herunterladen-Funktion.]]

== Rechte und Rollen ==
Alle Rollen aus dem DiPlan Cockpit werden gemäß ihrer Berechtigungen mit einer entsprechenden Rolle in Superset versehen. Prinzipiell gibt es zwei relevante Rollen, denen die Nutzenden in Superset zugeordnet werden. Dies passiert automatisch und regelt ob die Nutzenden berechtigt sind Auswertungen selbst anzulegen, freizugeben und zu veröffentlichen oder ob sie ausschließlich die freigegebenen Auswertungen gemäß ihrer Zuständigkeit im DiPlan Cockpit sehen können. Nachfolgend sehen Sie eine Übersicht über die verschiedenen Berechtigungen:
{| class="wikitable"
|'''Rolle DiPlan Cockpit'''
|'''Rolle Superset'''
|'''Berechtigungen'''
|-
|'''EfA Cockpit Pro'''
* M-A = Mandanten-Administration
* FP-A = Fachplanung-Administration

'''EfA Cockpit Basis'''

* M-A-Basis = Mandanten-Administration-Basis
* FP-A-Basis = Fachplanung-Administration Basis
|'''Reporting-Administrator'''
|
* Kann direkt aus dem DiPlan Cockpit zu Superset abspringen und ist dort automatisch eingeloggt (SSO).
* Kann Datensätze (Superset-spezifische Zwischenschicht zwischen DB-Tabelle und Abfrage) erstellen.
* Kann Auswertungen/Diagramme in Superset erstellen.
* Kann Dashboards mit verschiedenen Auswertungen/Diagramme zusammenstellen.
* Kann Dashboards freigeben für den ganzen Mandanten (z.B. ganz Hamburg).
* Kann alle Daten im Dashboard eines Mandanten sehen.
* Kann Abfragen filtern, also z.B. in Hamburg nach Belieben nach Bezirk (Zuständigkeit) z.B. Altona oder Senat.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
* Kann andere Reporting-Administratoren für die eigenen Dashboards/Diagramme als Besitzer eintragen, um diese für die Bearbeitung, Freischaltung und Veröffentlichung zu berechtigen.
|-
|''''''EfA Cockpit Pro''''''
* FP-VM = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)

'''EfA Cockpit Basis'''

* FP-VM-Basis = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB-Basis = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)
|'''Sachbearbeiter'''
|
* Sieht ausschließlich die vorgefilterten Daten entsprechend der eigenen Zuständigkeit (also z.B. Altona).
* Kann Auswertungen herunterladen, aber nur mit den Daten der eigenen Zuständigkeit.
* Kann freigegebene Dashboards betrachten.
* Kann Auswertungen filtern, wenn Filter eingerichtet wurden.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
|}

== Superset als zentrales Tool für Reporting-Administratoren ==

=== Übergreifende Informationen zu Superset ===
Für die Erstellung und Darstellung des Reportings wurde das Open-Source-Tool Apache Superset in das DiPlan Cockpit implementiert. Superset ist eine Reporting- und Monitoring-Technologie, die es ermöglicht komplexe Daten auf Dashboards in leicht verständlichen Visualisierungen darzustellen. Die Erstellung der Dashboards erfolgt dabei direkt in der Superset-Anwendung. Dort wird auch gesteuert, welche Dashboards mit welchen Auswertungen im DiPlan Cockpit veröffentlicht werden sollen.

=== Absprung aus dem DiPlan Cockpit zu Superset ===
Sobald eine Rolle für die Erstellung von Auswertungen berechtigt ist (zum Beispiel M-A oder FP-A), findet sich im Reiter Auswertungen automatisch der Button '''"Auswertungen konfigurieren"'''. Bei Klick öffnet sich ein weiteres Browserfenster mit der Superset-Plattform. Eine gesonderte Anmeldung in Superset ist nicht erforderlich, da die Anmeldung durch das Cockpit erfolgt (auch Single Sign-On (SSO) genannt).

'''Bitte beachten:''' Nach 4 Stunden erfolgt aus Sicherheitsgründen ein automatischer Logout aus Superset - unabhängig davon ob Sie gerade in Superset arbeiten oder nicht aktiv waren. Sie erhalten keine Warnung vor dem Logout. Deshalb empfiehlt es sich, Änderungen regelmäßig zu speichern, um zu verhindern, dass ungesicherte Abfragen verloren gehen.
[[Datei:ImageButtonAuswertungenKonfigurieren.png|zentriert|mini|491x491px|Berechtigte Personen sehen über den Dashboards im DiPlan Cockpit einen Absprungbutton zu Superset mit der Bezeichnung "Auswertungen konfigurieren."]]
[[Datei:ImageStartbildschirmSuperset.png|zentriert|mini|508x508px|Startbildschirm in Superset mit einer Vorschau auf Dashboards und Diagrammen. Die Hauptmenüpunkte zur Navigation sind am oberen Bildschirmrand zu sehen.]]

=== Auswertungen erstellen, veröffentlichen und freigeben ===
Datenvisualisierungen von Abfragen werden in Superset als '''"Diagramme"''' bezeichnet. Sobald mindestens ein Diagramm erstellt ist, kann dieses auf einem Dashboard integriert werden und mit weiteren Filtermöglichkeiten versehen werden. Wie bereits erwähnt, können Sie als '''Reporting-Administrator''' selbst nach Belieben Diagramme erstellen. Nachfolgend wird beispielhaft die Erstellung und Freigabe des Dashboards mit dem Diagramm "Verfahrensstand aller Verfahren" beschrieben, um einige der Grundfunktionalitäten in Superset zu verdeutlichen (siehe dazu das Kapitel: "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]").

=== Datensätze erstellen ===
Um ein Diagramm zu erstellen wird zunächst ein Datensatz benötigt. Für einfache Abfragen reicht der '''Verfahrensdatensatz''' aus, der bereits standardmäßig enthalten ist. Dieser entspricht der '''Tabelle "Verfahren"''' mit den '''zugehörigen Datenfeldern (Stammdaten)'''.

Für Abfragen auf dem Verfahrensdatensatz können Sie direkt zum Abschnitt "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]" springen.

Für komplexere '''Abfragen über mehrere Tabellen hinweg, eigene Metriken oder eigene berechnete Spalten''' ist die Erstellung eines eigene Datensatzes mithilfe von SQL-Abfragen notwendig. Folgende Informationen sind in gesonderten Tabellen enthalten:

* Gebietseinheiten
* Kontakte
* Nutzer
* Parallelverfahren
* Termine
* Veränderungssperren
* Vertragsarten
* Vorgesehene Nutzungen
* Zurückstellungen

'''Bitte beachten:''' Bei der Erstellung von eigenen Datensätzen, muss die Spalte "'''''zustaendigkeit_code"''''' aus der Tabelle "'''''verfahren"'' immer enthalten sein,''' da hierüber die Ansicht für Sachbearbeiter standardmäßig gefiltert wird.

'''Um eigene Datensätze zu erstellen gehen Sie bitte wie folgt vor:'''

* Klick im Hauptmenü auf den '''Reiter "SQL"''' und im zugehörigen Dropdown-Menü auf '''"SQL Lab".'''
[[Datei:ImageStartSQLLab.png|zentriert|mini|576x576px|Startansicht SQL Lab]]
* Erstellen Sie Ihre '''SQL-Abfrage''' und klicken Sie auf den '''Button "Ausführen"''', um eine Vorschau auf die Ergebnisse der Abfrage zu erhalten. Ein rotes Kreuzchen links vom SQL-Editor weist auf Fehler im SQL hin.
[[Datei:ImageAusfuehrenSQLLab.png|zentriert|mini|576x576px|Ausführen einer SQL Abfrage im SQL Lab]]
'''Typische Anwendungsfälle und die dazugehörigen SQL Abfragen könnten z.B. sein:'''

* Sie möchten, dass Ihre Abfragen z.B. nach "Gebietseinheiten" und "Vorgesehenen Nutzungen" gefiltert werden können:

{| class="wikitable"
|
SELECT v.*, g.gebietseinheit, vn.vorgesehene_nutzungen
FROM verfahren v
LEFT JOIN gebietseinheiten g ON g.verfahren_id = v.id
LEFT JOIN vorgesehene_nutzungen vn ON vn.verfahren_id = v.id;
|}

* Sie möchten, dass Ihr Datensatz bestimmte Termine enthält (z.B. Grobabstimmungsdatum, Vorweggenehmigungsreife):

{| class="wikitable"
|
WITH grobabstimmung_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Grobabstimmung'
),
vorweggenehmigungsreife_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Vorweggenehmigungsreife'
)
SELECT
v.*,
t1.beginn AS grobabstimmung,
t2.beginn AS vorweggenehmigungsreife
FROM verfahren v
LEFT JOIN grobabstimmung_termin t1 ON t1.verfahren_id = v.id
LEFT JOIN vorweggenehmigungsreife_termin t2 ON t2.verfahren_id = v.id;
|}

* '''Speichern Sie Ihre Abfrage als Datensatz''' ab, indem Sie auf den '''Dropdown-Pfeil neben dem Button "Speichern"''' klicken und dann '''"Datensatz speichern"''' auswählen. Es öffnet sich ein Dialogfeld, in dem Sie einen Namen für Ihren Datensatz vergeben können.
** Hinweis: Wenn Sie statt auf "Datensatz speichern" auf "Speichern" klicken, finden Sie Ihre SQL Abfrage unter dem Reiter '''"Gespeicherte Abfragen"''' wieder.
[[Datei:ImageSpeichernDatensatzSuperset.png|zentriert|mini|581x581px|Speichern eines neuen Datensatzes]]
Nach der Erstellung eines Datensatzes können Sie diesen noch weiter bearbeiten und Labels, eigene Metriken oder berechnete Spalten hinzufügen. Gehen Sie dazu wie folgt vor:
* Klick im Hauptmenü auf den '''Reiter "Datensätze"'''. Hier sind die verfügbaren Datensätze aufgelistet.
* Klicken Sie ganz rechts neben dem Datensatz, den Sie bearbeiten wollen, auf das '''Stift-Symbol.''' Es öffnet sich eine Bearbeitungsmaske.
[[Datei:ImageBearbeitungDatensatzSuperset.png|zentriert|mini|427x427px|Öffnen Sie den Bearbeitungsmodus durch Klick auf das Stiftsymbol]]
*'''Reiter "Quelle":''' Hier kann die zugrundeliegende SQL Abfrage nachträglich angepasst werden. Klicken Sie hierfür auf das Schloss-Symbol.
[[Datei:ImageReiterQuelleSuperset.png|zentriert|mini|411x411px|Im Reiter "Quelle" kann das SQL nachträglich angepasst werden]]
*'''Reiter "Metriken":''' Hier können eigene Metriken angelegt werden.
[[Datei:ImageReiterMetrikenSuperset.png|zentriert|mini|350x350px|Eine neue Metrik "Anzahl Verfahren" wird hinzugefügt]]
*'''Reiter "Spalten":''' Hier sind alle im Datensatz enthaltenen Spalten aufgeführt. An den Werten in der Tabelle ("Datentyp", "Ist zeitlich" etc.) sollte in der Regel nichts geändert werden, dies wird von Superset automatisch richtig erkannt. Beim '''Klick auf das "Plus"''' neben jeder Spalte kann unter "Beschriftung" ein sprechendes Label hinzugefügt werden. Dieses wird später in den Diagrammen angezeigt.
[[Datei:ImageReiterSpaltenSuperset.png|zentriert|mini|470x470px|Im Reiter "Spalten" wird ein Label hinzugefügt]]
*'''Reiter "Berechnete Spalten":''' Hier können dem Datensatz weitere Spalten hinzugefügt werden, die Werte enthalten, die aus anderen Spalten errechnet werden. Verwenden Sie für die Berechnung SQL-Syntax.
[[Datei:ImageReiterBerechneteSpaltenSuperset.png|zentriert|mini|416x416px|Eine berechnete Spalte wird hinzugefügt]]
* Speichern Sie Ihre Änderungen am Datensatz durch das '''Klicken auf den "Speichern"-Button'''. Um die Änderungen zu prüfen, empfiehlt es sich ein Diagramm mit dem Datensatz anzulegen (z.B. eine Tabelle).

=== Beispiel-Diagramm erstellen ===
Nachfolgend soll beispielhaft ein Diagramm "Verfahrensstand aller Verfahren" erstellt werden. Dazu gehen Sie wie folgt vor:

# Klick auf den '''Menüpunkt "Diagramme":''' Auf dieser Seite findet sich eine Liste mit allen bereits erstellten Diagrammen. Innerhalb dieser Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Diagramm-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageUebersichtDiagrammeSuperset.png|zentriert|mini|501x501px|Im Menüpunkt "Diagramme" findet sich eine Übersicht über die bisher erstellten Diagramme (Abfragen) mit vielen Zusatzinformationen.]]
# Um ein neues Diagramm zu erstellen klicken Sie auf den '''Button "+Diagramm"''' rechts oben. Es öffnet sich der Dialog '''"Neues Diagramm erstellen".'''[[Datei:ImageNeuesDiagrammSuperset.png|zentriert|mini|487x487px|Dialog um ein neues Diagramm zu erstellen]]
# Zunächst muss der '''passende Datensatz für die Auswertung ausgewählt''' werden. Für dieses Beispiel wählen wir unter '''"1- Datensatz auswählen"''' den Datensatz '''"verfahren"''' im Dropdownmenü aus.
# Im nächsten Schritt wird der '''passende Diagrammtyp ausgewählt'''. Hier werden Ihnen viele verschiedene Visualisierungsmöglichkeiten geboten. Im genannten Beispiel passt ein "Kreisdiagramm" am besten zu der Visualisierung der Verfahrensstände aller Verfahren. Sie finden das Kreisdiagramm unter dem Hauptmenü "Teil des Ganzen". Klicken Sie '''auf das Kreisdiagramm''' und anschließend auf '''"Neues Diagramm erstellen"'''.
# Nun geht es um die '''Detailkonfiguration''' des Diagramms. Grundsätzlich ist der Arbeitsbereich wie folgt aufgebaut:
#* Die linke Spalte enthält einen '''Überblick''' über die '''zur Verfügung stehenden Daten'''.
#* Die mittlere Spalte enthält die '''Werkzeuge''', um das '''Diagramm zu konfigurieren.'''
#* Im rechten Bereich kann man sich jeweils eine '''Vorschau des Diagramms''' anzeigen lassen.
'''Wir gehen für unser Beispiel wie folgt vor:'''

* Im Feld '''"Name des Diagramms hinzufügen"''' das Diagramm mit einer passenden Bezeichnung versehen.
* Um die Dimensionen des Diagramms festzulegen im Tab '''"Daten"''' unter der Überschrift '''"Abfrage > Dimensionen"''' die Spalte '''"verfahrensstand"''' von links per Drag & Drop herüberziehen.
* Der dazustellende Wert soll hier die Anzahl sein, weshalb nun unter '''"Metrik"''' das Feld '''"Anzahl"''' Button "+Diagramm" per Drag & Drop von links herübergezogen wird. Je nach Fragestellung bzw. welche Daten auf dem Diagramm dargestellt werden sollen, können verschiedenste Kombinationen in der selben Art und Weise über Drag & Drop zusammengestellt werden.
* Unter dem '''Punkt "Filter"''' kann eine Vorabfilterung eingebaut werden, also beispielsweise könnten Sie simulierte Verfahren standardmäßig herausfiltern, so dass die Nutzenden diese gar nicht auswerten können. Anmerkung: "imported_at" kann nicht gelöscht werden. Dieser Wert wird von Superset standardmäßig gesetzt und hat keine Auswirkung auf Ihre Auswertungen.
* Das für die Berechnung zugrundeliegende Zeilenlimit kann bei Bedarf verändert werden.
* Ein Klick auf den '''blauen Button "Diagramm erstellen"''' zeigt eine '''Vorschau''' des erstellten Diagrammes auf der rechten Bildschirmhälfte. Das Diagramm kann nun jederzeit mit einem '''Klick auf "Speichern"''' rechts oben gesichert werden.[[Datei:ImageDiagrammErstellenSuperset.png|zentriert|mini|426x426px|Dialog zur Detaildefinition des neuen Diagramms. Hier beispielhaft zusammengestellt für die Darstellung "Verfahrenstand aller Verfahren".]]

* Unter dem '''Tab "Anpassen"''' finden sich zahlreiche Möglichkeiten, das Diagramm weiter zu verfeinern (zum Beispiel in Farbe und Layout). Hier kann ganz nach Belieben ausprobiert werden. Mit '''Klick auf''' '''"Diagramm aktualisieren"''' kann die Vorschau des Diagramms zur Überprüfung mit den neu gewählten Einstellungen geladen werden.[[Datei:ImageDiagrammAnpassenSuperset.png|zentriert|mini|421x421px|Diagramm kann nach Belieben im Tab "Anpassen" verändert und verfeinert werden.]]
* '''Speichern nicht vergessen:''' Das Diagramm wird erst gespeichert durch '''Klick auf "Speichern" rechts oben'''. Es öffnet sich ein Dialog zu weiteren Speicheroptionen, der mit '''einer weiteren Speicherbestätigung''' abgeschlossen werden kann.[[Datei:ImageDiagrammSpeichernSuperset.png|zentriert|mini|427x427px|Speichern-Dialog für das erstellte Diagramm]]

=== Beispiel-Dashboard erstellen ===

# '''Klick auf den Menüpunkt "Dashboards":''' Unter der Überschrift "Dashboards" findet sich eine Liste mit allen bereits erstellten Dashboards. Diese Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Dashboard-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageDashboardsSuperset.png|zentriert|mini|452x452px|Unter dem Menüpunkt "Dashboards" finden sich alle bereits angelegten Dashboards, sowie die Möglichkeit neue Dashboards zu erstellen.]]
# Mit Klick auf den Button '''"+Dashboard"''' rechts oben öffnet sich ein neuer, leerer Dashboard -Entwurf.
# Der Titel des Dashboards ist standardmäßig als "untitled dashboard" angeben und kann durch '''Klick auf den Namen''' geändert werden.
# Auf der Seitenleiste am rechten Bildschirmrand finden sich alle bereits erstellten Diagramme. Das gewünschte Diagramm kann einfach durch '''Drag & Drop mit der Maus auf das Dashboard gezogen''' werden. Auch die Größe kann leicht geändert werden indem sie die Ränder oder Ecken des Diagramms klicken, gedrückt halten und auf die gewünschte Größe ziehen. Sie können ein oder auch mehrere Diagramme auf einem Dashboard platzieren.
# Zu guter Letzt oben rechts auf den '''Button "Speichern"''' klicken um Ihre Arbeit zu sichern. Nach dem Speichern können Sie jederzeit am Dashboard weiter arbeiten indem Sie auf den nun erscheinenden Button '''"Dashboard bearbeiten"''' klicken.
# Sollten Sie ein Diagramm wieder vom Dashboard löschen wollen, können Sie einfach das '''Mülleimer-Symbol''' klicken, welches bei Mouseover über das jeweilige Diagramm erscheint.[[Datei:ImageDragDropDiagrammSuperset.png|zentriert|mini|351x351px|Das gewünschte Diagramm kann mit der Maus einfach auf das Dashboard gezogen und platziert werden.]]
[[Datei:ImageDiagrammGroesseSuperset.png|zentriert|mini|325x325px|Die Größe des Diagramms lässt sich einfach durch Ziehen der Maus an Ecken oder Rändern verändern.]]

=== Einen oder mehrere Filter zu einem Dashboard zufügen ===
Es ist möglich Ihre Auswertungsdiagramme mit Filtermöglichkeiten zu versehen. Im folgenden wird beispielhaft ein Filter nach der Zuständigkeit auf dem Dashboard "Verfahrensstand aller Verfahren" hinzugefügt:

# Öffnen Sie das Dashboard oder legen Sie sich ein entsprechendes neues Dashboard an und speichern dieses.
# An der linken Bildschirmkante den '''kleinen Pfeil klicken''', um das Filtermenü auszuklappen. '''Wichtig:''' Der Pfeil ist nur sichtbar, wenn das Dashboard bereits gespeichert ist und sich nicht gerade im offenen Bearbeitungsmodus befindet. Sprich: Klicken Sie '''nicht''' "Dashboard bearbeiten" bevor Sie den Filter hinzufügen.
# Klicken Sie auf das '''kleine Zahnrad''' um das Untermenü zu öffnen.
# Ein Klick auf '''"Hinzufügen und Bearbeiten von Filtern"''' öffnet das Menü um die Filter zu konfigurieren.[[Datei:ImageDashboardFilterMenueSuperset.png|zentriert|mini|372x372px|Durch Klick auf den kleinen Pfeil öffnet sich das Menü, mit dem Filter hinzugefügt und konfiguriert werden können.]]
# Um nach der Zuständigkeit zu filtern muss im '''Menü Filtertyp die Option "Wert"''' ausgewählt sein.
# Im Menüpunkt Tabellenname '''"Zuständigkeit"''' als '''Namen des Filters''' eintragen.
# Im '''Feld Datensatz''' wird in diesem Fall '''"verfahren"''' ausgewählt.
# Im '''Feld "Spalte"''' den Filter auswählen, nach dem gefiltert werden soll: in diesem Fall '''"zustaendigkeit".'''
# Das Menü '''"Filterwerte sortieren"''' durch einen Haken aktivieren und absteigend sortieren und mit der '''Sortiermetrik "Anzahl"''' versehen.
# Im '''Reiter "Auswahlverfahren"''' kann der Filter durch eine Auswahl außerdem auf '''einzelne Diagramme oder auf alles bezogen''' werden.
# Durch '''Klick auf "Speichern"''' rechts unten wird der Filter in das Dashboard integriert.[[Datei:ImageFilteroptionenDashboardSuperset.png|zentriert|mini|431x431px|Sie können einen oder mehrere Filteroptionen auf einem Dashboard integrieren und in diesem Menü konfigurieren.]]
'''Übergeordnete Filtereinstellungen:'''

Nach '''Klick auf das Zahnrad''', im geöffneten Filter-Untermenü, können Sie außerdem entscheiden, ob der Filter '''oben''' über dem Diagramm '''oder seitlich links einklappbar''' angezeigt werden soll.

Es gibt dort außerdem die Möglichkeit für ein oder mehrere Diagramme eine '''Kreuzfilterung zu aktivieren.''' Diese erlaubt es Ihnen, direkt '''in einem Diagramm auf ein Element zu klicken''', um damit automatisch eines oder alle Diagramme im Dashboard zu filtern. So können Daten intuitiv und interaktiv erkundet werden, ohne separate Filtersteuerungen zu verwenden.
[[Datei:ImageFilterUntermenueSuperset.png|zentriert|mini|440x440px|Im Filter-Untermenü können bestehende Filter bearbeitet oder weitere Filter hinzugefügt werden. Außerdem kann die Kreuzfilterung aktiviert und die Darstellung der Filterleiste verändert werden.]]

=== Dashboards veröffentlichen ===
Dashboards werden erst im DiPlan Cockpit sichtbar, nachdem diese veröffentlicht und für die Sachbearbeitenden und Reporting-Administratoren freigeschalten wurden. Dabei gilt es zu beachten, dass Sie nur Dashboards veröffentlichen und freischalten können, die Sie selbst erstellt haben oder für die Sie berechtigt worden sind. Siehe hierzu auch das Kapitel "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Diagramme_und_Dashboards_f.C3.BCr_andere_Reporting-Administratoren_zur_Bearbeitung_freigeben Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben]".

'''Zur Veröffentlichung und Freischaltung gehen Sie wie folgt vor:'''

# Öffnen Sie das Dashboard, welches veröffentlicht werden soll.
# Durch Klick auf das '''graue Feld "Entwurf"''' neben dem Dashboard Namen, ändert sich die Bezeichnung auf '''"Veröffentlicht".'''[[Datei:ImageStatusVeroeffentlichtSuperset.png|zentriert|mini|435x435px|Durch Klick ändert sich der Status von "Entwurf" auf "Veröffentlicht".]]
# Öffnen Sie rechts oben das '''Dreipunktemenü''' und wählen Sie dort den Unterpunkt '''"Dashboard einbetten"''' aus.[[Datei:ImageDashboardEinbettenSuperset.png|zentriert|mini|317x317px|Im Dreipunktemenü muss im nächsten Schritt der Punkt "Dashboard einbetten" geklickt werden.]]
# Im Einbetten-Dialog lassen Sie das Feld für "Zulässige Domänen" bitte einfach frei und klicken lediglich den '''Button "Einbettung aktivieren".''' Dann kann das Menü durch Klick auf das '''X-Symbol''' geschlossen werden.[[Datei:ImageEinbettungAktivierenSuperset.png|zentriert|mini|378x378px|Im Menü "Einbetten" klicken Sie auf "Einbettung aktivieren" und dann einfach auf das X um das Fenster zu schließen.]]
# Um das Dashboard nun für die '''Rolle der Sachbearbeitenden und Mandanten-Administratoren''' im DiPlan Cockpit '''freizugeben''' öffnen Sie bitte erneut den Reiter '''"Dashboards",''' um auf die Liste mit allen Dashboards zu gelangen.
# Klicken Sie auf das '''Stift-Symbol''' neben dem Dashboard, welches freigeschalten werden soll.[[Datei:ImageDashboardEigenschaftenOeffnenSuperset.png|zentriert|mini|398x398px|Durch Klick auf das Stiftsymbol neben dem Dashboard werden die Dashboardeigenschaften geöffnet. Dort können auch die einzelnen Rollen freigeschaltet werden.]]
# In den '''Dashboardeigenschaften''' können nun die Rollen eingetragen werden, für die das Dashboard freigeschalten werden soll. Die Rollenbezeichnungen in Superset fassen mehrere Rollen aus dem DiPlan Cockpit zusammen, was die Freigabe von Dashboards vereinfacht. Bitte tragen Sie im Feld "Rollen" deshalb '''"Reporting-Administrator"''' und '''"Sachbearbeiter" in der Liste ein.''' Dies ist durch Tippen in das Feld möglich, so wird die auszuwählende Rolle schneller sichtbar. Sie können jedoch auch manuell durch die Liste scrollen und die Rolle auswählen. Klicken Sie anschließend den '''"Speichern"-Button'''. Die Auswertungen sind nun im DiPlan Cockpit für alle berechtigten Rollen sichtbar.
'''Hinweis: Veröffentlichung zurücknehmen'''

Sollten Sie ein Dashboard im DiPlan Cockpit unsichtbar machen wollen, so klicken Sie wie im Punkt 2 beschrieben wieder auf die graue Schaltfläche und setzen Sie den Status von '''"Veröffentlicht"''' zurück auf '''"Entwurf".'''

=== Bestehendes Dashboard oder Diagramm bearbeiten oder löschen ===
'''Wie lösche ich ein eingebettetes Diagramm von einem bereits veröffentlichten und freigegebenen Dashboard?'''

* Öffnen Sie das Dashboard und '''klicken Sie "Dashboard bearbeiten"''' auf der rechten Bildschirmseite.
* Im geöffneten Bearbeitungsmodus können Sie nun die Maus über das nicht mehr erwünschte Diagramm bewegen und durch '''Klick auf das erscheinende Mülleimersymbol''' löschen. Das Diagramm bleibt in der Liste der Diagramme weiterhin erhalten und wird lediglich vom Dashboard genommen.
* Sie können ein '''weiteres/neues Diagramm''' jederzeit wieder aus der Liste rechts auf das Dashboard ziehen.
* Bestätigen Sie das veränderte Dashboard durch Klick auf den "'''Speichern"-Button''' rechts oben.
* '''Bitte beachten:''' Änderungen an bereits veröffentlichten und freigegebenen Dashboards werden nach dem '''Speichern direkt auf dem DiPlan Cockpit sichtbar'''.

'''Wie bearbeite ich ein bestehendes Diagramm?'''

Ein Diagramm unabhängig vom Dashboard ändern:

* Öffnen Sie das zu bearbeitende Diagramm in der '''Liste der Diagramme''' durch einen '''Klick auf den Namen'''.
* Das Diagramm öffnet sich direkt im Bearbeitungsmodus und kann nach '''Belieben angepasst werden'''.
* Ist das Diagramm bereits auf einem veröffentlichten und freigegebenen Dashboard eingebettet, so werden alle Änderungen nach dem Speichern direkt übernommen und im '''DiPlan Cockpit sichtbar'''.

Ein Diagramm direkt auf einem Dashboard ändern:

* Öffnen Sie das Dashboard und klicken Sie '''"Dashboard bearbeiten"'''.
* Bewegen Sie die Maus über die entsprechende Grafik, öffnen Sie das Dreipunktemenü rechts und klicken '''"Diagramm bearbeiten".'''
* Nachdem Sie das Diagramm bearbeitet haben klicken Sie '''"Speichern"'''.

'''Bitte beachten:''' Im Speichern-Dialog können Sie entscheiden, ob sie das bestehende '''Diagramm überschreiben''' oder ein '''neues Diagramm speichern''' wollen. Dies kann hilfreich sein, wenn Sie das Diagramm nicht generell, sondern nur auf einem bereits bestehenden Dashboard ändern wollen.

'''Wie lösche ich ein Dashboard oder Diagramm dauerhaft?'''

Sie können ein Dashboard unabhängig vom Status (also veröffentlicht oder auch als Entwurf) in der Liste der Dashboards wie folgt löschen:

* Bewegen Sie die Maus über den entsprechenden '''Listeneintrag.'''
* Klicken Sie das in der Zeile rechts erscheinende '''Papierkorb-Symbol''' und folgen den Anweisungen im erscheinenden Löschdialog.
* Die Originaldiagramme auf dem Dashboard bleiben dabei weiterhin in der Liste "Diagramme" erhalten.
* Sollten Sie ein Diagramm dauerhaft löschen wollen, so gehen Sie genauso wie beim Dashboard vor, jedoch im '''Reiter "Diagramme"'''.

=== Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Bitte beachten:''' Solange Reporting-Administratoren nicht als Besitzer eingetragen sind, haben diese nur Zugriff auf die eigenen erstellten Daten.

'''Das bedeutet konkret für die erstellten Daten von anderen Reporting-Administratoren:'''

* Unveröffentlichte Dashboards sind nicht sichtbar.
* Veröffentlichte Dashboards sind sichtbar, aber nicht bearbeitbar.
* Alle Diagramme sind sichtbar, Änderungen können jedoch nur als neue Diagramme gespeichert werden.
* Datensätze sind sichtbar und können verwendet, aber nicht bearbeitet werden.
* Gespeicherte Abfragen sind nicht sichtbar (Berechtigungen können hier grundsätzlich nicht vergeben werden).

Sie haben grundsätzlich keine Rechte ein Dashboard zu bearbeiten oder ein Diagramm zu überschreiben, welches nicht von Ihnen erstellt wurde, außer Sie wurden als '''"Besitzende/r"''' dazu ermächtigt.

Das bedeutet beispielsweise, dass Sie ein Diagramm, welches jemand anders erstellt hat, zwar bearbeiten, dies aber nur als neues Diagramm abspeichern können. Das Originaldiagramm wird hier nicht verändert. Um jemanden für die '''Mitarbeit an Ihrem Diagramm oder Dashboard zu ermächtigen''' gehen Sie wie folgt vor:

* Klicken Sie in der Liste der Diagramme oder Dashboards auf das '''Stift-Symbol "Bearbeiten".''' Der Dialog '''"Diagrammeigenschaften bearbeiten"''' öffnet sich.
* Unter der '''Überschrift "Zugang"''' können weitere '''"Besitzende" eingetragen''' werden. Klicken Sie hierzu in das Eingabefeld und fangen Sie an den Namen zu tippen oder scrollen Sie durch die Liste bis zum gewünschten Namen.
* '''Wählen Sie einen oder mehrere Namen aus,''' um diese in das Feld zu übernehmen und klicken Sie dann auf '''"Speichern"'''. Die eingetragene Person hat nun die gleichen '''Rechte zur Bearbeitung wie der/die ursprüngliche Ersteller/in'''.

=== Datensätze für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Um Datensätze für andere Reporting-Administratoren zur Bearbeitung freizugeben, gehen Sie wie folgt vor:'''

* Klick auf den '''Reiter "Datensätze"'''
* In der Übersicht-Liste klicken Sie bitte das '''Stift- Symbol''' neben dem gewünschten Datensatz.
* Klicken Sie den '''Reiter "Einstellungen"''' ganz rechts und scrollen Sie ganz nach unten.
* Dort können Sie im '''Feld "Besitzende"''' auch andere Reporting-Administratoren zur Bearbeitung berechtigen.

== Weiterführende Informationen ==
Unter folgendem Link können Sie weitere Informationen zu Superset in englischer Sprache finden. Bitte beachten Sie, dass Ihre Datenbank bereits angebunden ist und der Punkt "Connecting to a new database" in der Dokumentation somit nicht beachtet werden sollte: '''[https://superset.apache.org/docs/6.0.0/using-superset/creating-your-first-dashboard#creating-your-first-dashboard Englische Dokumentation des Open-Source-Tools Superset]'''

Datei:ImageDashboardEigenschaftenOeffnenSuperset.png

2026-03-16T10:27:23Z

Diplanung:

ImageDashboardEigenschaftenOeffnenSuperset

Reporting: Auswertungen im DiPlan Cockpit

2026-03-16T10:25:23Z

Diplanung: /* Dashboards veröffentlichen */

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

'''> Zurück zur Hauptseite [[DiPlan Cockpit Pro für Mandanten-Administratoren (M-A)|DiPlanCockpit Pro für Mandanten-Administratoren (M-A)]]'''

⚠️ '''Bitte beachten: Die Reporting-Funktionalität wird nach und nach Mandanten spezifisch freigeschaltet. Informationen zur Funktionsweise finden Sie hier vorab.'''

== Einleitung ==
Die Auswertungskomponente für das DiPlan Cockpit ermöglicht das Abrufen, Filtern und Downloaden von Reports und Auswertungen aus Planungs- und Genehmigungsverfahren. Die Auswertungsdiagramme zu individuellen Fragestellungen werden in dem externen BI-Tool Superset von berechtigten Personen auf Basis grundlegender SQL- und Datenmodell-Kenntnisse erstellt, verwaltet, auf Dashboards zusammengestellt und schließlich für die Darstellung im DiPlan Cockpit freigegeben.

== Aufruf der Auswertungen ==
Die Auswertungen sind in dem gleichnamigen Reiter im DiPlan Cockpit zu finden.

In der linken Bildschirmhälfte sind die Namen der jeweiligen zur Verfügung stehenden Dashboards zu finden. Ein Dashboard ist eine Zusammenstellung von einem oder mehreren Auswertungsdiagrammen auf einer Seite. Standardmäßig wird das Dashboard "Verfahrensstand aller Verfahren" für jeden Mandant initial mit ausgerollt. Alle weiteren Dashboards können je nach Bedarf individuell durch berechtigte Personen je Mandant erstellt werden. Mehr dazu findet sich im Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Auswertungen_erstellen.2C_ver.C3.B6ffentlichen_und_freigeben Auswertungen erstellen, veröffentlichen und freigeben].

'''Gut zu wissen:'''

* '''Datengrundlage:''' Grundsätzlich fließen gelöschte Verfahren nicht in die Auswertungen ein.
* '''Aktualität der Daten:''' Die Daten werden jede Nacht einmal mit der DiPlan Cockpit Datenbank synchronisiert.
* '''Darstellung:''' Das Reporting wird mit dem Tool Superset umgesetzt, welches in das DiPlan Cockpit eingebunden wird. Für eine optimale Darstellung nutzen Sie bitte den Browser Microsoft Edge.
[[Datei:ImageAuswertungenCockpit.png|zentriert|mini|717x717px|Ansicht des Reiters "Auswertungen" im DiPlan Cockpit mit dem Standarddashboard "Verfahrensstand aller Verfahren".]]

== Filtern der Dashboards bzw. Auswertungen ==
Je nach Art der dargestellten Auswertungen können Sie weitere Aktionen in den einzelnen Diagrammen vornehmen. Oftmals sind zum Beispiel verschiedene Filterungsmöglichkeiten hinterlegt. Zum Öffnen der Filter gehen Sie bitte folgendermaßen vor:

* Aufklappen der Filter durch Klick auf den kleinen blauen Pfeil links neben den Diagrammen. Alternativ können die Filter auch am oberen Rand des Dashboards eingebunden sein.
* Auswählen der gewünschten Filter.
* Klick auf "Filter anwenden".
* Bei Klick auf "Alles löschen" werden sämtliche gesetzte Filter wieder zurückgesetzt.
[[Datei:ImageAuswertungenCockpitFilter.png|zentriert|mini|742x742px|Falls eine Filterung im Dashboard integriert wurde, so lässt diese sich über den kleinen Pfeil ausklappen oder befindet sich am oberen Rand des Dashboards. Hier zu sehen eine Filterung auf dem Dashboard nach Zuständigkeit oder Verfahrenstyp.]]
[[Datei:ImageAuswertungenCockpitFilter2.png|zentriert|mini|742x742px|Das Reporting bietet die Möglichkeit auch mehrere verschiedene Diagrammtypen auf einem Dashboard darzustellen. Diese können von Mandanten-Administratoren konfiguriert und freigegeben werden. Hier ein Beispiel mit integrierten Filtern am oberen Rand des Dashboards.]]

== Download der Auswertungen ==
Neben jeder Auswertungsgrafik (jedem Diagramm) finden sich drei Punkte, welche bei Klick ein Drop-Down Menü öffnen. Durch '''Mouseover auf "Herunterladen"''' öffnet sich das Menü zum Download des Diagramms in verschiedenen auswählbaren Formaten. Hier sind folgende Punkte zu beachten:

* '''Der Download entspricht immer der Filterung:''' Wird eine Grafik durch eine Filterung angepasst und dann ein Download gestartet, so entsprechen die heruntergeladenen Daten immer genau der Filterung, das heißt es sind nicht alle Daten vorhanden. Je nach Grafik ist in den heruntergeladenen Dateien nicht selbsterklärend, dass eine Filterung angewendet wurde und es ist wichtig das Downloadergebnis bei der weiteren Verwendung in den richtigen Kontext zu setzen. Laden Sie sich alternativ die Daten ohne Filterung herunter und filtern Sie zum Beispiel bei Bedarf gesondert in MS Excel.
* '''Die Rollen der Sachbearbeitenden sehen nur die eigene Zuständigkeit:''' Je nach Rolle der Nutzenden werden unter Umständen nicht alle Daten auf den Dashboards dargestellt. Sachbearbeitende können nur Daten der eigenen Zuständigkeit sehen. Siehe dazu auch das nächste Kapitel [https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Rechte_und_Rollen Rechte und Rollen].
[[Datei:ImageAuswertungenHerunterladen.png|zentriert|mini|327x327px|Das vertikale Dreipunktemenü in den Diagrammen beinhaltet die Herunterladen-Funktion.]]

== Rechte und Rollen ==
Alle Rollen aus dem DiPlan Cockpit werden gemäß ihrer Berechtigungen mit einer entsprechenden Rolle in Superset versehen. Prinzipiell gibt es zwei relevante Rollen, denen die Nutzenden in Superset zugeordnet werden. Dies passiert automatisch und regelt ob die Nutzenden berechtigt sind Auswertungen selbst anzulegen, freizugeben und zu veröffentlichen oder ob sie ausschließlich die freigegebenen Auswertungen gemäß ihrer Zuständigkeit im DiPlan Cockpit sehen können. Nachfolgend sehen Sie eine Übersicht über die verschiedenen Berechtigungen:
{| class="wikitable"
|'''Rolle DiPlan Cockpit'''
|'''Rolle Superset'''
|'''Berechtigungen'''
|-
|'''EfA Cockpit Pro'''
* M-A = Mandanten-Administration
* FP-A = Fachplanung-Administration

'''EfA Cockpit Basis'''

* M-A-Basis = Mandanten-Administration-Basis
* FP-A-Basis = Fachplanung-Administration Basis
|'''Reporting-Administrator'''
|
* Kann direkt aus dem DiPlan Cockpit zu Superset abspringen und ist dort automatisch eingeloggt (SSO).
* Kann Datensätze (Superset-spezifische Zwischenschicht zwischen DB-Tabelle und Abfrage) erstellen.
* Kann Auswertungen/Diagramme in Superset erstellen.
* Kann Dashboards mit verschiedenen Auswertungen/Diagramme zusammenstellen.
* Kann Dashboards freigeben für den ganzen Mandanten (z.B. ganz Hamburg).
* Kann alle Daten im Dashboard eines Mandanten sehen.
* Kann Abfragen filtern, also z.B. in Hamburg nach Belieben nach Bezirk (Zuständigkeit) z.B. Altona oder Senat.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
* Kann andere Reporting-Administratoren für die eigenen Dashboards/Diagramme als Besitzer eintragen, um diese für die Bearbeitung, Freischaltung und Veröffentlichung zu berechtigen.
|-
|''''''EfA Cockpit Pro''''''
* FP-VM = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)

'''EfA Cockpit Basis'''

* FP-VM-Basis = Fachplanung-Verfahrensmanagement (ex. Verfahrensmanager)
* FP-SB-Basis = Fachplanung-Sachbearbeitung (ex. Sachbearbeiter intern)
|'''Sachbearbeiter'''
|
* Sieht ausschließlich die vorgefilterten Daten entsprechend der eigenen Zuständigkeit (also z.B. Altona).
* Kann Auswertungen herunterladen, aber nur mit den Daten der eigenen Zuständigkeit.
* Kann freigegebene Dashboards betrachten.
* Kann Auswertungen filtern, wenn Filter eingerichtet wurden.
* Kann Auswertungen in verschiedenen Formaten herunterladen.
|}

== Superset als zentrales Tool für Reporting-Administratoren ==

=== Übergreifende Informationen zu Superset ===
Für die Erstellung und Darstellung des Reportings wurde das Open-Source-Tool Apache Superset in das DiPlan Cockpit implementiert. Superset ist eine Reporting- und Monitoring-Technologie, die es ermöglicht komplexe Daten auf Dashboards in leicht verständlichen Visualisierungen darzustellen. Die Erstellung der Dashboards erfolgt dabei direkt in der Superset-Anwendung. Dort wird auch gesteuert, welche Dashboards mit welchen Auswertungen im DiPlan Cockpit veröffentlicht werden sollen.

=== Absprung aus dem DiPlan Cockpit zu Superset ===
Sobald eine Rolle für die Erstellung von Auswertungen berechtigt ist (zum Beispiel M-A oder FP-A), findet sich im Reiter Auswertungen automatisch der Button '''"Auswertungen konfigurieren"'''. Bei Klick öffnet sich ein weiteres Browserfenster mit der Superset-Plattform. Eine gesonderte Anmeldung in Superset ist nicht erforderlich, da die Anmeldung durch das Cockpit erfolgt (auch Single Sign-On (SSO) genannt).

'''Bitte beachten:''' Nach 4 Stunden erfolgt aus Sicherheitsgründen ein automatischer Logout aus Superset - unabhängig davon ob Sie gerade in Superset arbeiten oder nicht aktiv waren. Sie erhalten keine Warnung vor dem Logout. Deshalb empfiehlt es sich, Änderungen regelmäßig zu speichern, um zu verhindern, dass ungesicherte Abfragen verloren gehen.
[[Datei:ImageButtonAuswertungenKonfigurieren.png|zentriert|mini|491x491px|Berechtigte Personen sehen über den Dashboards im DiPlan Cockpit einen Absprungbutton zu Superset mit der Bezeichnung "Auswertungen konfigurieren."]]
[[Datei:ImageStartbildschirmSuperset.png|zentriert|mini|508x508px|Startbildschirm in Superset mit einer Vorschau auf Dashboards und Diagrammen. Die Hauptmenüpunkte zur Navigation sind am oberen Bildschirmrand zu sehen.]]

=== Auswertungen erstellen, veröffentlichen und freigeben ===
Datenvisualisierungen von Abfragen werden in Superset als '''"Diagramme"''' bezeichnet. Sobald mindestens ein Diagramm erstellt ist, kann dieses auf einem Dashboard integriert werden und mit weiteren Filtermöglichkeiten versehen werden. Wie bereits erwähnt, können Sie als '''Reporting-Administrator''' selbst nach Belieben Diagramme erstellen. Nachfolgend wird beispielhaft die Erstellung und Freigabe des Dashboards mit dem Diagramm "Verfahrensstand aller Verfahren" beschrieben, um einige der Grundfunktionalitäten in Superset zu verdeutlichen (siehe dazu das Kapitel: "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]").

=== Datensätze erstellen ===
Um ein Diagramm zu erstellen wird zunächst ein Datensatz benötigt. Für einfache Abfragen reicht der '''Verfahrensdatensatz''' aus, der bereits standardmäßig enthalten ist. Dieser entspricht der '''Tabelle "Verfahren"''' mit den '''zugehörigen Datenfeldern (Stammdaten)'''.

Für Abfragen auf dem Verfahrensdatensatz können Sie direkt zum Abschnitt "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Beispiel-Diagramm_erstellen Beispiel-Diagramm erstellen]" springen.

Für komplexere '''Abfragen über mehrere Tabellen hinweg, eigene Metriken oder eigene berechnete Spalten''' ist die Erstellung eines eigene Datensatzes mithilfe von SQL-Abfragen notwendig. Folgende Informationen sind in gesonderten Tabellen enthalten:

* Gebietseinheiten
* Kontakte
* Nutzer
* Parallelverfahren
* Termine
* Veränderungssperren
* Vertragsarten
* Vorgesehene Nutzungen
* Zurückstellungen

'''Bitte beachten:''' Bei der Erstellung von eigenen Datensätzen, muss die Spalte "'''''zustaendigkeit_code"''''' aus der Tabelle "'''''verfahren"'' immer enthalten sein,''' da hierüber die Ansicht für Sachbearbeiter standardmäßig gefiltert wird.

'''Um eigene Datensätze zu erstellen gehen Sie bitte wie folgt vor:'''

* Klick im Hauptmenü auf den '''Reiter "SQL"''' und im zugehörigen Dropdown-Menü auf '''"SQL Lab".'''
[[Datei:ImageStartSQLLab.png|zentriert|mini|576x576px|Startansicht SQL Lab]]
* Erstellen Sie Ihre '''SQL-Abfrage''' und klicken Sie auf den '''Button "Ausführen"''', um eine Vorschau auf die Ergebnisse der Abfrage zu erhalten. Ein rotes Kreuzchen links vom SQL-Editor weist auf Fehler im SQL hin.
[[Datei:ImageAusfuehrenSQLLab.png|zentriert|mini|576x576px|Ausführen einer SQL Abfrage im SQL Lab]]
'''Typische Anwendungsfälle und die dazugehörigen SQL Abfragen könnten z.B. sein:'''

* Sie möchten, dass Ihre Abfragen z.B. nach "Gebietseinheiten" und "Vorgesehenen Nutzungen" gefiltert werden können:

{| class="wikitable"
|
SELECT v.*, g.gebietseinheit, vn.vorgesehene_nutzungen
FROM verfahren v
LEFT JOIN gebietseinheiten g ON g.verfahren_id = v.id
LEFT JOIN vorgesehene_nutzungen vn ON vn.verfahren_id = v.id;
|}

* Sie möchten, dass Ihr Datensatz bestimmte Termine enthält (z.B. Grobabstimmungsdatum, Vorweggenehmigungsreife):

{| class="wikitable"
|
WITH grobabstimmung_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Grobabstimmung'
),
vorweggenehmigungsreife_termin AS (
SELECT t.id, t.beginn, t.verfahren_id
FROM termin t
WHERE t.name = 'Vorweggenehmigungsreife'
)
SELECT
v.*,
t1.beginn AS grobabstimmung,
t2.beginn AS vorweggenehmigungsreife
FROM verfahren v
LEFT JOIN grobabstimmung_termin t1 ON t1.verfahren_id = v.id
LEFT JOIN vorweggenehmigungsreife_termin t2 ON t2.verfahren_id = v.id;
|}

* '''Speichern Sie Ihre Abfrage als Datensatz''' ab, indem Sie auf den '''Dropdown-Pfeil neben dem Button "Speichern"''' klicken und dann '''"Datensatz speichern"''' auswählen. Es öffnet sich ein Dialogfeld, in dem Sie einen Namen für Ihren Datensatz vergeben können.
** Hinweis: Wenn Sie statt auf "Datensatz speichern" auf "Speichern" klicken, finden Sie Ihre SQL Abfrage unter dem Reiter '''"Gespeicherte Abfragen"''' wieder.
[[Datei:ImageSpeichernDatensatzSuperset.png|zentriert|mini|581x581px|Speichern eines neuen Datensatzes]]
Nach der Erstellung eines Datensatzes können Sie diesen noch weiter bearbeiten und Labels, eigene Metriken oder berechnete Spalten hinzufügen. Gehen Sie dazu wie folgt vor:
* Klick im Hauptmenü auf den '''Reiter "Datensätze"'''. Hier sind die verfügbaren Datensätze aufgelistet.
* Klicken Sie ganz rechts neben dem Datensatz, den Sie bearbeiten wollen, auf das '''Stift-Symbol.''' Es öffnet sich eine Bearbeitungsmaske.
[[Datei:ImageBearbeitungDatensatzSuperset.png|zentriert|mini|427x427px|Öffnen Sie den Bearbeitungsmodus durch Klick auf das Stiftsymbol]]
*'''Reiter "Quelle":''' Hier kann die zugrundeliegende SQL Abfrage nachträglich angepasst werden. Klicken Sie hierfür auf das Schloss-Symbol.
[[Datei:ImageReiterQuelleSuperset.png|zentriert|mini|411x411px|Im Reiter "Quelle" kann das SQL nachträglich angepasst werden]]
*'''Reiter "Metriken":''' Hier können eigene Metriken angelegt werden.
[[Datei:ImageReiterMetrikenSuperset.png|zentriert|mini|350x350px|Eine neue Metrik "Anzahl Verfahren" wird hinzugefügt]]
*'''Reiter "Spalten":''' Hier sind alle im Datensatz enthaltenen Spalten aufgeführt. An den Werten in der Tabelle ("Datentyp", "Ist zeitlich" etc.) sollte in der Regel nichts geändert werden, dies wird von Superset automatisch richtig erkannt. Beim '''Klick auf das "Plus"''' neben jeder Spalte kann unter "Beschriftung" ein sprechendes Label hinzugefügt werden. Dieses wird später in den Diagrammen angezeigt.
[[Datei:ImageReiterSpaltenSuperset.png|zentriert|mini|470x470px|Im Reiter "Spalten" wird ein Label hinzugefügt]]
*'''Reiter "Berechnete Spalten":''' Hier können dem Datensatz weitere Spalten hinzugefügt werden, die Werte enthalten, die aus anderen Spalten errechnet werden. Verwenden Sie für die Berechnung SQL-Syntax.
[[Datei:ImageReiterBerechneteSpaltenSuperset.png|zentriert|mini|416x416px|Eine berechnete Spalte wird hinzugefügt]]
* Speichern Sie Ihre Änderungen am Datensatz durch das '''Klicken auf den "Speichern"-Button'''. Um die Änderungen zu prüfen, empfiehlt es sich ein Diagramm mit dem Datensatz anzulegen (z.B. eine Tabelle).

=== Beispiel-Diagramm erstellen ===
Nachfolgend soll beispielhaft ein Diagramm "Verfahrensstand aller Verfahren" erstellt werden. Dazu gehen Sie wie folgt vor:

# Klick auf den '''Menüpunkt "Diagramme":''' Auf dieser Seite findet sich eine Liste mit allen bereits erstellten Diagrammen. Innerhalb dieser Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Diagramm-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageUebersichtDiagrammeSuperset.png|zentriert|mini|501x501px|Im Menüpunkt "Diagramme" findet sich eine Übersicht über die bisher erstellten Diagramme (Abfragen) mit vielen Zusatzinformationen.]]
# Um ein neues Diagramm zu erstellen klicken Sie auf den '''Button "+Diagramm"''' rechts oben. Es öffnet sich der Dialog '''"Neues Diagramm erstellen".'''[[Datei:ImageNeuesDiagrammSuperset.png|zentriert|mini|487x487px|Dialog um ein neues Diagramm zu erstellen]]
# Zunächst muss der '''passende Datensatz für die Auswertung ausgewählt''' werden. Für dieses Beispiel wählen wir unter '''"1- Datensatz auswählen"''' den Datensatz '''"verfahren"''' im Dropdownmenü aus.
# Im nächsten Schritt wird der '''passende Diagrammtyp ausgewählt'''. Hier werden Ihnen viele verschiedene Visualisierungsmöglichkeiten geboten. Im genannten Beispiel passt ein "Kreisdiagramm" am besten zu der Visualisierung der Verfahrensstände aller Verfahren. Sie finden das Kreisdiagramm unter dem Hauptmenü "Teil des Ganzen". Klicken Sie '''auf das Kreisdiagramm''' und anschließend auf '''"Neues Diagramm erstellen"'''.
# Nun geht es um die '''Detailkonfiguration''' des Diagramms. Grundsätzlich ist der Arbeitsbereich wie folgt aufgebaut:
#* Die linke Spalte enthält einen '''Überblick''' über die '''zur Verfügung stehenden Daten'''.
#* Die mittlere Spalte enthält die '''Werkzeuge''', um das '''Diagramm zu konfigurieren.'''
#* Im rechten Bereich kann man sich jeweils eine '''Vorschau des Diagramms''' anzeigen lassen.
'''Wir gehen für unser Beispiel wie folgt vor:'''

* Im Feld '''"Name des Diagramms hinzufügen"''' das Diagramm mit einer passenden Bezeichnung versehen.
* Um die Dimensionen des Diagramms festzulegen im Tab '''"Daten"''' unter der Überschrift '''"Abfrage > Dimensionen"''' die Spalte '''"verfahrensstand"''' von links per Drag & Drop herüberziehen.
* Der dazustellende Wert soll hier die Anzahl sein, weshalb nun unter '''"Metrik"''' das Feld '''"Anzahl"''' Button "+Diagramm" per Drag & Drop von links herübergezogen wird. Je nach Fragestellung bzw. welche Daten auf dem Diagramm dargestellt werden sollen, können verschiedenste Kombinationen in der selben Art und Weise über Drag & Drop zusammengestellt werden.
* Unter dem '''Punkt "Filter"''' kann eine Vorabfilterung eingebaut werden, also beispielsweise könnten Sie simulierte Verfahren standardmäßig herausfiltern, so dass die Nutzenden diese gar nicht auswerten können. Anmerkung: "imported_at" kann nicht gelöscht werden. Dieser Wert wird von Superset standardmäßig gesetzt und hat keine Auswirkung auf Ihre Auswertungen.
* Das für die Berechnung zugrundeliegende Zeilenlimit kann bei Bedarf verändert werden.
* Ein Klick auf den '''blauen Button "Diagramm erstellen"''' zeigt eine '''Vorschau''' des erstellten Diagrammes auf der rechten Bildschirmhälfte. Das Diagramm kann nun jederzeit mit einem '''Klick auf "Speichern"''' rechts oben gesichert werden.[[Datei:ImageDiagrammErstellenSuperset.png|zentriert|mini|426x426px|Dialog zur Detaildefinition des neuen Diagramms. Hier beispielhaft zusammengestellt für die Darstellung "Verfahrenstand aller Verfahren".]]

* Unter dem '''Tab "Anpassen"''' finden sich zahlreiche Möglichkeiten, das Diagramm weiter zu verfeinern (zum Beispiel in Farbe und Layout). Hier kann ganz nach Belieben ausprobiert werden. Mit '''Klick auf''' '''"Diagramm aktualisieren"''' kann die Vorschau des Diagramms zur Überprüfung mit den neu gewählten Einstellungen geladen werden.[[Datei:ImageDiagrammAnpassenSuperset.png|zentriert|mini|421x421px|Diagramm kann nach Belieben im Tab "Anpassen" verändert und verfeinert werden.]]
* '''Speichern nicht vergessen:''' Das Diagramm wird erst gespeichert durch '''Klick auf "Speichern" rechts oben'''. Es öffnet sich ein Dialog zu weiteren Speicheroptionen, der mit '''einer weiteren Speicherbestätigung''' abgeschlossen werden kann.[[Datei:ImageDiagrammSpeichernSuperset.png|zentriert|mini|427x427px|Speichern-Dialog für das erstellte Diagramm]]

=== Beispiel-Dashboard erstellen ===

# '''Klick auf den Menüpunkt "Dashboards":''' Unter der Überschrift "Dashboards" findet sich eine Liste mit allen bereits erstellten Dashboards. Diese Liste kann auf verschiedene intuitive Weisen navigiert werden. So kann z.B. nach Dashboard-Namen gesucht werden oder nach dem/der Besitzer*in. Außerdem können die einzelnen Spalten unterschiedlich sortiert werden.[[Datei:ImageDashboardsSuperset.png|zentriert|mini|452x452px|Unter dem Menüpunkt "Dashboards" finden sich alle bereits angelegten Dashboards, sowie die Möglichkeit neue Dashboards zu erstellen.]]
# Mit Klick auf den Button '''"+Dashboard"''' rechts oben öffnet sich ein neuer, leerer Dashboard -Entwurf.
# Der Titel des Dashboards ist standardmäßig als "untitled dashboard" angeben und kann durch '''Klick auf den Namen''' geändert werden.
# Auf der Seitenleiste am rechten Bildschirmrand finden sich alle bereits erstellten Diagramme. Das gewünschte Diagramm kann einfach durch '''Drag & Drop mit der Maus auf das Dashboard gezogen''' werden. Auch die Größe kann leicht geändert werden indem sie die Ränder oder Ecken des Diagramms klicken, gedrückt halten und auf die gewünschte Größe ziehen. Sie können ein oder auch mehrere Diagramme auf einem Dashboard platzieren.
# Zu guter Letzt oben rechts auf den '''Button "Speichern"''' klicken um Ihre Arbeit zu sichern. Nach dem Speichern können Sie jederzeit am Dashboard weiter arbeiten indem Sie auf den nun erscheinenden Button '''"Dashboard bearbeiten"''' klicken.
# Sollten Sie ein Diagramm wieder vom Dashboard löschen wollen, können Sie einfach das '''Mülleimer-Symbol''' klicken, welches bei Mouseover über das jeweilige Diagramm erscheint.[[Datei:ImageDragDropDiagrammSuperset.png|zentriert|mini|351x351px|Das gewünschte Diagramm kann mit der Maus einfach auf das Dashboard gezogen und platziert werden.]]
[[Datei:ImageDiagrammGroesseSuperset.png|zentriert|mini|325x325px|Die Größe des Diagramms lässt sich einfach durch Ziehen der Maus an Ecken oder Rändern verändern.]]

=== Einen oder mehrere Filter zu einem Dashboard zufügen ===
Es ist möglich Ihre Auswertungsdiagramme mit Filtermöglichkeiten zu versehen. Im folgenden wird beispielhaft ein Filter nach der Zuständigkeit auf dem Dashboard "Verfahrensstand aller Verfahren" hinzugefügt:

# Öffnen Sie das Dashboard oder legen Sie sich ein entsprechendes neues Dashboard an und speichern dieses.
# An der linken Bildschirmkante den '''kleinen Pfeil klicken''', um das Filtermenü auszuklappen. '''Wichtig:''' Der Pfeil ist nur sichtbar, wenn das Dashboard bereits gespeichert ist und sich nicht gerade im offenen Bearbeitungsmodus befindet. Sprich: Klicken Sie '''nicht''' "Dashboard bearbeiten" bevor Sie den Filter hinzufügen.
# Klicken Sie auf das '''kleine Zahnrad''' um das Untermenü zu öffnen.
# Ein Klick auf '''"Hinzufügen und Bearbeiten von Filtern"''' öffnet das Menü um die Filter zu konfigurieren.[[Datei:ImageDashboardFilterMenueSuperset.png|zentriert|mini|372x372px|Durch Klick auf den kleinen Pfeil öffnet sich das Menü, mit dem Filter hinzugefügt und konfiguriert werden können.]]
# Um nach der Zuständigkeit zu filtern muss im '''Menü Filtertyp die Option "Wert"''' ausgewählt sein.
# Im Menüpunkt Tabellenname '''"Zuständigkeit"''' als '''Namen des Filters''' eintragen.
# Im '''Feld Datensatz''' wird in diesem Fall '''"verfahren"''' ausgewählt.
# Im '''Feld "Spalte"''' den Filter auswählen, nach dem gefiltert werden soll: in diesem Fall '''"zustaendigkeit".'''
# Das Menü '''"Filterwerte sortieren"''' durch einen Haken aktivieren und absteigend sortieren und mit der '''Sortiermetrik "Anzahl"''' versehen.
# Im '''Reiter "Auswahlverfahren"''' kann der Filter durch eine Auswahl außerdem auf '''einzelne Diagramme oder auf alles bezogen''' werden.
# Durch '''Klick auf "Speichern"''' rechts unten wird der Filter in das Dashboard integriert.[[Datei:ImageFilteroptionenDashboardSuperset.png|zentriert|mini|431x431px|Sie können einen oder mehrere Filteroptionen auf einem Dashboard integrieren und in diesem Menü konfigurieren.]]
'''Übergeordnete Filtereinstellungen:'''

Nach '''Klick auf das Zahnrad''', im geöffneten Filter-Untermenü, können Sie außerdem entscheiden, ob der Filter '''oben''' über dem Diagramm '''oder seitlich links einklappbar''' angezeigt werden soll.

Es gibt dort außerdem die Möglichkeit für ein oder mehrere Diagramme eine '''Kreuzfilterung zu aktivieren.''' Diese erlaubt es Ihnen, direkt '''in einem Diagramm auf ein Element zu klicken''', um damit automatisch eines oder alle Diagramme im Dashboard zu filtern. So können Daten intuitiv und interaktiv erkundet werden, ohne separate Filtersteuerungen zu verwenden.
[[Datei:ImageFilterUntermenueSuperset.png|zentriert|mini|440x440px|Im Filter-Untermenü können bestehende Filter bearbeitet oder weitere Filter hinzugefügt werden. Außerdem kann die Kreuzfilterung aktiviert und die Darstellung der Filterleiste verändert werden.]]

=== Dashboards veröffentlichen ===
Dashboards werden erst im DiPlan Cockpit sichtbar, nachdem diese veröffentlicht und für die Sachbearbeitenden und Reporting-Administratoren freigeschalten wurden. Dabei gilt es zu beachten, dass Sie nur Dashboards veröffentlichen und freischalten können, die Sie selbst erstellt haben oder für die Sie berechtigt worden sind. Siehe hierzu auch das Kapitel "[https://wiki.diplanung.de/index.php?title=Reporting:_Auswertungen_im_DiPlan_Cockpit#Diagramme_und_Dashboards_f.C3.BCr_andere_Reporting-Administratoren_zur_Bearbeitung_freigeben Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben]".

'''Zur Veröffentlichung und Freischaltung gehen Sie wie folgt vor:'''

# Öffnen Sie das Dashboard, welches veröffentlicht werden soll.
# Durch Klick auf das '''graue Feld "Entwurf"''' neben dem Dashboard Namen, ändert sich die Bezeichnung auf '''"Veröffentlicht".'''[[Datei:ImageStatusVeroeffentlichtSuperset.png|zentriert|mini|435x435px|Durch Klick ändert sich der Status von "Entwurf" auf "Veröffentlicht".]]
# Öffnen Sie rechts oben das '''Dreipunktemenü''' und wählen Sie dort den Unterpunkt '''"Dashboard einbetten"''' aus.[[Datei:ImageDashboardEinbettenSuperset.png|zentriert|mini|317x317px|Im Dreipunktemenü muss im nächsten Schritt der Punkt "Dashboard einbetten" geklickt werden.]]
# Im Einbetten-Dialog lassen Sie das Feld für "Zulässige Domänen" bitte einfach frei und klicken lediglich den '''Button "Einbettung aktivieren".''' Dann kann das Menü durch Klick auf das '''X-Symbol''' geschlossen werden.[[Datei:ImageEinbettungAktivierenSuperset.png|zentriert|mini|378x378px|Im Menü "Einbetten" klicken Sie auf "Einbettung aktivieren" und dann einfach auf das X um das Fenster zu schließen.]]
# Um das Dashboard nun für die '''Rolle der Sachbearbeitenden und Mandanten-Administratoren''' im DiPlan Cockpit '''freizugeben''' öffnen Sie bitte erneut den Reiter '''"Dashboards",''' um auf die Liste mit allen Dashboards zu gelangen.
# Klicken Sie auf das '''Stift-Symbol''' neben dem Dashboard, welches freigeschalten werden soll.
# In den '''Dashboardeigenschaften''' können nun die Rollen eingetragen werden, für die das Dashboard freigeschalten werden soll. Die Rollenbezeichnungen in Superset fassen mehrere Rollen aus dem DiPlan Cockpit zusammen, was die Freigabe von Dashboards vereinfacht. Bitte tragen Sie im Feld "Rollen" deshalb '''"Reporting-Administrator"''' und '''"Sachbearbeiter" in der Liste ein.''' Dies ist durch Tippen in das Feld möglich, so wird die auszuwählende Rolle schneller sichtbar. Sie können jedoch auch manuell durch die Liste scrollen und die Rolle auswählen. Klicken Sie anschließend den '''"Speichern"-Button'''. Die Auswertungen sind nun im DiPlan Cockpit für alle berechtigten Rollen sichtbar.
'''Hinweis: Veröffentlichung zurücknehmen'''

Sollten Sie ein Dashboard im DiPlan Cockpit unsichtbar machen wollen, so klicken Sie wie im Punkt 2 beschrieben wieder auf die graue Schaltfläche und setzen Sie den Status von '''"Veröffentlicht"''' zurück auf '''"Entwurf".'''

=== Bestehendes Dashboard oder Diagramm bearbeiten oder löschen ===
'''Wie lösche ich ein eingebettetes Diagramm von einem bereits veröffentlichten und freigegebenen Dashboard?'''

* Öffnen Sie das Dashboard und '''klicken Sie "Dashboard bearbeiten"''' auf der rechten Bildschirmseite.
* Im geöffneten Bearbeitungsmodus können Sie nun die Maus über das nicht mehr erwünschte Diagramm bewegen und durch '''Klick auf das erscheinende Mülleimersymbol''' löschen. Das Diagramm bleibt in der Liste der Diagramme weiterhin erhalten und wird lediglich vom Dashboard genommen.
* Sie können ein '''weiteres/neues Diagramm''' jederzeit wieder aus der Liste rechts auf das Dashboard ziehen.
* Bestätigen Sie das veränderte Dashboard durch Klick auf den "'''Speichern"-Button''' rechts oben.
* '''Bitte beachten:''' Änderungen an bereits veröffentlichten und freigegebenen Dashboards werden nach dem '''Speichern direkt auf dem DiPlan Cockpit sichtbar'''.

'''Wie bearbeite ich ein bestehendes Diagramm?'''

Ein Diagramm unabhängig vom Dashboard ändern:

* Öffnen Sie das zu bearbeitende Diagramm in der '''Liste der Diagramme''' durch einen '''Klick auf den Namen'''.
* Das Diagramm öffnet sich direkt im Bearbeitungsmodus und kann nach '''Belieben angepasst werden'''.
* Ist das Diagramm bereits auf einem veröffentlichten und freigegebenen Dashboard eingebettet, so werden alle Änderungen nach dem Speichern direkt übernommen und im '''DiPlan Cockpit sichtbar'''.

Ein Diagramm direkt auf einem Dashboard ändern:

* Öffnen Sie das Dashboard und klicken Sie '''"Dashboard bearbeiten"'''.
* Bewegen Sie die Maus über die entsprechende Grafik, öffnen Sie das Dreipunktemenü rechts und klicken '''"Diagramm bearbeiten".'''
* Nachdem Sie das Diagramm bearbeitet haben klicken Sie '''"Speichern"'''.

'''Bitte beachten:''' Im Speichern-Dialog können Sie entscheiden, ob sie das bestehende '''Diagramm überschreiben''' oder ein '''neues Diagramm speichern''' wollen. Dies kann hilfreich sein, wenn Sie das Diagramm nicht generell, sondern nur auf einem bereits bestehenden Dashboard ändern wollen.

'''Wie lösche ich ein Dashboard oder Diagramm dauerhaft?'''

Sie können ein Dashboard unabhängig vom Status (also veröffentlicht oder auch als Entwurf) in der Liste der Dashboards wie folgt löschen:

* Bewegen Sie die Maus über den entsprechenden '''Listeneintrag.'''
* Klicken Sie das in der Zeile rechts erscheinende '''Papierkorb-Symbol''' und folgen den Anweisungen im erscheinenden Löschdialog.
* Die Originaldiagramme auf dem Dashboard bleiben dabei weiterhin in der Liste "Diagramme" erhalten.
* Sollten Sie ein Diagramm dauerhaft löschen wollen, so gehen Sie genauso wie beim Dashboard vor, jedoch im '''Reiter "Diagramme"'''.

=== Diagramme und Dashboards für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Bitte beachten:''' Solange Reporting-Administratoren nicht als Besitzer eingetragen sind, haben diese nur Zugriff auf die eigenen erstellten Daten.

'''Das bedeutet konkret für die erstellten Daten von anderen Reporting-Administratoren:'''

* Unveröffentlichte Dashboards sind nicht sichtbar.
* Veröffentlichte Dashboards sind sichtbar, aber nicht bearbeitbar.
* Alle Diagramme sind sichtbar, Änderungen können jedoch nur als neue Diagramme gespeichert werden.
* Datensätze sind sichtbar und können verwendet, aber nicht bearbeitet werden.
* Gespeicherte Abfragen sind nicht sichtbar (Berechtigungen können hier grundsätzlich nicht vergeben werden).

Sie haben grundsätzlich keine Rechte ein Dashboard zu bearbeiten oder ein Diagramm zu überschreiben, welches nicht von Ihnen erstellt wurde, außer Sie wurden als '''"Besitzende/r"''' dazu ermächtigt.

Das bedeutet beispielsweise, dass Sie ein Diagramm, welches jemand anders erstellt hat, zwar bearbeiten, dies aber nur als neues Diagramm abspeichern können. Das Originaldiagramm wird hier nicht verändert. Um jemanden für die '''Mitarbeit an Ihrem Diagramm oder Dashboard zu ermächtigen''' gehen Sie wie folgt vor:

* Klicken Sie in der Liste der Diagramme oder Dashboards auf das '''Stift-Symbol "Bearbeiten".''' Der Dialog '''"Diagrammeigenschaften bearbeiten"''' öffnet sich.
* Unter der '''Überschrift "Zugang"''' können weitere '''"Besitzende" eingetragen''' werden. Klicken Sie hierzu in das Eingabefeld und fangen Sie an den Namen zu tippen oder scrollen Sie durch die Liste bis zum gewünschten Namen.
* '''Wählen Sie einen oder mehrere Namen aus,''' um diese in das Feld zu übernehmen und klicken Sie dann auf '''"Speichern"'''. Die eingetragene Person hat nun die gleichen '''Rechte zur Bearbeitung wie der/die ursprüngliche Ersteller/in'''.

=== Datensätze für andere Reporting-Administratoren zur Bearbeitung freigeben ===
'''Um Datensätze für andere Reporting-Administratoren zur Bearbeitung freizugeben, gehen Sie wie folgt vor:'''

* Klick auf den '''Reiter "Datensätze"'''
* In der Übersicht-Liste klicken Sie bitte das '''Stift- Symbol''' neben dem gewünschten Datensatz.
* Klicken Sie den '''Reiter "Einstellungen"''' ganz rechts und scrollen Sie ganz nach unten.
* Dort können Sie im '''Feld "Besitzende"''' auch andere Reporting-Administratoren zur Bearbeitung berechtigen.

== Weiterführende Informationen ==
Unter folgendem Link können Sie weitere Informationen zu Superset in englischer Sprache finden. Bitte beachten Sie, dass Ihre Datenbank bereits angebunden ist und der Punkt "Connecting to a new database" in der Dokumentation somit nicht beachtet werden sollte: '''[https://superset.apache.org/docs/6.0.0/using-superset/creating-your-first-dashboard#creating-your-first-dashboard Englische Dokumentation des Open-Source-Tools Superset]'''