Verfahrenskonfiguration: Unterschied zwischen den Versionen

Aus DiPlanung

Zeile 5: Zeile 5:
  
 
=== Erläuterung der einzelnen Abschnitte ===
 
=== Erläuterung der einzelnen Abschnitte ===
Im Folgenden sind die einzelnen Abschnitte des Screenshots beschrieben. Die Zeilenangabe bezieht sich auf die im Screenshot sichtbare Zeilennummerrierung auf der linken Seite.
+
Im Folgenden sind die einzelnen Abschnitte des Screenshots beschrieben. Die Zeilenangabe bezieht sich auf die im Screenshot sichtbare Zeilennummerierung auf der linken Seite.
  
=== Zeilen 1-2 ===
+
==== Zeilen 1-2 ====
 
Abschnitt mit Metadaten zur VK
 
Abschnitt mit Metadaten zur VK
  
Rote Abschnitte zeigen an, dass Einträge nicht aufgelöst werden konnten. Hier scheint der Pfad falsch zu sein.
+
==== Zeilen 3-11 ====
 
 
''Frage ans BE: Konsequenz bzw. Handlungsbedarf?''
 
 
 
=== Zeilen 3-11 ===
 
 
Start des Mandanten spezifisch anpassbaren Bereichs:
 
Start des Mandanten spezifisch anpassbaren Bereichs:
  
Zeile 21: Zeile 17:
 
Hier gibt es einen Verfahrenstyp (Verfahrenssteuerung), für den ein beispielhaftes Setting an darunter liegenden Planarten und Verfahrensarten definiert ist. Die Codes referenzieren auf Einträge in den 3 relevanten Codelisten. Sie müssen übereinstimmen, um valide zu sein.
 
Hier gibt es einen Verfahrenstyp (Verfahrenssteuerung), für den ein beispielhaftes Setting an darunter liegenden Planarten und Verfahrensarten definiert ist. Die Codes referenzieren auf Einträge in den 3 relevanten Codelisten. Sie müssen übereinstimmen, um valide zu sein.
  
=== Zeilen 12-15 ===
+
==== Zeilen 12-15 ====
 
Abschnitt Zeitplanung: Für das DiPlanCockpit Basis ist er nicht relevant, muss aber valide Einträge zum Monitoring enthalten („nein“).
 
Abschnitt Zeitplanung: Für das DiPlanCockpit Basis ist er nicht relevant, muss aber valide Einträge zum Monitoring enthalten („nein“).
  
=== Zeilen 16-20 ===
+
==== Zeilen 16-20 ====
 
Abschnitt mit Verfahrensschritten (VS): Für das DiPlanCockpit Basis ist er nicht relevant, muss aber valide Einträge enthalten, also Einträge, die sich in der relevanten Codeliste wiederfinden, und „nein“ für Durchgänge enthalten.
 
Abschnitt mit Verfahrensschritten (VS): Für das DiPlanCockpit Basis ist er nicht relevant, muss aber valide Einträge enthalten, also Einträge, die sich in der relevanten Codeliste wiederfinden, und „nein“ für Durchgänge enthalten.
  
 
Zwingend erforderlich ist der VS „9998“, um Termine auf der Stammdatenseite eintragen und speichern zu können.
 
Zwingend erforderlich ist der VS „9998“, um Termine auf der Stammdatenseite eintragen und speichern zu können.
  
=== Zeilen 21-34 ===
+
==== Zeilen 21-34 ====
 
Abschnitt mit Verfahrens-teilschritten (VTS): Für das DiPlanCockpit Basis ist er nicht relevant, muss aber valide Einträge enthalten, also Einträge, die sich in der relevanten Codeliste wiederfinden.
 
Abschnitt mit Verfahrens-teilschritten (VTS): Für das DiPlanCockpit Basis ist er nicht relevant, muss aber valide Einträge enthalten, also Einträge, die sich in der relevanten Codeliste wiederfinden.
  
 
Zwingend erforderlich ist der VTS „9998“ mitsamt untergeordneten Code-Zeilen, um Termine auf der Stammdatenseite eintragen und speichern zu können.
 
Zwingend erforderlich ist der VTS „9998“ mitsamt untergeordneten Code-Zeilen, um Termine auf der Stammdatenseite eintragen und speichern zu können.
  
= Mandanten spezifischen Anpassung als Schritt-Anleitung =
+
== Mandanten spezifischen Anpassung als Schritt-Anleitung ==
  
== 1. Schritt: Konzeption ==
+
=== 1. Schritt: Konzeption ===
 
Sichten der 3 vorhandenen Codelisten
 
Sichten der 3 vorhandenen Codelisten
  
Zeile 45: Zeile 41:
 
Auswahl und Dokumentation der individuell passenden Optionen.
 
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 Schritt-Anleitung für Codelisten. Erst danach steht der 2. Schritt dieser Anleitung an.
+
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 ==
+
=== 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.
 
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.
  
Zeile 53: Zeile 49:
  
 
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.
 
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.
 
''Frage ans BE: Ist es möglich, eine hierarchische Auswahl zu definieren?''
 
 
''Fall a: Für einen bestimmten Verfahrenstyp (Verfahrenssteuerung) gibt es unterschiedliche Verfahrensarten je nach gewählter Planart?''
 
 
''= Wie würde dann der Codeschnipsel aussehen?''
 
  
 
Auf die Verfahrensart folgt der Abschnitt zur Zeitplanung. Im DiPlanCockpit BASIS steht die Zeitplanung nicht zur Verfügung; aus technischen Gründen muss dennoch eine Angabe zum Monitoring erfolgen. Da es keine Zeitplanung gibt, sollte auch das Monitoring deaktiviert sein. Dies erfolgt über das Setzen von aktiv=“nein“.
 
Auf die Verfahrensart folgt der Abschnitt zur Zeitplanung. Im DiPlanCockpit BASIS steht die Zeitplanung nicht zur Verfügung; aus technischen Gründen muss dennoch eine Angabe zum Monitoring erfolgen. Da es keine Zeitplanung gibt, sollte auch das Monitoring deaktiviert sein. Dies erfolgt über das Setzen von aktiv=“nein“.
Zeile 68: Zeile 58:
 
Das vorliegende Element zur Verfahrenssteuerung kann beliebig häufig kopiert und angepasst werden, so dass sich pro Verfahrenstyp individuelle Konfigurationen vornehmen lassen.
 
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 ==
+
=== 3. Schritt: Hochladen ins DiPlanCockpit ===
Das Hochladen der angepassten Verfahrenskonfiguration erfolgt im Admin-Bereich im Reiter Konfiguration, den Nutzer mit den Rollen M-A-Basis aufrufen können.
+
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 =
+
== Ergänzung ==
 
Für die änderbaren Codelisten
 
Für die änderbaren Codelisten
  
Zeile 78: Zeile 68:
  
 
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.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.Verfahrensteilschritt:
 +
[[Datei:Beispiel.png|zentriert|mini|464x464px]]
 +
  
Weitere Infos finden sich in der Schritt-Anleitung zur Anpassung von änderbaren Codelisten.
+
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].

Version vom 4. Juni 2024, 10:03 Uhr

Mit einer Verfahrenskonfiguration wird festgelegt, wie ein Verfahren aufgebaut ist. Anhand eines Beispiels wird im Folgenden die Struktur einer Verfahrenskonfiguration beschrieben.

Gesamtansicht des Beispiels[Bearbeiten | Quelltext bearbeiten]

BeispielVerfahrenskonfiguration.png

Erläuterung der einzelnen Abschnitte[Bearbeiten | Quelltext bearbeiten]

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

Zeilen 1-2[Bearbeiten | Quelltext bearbeiten]

Abschnitt mit Metadaten zur VK

Zeilen 3-11[Bearbeiten | Quelltext bearbeiten]

Start des Mandanten spezifisch anpassbaren Bereichs:

Abschnitt Verfahrenssteuerung:

Hier gibt es einen Verfahrenstyp (Verfahrenssteuerung), für den ein beispielhaftes Setting an darunter liegenden Planarten und Verfahrensarten definiert ist. Die Codes referenzieren auf Einträge in den 3 relevanten Codelisten. Sie müssen übereinstimmen, um valide zu sein.

Zeilen 12-15[Bearbeiten | Quelltext bearbeiten]

Abschnitt Zeitplanung: Für das DiPlanCockpit Basis ist er nicht relevant, muss aber valide Einträge zum Monitoring enthalten („nein“).

Zeilen 16-20[Bearbeiten | Quelltext bearbeiten]

Abschnitt mit Verfahrensschritten (VS): Für das DiPlanCockpit Basis ist er nicht relevant, muss aber valide Einträge enthalten, also Einträge, die sich in der relevanten Codeliste wiederfinden, und „nein“ für Durchgänge enthalten.

Zwingend erforderlich ist der VS „9998“, um Termine auf der Stammdatenseite eintragen und speichern zu können.

Zeilen 21-34[Bearbeiten | Quelltext bearbeiten]

Abschnitt mit Verfahrens-teilschritten (VTS): Für das DiPlanCockpit Basis ist er nicht relevant, muss aber valide Einträge enthalten, also Einträge, die sich in der relevanten Codeliste wiederfinden.

Zwingend erforderlich ist der VTS „9998“ mitsamt untergeordneten Code-Zeilen, um Termine auf der Stammdatenseite eintragen und speichern zu können.

Mandanten spezifischen Anpassung als Schritt-Anleitung[Bearbeiten | Quelltext bearbeiten]

1. Schritt: Konzeption[Bearbeiten | Quelltext bearbeiten]

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 Schritt-Anleitung für Codelisten. Erst danach steht der 2. Schritt dieser Anleitung an.

2. Schritt: Anpassen der Verfahrenskonfiguration[Bearbeiten | Quelltext bearbeiten]

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 (siehe Screens), 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; aus technischen Gründen muss dennoch eine Angabe zum Monitoring erfolgen. Da es keine Zeitplanung gibt, sollte auch das Monitoring deaktiviert sein. Dies erfolgt über das Setzen von aktiv=“nein“.

Abschließend folgt eine Auflistung von Verfahrensschritten (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.

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[Bearbeiten | Quelltext bearbeiten]

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[Bearbeiten | Quelltext bearbeiten]

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.Verfahrensteilschritt:

Beispiel.png


Weitere Infos finden sich in der Schritt-Anleitung zur Anpassung von änderbaren Codelisten.