Skip to main content

Feldspezifische Konfigurationsparameter

Je nach Art der zu speichernden Informationen können Dynamische Felder verschiedene Formen haben, z. B. Text- oder Auswahlfelder, Checklisten, Referenzen auf bestehende Objekte u.a.m.

Da jeder Feldtyp seine eigene Charakteristik besitzt, variieren die angebotenen Konfigurationsparameter entsprechend des von Ihnen gewählten Feldtyps.

Die nachfolgenden Konfigurationsparameter gelten für alle Feldtypen, außer für den Typ Checklist und Tabelle

Konfigurationsparameter

Beschreibung

Anzahl (min)

Mit der eingetragenen Anzahl legen Sie fest, wie oft das Feld mindestens im Formular enthalten sein soll.

  • 0 – Das Feld wird beim Laden des Formulars nicht angezeigt, kann aber durch Klick auf button_plus.png angezeigt werden.

  • 1 - Das Feld ist einmal im Formular enthalten.

  • 2 – Das Feld ist zweimal im Formular enthalten (usw.)

Ausnahme: In Auswahlfelder (z. B. Selection) wird hiermit die Mindestanzahl der auszuwählenden Werte angegeben. Somit wird das Feld zum Pflichtfeld, wenn der der Wert >0 ist.

Beispiele:

  • CountMin = 1, CountMax = 2

    Es werden im Dialog mindestens eins der maximal 2 möglichen Auswahlfelder angezeigt.

  • CountMin = 0, CountMax = 1, CountDefault = 0

    Im Dialog wird nur das Label ohne Auswahlfeld angezeigt. Das button_plus.png Symbol zum Anzeigen des Auswahlfeldes ist vorhanden.

Anzahl (max)

Mit der eingetragenen Anzahl legen Sie fest, wie oft das Feld maximal im Dialog enthalten sein darf.

Darf es mehrfach enthalten sein, werden hinter dem Feld ein Plus- und ein Minus-Symbol angezeigt, sodass das Feld für weitere Eingaben dupliziert werden kann. Maximal jedoch um die hier eingetragene Anzahl.

Die Angabe von 0 definiert keine Beschränkung der Anzahl.

spezifische-feldtypen_parameter_count-max.png

Beispiel: Feld „Zugeordneter Kontakt“ beim Anlegen eines neuen Assets

Ausnahme: In Auswahlfeldern (z. B. Typen Selection oder AssetReference) wird hiermit die Maximalanzahl der auswählbaren Werte angegeben. Geben Sie eine Zahl >1 an, wird das Auswahlfeld ein Multiselectfeld.

Anzahl (Standard)

Mit der hier eingetragenen Anzahl legen Sie fest, wie oft das Feld initial beim Aufruf des Formulars angezeigt wird.

Beispiel: CountMax = 5, CountDefault = 5: Es werden initial gleich alle 5 Eingabefelder im Formular angezeigt.

Einzeleintrag-Separator

Trennsymbol für die einzeilige Anzeige mehrerer Werte (i.d.R. Komma oder Semikolon).

Werden mehrere Werte in das Feld eingetragen (z. B. Mehrfachauswahl bei Select- und AssetReference-Feldern), so werden die einzelnen Werte mit diesem Trennsymbol verkettet, wenn die Werte einzeilig dargestellt werden (z. B. in Tabellen).

Vorgabewert

Vorbelegung des Feldes

  • Feldtyp Text und Textarea: Mit diesem Wert ist das Feld gefüllt, sofern kein anderer Wert eingetragen wird. Feldtyp

  • Feldtyp Selection: Der Key des zu setzenden Wertes

  • Feldtyp Datum und Datum/Uhrzeit: der Offset zum Zeitpunkt der Feldanzeige

    • 0 = jetzt

    • 3600 = Vordatieren der Zeit: jetzt + 1 Stunde

    • leer = keine Initialisierung

Dynamische Felder des Typs Asset Reference erzeugen Auswahlfelder, in denen ein oder mehrere Assets (maximal 15) mit einem Ticket oder mit einem FAQ-Artikel verknüpft werden können. Sie referenzieren auf ein oder mehrere Assets. Bei Verwendung sind die zur Auswahl stehenden Objekte abhängig von den Berechtigungen des angemeldeten Nutzers sowie der Feldkonfiguration (z. B. Einschränkung auf bestimmte Verwendungsstatus).

Solche Dynamischen Felder sind bspw. die Auswahlfelder Betroffenes Asset" in Tickets und Relevante Assets in FAQ-Artikeln. Sie können die Konfiguration dieser Dynamischen Felder an die unternehmenseigenen Erfordernisse anpassen und weitere Dynamische Felder dieses Feldtyps anlegen.

df-typ_assetreference.png

Abb.: Das Feld "Betroffenes Asset" als Beispiel für ein Dynamisches Feld vom Typ "Asset Reference"

Konfigurationsparameter

Beschreibung

CountMin

Mit der eingetragenen Anzahl legen Sie fest, wieviel Assets mindestens ausgewählt werden müssen.

Das Feld wird zum Pflichtfeld, wenn der der Wert >0 ist.

CountMax

Gibt an, wie viele Assets gleichzeitig ausgewählt werden können.

Tragen Sie einen Wert >1 ein, wird ein Multiselectfeld erzeugt.

Gleichzeitig entspricht der eingetragene Wert der Maximalanzahl der auswählbaren Werte.

Deployment States

Hinterlegen Sie hier einen oder mehrere Verwendungsstatus von Assets.

Im Formularfeld stehen dann nur Assets zur Auswahl, welche die hier angegebenen Verwendungsstatus haben.

Klicken Sie dazu (ggf. mehrfach) auf "Add item".

Klicken Sie auf "Delete item“, um den Auswahlwert zu entfernen.

Werden keine DeploymentStates ausgewählt, gibt es keine Einschränkung und im Formularfeld werden alle Verwendungsstatus berücksichtigt.

ITSMConfig- ItemClasses

Hinterlegen Sie hier eine oder mehrere Asset-Klassen.

Im Formularfeld stehen dann nur die Assets der hier angegebenen Asset-Klassen zur Auswahl.

Klicken Sie dazu (ggf. mehrfach) auf "Add item".

Klicken Sie auf "Delete item“, um die Asset-Klasse von der Auswahl zu entfernen.

Werden keine ITSMConfigItemClasses ausgewählt, gibt es keine Einschränkung und im Formularfeld können die Assets aller im System angelegten Asset-Klassen ausgewählt werden. Maximal jedoch 15 Assets.

Verwendungsstatus

Optional: Einschränkung der Auswahl auf den Verwendungsstatus

Klicken Sie dazu ggf. mehrfach auf die Plus-Schaltfläche.

  • Wenn angegeben: Es stehen im Auswahlfeld nur die Assets der hier angegebenen Verwendungsstatus zur Auswahl

  • Wenn nicht angegeben: keine Einschränkung

Assetklassen

Optional: Einschränkung der Auswahl auf ausgewählte Assetklassen

Klicken Sie dazu ggf. mehrfach auf die Plus-Schaltfläche.

  • Wenn angegeben: Es stehen im Auswahlfeld nur die Assets der hier angegebenen Assetklassen zur Auswahl

  • Wenn nicht angegeben: keine Einschränkung

GUI Integration

Erwartet dynamic-field-value als componentID und name als componentData

...
  "componentId": "dynamic-field-value",   
  "componentData": {
     "name": "AffectedAsset"
  },
...

Platzhalter für Asset-Referenz-Felder

Auf die im Dynamischen Feld ausgewählten Assets sowie auf deren Attribute können Sie via KIX Platzhalter zugreifen (s. Assetbezogene Platzhalterbereiche und Platzhalter für referenzierende Dynamische Felder

Damit können Sie bspw. in Jobs oder Aktionen auf diese Informationen referenzieren und an anderen Objekten zur Verfügung stellen.

Art der Verknüpfung ändern

Die in einem Feld des Typs Asset Reference ausgewählten Assets werden initial mit dem Ticket als Relevant für verknüpft. Im SysConfig-Schlüssel Ticket::EventModulePost###ITSMConfigItemLinkAdd können Sie die Art der Verknüpfung ändern. 

{
   "Event": "(TicketDynamicFieldUpdate_AffectedAsset)",
   "LinkType": "RelevantTo",   // DependsOn | RelevantTo | RequiredFor | normal
   "Module": "Kernel::System::Ticket::Event::ITSMConfigItemLinkAdd"
}

Checklisten ermöglichen Ihnen, eine Liste vordefinierter Aufgabenstellungen im Ticket zu integrieren.

Sie kann bspw. Servicetechnikern als Leitlinie für eine vollständige Serviceerbringung und damit zur Einhaltung von Qualitätsstandards dienen. Der Servicetechniker kann die Checkliste Punkt für Punkt abarbeiten, beantworten und ggf. einen Kommentar zu einzelnen Punkten notieren.

Sie können beliebig viele Checklisten anlegen und diese an einem oder mehreren Tickets bereitstellen. Agenten können dann diese Checklisten teilweise oder ganz abarbeiten. Wird das Ticket an einen anderen Agenten oder Team weitergeleitet, kann die Abarbeitung der Checkliste dort durch diese Agenten fortgesetzt werden.

Jede Checkliste besteht aus beliebig vielen, frei definierten Listenpunkten. Jeder Listenpunkt kann wiederum weitere, ihm untergeordnete Listenpunkte enthalten. Die einzelnen Listenpunkte können in beliebiger Reihenfolge und zu jedem Zeitpunkt abgearbeitet werden, da sie direkt am Ticket gespeichert sind. 

Jeder Listenpunkt ist ein Item. Es besteht aus einem kurzen Titel zur Benennung  und einem optionalen Hinweistext zur näheren Erläuterung des Listenpunkts . Unklarheiten und Nachfragen beim Abarbeiten der Checkliste werden so vermieden.

Ein Listenpunkt kann entweder ein einzeiliges oder mehrzeiliges Textfeld oder ein Auswahlfeld (Dropdown)  sein. Die in einem Auswahlfeld auswählbaren Werte können Sie frei definieren.

Wie weit eine Checkliste abgearbeitet ist, ist an einem Fortschrittsbalken erkennbar.

df-typ_checklist.png

Abb.: Beispiel einer Checkliste

  1. Navigieren Sie ins Menü System > Dynamische Felder

  2. Klicken Sie in der Tabelle auf Neues Feld.

    Es wird ein Formulardialog geöffnet, in dem Sie ein neues Dynamisches Feld anlegen können.

  3. Wählen Sie den Feldtyp Checkliste

    Es wird die Checklisten-Konfiguration angezeigt.

  4. Füllen Sie im Formular die Basis-Parameter aus (s. Allgemeine Konfigurationsparameter).

  5. Setzen Sie die Gültigkeit auf "gültig".

  6. Klicken Sie auf checkliste-konfig_SF-checklisteneintrag.png

    Die Item-Konfiguration für Item 1 wird geöffnet.

    Jedes Item entspricht einem Eingabe- bzw. Checklistenfeld, welches separat konfiguriert werden kann.

  7. Tragen Sie die Konfigurationsparameter für das Item ein (siehe: Konfiguration der Checklistenpunkte (Items)).

  8. Optional: Fügen Sie weitere Items mit Klick auf checkliste-konfig_SF-checklisteneintrag.png hinzu.

  9. Optional: Fügen Sie weitere, untergeordnete Sub-Items mit Klick auf checkliste-konfig_SF-sub.png.

    Konfigurieren Sie die Sub-Items analog der Haupt-Items.

  10. Speichern Sie Ihre Eingaben abschließend mit Speichern.

Das Dynamische Feld vom Typ Checkliste ist nun angelegt und kann in die Oberflächen des angegebenen Objekttyps integriert werden.

Jeder Checklistenpunkt ist ein Item. Sie können beliebig viele Items und Sub-Items erstellen. Klicken Sie dazu ggf. mehrfach auf die Plus-Schaltfläche neben Checklisteneintrag oder Sub+.

df-typ_checkliste_item-konfig.png

Jedes Item kann per Drag & Drop in die gewünschte Reihenfolge gezogen werden.

df-typ_checkliste_item-drag-drop.png

Hinweis: Die Konfigurationsoptionen Anzahl (min), Anzahl (max), Anzahl (Standard) usw. stehen in Checklisten nicht zur Verfügung.

Konfigurationsparameter

Beschreibung

Id

Beliebiger Wert für die interne Verarbeitung (optional).

Die ID darf nur einmal in der Checkliste vorkommen.

Wird keine ID eingetragen, wird sie vom System automatisch vergeben.

Titel

Der Titel kennzeichnet einen Checklisteneintrag

df-typ_checkliste_konfig-titel.png

Beschreibung

Optional: Genauere Beschreibung des Checklisteneintrags

df-typ_checkliste_konfig-beschreibung.png

Fertig

Relevant für Eingabewert Text bzw. TextArea.

Verfügbar nur in neu angelegten Checklisten.

Wenn aktiviert, wird der Fortschritt der Checkliste weitergezählt, sobald im Eingabefeld (Text und TextArea) etwas notiert wird.

Hinweis: Das Textfeld gilt als ausgefüllt, wenn die Länge des enthaltenen Strings >0 ist. Es wird nicht geprüft, ob nur Leerzeichen enthalten sind.

Abgrenzung: Die Field Agent App berücksichtigt für den Checklistenfortschritt nur die Checklist-State-Werte.

Datum der letzten Änderung anzeigen

Wenn aktiviert, wird am Item das Datum der letzten Änderung angezeigt.

df-typ_checkliste_konfig-aenderungszeit.png

Eingabe

Legt fest, ob ein Auswahlfeld oder ein Textfeld zur Beantwortung des Checklistenpunkts angezeigt wird.

  • Text: Es wird ein einzeiliges Textfeld angezeigt, in dem Nutzer kurze Informationen hinterlegen können, z. B. aufgetretene Hindernisse bei Ausführung der Arbeiten.

  • TextArea: Es wird ein mehrzeiliges Textfeld angezeigt, in dem Nutzer längere Texte inkl. Zeilenumbrüche eintragen können. 

    df-typ_checkliste_konfig-textarea.png
  • Checklisten-Status: Es wird ein Auswahlfeld angezeigt, in welchem der Status des Checklistenpunkts ausgewählt werden kann

    Die Auswahlwerte können Sie selbst definieren. Klicken Sie dazu auf die Plus-Schaltfläche

    df-typ_checkliste_konfig-checkliststatus.png

    Es werden weitere Konfigurationsoptionen offeriert:

    • Label: Bezeichnung des Status. Dieser wird im Dropdown als Auswahlwert angeboten

      df-typ_checkliste_konfig-item-label.png
    • Icon: Sie können dem Auswahlwert ein Icon voranstellen .

      Zur Auswahl stehen die KIX-Icons und eine Vielzahl an Fontawesome-Icons.

      df-typ_checkliste_konfig-item-icon.png
    • Fertig: Setzen Sie ein Häkchen, wenn bei Auswahl des Wertes der Fortschritt der Checkliste weitergezählt werden soll.

      Dies kann für jeden Auswahlwert gesondert festgelegt werden.

    Ist im Checklisten-Status nichts definiert, werden folgende Auswahlwerte per Default gesetzt:

Wert

Voreingestellter Wert (optional).

Mit dem angegebenen Text oder Auswahlwert wird das Feld vorbelegt. Er kann bei Verwendung der Checkliste durch den Agenten geändert werden.

Bei Typ ChecklistState ist ein Auswahlwert anzugeben, welcher auch im Checklisten-Status definiert ist (z. B. pending | OK | NOK | erledigt). Anderenfalls wirdkein Wert angezeigt.

checkliste-konfig_SF-sub.png

Legt weitere Unterpunkte für einen Checklisteneintrag an und generiert damit eine hierarchische Baumstruktur der Checkliste.

dialog_x-delete.png

Löscht den Checklisteneintrag einschließlich eventueller Sub-Items.

dialog_arrow-down_arrow.png dialog_arrow-up_arrow.png

Verschiebt den Checklisteneintrag einschließlich eventueller Sub-Items nach oben bzw. unten

Checklisten können auch per Automation (Macro Action "Dynamisches Feld Setzen") erstellt oder zugewiesen werden. Auf diese Art kann ein Checklistenfeld in mehreren Ausprägungen genutzt werden und mehrfache Konfiguration wird vermieden. Das nachfolgende Beispiel zeigt den vollständigen in einer Macro Action zuzuweisenden Wert.

  • InputStates: Optionale Angabe.

    Wenn angegeben, werden die Keys als Statuswerte betrachtet.

    Wenn nicht angegeben, werden die Default-Werte (OK, NOK, Pending, keine Angabe, nicht erforderlich) gesetzt.

  • order: Das Attribut definiert die Reihenfolge der Auswahlwerte und ist für die Anzeige der Checkliste in der Field Agent App erforderlich (ab r1.8.0 (151)).

  • icon: Optionale Angabe eines KIX- oder FontAwesome-Icons

  • done: Das Attribut definiert, ob der Auswahlwert den Fertigstellungsgrad der Checkliste erhöht.

Beispiel eines Checklisteninhalts für das Preboarding bei Einstellung neuer Mitarbeiter (technisch)

[
   {
      "id": "100",
      "title": "Informationen zusenden",
      "description": "Vor First Day Begrüßungs- und Info-Mail zusenden/ anrufen. Wichtige Informationen bereitstellen: wo, wann, von wem erwartet, Unternehmensleitbild, Organigramm oder Kommunikationsleitfäden. Ziel: vorab allg. Fragen klären.",
      "input": "ChecklistState",
      "inputStates": [
         {
            "value": "OK",
            "order": 1,
            "icon": "kix-icon-check",
            "done": true
         },
         {
            "value": "NOK",
            "order": 1,
            "icon": "kix-icon-exclamation",
            "done": true
         },
         {
            "value": "pending",
            "order": 1,
            "icon": "fa-times",
            "done": false
         }
      ],
      "value": "-"
   },
   {
      "id": "200",
      "title": "Dokumente besorgen",
      "description": "Mitwirkung des Arbeitnehmers einfordern. Sozialversicherungsausweis, Krankenkasse, Lohnsteuerkarte, Steuer-ID. Ziel: Vermeidung organisatorischer Fragen in erster Woche.",
      "input": "ChecklistState",
      "inputStates": [
         {
            "value": "erledigt",
            "order": 1,
            "icon": "kix-icon-check",
            "done": true
         },
         {
            "value": "in Arbeit",
            "order": 1,
            "icon": "kix-icon-exclamation",
            "done": true
         },
         {
            "value": "warten auf Rückmeldung",
            "order": 1,
            "icon": "fa-times",
            "done": false
         }
      ],
      "value": "-"
   },
   {
      "id": "300",
      "title": "Ansprechpartner benennen",
      "description": "Fester Ansprechpartner, der zur Seite steht - auch bei Anfragen aller Art im Vorfeld - aka Mentor/Pate/Buddy.",
      "input": "ChecklistState",
      "inputStates": [
         {
            "value": "erledigt",
            "order": 1,
            "icon": "kix-icon-check",
            "done": true
         },
         {
            "value": "nicht erforderlich",
            "order": 1,
            "icon": "kix-icon-exclamation",
            "done": true
         },
         {
            "value": "in Klärung",
            "order": 1,
            "icon": "fa-times",
            "done": false
         }
      ],
      "value": "-",
      "sub": [
         {
            "id": "310",
            "title": "Buddy",
            "input": "Text",
            "value": ""
         }
      ]
   },
   {
      "id": "400",
      "title": "Arbeitsplatz einrichten",
      "description": "Arbeitsplatz muss am First Day eingerichtet sein. Dazu gehören: Bereitstellung Passwörter, Druckerzugang, Telefon, Bürostuhl/ Schreibtisch, sonstige Hilfsmittel. Ziel: Vermeidung technischer Blocker in erster Woche.",
      "input": "ChecklistState",
      "inputStates": [
         {
            "value": "OK",
            "order": 1,
            "icon": "kix-icon-check",
            "done": true
         },
         {
            "value": "NOK",
            "order": 1,
            "icon": "kix-icon-exclamation",
            "done": true
         },
         {
            "value": "pending",
            "order": 1,
            "icon": "fa-times",
            "done": false
         }
      ],
      "value": "-"
   },
   {
      "id": "500",
      "title": "Einarbeitungsplan erstellen",
      "description": "Muss frühzeitig, vor Arbeitsbeginn, stehen. Inhalt: detaillierten Arbeitsplan für erste Woche; Aufgaben; künftige Projekte. Ziel: Chaos und Leerlauf verhindern.",
      "input": "ChecklistState",
      "inputStates": [
         {
            "value": "OK",
            "order": 1,
            "icon": "kix-icon-check",
            "done": true
         },
         {
            "value": "NOK",
            "order": 1,
            "icon": "kix-icon-exclamation",
            "done": true
         },
         {
            "value": "pending",
            "order": 1,
            "icon": "fa-times",
            "done": false
         }
      ],
      "value": "-",
      "sub": [
         {
            "id": "510",
            "title": "URL-Einarbeitungsplan",
            "input": "Text",
            "value": ""
         }
      ]
   },
   {
      "id": "600",
      "title": "Wohnungssuche organisieren",
      "description": "Unterstütztung Auswärtiger bei Wohnungssuche, Umzug oder Behördengängen. Ziel: Vermeidung Ablenkung, Ermöglichen Konzentration auf Einarbeitung",
      "input": "ChecklistState",
      "inputStates": [
         {
            "value": "OK",
            "order": 1,
            "icon": "kix-icon-check",
            "done": true
         },
         {
            "value": "NOK",
            "order": 1,
            "icon": "kix-icon-exclamation",
            "done": true
         },
         {
            "value": "pending",
            "order": 1,
            "icon": "fa-times",
            "done": false
         }
      ],
      "value": ""
   }
][
  {
    "id": "100",
    "title": "Informationen zusenden",
    "description": "Vor First Day Begrüßungs- und Info-Mail zusenden/anrufen. Wichtige Informationen bereitstellen: wo, wann, von wem erwartet, Unternehmensleitbild, Organigramm oder Kommunikationsleitfäden. Ziel: vorab allg. Fragen klären.",
    "input": "ChecklistState",
    "value": "-"
  },
  {
    "id": "200",
    "title": "Dokumente besorgen",
    "description": "Mitwirkung des Arbeitnehmers einfordern. Sozialversicherungsausweis, Krankenkasse, Lohnsteuerkarte, Steuer-ID. Ziel: Vermeidung organisatorischer Fragen in erster Woche.",
    "input": "ChecklistState",
    "value": "-"
  },
  {
    "id": "300",
    "title": "Ansprechpartner benennen",
    "description": "Fester Ansprechpartner, der zur Seite steht - auch bei Anfragen aller Art im Vorfeld - aka Mentor/Pate/Buddy.",
    "input": "ChecklistState",
    "value": "-",
    "sub": [
      {
        "id": "310",
        "title": "Buddy",
        "input": "Text",
        "value": ""
      }
    ]
  },
  {
    "id": "400",
    "title": "Arbeitsplatz einrichten",
    "description": "Arbeitsplatz muss am First Day eingerichtet sein. Dazu gehören: Bereitstellung Passwörter, Druckerzugang, Telefon, Bürostuhl/Schreibtisch, sonstige Hilfsmittel. Ziel: Vermeidung technischer Blocker in erster Woche.",
    "input": "ChecklistState",
    "value": "-"
  },
  {
    "id": "500",
    "title": "Einarbeitungsplan erstellen",
    "description": "Muss frühzeitig, vor Arbeitsbeginn, stehen. Inhalt: detaillierten Arbeitsplan für erste Woche; Aufgaben; künftige Projekte. Ziel: Chaos und Leerlauf verhindern.",
    "input": "ChecklistState",
    "value": "-",
    "sub": [
      {
        "id": "510",
        "title": "URL-Einarbeitungsplan",
        "input": "Text",
        "value": ""
      }
    ]
  },
  {
    "id": "600",
    "title": "Wohnungssuche organisieren",
    "description": "Unterstütztung Auswärtiger bei Wohnungssuche, Umzug oder Behördengängen. Ziel: Vermeidung Ablenkung, Ermöglichen Konzentration auf Einarbeitung.",
    "input": "ChecklistState",
    "value": ""
  }
]

Die Bereitstellung einer Checkliste in einem Dialog erfolgt analog dem Einbinden Dynamischer Felder (s. Dynamische Felder in Dialogen bereitstellen.)

Bei Bedarf können Sie nachfolgenden Quellcode für die Integration nutzen. Entfernen Sie die Kommentare und ersetzen Sie die Parameter id sowie value durch Ihre individuellen Bezeichner.

{
    "id": "ticket-new-form-field-dfpreboardingchecklist", //eindeutige ID des Feldes im Schlüssel
    "label": null,
    "property": "DynamicFields",
    "inputComponent": null,
    "required": false,          //Pflichtfeld: ja/nein
    "hint": "Translatable#Pre Boarding",
    "options": [
       {
          "option": "FIELD_NAME",
          "value": "PreBoardingChecklist"   //Name des Dynamischen Feldes wie oben angelegt
       }
    ],
    "defaultValue": {
       "value": null,
       "valid": true,
       "errorMessages": []
    },
    "fieldConfigurationIds": [],
    "children": [],
    "parentInstanceId": null,
    "countDefault": null,
    "countMax": null,
    "countMin": null,
    "maxLength": null,
    "regEx": null,
    "regExErrorMessage": null,
    "empty": false,
    "asStructure": false,
    "readonly": false,
    "placeholder": null,
    "existingFieldId": null,
    "showLabel": true,
    "name": null,
    "draggableFields": false,
    "defaultHint": "Translatable#optionaler_Hilfetext",
    "type": "FormField",
    "visible": true,
    "translateLabel": true,
    "instanceId": null
},
df-typ_checkliste_ticketdetails.png

Abb.: Der Status einer Checkliste in den Ticketdetails

Die Anzeige des Checklistenstatus in den Ticketdetails erfolgt analog dem Darstellen der Werte Dynamischer Felder (s. Werte Dynamischer Felder anzeigen).

Für die Integration können Sie den nachfolgenden Quellcode in den SysConfig-Schlüssel ticket-details-info-card einfügen.

Ersetzen Sie die Werte in den Parametern name und property durch Ihre eigenen individuellen Bezeichner.

Die Angabe der Parameter text, textStyle, icon, style ist optional.

Checklisten erwarten dynamic-field-value als componentID und name als componentData.

{
   "text": "Pre Boarding Checkliste",
   "textStyle": "font-weight:bold;margin-bottom:0.5rem",
   "icon": "kix-icon-ci",
   "style": "",
   "componentId": "dynamic-field-value",
   "componentData": {
      "name": "Status Pre Boarding"
   },
   "conditions": [
      {
         "property": "DynamicFields.DFPreBoardingChecklist",
         "operator": "NE",
         "value": null,
         "useObjectService": false,
         "useDisplayValue": false
      }
   ],
   "roleIds": []
}

Variante: Sie können einen separaten Abschnitt in den Ticketdetails anlegen, welcher mehrere Checklisten enthält. Verwenden Sie dazu nachfolgenden Codeblock und fügen Sie ihn an gewünschter Stelle in den rows-Block ein.

{
   "title": "Translatable#Checklists",
   "style": "",
   "separator": true,
   "values": [
      [
         {
            "text": "Pre Boarding Checklist",
            "textStyle": "font-weight:bold;margin-bottom:0.5rem",
            "icon": "kix-icon-ci",
            "componentId": "dynamic-field-value",
            "componentData": {
               "name": "PreBoardingChecklist"
            },
            "conditions": [
               {
                  "property": "DynamicFields.PreBoardingChecklist",
                  "operator": "NE",
                  "value": null,
                  "useObjectService": false,
                  "useDisplayValue": false
               }
            ]
         }
      ],
      [
         {
            "text": "Optionale 2. Checkliste",
            "textStyle": "font-weight:bold;margin-bottom:0.5rem",
            "icon": "kix-icon-ci",
            "componentId": "dynamic-field-value",
            "componentData": {
               "name": "NameDerCheckliste"
            },
            "conditions": [
               {
                  "property": "DynamicFields.NameDerCheckliste",
                  "operator": "NE",
                  "value": null,
                  "useObjectService": false,
                  "useDisplayValue": false
               }
            ]
         }
      ]
   ]
}
Key_ticket-details-info-card_variante-rows.png

Die Anzeige des Checklistenstatus in den Dashboard-Tabellen erfolgt mittels Personalisieren von Dashboards durch den Agenten. Somit kann jeder Agent für sich entscheiden, ob und in welcher Tabelle er den Checklistenstatus angezeigt bekommen möchte. Die Grundkonfiguration der Tabelle(n) wird dadurch nicht geändert, nur die benutzerdefinierte Ansicht im Dashboard.

Tipp

Als Administator können Sie jederzeit die vom Nutzer eingestellten Ansichten in den Dashboards zurücksetzen (s. Detailansicht eines Nutzers).

Alternativ zur Dashboard-Personalisierung kann der Checklistenstatus auch über die SysConfig in den Dashboard-Tabellen oder in anderen Tabellen-Widgets bereitgestellt werden. Dann ist die Checkliste im entsprechenden Kontext fixiert.

df-typ_checklist_fortschritt_dashboard.png

Abb.: Checklistenfortschritt im Home Dashboard

In der nachfolgenden Beispiel-Konfiguration wird der Tabelle Neue Tickets im Home-Dashboard eine weitere Spalte hinzugefügt, in welcher der Checklistenstatus angezeigt wird.

Diese Änderung am SysConfig-Schlüssel ändert die Grundkonfiguration der Tabelle. Sie gilt fortan als Default-Konfiguration für alle Agenten sowie beim Zurücksetzen der personalisierten Dashboard-Ansichten.

Sie können unter Verwendung dieses Beispiels den Checklistenstatus auch in anderen Tabellen-Widgets anzeigen.

  1. Navigieren Sie zum Menü System > SysConfig.

  2. Öffnen Sie den Schlüssel home-dashboard-ticket-table-new .

    In diesem Schlüssel ist der Aufbau der Tabelle konfiguriert.

  3. Kopieren Sie den Quellcode im Feld Wert in einen externen JSON-Editor. 

    In der maximierten Ansicht können Sie den Quellcode leichter bearbeiten.

  4. Kopieren Sie den folgenden Codeblock in die Zwischenablage.

    {
       "id": null,
       "name": null,
       "type": null,
       "property": "DynamicField.DFChecklist",
       "showText": true,
       "showIcon": false,
       "showColumnTitle": true,
       "showColumnIcon": false,
       "size": 230,
       "sortable": true,
       "filterable": true,
       "hasListFilter": true,
       "dataType": null,
       "resizable": true,
       "componentId": "dynamic-field-checklist-cell",
       "defaultText": null,
       "translatable": true,
       "titleTranslatable": true,
       "useObjectServiceForFilter": false,
       "valid": true,
       "rtl": false,
       "application": "agent-portal",
       "roleIds": []
    }
  5. Scrollen Sie im Quellcode zum Abschnitt tableColumns[...].

    Darin sind die Tabellenspalten definiert.

  6. Fügen Sie den Codeblock aus der Zwischenablage in den Editor ein.

    Platzieren Sie den Codeblock an gewünschter Stelle (ggf. zwischen 2 bereits vorhandene Tabellenspalten).

    Eine Tabellenspalte beginnt und endet mit je einer geschweiften Klammer ( {...} ).

    Mit Ihrer Platzierung legen Sie fest, in welcher Spalte der Tabelle der Checklistenfortschritt angezeigt wird.

    df-typ_checklist_integration-tabelle_tablecolumns.png
  7. Passen Sie den eingefügten Codeblock an Ihre Parameter an.

    Ersetzen Sie den Namen des Dynamischen Feldes (PreBoardingChecklist) durch den von Ihnen verwendeten Namen.

    Tipp

    Im Parameter componentID können Sie festlegen, ob der Checklistenstatus als Fortschrittsbalken oder als numerischer Wert (2/10) angezeigt werden soll:

    • Fortschrittbalken: "componentID" : "dynamic-field-checklist-cell",

    • numerischer Wert: "componentID" : null,

    Hinweis: Die Angaben der conditions ist optional. Diese definieren die Voraussetzungen für die Anzeige der Checkliste in den Ticketdetails. Im Beispiel wird die Checkliste nicht angezeigt, solange an ihr kein Wert gesetzt ist.

    Variante: Sie können einen separaten Abschnitt in den Ticketdetails anlegen, welcher eine oder mehrere Checklisten enthält. Verwenden Sie dazu nachfolgenden Codeblock und fügen Sie ihn an gewünschter Stelle in den rows -Block ein.

    {
       "title": "Translatable#Checklists",
       "style": "",
       "separator": true,
       "values": [
          [
             {
                "text": "Pre Boarding Checklist",
                "textStyle": "font-weight:bold;margin-bottom:0.5rem",
                "icon": "kix-icon-ci",
                "componentId": "dynamic-field-value",
                "componentData": {
                   "name": "PreBoardingChecklist"
                },
                "conditions": [
                   {
                      "property": "DynamicFields.PreBoardingChecklist",
                      "operator": "NE",
                      "value": null,
                      "useObjectService": false,
                      "useDisplayValue": false
                   }
                ]
             }
          ],
          [
             {
                "text": "Optionale 2. Checkliste",
                "textStyle": "font-weight:bold;margin-bottom:0.5rem",
                "icon": "kix-icon-ci",
                "componentId": "dynamic-field-value",
                "componentData": {
                   "name": "NameDerCheckliste"
                },
                "conditions": [
                   {
                      "property": "DynamicFields.NameDerCheckliste",
                      "operator": "NE",
                      "value": null,
                      "useObjectService": false,
                      "useDisplayValue": false
                   }
                ]
             }
          ]
       ]
    }
    Key_ticket-details-info-card_variante-rows.png
  8. Minimieren Sie im Editor den Quellcode, um unnötige Leerzeichen und Zeilenumbrüche zu entfernen und kopieren Sie ihn in die Zwischenablage.

  9. Fügen Sie den Quellcode aus der Zwischenablage zurück ins Feld Wert.

  10. Klicken Sie abschließend auf Speichern.

  11. Klicken Sie auf Lade Frontend-Konfigurationen neu, um die Ansicht im Frontend zu aktualisieren.

Der Status der Checkliste wird nun in der Tabelle angezeigt.

Dynamische Felder der Typen Datum und Datum/Uhrzeit erzeugen Datumsfelder. Diese können Sie bspw. verwenden, um geplante Fertigstellungstermine oder vereinbarte Liefertermine im Ticket zu hinterlegen.

Datumsangaben jenseits des Jahres 2200 werden nicht unterstützt.

In Feldern des Typs Date kann das Datum im Format TT.MM.JJJJ eingegeben werden.

df-typ_date.png

In Feldern des Typs Date Time kann das Datum sowie die Uhrzeit im Format TT.MM.JJJJ und hh:mm eingegeben werden.

df-typ_datetime.png

Konfigurationsparameter

Beschreibung

Vorgabewert

Initiale Vorbelegung der Zeit. Tragen Sie keinen Wert ein, wird das aktuelle Datum angezeigt.

  • Typ Datum: 0 = aktuelles Datum, 1 = morgen, 2 = übermorgen

  • Typ Date Time: Tragen Sie eine Anzahl in Sekunden ein, wird diese zur aktuellen Zeit hinzuaddiert (3600 = Jetzt + 1 Stunde; 86400 = Jetzt + 1 Tag).

Jahre in Zukunft

Anzahl in Jahren

Legen Sie fest, wieviel Jahre der Kalender in die Zukunft reichen soll, ausgehend vom aktuellen Datum.

Jahre in Vergangenheit

Anzahl in Jahren

Legen Sie fest, wieviel Jahre der Kalender zurück reichen soll, ausgehend vom aktuellen Datum.

Datumsbeschränkung

  • none: Es gibt keine Einschränkung bei der Auswahl eines Datums.

  • DisableFutureDates: Verhindert die Eingabe von Daten, die in der Zukunft liegen, ausgehend vom aktuellen Datum.

  • DisablePastDates: Verhindert die Eingabe von Daten, die in der Vergangenheit liegen, ausgehend vom aktuellen Datum.

GUI Integration

Erwartet object-avatar-label als componentID und property als componentData

...
  "componentId": "object-avatar-label",
  "componentData": {
     "property": "DynamicFields.DFDate"
  },
...

Dynamische Felder vom Typ Richtext stellen an Formularen einen einfachen Texteditor zur Eingabe von formatiertem Text bereit. Dieser unterstützt u.a. Textformatierungen und Listen.

df-typ_richtext.png

Abb.: Dynamisches Feld vom Typ Richtext

Die Konfiguration des Dynamischen Feldes umfasst nur Allgemeine Konfigurationsparameter und die Parameter für Alle Feldtypen

GUI Integration

Wird das Feld in den Ticketdetails eingebunden, erfolgt die Anzeige des Inhalts als Plaintext. Nach Klick auf das Lupensymbol wird eine formatierte Ansicht geöffnet.

Erwartet object-avatar-label als componentID und property als componentData

... 
  "componentId": "object-avatar-label", 
  "detailViewWidthFactor": 4,
  "componentData": { 
    "property": "DynamicFields.DFRichtext" 
  }, 
...

Tipp

Verwenden Sie den Parameter detailViewWidthFactor, um die Anzeigenbreite des Feldes zu beeinflussen. Je größer der Wert, desto breiter das Feld. Empfohlener max. Wert: 4

KIX Platzhalter

Anmerkung: Das im Folgenden verwendete DFRichtext entspricht dem Namen des jeweiligen Dynamischen Feldes

  • <KIX_TICKET_DynamicField_DFRichtext>: liefert den Plaintext

    Liefert den HTML-Inhalt bei Verwendung im Body (Artikeltext) der MacroAction TicketCreate bzw. ArticleCreate

  • <KIX_TICKET_DynamicField_DFRichtext_Value>: liefert den Plaintext

    Liefert den HTML-Inhalt bei Verwendung im Body (Artikeltext) der MacroAction TicketCreate bzw. ArticleCreate

  • <KIX_TICKET_DynamicField_DFRichtext_Key>: liefert den Plaintext

  • <KIX_TICKET_DynamicField_DFRichtext_Short>: liefert den Plaintext

  • <KIX_TICKET_DynamicField_DFRichtext_HTML>: liefert den HTML-Wert

  • <KIX_TICKET_DynamicField_DFRichtext_ObjectValue>: liefert das Array mit den HTML-Werten

  • <KIX_TICKET_DynamicField_DFRichtext_ObjectValue_0>: liefert den ersten HTML-Wert

  • <KIX_TICKET_DynamicField_DFRichtext_Object>: wird nicht unterstützt (da kein referenziertes Objekt vorhanden)

Der Feldtyp Selection erzeugt Auswahlfelder sowohl für die Einfachauswahl (Singleselect) als auch für die Mehrfachauswahl (Multiselect).

Sie enthalten eine Liste vordefinierter Werte, aus denen der Agent auswählen kann. Die Auswahlwerte können Sie individuell definieren.

df-typ_selection.png

Konfigurationsparameter

Beschreibung

Anzahl (min)

Mit der eingetragenan Anzahl legen Sie die Mindestanzahl der auswählbaren Werte fest.

Das Feld wird zum Pflichtfeld, wenn der der Wert >0 ist.

Anzahl (max)

Gibt an, wieviel Werte gleichzeitig ausgewählt werden können.

Tragen Sie einen Wert >1 ein, wird ein Multiselectfeld erzeugt. Gleichzeitig entspricht der eingetragene Wert der Maximalanzahl der auswählbaren Werte.

Beispiele:

  • CountMax >1: Es können maximal  "CountMax" Auswahlwerte ausgewählt werden (Multiselectfeld mit Maximalauswahl).

  • CountMin >0: Es müssen mindestens die "CoundMin"-Anzahl an Werte gewählt werden.

  • CountMax <0: Es können beliebig viele Auswahlwerte ausgewählt werden (Multiselectfeld)

  • CountMax ==1 ODER CountMax ==0 oder CountMax ==NULL: Es kann genau ein Wert ausgewählt werden (Singleselect)

Anzahl (Standard)

nicht relevant

Zu übersetzende Werte

Wenn Sie diese Einstellung aktivieren, werden die Spaltenüberschriften in die Sprache des Benutzers übersetzt.

Die Pattern dafür müssen Sie im Menü Internationalisierung > Übersetzungen manuell hinzufügen

Mögliche Werte

Hinterlegen Sie hier die möglichen Auswahlwerte, die im Selectfeld aufgeführt werden.

Klicken Sie (ggf. mehrfach) auf die Plus-Schaltfläche, um diese Werte als Schlüssel-Wert-Paar zu hinterlegen.

Klicken Sie auf "Delete item", um den Auswahlwert aus dem Auswahlfeld zu entfernen.

Key: interner Wert für die Verarbeitung des Auswahlwertes. Dieser Wert darf nur einmal im Selection-Feld enthalten sein. Die Angabe eines Keys ist erforderlich.

Value: angezeigter Wert; diesen sieht der Agent, wenn er das Auswahlfeld öffnet.

GUI Integration

Erwartet object-avatar-label als componentID und property als componentData

...
  "componentId": "object-avatar-label",
  "componentData": {
     "property": "DynamicFields.DFSelect"
  },
...

Dynamische Felder des Typs Table erzeugen Tabellen, um Werte tabellarisch am Ticket speichern zu können. So zum Beispiel, um für Bestandsaufnahmen die Anzahl, Artikel- und Regal-Nummer sowie eine Bemerkung zu erfassen.

Die Spaltenköpfe der Tabelle werden beim Anlegen des Dynamischen Feldes definiert und können in den Bearbeitungsmasken nicht geändert werden.

df-typ_table.png

Abb.: Ein Dynamisches Feld vom Typ "Table" im Ticket-Neu-Dialog

Konfigurationsparameter

Beschreibung

Anzahl Zeilen (min)

Mindestanzahl der Tabellenzeilen, die angezeigt werden sollen

Werte <1 sind nicht möglich.

Anzahl Zeilen (initial)

Anzahl der initial anzuzeigenden Tabellenzeilen

Sie legen damit fest, das bspw. beim Anlegen eines neuen Tickets die Tabelle mit 3 Zeilen vorliegt.

Anzahl Zeilen (max)

Maximale Anzahl der Tabellenzeilen

Sie legen damit fest, dass die Tabelle bspw. maximal 5 Zeilen umfassen darf.

Mehr Zeilen können durch den Nutzer mit Klick auf das Plus-Symbol nicht angefügt werden.

Zu übersetzende Spalten

Wenn aktiviert, werden die Spaltenüberschriften in die vom Nutzer verwendete Sprache übersetzt.

Vorausgesetzt, unter Internationalisierung > Übersetzungen wurden die entsprechenden Pattern hinterlegt.

Spalten

Definieren Sie hier die Spalten.

Klicken Sie auf die Plus-Schaltfläche, um weitere Spalten hinzuzufügen.

Schreiben Sie die Spaltenüberschrift in das Textfeld des Items.

Das Einbinden der Tabelle in die Ticket-Oberflächen erfolgt prinzipiell wie unter Dynamische Felder in Dialogen bereitstellen beschrieben.

Um die Tabelle in den Ticketdetails anzuzeigen, können Sie den nachfolgenden Codeblock in den Schlüssel ticket-details-info-card einfügen.

Verfahren Sie wie unter Werte Dynamischer Felder anzeigen beschrieben. Ersetzen Sie dabei die beispielhaften Bezeichnungen "Inventory" bzw. "DFInventoryList" durch die reellen Bezeichnungen.

Geben Sie als dynamic-field-value als componentID und name als componentData an.

{
  "title": "Translatable#Inventory",
  "style": "",
  "separator": true,
  "values": [
    [
     {
       "componentId": "dynamic-field-value",
       "componentData": {
         "name": "DFInventoryList"
       },
       "conditions": [
         {
           "property": "DynamicFields.DFInventoryList",
           "operator": "NE",
           "value": null,
           "useObjectService": false,
           "useDisplayValue": false
         }
       ]
      }
    ]
  ]
},

Tabellen können als Pflichtfeld deklariert werden. Setzen Sie dazu in der Tabellenkonfiguration den Parameter required auf true.

Ist die Tabelle als Pflichtfeld deklariert, dann darf die Tabelle keine leeren Zeilen enthalten und die Tabelle kann nicht entfernt bzw. eingeblendet werden.

df-typ_table_parameter-required_start.png

Um auf die Daten der Tabelle zuzugreifen, können Sie folgende KIX Platzhalter nutzen:

  • <KIX_TICKET_DynamicField_TableFieldKey>:  Stellt die Tabelle in einer reinen Text-Darstellung dar.

  • <KIX_TICKET_DynamicField_TableFieldKey_Short>: Stellt die Tabelle in der Form "X rows" (X = Anzahl der Zeilen) dar.

  • <KIX_TICKET_DynamicField_TableFieldKey_HTML>: Stellt die Tabelle mit Überschrift und Werten im Body der Benachrichtigung/Artikel/E-Mail dar.

In einzeiligen Textfeldern des Typs Text kann nur ein Wort oder ein Satz eingegeben werden.

df-typ_text.png

In mehrzeiligen Textfeldern des Typs Textbereich können längere Texte hinterlegt werden.

df-typ_textarea.png

Konfigurationsparameter

Beschreibung

RegEx Liste

Tragen Sie hier eine Liste von regulären Ausdrücken ein, um die Eingaben im Feld vor dem Speichern zu prüfen. Die Eingaben müssen den regulären Ausdrücken entsprechen um akzeptiert zu werden.

Mit Regulären Ausdrücken (RegEx) können Textfelder auf Gültigkeit der Eingaben geprüft werden. Damit können Sie bspw. festlegen, dass bestimmte Ausdrücke im Text nicht akzeptiert werden oder dass bestimmte Zeichen zwingend enthalten sein müssen (z. B. @ in E-Mail-Adressen).

Klicken Sie (ggf. mehrfach) auf die Plus-Schaltfläche, um weitere Reguläre Ausdrücke und optional die dazugehörigen Fehlermeldungen zu hinterlegen.

  • RegEx

    Tragen Sie hier den regulären Ausdruck ein, auf den der eingetragene Text geprüft wird.

    Sie können mehrere reguläre Ausdrücke verwenden. 

    z. B.: ^[A-Za-z0-9]+$, um eine beliebig lange Zeichenfolgen, bestehend aus Buchstaben und Ziffern zu erlauben.

  • RegExErrorMessage

    Tragen Sie hier den Text ein, welcher als Fehlermeldung angezeigt wird, wenn der ins Textfeld eingetragene Text den Festlegungen des regulären Ausdrucks widerspricht.

GUI Integration

Erwartet object-avatar-label als componentID und property als componentData

...
  "componentId": "object-avatar-label",
  "componentData": {
     "property": "DynamicFields.DFText"
  },
...