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 vom Typ Anhang erzeugen Auswahlfelder zum Upload von Dateianhängen.

Damit können Sie sowohl im Agenten- als auch im Self Service Portal Dateien per Upload an ein Ticket anzuhängen und diese in den Ticketdetails des Agentenportals zum Download anzubieten.

df-typ_anhang.png

Abb.: Dynamisches Feld vom Typ Anhang in den Ticketdetails

Konfigurationsparameter

Beschreibung

Anzahl (min)

Legt fest, ob das Dynamische Feld ein Pflichtfled ist:

  • 0 = kein Pflichtfeld

  • 1 = Pflichtfeld

Anzahl (max)

Legt die maximale Anzahl an Dateien fest, die hochgeladen werden können.

Anzahl (Standard)

nicht relevant

Einzeleintrag-Separator

Trennzeichen zwischen den Anhängen, wenn mehrere im Feld ausgewählt werden können (i.d.R. Komma oder Semikolon).

Wird für die Verarbeitung des Dynamischen Feldes benötigt (s. auch Platzhalter-Verwendung)

Maximale Dateigröße

Legt die Dateigröße aller Dateien fest. Angabe in Bytes.

Ist nichts angegeben, ist die Dateigröße unbegrenzt.

Erlaubte Dateiformate

Wählen Sie aus, welche Dateiformate zulässig sind (1 Format pro Eintrag).

Mit Klick auf das Plus-Symbol können Sie weitere Dateiformate hinzufügen.

Mit Klick auf das Plus-Symbol können Sie weitere Dateiformate hinzufügen.

Tipp: Tippen Sie bei geöffnetem Dropdown den gesuchten Mime-Type ein. Der Cursor springt dann automatisch zum jeweiligen Eintrag, sofern dieser in der Liste vorhanden ist.

Verbotene Dateiformate

Wählen Sie aus, welche Dateiformate nicht zulässig sind (1 Format pro Eintrag).

Mit Klick auf das Plus-Symbol können Sie weitere Dateiformate hinzufügen.

Verbotene Dateiformate haben Vorrang gegenüber erlaubten Dateiformaten.

Tipp: Tippen Sie bei geöffnetem Dropdown den gesuchten Mime-Type ein. Der Cursor springt dann automatisch zum jeweiligen Eintrag, sofern dieser in der Liste vorhanden ist.

  • Vorlagen/Aktionen

    In der Konfiguration von Vorlagen/Aktionen können Dateianhänge vorausgewählt werden. Diese Dateianhänge sind dann per Default bereits im entsprechenden Dialog enthalten.

    Die getroffenen Festlegungen zur Dateigröße sowie zu erlaubten/nicht erlaubten Dateitypen finden bereits bei der Konfiguration von Vorlagen und Aktionen Berücksichtigung.

  • Jobs

    Die an einem Dynamischen Feld vom Typ Anhang hinterlegten Dateien können per Job an einem Artikel als Anhang hinterlegt werden (z. B. mit Macro Action Dynamisches Feld setzen).

    Verwenden Sie dazu Platzhalter mit _Object bzw. _ObjectValue (s. auch Platzhalter-Verwendung

  • GUI Integration

    Erwartet dynamic-field-attachment-value als componentID und name als componentData. Nur dann kann die Datei mit Klick auf das Label heruntergeladen werden.

    Beispiel: Integration in die Ticket Detailansicht

    {
       "text": "Translatable#Attachment",
       "textStyle": "font-weight:bold; margin-bottom:0.5rem;",
       "componentId": "dynamic-field-attachment-value",
       "placeholder": "Attachment",
       "componentData": {
          "name": "DFAttachment"
       },
       "conditions": [
          {
             "property": "DynamicFields.DFAttachment",
             "operator": "NE",
             "value": null,
             "useObjectService": false,
             "useDisplayValue": false
          }
       ]
    }
  • Rollen/Berechtigungen

    Für die Verwendung des Dynamischen Feldes vom Typ Anhang sind folgende Rollen initial berechtigt:

    • Customer

    • Customer Manager

    • Ticket Agent

    • FAQ Reader

    Weitere Rollen müssen entsprechend erweitert werden, um Dynamische Felder vom Typ Anhang verwenden zu können:

    Ressource | /virtualfs | - R - - - 

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

  • <KIX_TICKET_DynamicField_DFAttachment>

    Liefert den Dateinamen der hinterlegten Datei(en).

    Sind mehrere Dateien am Feld hinterlegt, werden diese mit dem in der Konfiguration angegebenem Einzeleintrag-Separator getrennt.

    Beispiel: Rechnung_2024-04-21.pdf (52.8 KBytes);Rechnung _2024-03-15.pdf(55.2 KBytes)

  • <KIX_TICKET_DynamicField_DFAttachment_Value>

    Liefert den Dateinamen der hinterlegten Datei(en).

    Sind mehrere Dateien am Feld hinterlegt, werden diese mit dem in der Konfiguration angegebenem Einzeleintrag-Separator getrennt.

    Beispiel: Rechnung_2024-04-21.pdf (52.8 KBytes);Rechnung _2024-03-15.pdf(55.2 KBytes)

  • <KIX_TICKET_DynamicField_DFAttachment_Key>

    Liefert die FileID (vom VirutalFS) der hinterlegten Datei(en).

    Sind mehrere Dateien am Feld hinterlegt, werden diese mit dem in der Konfiguration angegebenem Einzeleintrag-Separator getrennt.

    Beispiel: 10; 11

    Achtung

    Bei Verwendung in Macro Actions (z. B. Dynamisches Feld setzen) entspricht _Key einem _ObjectValue und liefert ein JSON.

    Um dies zu umgehen, können Sie vor oder nach dem Platzhalter ein Leerzeichen setzen oder den Platzhalter davor und/oder danach mit Text umgeben.

    Dieses Verhalten stellt ein Fallback für bestehende Konfigurationen dar.

    Wir empfehlen daher ausdrücklich die Verwendung von _ObjectValue, wenn in Macro Actions der Wert des Objekts erwartet wird!

  • <KIX_TICKET_DynamicField_DFAttachment_Object> oder <KIX_TICKET_DynamicField_DFAttachment_ObjektValue>

    Liefert einen JSON-String, welcher zu jeder im Dynamischen Feld hinterlegten Datei folgende Informationen als Parameterwerte enthält:

    • Content (Dateiinhalt als Base64-String)

    • ContentType (Mime-Type der Datei)

    • Filename (Dateiname)

    • Filesize (Größe der Datei in Bytes)  

    Achtung

    Beachten Sie, dass content den kompletten Inhalt der Datei als Base64-String beinhaltet.

    Sind mehrere Dateien im Feld gespeichert, enthält das JSON von jeder Datei den kompletten Dateiinhalt als Base64- String.

    Beispiel:

    {
       "ContentType":"application/pdf",
       "Filename":"Rechnung_2024-04-21.pdf",
       "Filesize":"52836",
       "Content":"kompletter Dateiinhalt als Base64-String"
    },
    {
       "ContentType":"application/pdf",
       "Filename":"Rechnung_2024-03-15.pdf",
       "Filesize":"52836",
       "Content":"kompletter Dateiinhalt als Base64-String"
    }

    Hinweis

    Der Platzhalter <KIX_TICKET_DynamicField_DFAttachment_ObjectValue> liefert lediglich einen JSON-String mit den einzelnen Werten des Objekts. Er ist nicht geeignet, um einen Anhang direkt am Artikel zu übergeben.

    Wenn Sie einer E-Mail einen Anhang mitgeben möchten, müssen Sie über die Macro Action "Objekt zusammenstellen" die entsprechende Datei für den Dateianhang erzeugen. Diese Datei können Sie dann am Artikel übergeben. Die Definition in der Macro Action könnte wie folgt lauten:

    {
        Filename: '<KIX_TICKET_DynamicField_DFAttachment_Object_0_Filename>',
        ContentType: '<KIX_TICKET_DynamicField_DFAttachment_Object_0_ContentType>',
        Content: '<KIX_TICKET_DynamicField_DFAttachmentz_Object_0_Content>'
    }
  • <KIX_TICKET_DynamicField_DFAttachment_ObjectValue_n>

    Liefert einen JSON-String mit Dateiinformationen zu einer bestimmten Datei (bspw. wenn mehrere Dateien im Dynamischen Feld hinterlegt sind).

    Achtung

    Beachten Sie, dass content den kompletten Inhalt der Datei als Base64-String beinhaltet.

    Sind mehrere Dateien im Feld gespeichert, enthält das JSON von jeder Datei den kompletten Dateiinhalt als Base64- String.

    Beispiele:

    • <KIX_TICKET_DynamicField_DFAttachment _ObjectValue_0>

      Liefert von der ersten Datei Informationen zu Content, ContentType, Filename, Filesize  

    • <KIX_TICKET_DynamicField_DFAttachment _ObjectValue_2>

      Liefert von der dritten Datei die Informationen zu Content, ContentType, Filename, Filesize

    • {
         "ContentType":"application/pdf",
         "Filename":"Rechnung_2024-04-21.pdf",
         "Filesize":"54056",
         "Content":"kompletter Dateiinhalt als Base64-String"
      }
  • <KIX_TICKET_DynamicField_DFAttachment_Object_n[Parameter]>

    Liefert einen bestimmten Parameter von einer bestimmten Datei, welche im Dynamischen Feld hinterlegt ist (bspw. wenn mehrere Dateien im Dynamischen Feld hinterlegt sind).

    Beispiele:

    • <KIX_TICKET_DynamicField_DFAttachment _Object_0_Filename>

      Liefert von der ersten im Feld hinterlegten Datei den Dateinamen: Rechnung_ 2024-04-21.pdf

    • <KIX_TICKET_DynamicField_DFAttachment _Object_2_Filesize>

      Liefert von der dritten im Feld hinterlegten Datei die Dateigröße: 55.2 KBytes

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 sowie über Ticket-Aktionen und -Vorlagen 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.

Der Status der Checkliste wird nun in der Tabelle angezeigt.

Grundsätzlich bestehen Dynamische Felder vom Typ Checkliste aus JSON-Inhalten, die den vollständigen Inhalt der Checkliste beschreiben. Dadurch ergeben sich erweiterte Möglichkeiten für die Verwendung und Konfiguration von Checklisten. Die Datenstruktur entspricht folgendem Aufbau (Anlehnung an EBNF):

CheckList := [ <CheckListIem>+ ];
  
CheckListItem := {
  "id": "intvalue",
  "title": "Some string describing the task",
  "input": "TextArea | Text | ChecklistState"
  "value": "- | pending | OK | NOK | n.a. | ... or just a string for Text-inputs...",
  "description": "Optional description for the task.", ?    # optional
  "sub": <CheckList> ?                                      # optional
}

Das heißt, bei Erstellung von Aktionen oder Vorlagen kann durch Zuweisung eines JSON-Strings eine Checkliste vollständig neu gesetzt werden.

Eine Anpassung des Dynamischen Feldes ist dazu nicht erforderlich. Dies kann auch automatisiert durch einen Job (Konfiguration im Menü: Automatisierung > Jobs) erfolgen.

In Verbindung mit dem Variablen-Filter "jq" können bestehende Checklisten verändert werden, um bspw. automatisiert Checklisten-Aufgaben hinzuzufügen, abzuhaken oder zu entfernen (s. auch https://jqplay.org).

Beispiel einer Checkliste im JSON-Format: siehe ???

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 des Typs FAQArticleReferenz erzeugen Auswahlfelder zur Auswahl eines oder mehrerer FAQ Einträge. Sie dienen dazu, einfache Verweise zu FAQ-Einträgen zu erstellen, um Vorlagen und Aktionen damit zu initialisieren.

Es wird eine Verknüpfung zwischen dem Ticket und den referenzierten FAQ-Einträgen erzeugt, was insbesondere für Anwendungsszenarien wie Wartungsplanung oder in Verbindung mit der Field Agent App hilfreich ist.

Somit können Sie FAQ Einträge (Herstellerhinweise, Produktdatenblätter u.a.m.) bspw. an Vorlagen für Wartungsplänen hinterlegen, damit diese bei Ticketerstellung automatisch am Ticket verfügbar sind.

Das Eingabe- bzw. Auswahlverhalten entspricht dem eines Select-Feldes. Bei Verwendung sind die zur Auswahl stehenden FAQ Einträge abhängig von den Berechtigungen des angemeldeten Nutzers und der Feldkonfiguration (z. B. Eingrenzung der FAQ Einträge auf ausgewählte Kategorien und Sprachen).

Die Platzhalter für diese Felder liefern ein Array zurück, deren einzelne Werte konkret angesprochen werden können. Hinweise dazu finden Sie unter Platzhalter für referenzierende Dynamische Felder

Konfigurationsparameter

Beschreibung

Anzahl (min.)

Legt fest, wieviel FAQ Einträge mindestens ausgewählt werden müssen.

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

Anzahl (max.)

Legt fest, wie viele FAQ Einträge maximal ausgewählt werden dürfen.

Einzeleintrag-Separator

Trennzeichen zwischen den einzelnen FAQ Einträgen, wenn mehrere im Feld ausgewählt werden können (i.d.R. Komma oder Semikolon).

Vorgabewert

Legt fest, mit welchem FAQ Artikel das Dynamische Feld vorbelegt sein soll.

Geben Sie die ID3) des FAQ Artikels an.

Die hier getroffene Vorauswahl kann vom Nutzer durch Auswahl anderer FAQ Artikel geändert werden.

Ist kein Standardwert definiert, wird das Feld ohne Vorbelegung (leer) angezeigt. 

Tipp: Die ID können Sie der Fußleiste Ihres Browsers entnehmen, wenn Sie in der Übersicht der FAQ Artikel den Mauszeiger über einen FAQ Artikel führen.

FAQ Kategorien

Beschränkung der zur Auswahl stehenden FAQ Einträge auf FAQ Kategorien.

Im Dynamischen Feld werden nur die FAQ Artikel angezeigt, die den hier angegebenen FAQ Kategorien zugeordnet sind.

Klicken Sie dazu ggf. mehrfach auf die Plus-Schaltfläche und wählen Sie die entsprechenden FAQ Kategorien aus.

FAQ Sprachen

Beschränkung der zur Auswahl stehenden FAQ Einträge auf die hier angegebenen Sprachen.

Klicken Sie dazu ggf. mehrfach auf die Plus-Schaltfläche und wählen die entsprechenden Sprachen aus.

FAQ Kunden Sichtbarkeit

Beschränkt die im Feld zur Auswahl stehenden FAQ Einträge anhand der eingestellten Sichtbarkeit im Self Service Portal.

  • Nur im Self Service Portal sichtbare: Es stehen nur FAQ Einträge mit aktivierter Option "Im Kundenportal anzeigen" zur Auswahl.

  • Nur nicht im Self Service Portal sichtbare: Es stehen nur FAQ Einträge mit deaktivierter Option "Im Kundenportal anzeigen" zur Auswahl.

  • Beides: Es stehen die im Self Service Portal sichtbaren und nicht sichtbaren FAQ Einträge zur Auswahl.

Verknüpfungstyp

Wählen Sie den Verknüpfungstyp aus, mit dem der gewählte Objekttyp und FAQ Artikel verbunden werden sollen. 

GUI Integration

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

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

Dynamische Felder des Typs Kontaktverweis erzeugen Auswahlfelder zur Auswahl eines Kontakts oder mehrerer Kontakte am Ticket. Es ist damit möglich, weitere Kontakte an einem Ticket zu hinterlegen. Das Eingabeverhalten entspricht dem eines Select-Felds.

df-typ_kontaktverweis.png

Abb.: Ein Dynamisches Feld vom Typ "Kontaktverweis" in einer Ticketvorlage

Die Platzhalter für diese Felder liefern ein Array zurück, deren einzelne Werte konkret angesprochen werden können. Hinweise dazu finden Sie unter Platzhalter für referenzierende Dynamische Felder

In der Feldkonfiguration können Sie die Auswahl der Kontakte auf ausgewählte Organisationen und auf bestimmte Nutzergruppen (Agenten, Kunden) beschränken. In den Oberflächen stehen dann nur die Kontakte zur Auswahl, die den hier festgelegten Kriterien entsprechen. Zudem sind die zur Auswahl stehenden Kontakte abhängig von den Berechtigungen des angemeldeten Nutzers.

Konfigurationsparameter

Beschreibung

Anzahl (min.)

Legt fest, wieviel Kontakte mindestens ausgewählt werden müssen.

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

Anzahl (max.)

Legt fest, wie viele Kontakte maximal ausgewählt werden dürfen.

Einzeleintrag-Separator

Trennzeichen zwischen den einzelnen Kontakten, wenn mehrere Kontakte im Feld ausgewählt werden können (i.d.R. Komma oder Semikolon).

Wichtig

Der Separator muss zwingend ein Komma sein, wenn in den zusätzlichen Empfängern von Ticketbenachrichtigungen auf das Feld referenziert wird.

Vorgabewert

Legt fest, mit welchem Kontakt das Dynamische Feld vorbelegt sein soll.

Geben Sie die ID2) eines Kontakts an.

Die hier getroffene Vorauswahl kann vom Nutzer durch Auswahl anderer Kontakte geändert werden. I

Ist kein Standardwert definiert, wird das Feld ohne Vorbelegung (leer) angezeigt.

Hinweis: Ist der Standardwert nicht kompatibel mit der in der Konfiguration gesetzten Organisation oder Kontextverwendung, wird der jeweilige Kontakt nicht gesetzt.

Organisationen

Optional: Einschränkung der zur Auswahl stehenden Kontakte.

Es stehen nur die Kontakte der hier gewählten Organisationen zur Auswahl.

Klicken Sie dazu (ggf. mehrfach) auf die Plus-Schaltfläche und geben Sie in jedem Item die ID2) einer Organisation an.

Ist hier nichts festgelegt, stehen alle Kontakte zur Auswahl (ggf. abhängig vom gewählten Nutzungskontext).

Rollen

Optional: Einschränkung der zur Auswahl stehenden Kontakte auf ausgewählte Rollen

Wenn Sie hier Rollen angegeben haben, werden nur Kontakte zur Auswahl angeboten, denen mindestens eine der genannten Rollen zugeordnet ist.

Hinweis

Wenn konfigurierter Kontext und Rollenbeschränkung sich ausschließen, kann die Ergebnismenge (Wertebereich des Feldes) leer sein.

Nutzungskontext

Optional: Schränkt die Auswahl anhand des Nutzungskontextes ein. Klicken Sie dazu auf "Add Item". Pro Item kann ein Nutzungskontext gewählt werden. 

  • Agent: Es können nur Nutzer gewählt werden, die Zugriff auf das Agentenportal haben.

  • Kunde: Es können nur Nutzer gewählt werden, die Zugriff auf das Self Service Portal haben.

Die Kombination von Nutzungskontext Agent und Kunde ist möglich. Ist nichts definiert, besteht keine Einschränkung auf Nutzer, sodass auch Kontakte (ohne Zugang zum Agenten- oder Self Service Portal) zur Auswahl stehen.

2) Tipp: Die ID können Sie der Fußleiste Ihres Browsers entnehmen, wenn Sie in der Übersicht der Kontakte den Mauszeiger über einen Kontakt führen.

GUI Integration

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

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

Platzhalter

Mittels KIX Platzhalter können Dynamische Felder vom Typ Kontaktverweis auch als zusätzliche Empfänger in Ticketbenachrichtigungen gesetzt werden. Die Ticketbenachrichtigung kann somit variabel an die jeweiligen im Ticket gesetzten Kontakte gesendet werden.

Dem Platzhalter wird die E-Mail-Adresse des Kontakts entnommen, sodass Sie die Parameter _Short, _Value und _HTML verwenden können:

  • <KIX_TICKET_DynamicField_myDFContactReference_Value> : "Nachname, Vorname" <E-Mail-Adresse>

  • <KIX_TICKET_DynamicField_myDFContactReference_Short> : E-Mail-Adresse

  • <KIX_TICKET_DynamicField_myDFContactReference_HTML>: "Nachname, Vorname" <E-Mail-Adresse>  (als "mailto-HREF")

Voraussetzung für eine korrekte Verwendung ist, dass im Ticket eine gültige und syntaktisch korrekte E-Mail-Adresse im Dynamischen Feld hinterlegt ist. 

Sollen die Adressdaten als Hyperlink in der GUI dargestellt werden, geben Sie zusätzlich "renderHTML":true an (s. auch: Attribute des Objekt-Info-Widgets).

Dynamische Felder des Typs Organisationsverweis verweisen auf Organisationen. Sie erzeugen Auswahlfelder zur Auswahl einer oder mehrerer Organisationen. Das Eingabeverhalten entspricht dem eines Select-Felds.

df-typ_organisationsverweis.png

Abb.: Ein Dynamisches Feld vom Typ "OrganisationReference" in einer Ticketvorlage

Die Platzhalter für diese Felder liefern ein Array zurück, deren einzelne Werte konkret angesprochen werden können. Hinweise dazu finden Sie unter Platzhalter für referenzierende Dynamische Felder

In der Konfiguration können Sie u. a. definieren, welche Organisationen dem Nutzer zur Auswahl stehen und mit welcher Organisation das Feld vorbelegt sein soll (Mehrfachauswahl möglich). Zudem sind die zur Auswahl stehenden Objekte abhängig von den Berechtigungen des angemeldeten Nutzers.

Konfigurationsparameter

Beschreibung

Anzahl (min.)

Legt fest, wieviel Organisationen mindestens ausgewählt werden müssen.

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

Anzahl (max.)

Legt fest, wie viele Organisationen maximal ausgewählt werden können.

Anzahl (Standard)

nicht relevant

Vorgabewert

Legt fest, mit welcher Organisation das Dynamische Feld vorbelegt sein soll.

Geben Sie die ID1) einer Organisation an.

Die hier getroffene Vorauswahl kann vom Nutzer durch Auswahl anderer Organisationen geändert werden.

Ist kein Standardwert definiert, wird das Feld ohne Vorbelegung (leer) angezeigt. 

Organisationen

Einschränkung der zur Auswahl stehenden Organisationen.

Wenn Einschränkungen getroffen, stehen im Feld nur die hier angegebenen Organisationen zur Auswahl.

Klicken Sie dazu (ggf. mehrfach) auf die Plus-Schaltfläche und geben Sie in jedem Item die ID1) einer Organisation an.

Ist hier nichts festgelegt, stehen alle Organisationen zur Auswahl. 

1) Tipp: Die ID können Sie der Fußleiste Ihres Browsers entnehmen, wenn Sie in der Übersicht der Organisationen den Mauszeiger über eine Organisation führen.

GUI Integration

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

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

Dynamische Felder vom Typ QRCode dienen dazu, Informationen und Werte von Objektattributen als QR-Code in Nachrichten, Textbausteinen oder Vorlagen einzubetten, um den Empfängern eine einfache Möglichkeit zur Reaktion oder Rückmeldung zu geben.

Anwendungsfälle für diese Dynamische Felder können sein:

  • Bereitstellung von Asset-Informationen

  • Bereitstellung von WiFi-Zugriffen

  • Bereitstellung einer digitalen Visitenkarte

  • Versand eines vorausgefüllten Überweisungsträgers als QR-Code

  • Bereitstellung von Rücksende-Etiketten

    Ermöglicht der Poststelle den direkten Aufruf des RMA-Tickets; der QR-Code beinhaltet dabei die URL zum Ticket

  • u.v.a.m.

Konfigurationsparameter

Beschreibung

Größe

Definiert die horizontale und vertikale Größe eines Punktes

Standard: 4

df_qrcode_size.png

Seitenrand

Definiert den Randabstand (Ruhezone)

Wert sollte nicht kleiner als 4 sein.

Standard: 3

df_qrcode_margin.png

Version

Angabe der Versionsgröße (Anzahl der Modulspalten und -zeilen)

Formel für die Berechnung der Modulgröße: (Versionsnummer - 1) * 4 + 21

  • 0: KIX verwendet automatisch die kleinste Version

  • 1: 21 x 21 Module (kleinste Version)

  • 40: 177 x 177 Module (Maximum)

    Berechnung: 39 * 4 + 21 = 177

df_qrcode_version.png

Level

Fehlerkorrektur-Level; schützt die Daten im QR-Code

Mit dem eingestellten Wert wird die Menge an Daten bestimmt, die im QR-Code gespeichert werden. Gleichzeitig wird die Fähigkeit erhöht, Fehler zu erkennen und zu korrigieren. So können je nach Fehlerkorrektur-Level bis zu 30 % des Codes beschädigt sein, ohne dass die Lesbarkeit beeinträchtigt wird.

Je höher das Fehlerkorrektur-Level ist, desto größer wird der QR-Code.

Standard: L

Gültige Werte sind:

  • L- Niedrig (7 %)

  • M - Mittel (15%)

  • Q - Quartil (25 %)

  • H - Hoch (30 %)

df_qrcode_level.png

Weiterführende Informationen finden Sie beispielsweise unter www.qrcode.com

Vordergrundfarbe

Farbe des Musters

Klicken Sie in das Farbfeld, wenn Sie eine andere Farbe auswählen möchten.

Hintergrundfarbe

Farbe des Musterhintergrunds

Klicken Sie in das Farbfeld, wenn Sie eine andere Farbe auswählen möchten.

Verweise

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

Hinweis: Die unter text angegebene Bezeichnung wird oberhalb des QR-Codes angezeigt.

 [
  {
    "text": "QRCode",
    "textstyle": "font-weight:bold; margin-bottom: 0.5rem",
    "icon": "kix-icon-ci",
    "componentId": "dynamic-field-image-value",
    "componentData": {
      "name": "QRCode"
    },
    "conditions": [
      {
        "property": "DynamicFields.QRCode",
        "operator": "NE",
        "value": null,
        "useObjectService": false,
        "useDisplayValue": false
      }
    ]
  }
],

  • Dynamische Felder vom Typ QRCode verhalten sich wie Text. Bei einer Suche wird nur nach dem Inhalt gesucht bzw. sortiert und nicht nach dem QR-Code.

  • Bei Einbindung in einen Dialog wird das Dynamische Feld als einzeiliges Textfeld dargestellt. In dieses können Agenten die im QR-Code zu speichernden Informationen hinterlegen (bspw. die URL zu einem Asset)

    df_qrcode_verwendung_text.png

    Hinweis

    Beachten Sie, dass hier nur einzeilige Angaben hinterlegt werden können.

    Informationen, die mehrzeilige Angaben benötigen (wie bspw. vCard), können hierüber nicht abgebildet werden. Verwenden Sie Jobs oder Aktionen, wenn Zeilenumbrüche/mehrzeilige Angaben gefordert sind und auch, wenn umfangreiche Informationen im QR-Code gespeichert werden sollen.

  • Bei Einbindung in die Ticket Detailansicht wird der QR-Code als Bild angezeigt.

  • Tabellen zeigen den Wert des Dynamischen Feldes, nicht den QR-Code.

  • Der QR-Code kann in Druckvorlagen angewendet werden.

Platzhalter

Beschreibung

<KIX_TICKET_DynamicField_QRCode>

<KIX_TICKET_DynamicField_QRCode_Key>

<KIX_TICKET_DynamicField_QRCode_Value>

Liefern den Wert zurück, der für den QR-Code eingetragen wurde (z. B. die Webadresse)

<KIX_TICKET_DynamicField_QRCode_Short>

Liefert den base64 Content (das Bild als Base64-String)

<KIX_TICKET_DynamicField_QRCode_HTML>

Liefert den base64 Content als HTML img-Tag, sodass dieser als QR-Code (Bild) angezeigt werden kann.

Beispiel: <img src="data:image/png;base64,base64content" />

Sie können QR-Codes mittels Jobs oder Aktionen automatisiert oder teilautomatisiert bereitstellen.

Dadurch könnten bspw. mittels Jobs elektronische Visitenkarten (vCard), Überweisungsträger oder der Gäste-Zugang für das WLAN erzeugt und per E-Mail versendet werden.

Mittels Aktionen können bspw. die benötigten Informationen vom Agenten abgefragt und daraus der QR-Code generiert werden.

Nutzen Sie Jobs oder Aktionen für die Bereitstellung von QR-Codes insbesondere, wenn umfangreiche Informationen gespeichert werden sollen oder wenn die Informationen mehrzeilige Angaben erfordern (z. B. vCard)

Erstellen Sie einen Job mit mindestens den Pflichtangaben, legen Sie das auslösende Event bzw. den Zeitpunkt fest und definieren Sie ggf. die benötigten Filter. Für die Konfiguration der vom Job auszuführenden Aktionen können Sie sich an nachfolgendem Beispiel orientieren.

Zum Erstellen einer Aktion können Sie die Beispiel-Konfiguration ebenfalls verwenden (Pre- oder Post-Actions).

df_qrcode_verwendung_vcard.png

Abb.: Beispielkonfiguration eines Jobs zum Erstellen einer vCard als Barcode

  1. Aktion : Objekt zusammenstellen

    • Objekt: vCard

    • Überspringen: deaktiviert

    • Debug: deaktiviert (optional: aktiviert)

    • Typ: JSON

    • Definition:

      In der Definition werden die im Barcode zu speichernden Informationen hinterlegt (z. B. Kontaktinformationen für eine Visitenkarte).

      Die Macro Action erstellt aus diesen Informationen ein Objekt, welches in der nachfolgenden Aktion im Dynamischen Feld vom Typ QRCode gespeichert wird.

      Manche Barcode-Objekte benötigen mehrzeilige Angaben (z. B. vCards). Somit müssen Zeilenumbrüche angegeben werden. Sie werden durch Angabe von\n erzeugt.

      Anstelle der Klarnamen und -informationen im Beispiel können Sie KIX Platzhalter verwenden.

      {
        "Text":"BEGIN:VCARD\nVERSION:2.1\nFN:Martin Mustermann\nN:Mustermann;Max\nTITLE:Dr.-Ing.\nTEL;CELL:+49 163 1737743\nTEL;WORK;VOICE:+49 123 7654321\nTEL;HOME;VOICE:+49 123 123456\nEMAIL;HOME;INTERNET:max.mustermann@example.com\nEMAIL;WORK;INTERNET:work@example.org\nURL:http://example.com\nADR:;;Musterstraße 123;Musterstadt;;77777;Deutschland\nORG:ACME Inc.\nEND:VCARD"
      }
  2. Aktion: Dynamisches Feld setzen

    • Überspringen: deaktiviert

    • Debug: deaktiviert (optional: aktiviert)

    • Objekt ID: ${ObjectID}

    • Dynamic Field Name: QRCode

      Geben Sie ggf. einen anderen Namen an. Erwartet wird der Name des Dynamischen Feldes, in welchem der Wert als QR-Code gespeichert werden soll.

      Das Dynamische Feld muss vom Feldtyp QRCode sein und muss im System existieren. Legen Sie es an, sofern noch nicht geschehen.

    • Dynamic Field Value: ${vCard.Object.Text}

      Mit Angabe dieser Variable wird im Dynamischen Feld QRCode der Inhalt des Objekts Text gespeichert, welches in der Definition der 1. Aktion (Objekt zusammenstellen) erzeugt wurde. D. h. die vCard-Informationen werden ins Dynamische Feld geschrieben.

      Bei Jobausführung bzw. bei Ausführen der Aktion wird aus den im Dynamischen Feld hinterlegten Daten der QR-Code erzeugt.

Sie können QR-Codes erstellen, die eine elektronische Visitenkarte (vCard) enthalten, bspw. die Kontaktinformationen des Ticketbearbeiters. Durch Scannen des QR-Codes können die Kontaktinformationen direkt ins Adressbuch des Smartphones importiert oder weitere Aktionen gestartet werden.

Damit eine vCard als Barcode gespeichert werden kann, müssen die Daten in einem bestimmten Format und in expliziter Reihenfolge vorliegen (s. auch: https://goqr.me/de/qr-codes/typ-vcard.html).

BEGIN:VCARD
VERSION:2.1
FN:Max Mustermann
N:Mustermann;Max
TITLE:Dr.-Ing.
TEL;CELL:+49 163 1737743
TEL;WORK;VOICE:+49 123 7654321
TEL;HOME;VOICE:+49 123 123456
EMAIL;HOME;INTERNET:max.mustermann@example.com
EMAIL;WORK;INTERNET:work@example.org
URL:http://example.com
ADR:;;Musterstraße 123;Musterstadt;;77777;Deutschland
ORG:ACME Inc.
END:VCARD

Anstelle der Klarnamen und -Bezeichnungen können Sie KIX Platzhalter verwenden. Nicht benötigte Felder können Sie weglassen. Die Reihenfolge der Parameter sollte dennoch unbedingt beibehalten bleiben.

BEGIN:VCARD
VERSION:2.1
FN:<KIX_TICKET_Owner>
N:<KIX_OWNER_Lastname>;<KIX_OWNER_Firstname>
TEL;CELL:<KIX_OWNER_Mobile>
TEL;WORK;<KIX_OWNER_Phone>
EMAIL;WORK;INTERNET:<KIX_QUEUE_SystemAddress>
URL:http://example.com
ADR:;;Musterstraße 123;Musterstadt;;77777;Deutschland
ORG:<KIX_TICKET_Organisation>
END:VCARD

Visitenkarten erfordern mehrzeilige Angaben. In der Konfiguration von Macro Actions werden diese durch Angabe von \n erzeugt:

{
  "Text":"BEGIN:VCARD\nVERSION:2.1\nFN:Martin Mustermann\nN:Mustermann;Max\nTITLE:Dr.-Ing.\nTEL;CELL:+49 163 1737743\nTEL;WORK;VOICE:+49 123 7654321\nTEL;HOME;VOICE:+49 123 123456\nEMAIL;HOME;INTERNET:max.mustermann@example.com\nEMAIL;WORK;INTERNET:work@example.org\nURL:http://example.com\nADR:;;Musterstraße 123;Musterstadt;;77777;Deutschland\nORG:ACME Inc.\nEND:VCARD"
}

Sie können QR-Codes erstellen, die einen WiFi-Zugang ermöglichen. Durch Versand des QR-Codes per E-Mail kann somit bspw. einem Gast oder Kunden der Zugang zum Gäste-WLAN bereitgestellt werden.

Damit ein WiFi-Zugang als Barcode gespeichert werden kann, müssen folgende Parameter angegeben sein:

  • T: Zugangsmethode/Authentifizierungsart| WPA2 | WEP)

    Z. B. WPA (alternativ: WPA2 oder WEP)

    Kann leer sein, wenn kein Passwort benötigt wird

  • S: Netzwerk-SSID (erforderlich)

  • P: Passwort für den Zugang

    Kann frei bleiben, wenn T nicht angegeben ist

  • H: Soll die Netzwerk-SSID versteckt werden? (optional)

    Werte: true | false

Beispiel: WIFI:T:WPA;S:MyNetworkName;P:ThisIsMyPassword;;

Da diese Angaben einzeilig sind, können Sie vom Agenten direkt in ein Dynamisches Feld vom Typ QR-Code gesetzt werden. Aber auch die Verwendung in der Konfiguration eines Jobs oder einer Aktion ist möglich.

df_qrcode_verwendung_wifi.png

Abb.: WiFi-Informationen direkt im Dynamischen Feld vom Typ QR-Code

df_qrcode_verwendung_wifi-job.png

Abb.: WiFi-Informationen in einer Jobkonfiguration zur Erzeugung eines QR-Codes

Sie können QR-Codes für Überweisungsträger erstellen. Durch Scannen des QR-Codes können die Überweisungsinformationen direkt eingelesen werden. Tippfehler und fehlerhafte Überweisungen werden somit vermieden.

Damit ein Überweisungsträger als Barcode gespeichert werden kann, müssen die Daten in einem bestimmten Format und in der richtigen Reihenfolge vorliegen.

Hinweis: Die mit * markierten Daten sind Pflichtangaben. Optionale Angaben müssen durch eine Leerzeile angegeben werden, sofern nicht gesetzt.

Zeile

Beschreibung

Beispiel

1

Service Tag*

BCD

2

Version*

002

3

Zeichensatz*

2

4

Identifikations-Code*

SCT

5

BIC

Ist Pflicht, wenn Zeile 2 den Wert 001 hat; ist optional, wenn Zeile 2 den Wert 002 hat.

PBNKDEFF

6

Name des Zahlungsempfängers*

Lieferant GmbH

7

IBAN des Zahlungsempfängers*

DE12345678901234567890

8

Zahlungsbetrag

Ist optional, aber empfohlen

EUR20.00

Punkt als Dezimaltrennzeichen verwenden!

9

SEPA Purpose Code (Zahlungszweck)

GDDS

10

Buchungs-Referenz

RF18 5390 0754 7034

11

Verwendungszweck

RE 23589 KD 9867

12

Information

Informationen zwischen Debitor und Zahlungsempfänger

Verweise:

Überweisungsträger erfordern mehrzeilige Angaben. In der Konfiguration von Macro Actions werden diese durch Angabe von \n erzeugt:

{
"EPC": "BCD\n001\n2\nSCT\nPBNKDEFF\nLieferant GmbH\nDE08700901001234567890\nEUR20.00\nGDDS\n\nRE 23589 KD 9867"
}
df_qrcode_verwendung_epc_de.png

Abb.: Beispielkonfiguration für einen Überweisungsträger als Barcode

Sie können Barcodes mit Asset-Informationen bereitstellen. Durch Scannen des Barcodes kann bspw. der Field Agent den an einem Gerät angebrachten QR-Code scannen und so direkt auf die benötigten CMDB-Informationen zugreifen.

Dazu ist es ausreichend, die URI des Assets im Barcode zu speichern. Dies kann direkt am Ticket erfolgen, wenn im Formular ein Dynamisches Feld vom Typ QRCode eingebunden ist.

Alternativ können Sie einen Job konfigurieren, der für alle Betroffenen Assets den Barcode erzeugt. Dieser kann optional in den Ticketdetails angezeigt werden.

Jobkonfiguration

Voraussetzung ist, dass ein Dynamisches Feld vom Typ QRCode existiert (hier: QRCodeTicket).

  1. Job Informationen: Hinterlegen Sie mindestens die Pflichtfelder und setzen Sie den Job auf gültig

  2. Ausführungsplan

    • Event: TicketDynamicFieldUpdate_AffectedAsset

      Der Job wird bei jeder Änderungen am Feld "Betroffene Assets" ausgelöst.

  3. Filter: optional

  4. Aktionen

    1. 1. Aktion: Dynamisches Feld setzen

      • Objekt ID: ${ObjectID}

      • Dynamic Field Name: QRCodeTicket

    2. 2. Aktion: Schleife

      • Werte: <KIX_TICKET_DynamicField_AffectedAsset_ObjectValue>

      • Schleifenvariable: AffectedAsset

      • Macro: Ticket

        • 1. Aktion: Dynamisches Feld setzen

          • Objekt ID: ${RootObjectID}

          • Dynamic Field Name: QRCodeTicket

          • Dynamic Field Value: <KIX_CONFIG_FQDN>/configitems/${AffectedAsset}

          • Hinzufügen: aktiviert

Integration in die Ticketdetails

  1. Navigieren Sie im Explorer zu System > GUI Konfiguration > Agentenportal.

  2. Suchen und öffnen Sie den SysConfig-Schlüssel ticket-details-info-card (Ticket Info Widget)

  3. Fügen Sie nachfolgenden Codeblock innerhalb des Parameters rows ein.

    Der Code erzeugt eine neue Zeile, in welcher der Barcode/die Barcodes angezeigt werden.

     {
      "title": "Translatable#QR Codes",
      "style": "",
      "separator": true,
      "roleIds": [],
      "values": [
        [
          {
            "text": "QRCode",
            "textstyle": "font-weight:bold; margin-bottom:0.5 rem",
            "icon": "kix-icon-ci",
            "componentId": "dynamic-field-image-value",
            "componentData": {
              "name": "QRCode"
            },
            "conditions": [
              {
                "property": "DynamicFields.QRCode",
                "operator": "NE",
                "value": null,
                "useObjectService": false,
                "useDisplayValue": false
              }
            ]
          }
        ],
      ]
    },
  4. Optional: Ersetzen Sie im Quellcode den Namen des Dynamischen Feldes (QRCode) durch den Namen des anzuzeigenden Dynamischen Feldes.

  5. Speichern Sie Ihre Änderungen mit Speichern.

  6. Klicken Sie im Header der SysConfig auf Lade Frontend-Konfigurationen neu, um die Ansicht im Frontend zu aktualisieren.

Das Dynamische Feld ist nun in den Ticketdetails eingebunden, sodass die am Ticket hinterlegten QR-Codes als Bild angezeigt werden können.

Sie können Textbausteine anlegen, die einen QR-Code beinhalten. Agenten können diesen Textbaustein verwenden, um bspw. den QR-Code an den Ticketkontakt zu senden (Bereitstellung Gästezugang zum WLAN).

Dazu muss im System ein Dynamisches Feld vom Typ QRCode existieren. Im Feld müssen die bereitzustellenden Informationen gespeichert sein (z. B. die Informationen für den WiFi-Zugang). Dies kann bspw. mittels einmaliger/manueller Ausführung eines Jobs oder einer Aktion erfolgen.

  1. Legen Sie im Menü Ticket > Textbausteine einen neuen Baustein an (s. auch Einen Textbaustein anlegen).

  2. Füllen Sie die Pflichtangaben aus.

  3. Referenzieren Sie via KIX Platzhalter auf das Dynamische Feld vom Typ QRCode.

    Verwenden Sie das Suffix _HTML, damit der Barcode als Bild dargestellt wird.

    df_qrcode_verwendung_textbaustein.png
  4. Speichern Sie abschließend Ihrer Eingaben mit Speichern.

Agenten können nun diesen Textbaustein nutzen, um bspw. im Ticket- oder Artikel-Text den Barcode und somit bspw. den Zugang zum Gäste-WLAN zu versenden.

df_qrcode_verwendung_textbaustein-article.png

Abb.: Artikeltext mit einem via Textbaustein eingefügten QR-Code

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.

In KIX Pro können die Tabellen komfortabel über Aktionen und Vorlagen bereitgestellt werden.

Um die Tabelle in den Ticketdetails anzuzeigen, können Sie den nachfolgenden Codeblock in den Schlüssel ticket-details-info-card (KIX Pro: Ticket Info Widget) 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. Aktivieren Sie das Häkchen vor dem Dynamischen Feld beim Erstellen der Aktion bzw. der Vorlage.

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_pro.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"
  },
...

Dynamische Felder des Typs Ticketreferenz erzeugen Auswahlfelder, in denen auf ein oder mehrere Tickets verwiesen werden kann. Das Eingabeverhalten entspricht dem eines Select-Felds. Beispiele für diesen Feldtyp sind die Felder Verwandte Tickets oder Eltern Tickets bzw. Kind Tickets.

df-typ_ticketreferenz.png

Abb.: Das Feld Verwandte Tickets als Beispiel für ein Dynamisches Feld vom Typ Ticketreferenz im Dialog Ticket Bearbeiten

Die Platzhalter für diese Felder liefern ein Array zurück, deren einzelne Werte konkret angesprochen werden können. Hinweise dazu finden Sie unter Platzhalter für referenzierende Dynamische Felder

Bei Verwendung sind die zur Auswahl stehenden Objekte abhängig von den Berechtigungen des angemeldeten Nutzers und der Feldkonfiguration (z. B. Einschränkung auf Tickettypen und -status). Die Suche nach Tickets entspricht einer Volltextsuche nach Ticketnummer oder Tickettitel. Sie können auch den Nutzernamen eingeben, um nach Tickets dieses Nutzers zu suchen. 

Dynamische Felder des Typs Ticketreferenz können bspw. für die Zuordnung von Eltern-/Kind-Tickets, zum Etablieren von Strukturen für Haupt-/Teilaufgaben, Abhängigkeiten oder sonstige Verweise genutzt werden. Die Felder Parent Tickets, Child Tickets und Related Tickets werden vorkonfiguriert ausgeliefert. Zur Verwendung von Parent-/Child-Tickets müssen die Felder in der Konfiguration der Eingabemasken (siehe Aktionen)hinzugefügt werden. 

Das Eintragen von Werten in diesen Feldern fügt entsprechend der Konfiguration des Dynamischen Felds automatisch Verknüpfungen zwischen dem aktuellen Ticket und den in den Feldern referenzierten Tickets zu.

Konfigurationsparameter

Beschreibung

Werte

Anzahl (min)

Mit der eingetragenen Anzahl legen Sie die Mindestanzahl der auszuwählenden Werte fest.

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

0...n

Anzahl (max)

Gibt an, wieviel Werte in einem Feld maximal eingetragen werden können.

Wird ein Wert >1 eingestellt, wird ein Multiselectfeld erzeugt. 

0...n

Anzahl (Standard)

nicht relevant

TicketStates

Hinterlegen Sie hier einen oder mehrere Ticketstatus.

Bei Eingabe werden dann nur Status dieser Typen betrachtet. 

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

new | open | pending reminder | pending auto | closed | ...

TicketTypes

Hinterlegen Sie hier eine oder mehrere Tickettypen.

Im Formularfeld stehen dann nur Tickets der entsprechenden Tickettypen zur Auswahl.

 Werden keine Ticket Typen ausgewählt, gibt es keine Einschränkung und im Formularfeld können Tickets aller Typen ausgewählt werden.

Unclassified | Incident | Service Request | ...

Verknüpfungstyp

Definiert welche Verknüpfung zwischen dem aktuellen Objekt (Ticket) und dem Zielticket erstellt wird.

Das Zielticket ist <Link-Type> des Quelltickets.

Ohne Angabe wird keine Verknüpfung etabliert.

Wichtig

Das Dynamische Feld muss im SysConfig-Schlüssel Ticket::EventModulePost###900-AddTicketReferenceLink hinterlegt werden, damit die Verknüpfungen mit anderen Tickets erzeugt werden können.

df-typ_ticketreferenz_eventhandler.png

Abb.: Hinterlegen eines Dynamischen Feldes vom Typ Ticketreferenz im Eventhandler

Parent | Child | Normal 

GUI Integration

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

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