Verfahrenskonfiguration: Unterschied zwischen den Versionen

Aus DiPlanung

 
(11 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
'''Achtung! Diese Seite ist aktuell noch ein Entwurf!'''
+
'''> 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.
 
Mit einer Verfahrenskonfiguration wird festgelegt, wie ein Verfahren aufgebaut ist. Anhand eines Beispiels wird im Folgenden die Struktur einer Verfahrenskonfiguration beschrieben.
  
 
== Gesamtansicht des Beispiels ==
 
== Gesamtansicht des Beispiels ==
[[Datei:VKBasis.png|zentriert|rahmenlos|718x718px]]
+
[[Datei:ImageVKBasis2.png|zentriert|rahmenlos|640x640px]]
  
 
=== 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 Zeilennummerierung 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 ====
+
==== Headerbereich (Zeile 1-2) ====
 
Abschnitt mit Metadaten zur VK
 
Abschnitt mit Metadaten zur VK
  
==== Zeilen 3-11 ====
+
==== Verfahrenssteuerung (Zeile 3) ====
Start des Mandanten spezifisch anpassbaren Bereichs:
+
Es können beliebig viele Verfahrenssteuerungstypen angelegt werden, eine je Verfahrenskonfiguration. Im DiPlanCockpit Basis sind zur Konfiguration nur Plan- und Verfahrensarten anzugeben bzw. relevant.
  
Abschnitt Verfahrenssteuerung:
+
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.
  
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.
+
==== Planarten (Zeilen 4-10) ====
 +
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.  
  
==== Zeilen 12-15 ====
+
==== Verfahrensarten (Zeilen 11-14) ====
Abschnitt Zeitplanung: Für das DiPlanCockpit Basis ist er nicht relevant, muss aber valide Einträge zum Monitoring enthalten („nein“).
+
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.  
  
==== Zeilen 16-20 ====
+
==== Verfahrensschritt (Zeile 16-31) ====
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.
+
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. Der dargestellte Abschnitt kann unverändert übernommen werden.
 
 
Zwingend erforderlich ist der VS „9998“, um Termine auf der Stammdatenseite eintragen und speichern zu können.
 
 
 
==== 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.
 
 
 
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 spezifische Anpassung als Schritt-Anleitung ==
 
=== 1. Schritt: Konzeption ===
 
=== 1. Schritt: Konzeption ===
 
Sichten der 3 vorhandenen Codelisten
 
Sichten der 3 vorhandenen Codelisten
Zeile 48: Zeile 41:
 
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.
  
'''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.
+
'''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.
 
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.
Zeile 56: Zeile 49:
 
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.
 
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.
+
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.
 
Das vorliegende Element zur Verfahrenssteuerung kann beliebig häufig kopiert und angepasst werden, so dass sich pro Verfahrenstyp individuelle Konfigurationen vornehmen lassen.
Zeile 69: Zeile 62:
 
* Code.Verfahrensteilschritt
 
* 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:
+
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:Beispiel.png|zentriert|mini|464x464px]]
+
[[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].
 
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].

Aktuelle Version vom 12. November 2024, 09:55 Uhr

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

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

Headerbereich (Zeile 1-2)[Bearbeiten | Quelltext bearbeiten]

Abschnitt mit Metadaten zur VK

Verfahrenssteuerung (Zeile 3)[Bearbeiten | Quelltext bearbeiten]

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.

Planarten (Zeilen 4-10)[Bearbeiten | Quelltext bearbeiten]

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 Codeliste Planart aufgeführt. Der Eintrag in der Spalte "Übergeordneter Wert" der Codeliste bezeichnet den passenden Verfahrenssteuerungstyp.

Verfahrensarten (Zeilen 11-14)[Bearbeiten | Quelltext bearbeiten]

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.

Verfahrensschritt (Zeile 16-31)[Bearbeiten | Quelltext bearbeiten]

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. Der dargestellte Abschnitt kann unverändert übernommen werden.

Mandanten spezifische 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, 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 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[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.Verfahrensschritt:

9998VS.png


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