Codelisten

Achtung! Diese Seite ist aktuell noch ein Entwurf!

Codelisten dienen dazu, dass DiPlanCockpit zu konfigurieren. Änderbare Codelisten ermöglichen Mandanten spezifische Anpassungen. 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.

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 unveränderbaren und mandantenspezifisch veränderbaren Codelisten. Sie können hier die unveränderbaren 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.

Unveränderbare Codelisten auslesen

tbd

Veränderbare Codelisten aktualisieren

Im Tabellenbereich des Reiters Codelisten werden Ihnen alle Codelisten zum Down- und Upload abgeboten.

1. Finden Sie die jeweilige Codeliste über die Suchfunktion.
2. Klicken Sie den Namen der Codeliste, um die jeweilige Codeliste lokal herunterzuladen.
3. 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.
4. Klicken Sie auf das Pfeil-nach-oben Symbol, um die jeweilige Codeliste in Ihr DiPlanCockpit hochzuladen.
   1. Die hochgeladene Codeliste wird XML-Schema validiert. Ungültige Dateien werden mit einer Fehlermeldung abgelehnt.
   2. 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 jedoch nur entfernen, wenn der zu entfernende Wert nicht mehr in aktuellen Datenbestand referenziert wird. Eine Fehlermeldung gibt Aufschluss über den konkreten Codelistenwert, z.B.: Die Codeliste enthält nicht folgende erforderlichen Codes: {Code 'Altona (Altona)' wird noch in Tabelle 'verfahren' benutzt und kann nicht gelöscht werden}. Korrigieren Sie in diesem Fall im Vorwege den Datenbestand.

Erläuterung des Templates

1. Cockpit Basis/Pro: Die Codeliste ist in der Cockpit Basis Version enthalten (demnach auch ich Pro) oder sie ist nur in Pro enthalten
2. Fachliche Bedeutung: Beschreibung der Bedeutung der Codeliste im Cockpit
3. Bezug zu anderen Komponenten: Angabe, wo in welcher Konfiguration die Codeliste referenziert wird
4. Technische Details:
   1. Anpassbar: ja/nein
      1. Verpflichtende Codes: Aufzählung der Codes, die nicht gelöscht werden dürfen (nur wenn anpassbar)
   2. Codeformat: vierstellig, zweistellig, ID, ...
   3. URN: Angabe der URN
   4. Attribute/Spalten: zusätzliche Angaben neben Beschreibung und Code
5. 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.Planart

1. Cockpit Basis/Pro: Basis + Pro
2. 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
3. Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration und dem Datentyp Verfahrensbeschreibung referenziert.
4. Technische Details:
   • Anpassbar: nein
   • Codeformat: z.B. 2_1_LandesweiterRaumordnungsplan
   • URN: urn:xoev-de:xplanverfahren:codeliste:planart
   • Attribute/Spalten: beschreibungLang, uebergeordneterWert, xPlanFachmodell, plu-planType
5. Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

Code.Verfahrensart

1. Cockpit Basis/Pro: Basis
2. 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
3. Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration zur Auflistung aller möglichen Verfahrensarten referenziert.
4. Technische Details:
   • Anpassbar: ja
     • Verpflichtende Codes: keine
   • Codeformat: vierstelliger Zahlencode
   • URN: urn:xoev-de:xplanverfahren:codeliste:verfahrensart
   • Attribute/Spalten: plu-ProcedureType
5. Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

Code.Verfahrensstand

1. Cockpit Basis/Pro: Basis + Pro
2. Fachliche Bedeutung: Bezeichnet den aktuellen Reifegrad eines Verfahrens, z.B. "simuliert" oder "beschlossen" und dient der Statusüberwachung innerhalb des Cockpits.
3. 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 (Tabelle mit passenden Werten).
4. Technische Details:
   • Anpassbar: nein
   • Codeformat: vierstellige Zahlencodes
   • URN: urn:xoev-de:xplanverfahren:codeliste:verfahrensstand
   • Attribute/Spalten: plu-procedureState, plu-planstate
5. Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

Code.Verfahrenssteuerung (auch genannt: Verfahrenstyp bzw. Verfahrenssteuerungstyp)

1. Cockpit Basis/Pro: Basis + Pro
2. 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
3. Bezug zu anderen Komponenten: Wird in der Verfahrenskonfiguration zur Auflistung aller möglichen Verfahrenstypen referenziert.
4. Technische Details:
   • Anpassbar: ja
     • Verpflichtende Codes: keine
   • Codeformat: vierstellige Zahlencodes
   • URN: urn:xoev-de:xplanverfahren:codeliste:verfahrenssteuerung
   • Attribute/Spalten: keine
5. Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

Code.Zustaendigkeit

1. Cockpit Basis/Pro: Basis + Pro
2. 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.
3. Bezug zu anderen Komponenten:
4. Technische Details:
   • Anpassbar: ja
     • Verpflichtende Codes: keine
   • Codeformat: frei wählbar, z.B. Senat
   • URN: urn:xoev-de:xplanverfahren:codeliste:zustaendigkeit
   • Attribute/Spalten: Metadaten Parent ID bzw. uuid
5. Weitere Hinweise zur Mandanten spezifischen Anpassung: keine

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.

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 <SimpleCodeList/> 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:

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

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 https://www.uuidgenerator.net/  (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.