Die Sidebar

Die rechte Sidebar steht Ihnen in allen ticketrelevanten Oberflächen zur Verfügung. Sie kann für jeden Kontext, in dem sie sich befindet (Home Dashboard, Ticketdetails, Dialoge etc.) separat konfiguriert werden. Somit kann die Sidebar in jedem Kontext andere Widgets mit jeweils anderen Inhalten enthalten.

Die Konfiguration der Sidebar und der einzelnen Widgets erfolgt im Menü System > SysConfig.

Eine Sidebar besteht aus der Sidebar selbst und den darin enthaltenen Widgets . Jeder Kontext besitzt seine eigene Sidebar und beinhaltet dafür in seinem Konfigurationsschlüssel den Codeblock "sidebars": [...] . In diesem Codeblock kann eine Liste von Widget-Konfigurationen angegeben werden, um damit den in der Sidebar anzuzeigenden Inhalt zu definieren.

Abb.: Die Ticketdetails mit konfigurierter Sidebar

Konfiguration der Sidebar

Die Konfiguration der Sidebar ist wie folgt strukturiert:

Context
- Sidebar
  - Widget-Instanzen
    Es können ein oder mehrere Widgets (Tabellen-Widgets oder Objekt-Info-Widgets) definiert sein.
    Jedes Widget muss eine eigene instanceId besitzen. Unter instanceID ist der Name des Konfigurationsschlüssels anzugeben, welcher die spezifische Konfiguration des jeweiligen Widgets enthält.
    Bei Bedarf können eigene Konfigurationen implementiert werden.

Beispiel: Konfiguration der Sidebar in den Ticketdetails von KIX Start

{ //Konfiguration des Kontexts Ticket-Details
  "id": "ticket-details",
  "name": "Ticket Details",
  "type": "Context",
  "contextId": "ticket-details",
  "sidebars": [
    { //Instanz des Widgets Kontakt Informationen
      "instanceId": "ticket-details-contact-card-widget",
      "configurationId": "ticket-details-contact-card-widget",
      "permissions": [],
      "size": "large"
    },
    { //Instanz des Widgets Empfohlene FAQ
      "instanceId": "ticket-details-suggested-faq-widget",
      "configurationId": "ticket-details-suggested-faq-widget",
      "permissions": [],
      "size": "large"
    },
    { //Instanz des Widgets Tickets zu Assets
      "instanceId": "ticket-details-affected-asset-tickets",
      "configurationId": "ticket-details-affected-asset-tickets",
      "permissions": [],
      "size": "large"
    },
    { //Instanz des WidgetsTickets zu Kontakt
      "instanceId": "ticket-details-contact-tickets",
      "configurationId": "ticket-details-contact-tickets",
      "permissions": [],
      "size": "large"
    }
  ],

Um eine Sidebar anzupassen, haben Sie folgende Möglichkeiten:

Sie können die Konfiguration der initial in der Sidebar enthaltenen Widgets nachkonfigurieren um individuelle Festlegungen zu treffen, welche Inhalte im Sidebar-Widget angezeigt werden sollen. Beispielsweise, um die erforderlichen Berechtigungen für die Anzeige des Widgets festlegen (Parameter "permissions": [...] ).
Weiterführende Informationen dazu finden Sie unter:
Sie können nicht benötigte Widgets entfernen, indem Sie den Codeblock des Widgets aus der Sidebar löschen. Sie können die Instanz des Widgets jederzeit wieder in die Sidebar integrieren (s. auch: Der Sidebar ein Widget hinzufügen)
Sie können die in der Sidebar enthaltenen Widgets um weitere Widgets ergänzen, deren Konfigurationsschlüssel im System bereits existiert. Sie können sich dabei an der bestehenden Sidebar-Konfiguration orientieren (s. auch: Der Sidebar ein Widget hinzufügen).
Sie können eigene, individuelle Widgets in die Sidebar integrieren. Diese müssen jedoch direkt in die Sidebar fest implementiert werden.
Informationen dazu finden Sie unter:
- Implementierungsarten von Widgets
- Der Sidebar ein Widget hinzufügen

SysConfig-Schlüssel der Sidebars

Die zu verwendenden Konfigurationsschlüssel für die Sidebar sind vom Kontext abhängig, in dem die Sidebar eingebunden ist. Ebenso sind die Konfigurationsschlüssel der Sidebar-Widgets vom Kontext der Sidebar abhängig.

Nachfolgend die wichtigsten Konfigurationsschlüssel für die Konfiguration der Sidebars sowie der initial darin enthaltenen Widgets.

Sie können für die Suche nach den Konfigurationsschlüsseln den Stern-Platzhalter (*) verwenden, z. B. *card* für die Suche nach dem object-information-card-widget Kontakt Informationen.

Konfigurationsschlüssel der Sidebars

Kontext der Sidebar	Konfigurationsschlüsel
Ticketdetails	ticket-details
Dialog "Neues Ticket"	new-ticket-dialog-context
Dialog "Ticket bearbeiten"	edit-ticket-dialog-context
Dialog "Neuer Artikel"	new-ticket-article-dialog-context

Konfigurationsschlüssel der Widgets in den Sidebars

Widget	Ticket Details	Dialog "Neues Ticket"	Dialog "Ticket bearbeiten
Kontakt Informationen	ticket-details-contact-card-widget	ticket-new-contact-card-widget	ticket-edit-contact-card-widget
Empfohlene FAQ	ticket-details-suggested-faq-widget	ticket-new-dialog-suggested-faq-widget	ticket-edit-dialog-suggested-faq-widget
Tickets zu Assets	ticket-details-affected-asset-tickets	ticket-new-affected-asset-tickets	ticket-edit-affected-asset-tickets
Tickets zu Kontakt	ticket-details-contact-tickets	ticket-new-contact-tickets	n.a.
Offene Kind-Tickets	ticket-details-child-tickets	n.a.	n.a.
Zeitbuchung	ohne Die Konfiguration ist direkt in die Sidebar implementiert (Key: ticket-details)	n.a.	n.a.

Der Sidebar ein Widget hinzufügen

Die nachfolgende Beschreibung bezieht sich auf die Konfiguration der Sidebar der Ticketdetails. Für alle anderen Sidebars können Sie analog verfahren.

Ein initial existierendes Widget in die Sidebar integrieren

Sie können Widgets, die initial in KIX existieren, in die Sidebar integrieren. Dabei kann es sich sowohl um Objekt-Info-Widgets oder auch Tabellen-Widgets handeln. Gehen Sie dazu wie folgt vor:

Suchen Sie nach dem Widget, welches Sie in die Sidebar integrieren möchten.
Notieren Sie sich die genaue Bezeichnung des Widgets. Sie benötigen den Namen, um darauf zu referenzieren.
Suchen und öffnen Sie den Konfigurationsschlüssel des Kontextes, in dessen Sidebar Sie das Widget integrieren möchten (z. B.: ticket-details oder new-ticket-dialog-context).
Duplizieren Sie eine der unter "sidebars":[] angegebenen Instanzen (ggf. mehrfach).
Ersetzen Sie die Werte von instanceID und configurationID durch die ID des einzufügenden Widgets. Als ID ist der Name des zu integrierenden Widgets anzugeben (s. Punkt 3).
Speichern Sie Ihre Änderungen mit Speichern.
Klicken Sie in der Übersicht auf Lade Frontend-Konfigurationen neu, um die Ansicht im Frontend zu aktualisieren.

Die Sidebar enthält nun das zusätzliche Widget.

Ein individuelles Widget in die Sidebar integrieren

Sie können eigene, individuell definierte Widgets in die Sidebar integrieren. Diese müssen direkt in der Sidebar fest implementiert werden. Das Generieren eigener SysConfig-Schlüssel gestattet KIX nicht.

Gehen Sie wie folgt vor:

Navigieren Sie im Explorer zu System > GUI Konfiguration > Agentenportal.
Suchen und öffnen Sie den SysConfig-Schlüssel ticket-details
Alternativ können Sie den Konfigurationsschlüssel eines anderen Kontextes bearbeiten (s. auch: SysConfig-Schlüssel der Sidebars)

Fügen Sie den nachfolgenden Quellcode innerhalb des Abschnitt "sidebars": [...] ein. Dieser bildet das Grundgerüst für ein Objekt-Info-Widget.

Zum Einbinden eines Tabellen-Widgets können Sie sich an der Beispielkonfiguration im Kapitel Konfiguration Widget "Empfohlene FAQ" orientieren.

Platzieren Sie den Quellcode zwischen 2 bestehende Widgets oder an den Anfang bzw. das Ende des Abschnitts. Sie legen damit fest, an welcher Stelle das Widget in der Sidebar angezeigt wird.

{   //Instanz des eigenen Widgets anlegen
   "instanceId": "ticket-details-my-own-widget",
   //Konfiguration des eigenen Widgets
   "configuration": {
      "id": "ticket-details-my-own-widget",
      "name": "My Own Widget",
      "type": "Widget",
      "widgetId": "object-information-card-widget",
      "title": "Translatable#My Own Widget",
      "actions": [],
      "subConfigurationDefinition": null,
      //Konfiguration des Widget-Inhalts
      "configuration": {
         //Konfiguration des Avatars   
         "avatar": {
            "displayValues": [],
            "KIXObjectType": "OBJECT_ICON",
            "ObjectId": "<KIX_CONTACT_ID>",
            "Object": "CONTACT",
            "ContentType": null,
            "Content": null
         },
         //zeilenweise anzuzeigender Inhalt im Widget
         "rows": [
            //Zeile 1
            {
               "margin": false,
               "values": [
                  {
                     "icon": null,
                     "text": "<KIX_CONTACT_ID>",
                     "linkSrc": null
                  }
               ]
            },
            //Zeile 2
            {
               "margin": true,
               "values": [
                  {
                     "icon": "kix-icon-handshake",
                     "text": "Description:<KIX_CONTACT_Firstname><KIX_CONTACT_Lastname>",
                     "linkSrc": null
                  }
               ]
            }
         ]
      },
      //Verhalten des Widgets und Widget-Titel
      "minimized": false,
      "minimizable": true,
      "icon": "kix-icon-man-house",
      "contextDependent": false
   },
   "permissions": [],
   "size": "large"
},

Abb.: Ein eigenes Objekt-Info-Widget in der Sidebar der Ticket Details

Entfernen Sie die Kommentare im Quellcode (//Komentartext ) und konfigurieren Sie den Widget-Inhalt. Lesen Sie dazu das Kapitel Ein Object-information-card-widget konfigurieren.
Übersichten zu den Attributen (Konfigurationsparametern) finden Sie hier:
- Attribute des Objekt-Info-Widgets
- Das Tabellen-Widget
Speichern Sie Ihre Änderungen abschließend mit Speichern.
Klicken Sie in der Übersicht auf Lade Frontend-Konfigurationen neu, um die Ansicht im Frontend zu aktualisieren.

Die Sidebar enthält nun das zusätzliche Widget.

Abb.: Ein zusätzliches Sidebar-Widget

Hinweis

Gegebenenfalls müssen Sie die Übersetzung für den Widget-Titel bzw. für individuelle Elemente im Widget nachpflegen. Hinterlegen Sie dazu im Menü Internationalisierung > Übersetzungen die entsprechenden Pattern.

In diesem Abschnitt: