Admin-Bereich

Achtung! Diese Seite ist aktuell noch ein Entwurf!

Auf dieser Seite werden die Reiter im Admin-Bereich des DiPlan Cockpit Basis beschrieben. Die Beschreibung konzentriert sich auf die allgemeinen Funktionalitäten. Detaillierte Erläuterungen finden sich in den entsprechenden Unterkapiteln der Themen.

Unterscheidung Cockpit-Bereich und Admin-Bereich

Die Rollen für die Sachbearbeitung (z.B. FP-SB-Basis) sehen nur den Cockpit-Bereich, in dem Verfahren angelegt und laufend bearbeitet sowie in der Übersicht angezeigt bzw. gesucht werden können.

Ausschließlich die Admin-Rollen (z.B. M-A-Basis) können vom Cockpit-Bereich in den Admin-Bereich wechseln. Im Frontend steht dieser Begriff, den wir in der Dokumentation aufgrund der Länge nicht nutzen: Fachliche Leitstelle Administration.

Admin-Bereich im Detail

In der Basis-Version stehen die folgenden Reiter zur Verfügung:

• Systemparameter
• Konfiguration
• Codelisten
• Verfahrensverwaltung
• Planwerksverwaltung
• Transfer Messages
• Protokolle

Systemparameter

Dieser Reiter bietet eine Übersicht der vorhandenen Systemparameter. Mittels Systemparametern lassen sich Anpassungen am Cockpit vornehmen und individuelle Informationen hinterlegen.

Es gibt beispielsweise Systemparameter um den SMTP Server Host anzugeben oder einzustellen, dass der Papierkorb automatisch geleert werden soll. Die Änderungen per Systemparameter betreffen das gesamte Cockpit und sollten deswegen mit Bedacht ausgeführt werden.

Für jeden Systemparameter sind folgende Informationen angegeben:

• Beschreibung, z.B. SMTP Server Host, Automatisiertes Leeren des Papierkorbs erlauben
• Name, z.B. MAIL_SMTP_HOST, job.HousekeepingDokumenteJob.enabled
• Topic, z.B. SMTP, Housekeeping
• Art, z.B. URL, Aktivator
• Typ, z.B. STRING, BOOLEAN
• Wert (bei Typ STRING und URL optional), z.B. example.com, false

Filter und Suche

Es gibt sehr viele Systemparameter. Um schnell bestimmte Systemparameter finden zu können, stehen eine Suchfunktion und verschiedene Filter zur Verfügung.

Die Suche funktioniert über ein Freitextfeld, in das ein oder mehrere Suchbegriff(e) eingegeben werden können. Die Suche erfolgt direkt mit der Eingabe der Begriffe.

Zusätzlich oder alternativ zur Freitextsuche können Filter gesetzt werden. Eine Filterung kann nach dem Topic, der Art und/oder dem Typ erfolgen. Es steht jeweils ein Dropdown zur Verfügung, um einen oder mehrere der möglichen Werte auszuwählen.

Gesetzte Filter und Suchbegriffe können einzeln wieder entfernt oder mit einem Klick gleichzeitig zurückgesetzt werden.

Funktionen

Im oberen Bereich des Reiters stehen die Funktionen Hinzufügen, Exportieren und Importieren zur Verfügung.

Hinzufügen ermöglicht das manuelle Hinzufügen einzelner Systemparameter. Beschreibung und Name sind dabei über ein Freitextfeld anzugeben, Topic, Art und Typ per Auswahl aus einem Dropdown-Menü. Ein Wert kann je nach Typ unterschiedlich angegeben werden, bei den Typen URL und STRING ist die Eingabe per Freitextfeld optional.

Exportieren lädt alle Systemparameter in einer JSON-Datei herunter.

Importieren ermöglicht umgekehrt das Hochladen von Systemparametern in Form einer JSON-Datei. Der Import überschreibt vorhandene Systemparameter und fügt neue hinzu.

Für jeden Systemparameter gibt es per 3-Punkte-Menü die Option ihn zu löschen oder zu bearbeiten. Die Bearbeitung ermöglicht die Anpassung sämtlicher Felder, außer die des Namens.

Weiterführende Informationen

Auf der folgenden Unterseite finden sich weitere Informationen zu Systemparametern: Systemparameter

Konfiguration

Im Reiter Konfiguration kann die Verfahrenskonfiguration aktualisiert werden, es können Verfahren hinzugefügt und die Regeln zur Plannamenvalidierung aktualisiert werden.

Verfahrenskonfiguration

Die Verfahrenskonfiguration definiert die Grundlagen für Verfahren, die im DiPlanCockpit zur Verfügung gestellt werden. Für das DiPlanCockpit Basis bedeutet das im Wesentlichen die hierarchisch gegliederte Auswahl an:

1. Verfahrenssteuerung bzw. Verfahrenstyp
2. Planart
3. Verfahrensart

Die Optionen für 1. und 3. stammen aus änderbaren Codelisten, die für 2. aus einer festen Codeliste. Weitere Infos befinden sich im Abschnitt zum Reiter Codelisten weiter unten.

Die als Default ausgelieferte Verfahrenskonfiguration kann Mandanten spezifisch angepasst werden. Sie besteht aus einer oder mehreren Dateien im XML-Format - ja nach dem, ob eine Datei für alle Verfahrenstypen zusammen angelegt ist, oder es separate Verfahrenskonfigurationen je Verfahrenstyp gibt.

Für die Verfahrenskonfiguration stehen ein Up- und Download zur Verfügung. Eine neu hochgeladene Verfahrenskonfiguration gilt für alle anschließend neu angelegten Verfahren, bereits vorhandene Verfahren werden dadurch nicht verändert.

Das Herunterladen der Verfahrenskonfiguration erfolgt in Form einer ZIP-Datei. Darin sind sowohl XML-Dateien für jeden Verfahrenstyp, als auch eine XML-Datei, die die Verfahrenskonfiguration für alle Verfahrenstypen enthält.

Hinzufügen von Verfahren

Verfahren lassen sich hier hochladen. Für den Upload muss das Verfahren in einer XML-Datei vorliegen und dem XÖV-Standard xPlanverfahren entsprechen. Es ist sowohl das Hochladen eines einzelnen Verfahrens als auch mehrerer Verfahren gleichzeitig möglich. Die maximale Anzahl an Verfahren, die gleichzeitig hochgeladen werden können, wird mittels des Systemparameters XPLANVERFAHREN_IMPORT_VERFAHRENSANZAHL festgelegt und kann darüber bei Bedarf angepasst werden. Dabei ist zu beachten, dass der Upload sehr vieler und großer Verfahren einige Zeit beansprucht. Außerdem werden die Verfahren vor dem Import automatisch auf Konformität mit dem XÖV-Standard validiert. Werden dabei Fehler festgestellt, bricht der gesamte Import ab.

Regeln für die Validierung der Plannamen

Das DiPlanCockpit kann automatisch die Plannamen validieren, wenn Regeln hinterlegt sind. Per Default sind keine Regeln vorgegeben, das heißt, es müssen Regeln hinzugefügt werden, wenn eine Validierung gewünscht ist. Hinterlegte Regeln können herunter- und hochgeladen werden. Der Download liefert eine XML-Datei, die angepasst und anschließend wieder hochgeladen werden kann. Bei der XML-Datei ist darauf zu achten, dass sie dem Schema plannameValidatorkonfiguration.xsd entspricht.

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.

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 aktuell in der Übersicht vorhandenen Codelisten, können zusammen über einen Button ("Stammcodeliste herunterladen") heruntergeladen werden. Der Download erfolgt in Form einer JSON-Datei. Zusätzlich kann jede Codeliste 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.

Verfahrensverwaltung

Im Reiter Verfahrensverwaltung sind alle im Cockpit vorhandenen Verfahren aufgelistet. Das können angelegte Verfahren sowie importierte Verfahren sein. Simulierte Verfahren werden als solches ausgewiesen.

Die Admin-Rolle kann, anders als die Sachbearbeitung, nicht nur simulierte sondern auch bereits gestartete Verfahren löschen. Ein Verfahren kann dafür zuerst als gelöscht markiert und dann endgültig gelöscht oder direkt endgültig gelöscht werden.

Filter und Suche

Als Filter für die dargestellten Verfahren stehen verschiedene Optionen zur Verfügung. Die Suche nach einem Namen erfolgt per Freitextfeld. Filtermöglichkeiten per Dropdown bestehen für die Zuständigkeit, Gebietseinheiten, Planart, den Verfahrenssteuerungstyp sowie den Verfahrensstand. Gesetzte Filter und Suchbegriffe können einzeln wieder entfernt werden oder mit einem Klick gleichzeitig zurückgesetzt werden.

Funktionen

Ein Klick auf den Namen des Verfahrens öffnet es im Cockpit-Bereich.

Per Klick auf das Symbol Papierkorb lassen sich simulierte Verfahren endgültig löschen und nicht simulierte Verfahren wahlweise als gelöscht markieren oder endgültig löschen. Als gelöscht markierte Verfahren können anschließend endgültig gelöscht werden.

Planwerksverwaltung

In der Planwerksverwaltung sind alle Planwerke aus dem Cockpit aufgelistet. Für jedes Planwerk stehen zahlreiche Informationen zur Verfügung und es ist eine Filterung der Planwerke möglich.

Für jedes Planwerk können die folgenden Informationen angegeben sein (nicht für jedes Planwerk sind alle ausgefüllt): Name, ID, Nummer, Gemeinde, XPlan GML Version, Planart, sonstige Planart, Rechtsstand, Datum der Veröffentlichung (Datum Veröff.), Datum des Imports (Datum Import) und Planstatus.

Der Name des Planwerks lässt sich anklicken. Wenn man das zugehörige Verfahren bereits abonniert hat, öffnet sich direkt der Reiter Planwerke im entsprechenden Verfahren. Andernfalls erscheint eine Abfrage, ob man das Verfahren abonnieren möchte. Anschließend gelangt man per erneutem Klick auf das Planwerk in das Verfahren.

Filter und Suche

Eine Filterung der angezeigten Planwerke ist nach dem Namen per Freitextsuche möglich. Für eine Filterung nach der ID, Gemeinde, Planart und dem Planstatus stehen Dropdowns zur Auswahl. Ein Datum der Veröffentlichung oder des Imports lässt sich in einem Kalender auswählen. Gesetzte Filter und Suchbegriffe können einzeln wieder entfernt werden oder mit einem Klick gleichzeitig zurückgesetzt werden.

Funktionen

Für jedes Planwerk gibt es ein 3-Punkte-Menü. Darin gibt es die Funktionen Kartenvorschau, Herunterladen und Löschen bzw. es wird sie geben. Kartenvorschau öffnet eine Kartenansicht des Planwerkes. Herunterladen lädt es herunter. Löschen löscht das Planwerk.

Transfer Messages

Der Reiter Transfer Messages zeigt die beispielsweise, aber nicht ausschließlich, per DCAT-AP PLU übertragenen Nachrichten an. Für jede Nachricht werden die folgenden Informationen dargestellt: Message-ID (z.B. 20), Source (z.B. DCAT_AP_PLU), Direction (z.B. OUT), Message-Type (z.B. CREATE_OR_UPDATE_RECORD), Processingtime (z.B. 16.11.2023, 13:09:52) und Status (z.B. ERFOLGREICH). Per Klick auf "Details einblenden" öffnet sich für eine Nachricht ein Bereich mit zusätzlichen Informationen. Diese umfassen die Message-ID, Vorgangs-ID (z.B. ID_9a21687b-729c-4fbd-85f5-a435b27054ad), den Statustext (HTTP Status), optional Attachments, den MIME-Type (z.B. application/xml) und die gesamte Message.

Mit den Transfer Messages wir die erfolgte Kommunikation vom Cockpit insbesondere mit DiPlan Beteiligung und Metadateninformationssystemen dargestellt. Anhand des Status ist ersichtlich, ob die Nachrichtenübermittlung erfolgreich war. Wenn nicht (Status FEHLER), kann die Detailansicht der Message erste Anhaltspunkte für die Suche nach der Fehlerursache liefern.

Filter

Die angezeigten Nachrichten lassen sich nach den Inhalten von Source, Direction und Status per Auswahl aus einem Dropdown filtern. Außerdem lässt sich ein Zeitraum, für den die Nachrichten angezeigt werden sollen, in einem Kalender auswählen. Gesetzte Filter können einzeln wieder entfernt werden oder mit einem Klick gleichzeitig zurückgesetzt werden.

Funktionen

Die einzige Funktion im Reiter Transfer Messages ist das Löschen einzelner Nachrichten. Dies erfolgt per Klick auf das Mülleimer-Symbol an einer Nachricht.

Protokolle

Der Reiter Protokolle zeigt tabellarisch unterschiedliche Ereignisse an, beispielsweise die Aktualisierung einer Codeliste oder einen Virencheck durch ClamAV. Für jeden Protokolleintrag werden der Typ (z.B. CODELISTE), die Beschreibung (das Ereignis) und der Status (z.B. INFO) aufgeführt.

Filter und Suche

Als Filter für die Protokolleinträge stehen der Typ und Status als Auswahl aus einem Dropdown-Menü zur Verfügung. Gesetzte Filter können einzeln wieder entfernt werden oder mit einem Klick gleichzeitig zurückgesetzt werden.