Reiter Aufgaben: Übersicht der ActionItems: Unterschied zwischen den Versionen

Aus DiPlanung

Zeile 289: Zeile 289:
  
 
</actionItemString>
 
</actionItemString>
 +
|-
 +
|Textarea
 +
|Dient der Anzeige und Eingabe eines Strings. Der Wert kann in den Stammdaten, generischen Eigenschaften eines sonstigen Termins sowie am ActionItem gespeichert werden. Wenn das Kommentar-Feld einer Sitzung gesetzt werden soll, muss das Element "sitzung" angegeben sein
 +
|[[Datei:ImageTextarea.png|zentriert|mini]]
 +
|'''sitzung''': Hier muss der Wert der Codeliste "Code.Sitzungen" eingetragen werden, wenn an einer Sitzung ein Kommentar gesetzt werden soll.
 +
|<actionItemTextarea>
 +
<label>Beschlusskommentar dokumentieren</label>
 +
 +
    <sitzung>ak1</sitzung>
 +
 +
</actionItemTextarea>
 +
 
|}
 
|}

Version vom 12. August 2024, 14:48 Uhr

ACHTUNG Diese Seite ist noch ein Entwurf!

Der Reiter Aufgaben enthält die innerhalb einer Verfahrens zu erledigenden Aufgaben, unterteilt nach Verfahrensschritten, Verfahrensteilschritten und Unterverfahrensteilschritten. Aufgaben bestehen aus Unteraufgaben und diese wiederum aus ActionItems, die in der Verfahrenskonfiguration enthalten sind.

Auf dieser Seite ist beschrieben, wie die ActionItems im Frontend dargestellt werden und wie sie in der Verfahrenskonfiguration in XML konfiguriert werden.

Allgemeine Informationen zu ActionItems[Bearbeiten | Quelltext bearbeiten]

Ein ActionItem beschreibt eine Aktion die durchgeführt werden soll.

Alle ActionItems haben folgende übergreifenden Datenfelder:

Name Zweck
label Bezeichnung des ActionItem, erscheint als Überschrift
tooltip Tooltip des ActionItem, erscheint unter dem ActionItem

Einzelne ActionItems unterstützen das Auslesen und Zurückschreiben von Werten in den Stammdaten sowie in den generischen Eigenschaften der sonstigen Termine. Hierzu können an den ActionItems folgende Angaben gemacht werden:

Name Zweck
source Zu verwenden, wenn der Wert aus dem Stammdaten kommt. Angabe in Platzhalter-Syntax.
source.updateModel Angabe, ob der Wert in den Stammdaten bei Änderung zurückgeschrieben werden soll. Angabe "ja", wenn es erfolgen soll.
sonstigerTermin.code Zu verwenden, wenn der Wert aus einer generischen Eigenschaft eines sonstigen Termins kommt. Hier muss dann der Wert den sonstigen Termin aus der Codeliste "Code.SonstigerTermin" angegeben werden.
sonstigerTermin.eigenschaft Angabe der generischen Eigenschaft, wo der Wert definiert ist.

Welche ActionItems dieses Verhalten unterstützen ist der Datei "diplanung.xsd" zu entnehmen (aktuell sind es Textarea und Link).

Beschreibung der ActionItems[Bearbeiten | Quelltext bearbeiten]

ActionItem Beschreibung Grafische Darstellung (FE Ansicht) Datenfelder XML Codebeispiel XML
UploadFile Ermöglicht es Dateien in das Cockpit hochzuladen. Die Dateien werden in der Dokumentenbibliothek angezeigt.
allowedExtensions: Angabe der hochladbaren Dateiendungen in einer Komma/Semikolon separierten Liste.

Leerer String / nicht angegeben -> alle Dateiendungen möglich.

allowedUnterlagentypen: Angabe der erlaubten CodeUnterlagenTypen, die in der Anwendung auswählbar und damit hochladbar sind.

logicalFileID: Angabe einer logischen FileID, die die hochgeladenen Dateien bekommen. Dient in anderen ActionItems der Referenzierung der Dateien.

<actionItemUploadFile>

<label>Aktion File Upload</label>

<allowedUnterlagentypen>9900</allowedUnterlagentypen>

<allowedUnterlagentypen>0700</allowedUnterlagentypen> </actionItemUploadFile>

BeteiligungUploadFile Gleiche Funktionalität wie UploadFile. Es wird zusätzlich an der hochgeladenen Datei automatisch die Vormerkung "Beteiligungsverfahren" vergeben. siehe uploadFile siehe uploadFile <actionItemBeteiligungUploadFile>

<label>Dokumente für Beteiligungsverfahren hochladen</label>

<allowedUnterlagentypen>1180</allowedUnterlagentypen> </actionItemBeteiligungUploadFile>

VisualizeFile Stellt den Link zu einer über den Parameter logicalFileID verknüpften Datei dar.
logicalFileID: Logische FileID die auf eine Datei referenziert. Die ID hat kein fest vorgegebenes Format. <actionItemVisualizeFile>

<label>In Digitalen Wissensassistenten wechseln</label>

<logicalFileID>12345abc678</logicalFileID></actionItemVisualizeFile>

BeteiligungVisualizeLink Prägt mithilfe des Systemparameters BETEILIGUNG_URL, der BeteiligungsID und dem aus dem Element "type" ermittelten Zusatz eine URL ins Beteiligungsverfahren aus ("<BETEILIGUNG_URL> /verfahren/ <BETEILIGUNGS_ID>/type").
type: mögliche Angaben: #verfahren -> "/uebersicht" , #beteiligung -> "/public/detail",

#verteiler -> "/einstellungen/benutzer", #einladung -> "/einstellungen/benutzer"

<actionItemBeteiligungVisualizeLink>

<label>Verfahren in Bauleitplanung online konfigurieren</label>

<type>#verteiler</type>

</actionItemBeteiligungVisualizeLink>

ChooseFile Setzt an Dateien einen Unterlagentyp und eine logische FileID und bereitet sie so beispielsweise für die Ausleitung in einen fachlichen Ordner vor.
allowedExtensions: Angabe auswählbarer Dateiendungen in einer Komma/Semikolon separierten Liste.

logicalFileID: Angabe einer logischen FileID, die die hochgeladenen Dateien bekommen. Dient in anderen ActionItems der Referenzierung der Dateien.

<actionItemChooseFile>

<label>Aktion choose File</label>

<allowedExtensions>.pdf, .png</allowedExtensions>

<logicalFileID>12345abc678</logicalFileID>

</actionItemChooseFile>

BeteiligungChooseFile Dient der Auswahl von Dateien für ein Beteiligungsverfahren. siehe chooseFile allowedExtensions: Angabe auswählbarer Dateiendungen in einer Komma/Semikolon separierten Liste. <actionItemBeteiligungChooseFile>

<label>Dokumente auswählen für BOP</label>

<allowedExtensions>.pdf, .png</allowedExtensions>

</actionItemBeteiligungChooseFile>

ChangeDate Setzt das Datum (oder Zeitraum) und den Status (geplant/stattgefunden) eines VTS-Termins (Sitzung oder Sonstiger Termin).
datumsstatus: Mögliche Werte: "geplant" oder "stattgefunden"

sitzung.code: Im Fall einer Sitzung muss ihr Code aus der Codeliste "Code.Sizungstermine" angegeben werden.

sitzung.datumsart: Soll das Datum des Sitzungstermin geändert werden, so muss "sitzungsdatum" angegeben werden. Soll das Versanddatum des Sitzungstermin geändert werden entsprechend das "versanddatum". Wenn es den Wert "versanddatum" hat und der Termin eine Sitzung ist, dann wird er nicht als Planungsrelevant markiert und der Zeitpunkt ist der des Versanddatums.

Andernfalls werden die Planungsrelevanz und der Zeitraum aus dem Termin übernommen und die Nachfolgetermine werden ggf. neu berechnet.

sonstigerTermin.code: Im Fall eines sonstigen Termins muss hier der Wert aus der Codeliste "Code.SonstigerTermin" angegeben werden.

Sonstiger Termin

<actionItemChangeDate>

<label>Aktion ChangeDatum Stattgefunden</label>

    <datumsstatus>stattgefunden</datumsstatus>

    <sonstigerTermin code="0050"/>

</actionItemChangeDate>


Sitzung

<actionItemChangeDate>

<label>Aktion Date Change</label>

    <datumsstatus>stattgefunden</datumsstatus>

    <sitzung code="9200" datumsart="sitzungsdatum"/>

</actionItemChangeDate>

AddDate Dient der Angabe eines Datums (Zeitpunkt oder Zeitraum). Dieses ist kein VTS-Termin und wird ausschließlich am ActionItem gespeichert. D.h. es fließt nicht in die Zeitplanung oder Prognoseberechnung ein. siehe ChangeDate keine <actionItemAddDate>

<label>Aktion Date Add</label> </actionItemAddDate>

Mail Dient der Erstellung einer MSG-Datei. Diese kann im Cockpit heruntergeladen werden. In den Feldern "Subject" und "Body" ist es möglich Platzhalter zu verwenden.
ImageMail.png
body: Inhalt der Mail

subject: Betreff der Mail

receiverAddresses: Liste der Empfänger-Emailadressen, getrennt mit Semikolon.

copyAddresses: Liste der CC-Emailadressen, getrennt mit Semikolon.

<actionItemMail>

<label>E-Mail versenden</label>

<receiverAddresses>beispiel@mail.com</receiverAddresses>

</actionItemMail>

GenerateDocument Dient der Erstellung von Dokumenten, basierend auf im Cockpit enthaltenen Mustervorlagen. Die erstellten Dokumente werden in der Dokumentenbibliothek dargestellt.
ImageGenerateDocument.png
ImageGeneratedDocument.png
musterdokument: Code des Musterdokuments für das ein Dokument generiert werden soll.

Damit das Dokument generiert werden kann, muss eine gültige Vorlagenzuordnung für den musterdokument Code existieren. Wenn es sich um ein übergeordnetes Dokument handelt, muss der Verfahrensschritt und Verfahrensteilschritt mit „Alle“ angegeben werden.

unterlagentyp: Angabe des Wertes aus der Codeliste "Code.VerfahrensunterlagenTyp"

uebergeordnetesDokument: Angabe ob das Dokument in den Ordner "Übergeordnete Verfahrensdokumente" abgelegt werden soll. Wenn nicht wird das Dokument automatisch in dem Verfahrensschrittordner zugeordnet.

<actionItemGenerateDocument>

<label>Niederschrift des Nachgesprächs erstellen</label>

    <musterdokument>0482</musterdokument>

    <unterlagentyp>1132</unterlagentyp>

<uebergeordnetesDokument>nein</uebergeordnetesDokument>

</actionItemGenerateDocument>

Link Stellt im Cockpit einen Link (URL) dar. Der Link kann aus den Stammdaten, generischen Eigenschaften der sonstigen Termine oder am ActionItem selbst definiert werden.
ImageLinkExt.png
ImageLinkInt.png
name: Name des Links, wenn der Link nur am ActionItem definiert werden soll.

url: URL des Links, wenn der Link nur am ActionItem definiert werden soll.

<actionItemLink>

<label>Webseite aufrufen</label>

<name>Beispielseite</name>

<url>https://beispielseite.de</url>

</actionItemLink>

InputLink Ermöglicht die Eingabe eines Links (URL). Der Link kann in den Stammdaten, generischen Eigenschaften eines sonstigen Termins sowie am ActionItem gespeichert werden. Für die Speicherung an den Stammdaten muss das Attribut "updateModel" auf true gesetzt sein.
ImageInputLink.png
updateModel: Steuert Speicherung der Eingabe in den Stammdaten. <actionItemInputLink>

<label>URL zur Interseite eintragen</label>

    <source updateModel="ja">verfahrensbeschreibung.internetseite</source>

</actionItemInputLink>

Checkbox Dient der Anzeige und Eingabe eines Booleans. Der Wert kann in den Stammdaten, generischen Eigenschaften eines sonstigen Termins und am ActionItem gespeichert werden.
ImageCheckbox.png
checked: Angabe ob die Checkbox defaultmäßig selektiert ist. <actionItemCheckbox>

<label>Bereitstellung der Planinformationen prüfen</label>

<checked>nein</checked>

</actionItemCheckbox>

Dropdown Dient der Speicherung eines Wert aus einer Werteliste. Es kann an Sitzungen das Sitzungsergebnis setzen sowie an sonstigen Terminen den Wert einer generischen Eigenschaft des Typs Codeliste. Es kann am ActionItem eine eigene Werteliste definiert oder eine vorhandene Codeliste verwendet werden.
ImageDropdown.png
sitzung.code: Um ein Sitzungsergebnis zu setzen, muss hier der Wert der Sitzung aus der Codeliste "Code.Sitzungen" angegeben sein.

sitzung.ergebnistyp: Typ des Sitzungsergebnis. "Code.PolitischesSitzungsergebnis", "Code.VerwaltungstechnischesSitzungsergebnis" oder "Code.RechtspruefungSitzungsergebnis"

sonstigerTermin.code: Um den Wert einer generischen Eigenschaft eines sonstigen Termins zu setzen, muss hier der Wert des sonstigen Termins aus der Codeliste "Code.SonstigerTermin" angegeben sein.

sonstigerTermin.eigenschaft: Name der generischen Eigenschaft des sonstigen Termins bei dem der Wert gesetzt werden soll.

sonstigerTermin.codelistName: Name der Codeliste der generischen Eigenschaft.

optionLabels: Angabe aller Werte für eine eigene Werteliste am ActionItem.

codelistName: Angabe des Namens der Codeliste, wenn am ActionItem eine vorhandene Codeliste verwendet werden soll.

valueDefault: Angabe eines Wertes, der vorausgewählt sein soll.

Dokumentation eines Sitzungsergebnisses:

<actionItemDropdown>

<label>Sitzungsergebnis dokumentieren</label>

    <sitzung code="ak1">

<ergebnistyp>Code.verwaltungstechnischesSitzungsergebnis</ergebnistyp>

     </sitzung>

</actionItemDropdown>


Angabe einer Codeliste:

<actionItemDropdown>

<label>Zeitpunkt der Rechtsprüfung</label>

  <codelistName>Code.RechtspruefungZeitpunkt</codelistName>

</actionItemDropdown>

String Dient der Anzeige und Eingabe eines Strings. Der Wert kann in den Stammdaten, generischen Eigenschaften eines sonstigen Termins sowie am ActionItem gespeichert werden.
ImageString.png
keine <actionItemString>

<label>Abstimmungsbedarf benennen</label>

</actionItemString>

Textarea Dient der Anzeige und Eingabe eines Strings. Der Wert kann in den Stammdaten, generischen Eigenschaften eines sonstigen Termins sowie am ActionItem gespeichert werden. Wenn das Kommentar-Feld einer Sitzung gesetzt werden soll, muss das Element "sitzung" angegeben sein
ImageTextarea.png
sitzung: Hier muss der Wert der Codeliste "Code.Sitzungen" eingetragen werden, wenn an einer Sitzung ein Kommentar gesetzt werden soll. <actionItemTextarea>

<label>Beschlusskommentar dokumentieren</label>

    <sitzung>ak1</sitzung>

</actionItemTextarea>