Versionen

LiveChat 2.0/2019.x/2020.x

Standardinstallation

Dieser Installationsleitfaden beschreibt Schritt für Schritt eine möglichst einfache Standardinstallation mit den wichtigsten Funktionen von estos LiveChat 2/2019.x/2020.x.
estos LiveChat bietet darüber hinaus Spielraum für Anpassung und erweiterte Konfiguration für die vorhandene individuelle IT-Infrastruktur und Anforderungen an das Produkt.
Die ausführliche Dokumentation zum kompletten Leistungsumfang und mögliche Konfigurationsszenarien finden Sie unter https://livechat-doc.estos.de/index.html.

Installation des UCServer on premises

Im ersten Schritt ist es erforderlich, den estos UCServer aus dem ProCall Enterprise Paket zu installieren.

Systemvoraussetzungen

Hier finden Sie die Systemvoraussetzungen und Empfehlungen für Systemausbau


Installation des UCServer Setups

Unter https://www.estos.de/service/download können Sie das aktuelle Setup-Paket von ProCall Enterprise herunterladen, entpacken und installieren.
Für estos LiveChat ist es ausreichend, die Server Komponente zu installieren.
Dies kann entweder über die „Setup.exe" oder das „UCServer_VersionsnummerSpracheArchitektur.msi" file durchgeführt werden.
Hierzu folgen Sie bitte den Anweisungen im Installationswizard mit folgenden Eingabeaufforderungen:

  • Produkt lizensieren: Hier genügt es, eine LiveChat Lizenz zu hinterlegen, falls Sie den UCServer ausschließlich als Baustein für das Produkt LiveChat nutzen möchten.
  • Standortkonfiguration hinterlegen. Diesen Schritt können Sie für die reine Nutzung des LiveChat ggf. überspringen.

Generelle Unterstützung zum UCServer finden Sie in unserer Dokumentation oder in den dem Installationspaket beiliegenden Dokumenten.

Konfiguration des UCServer für LiveChat

Anlegen von Agentengruppen und Diensten

In der Verwaltungsoberfläche des estos UCServer finden Sie den Punkt „Benutzerdatenbank".
Zur Verwaltung der Computer, Benutzer und Gruppen kann entweder eine in den estos UCServer integrierte Benutzerverwaltung oder der Microsoft Verzeichnisdienst Active Directory® Server verwendet werden.
(Siehe hierzu auch: https://help.estos.com/help/de-DE/procall/6.4/ucserver/dokumentation/tapisrv/IDH_TSUSERMANAGEMENT.htm)
Um im estos LiveChat bestimmten Agenten bestimmte Dienste und Funktionen zu ermöglichen, empfiehlt es sich in einer Standardinstallation, mit zwei Gruppen zu arbeiten:

  • contactportal
  • webagents

Je nach Art der verwendeten Benutzerverwaltung ist dies entweder im AD oder der UCServer Verwaltungsoberfläche unter „Benutzerverwaltung > Gruppen" zu erledigen.
Innerhalb der Unterpunkte „Eigenschaften - Dienste" können Sie die jeweiligen Dienste für die Benutzer konfigurieren:

  • „Portal Gruppe"
  • „LiveChat Berater Gruppe"

(Siehe hierzu auch: https://help.estos.com/help/de-DE/procall/6.4/ucserver/dokumentation/tapisrv/IDH_SETGROUPS.htm)

UCServer veröffentlichen

Grundsätzlich gibt es zwei verschiedene Wege, eine LiveChat Umgebung einzurichten und über das Internet erreichbar zu machen.

  • Verwendung der integrierten Webseiten
  • Bereitstellung der Webseiten über einen separaten Webserver

Da in den meisten produktiven Umgebungen bereits eine Webserver-Infrastruktur vorhanden ist und dieser Weg von einer Vielzahl IT-Verantwortlicher präferiert wird, beschreibt dieses Dokument den Weg unter Verwendung eines eigenen separaten Webservers.
(Informationen zur Verwendung der integrierten Webseiten finden Sie unter https://livechat-doc.estos.de/install/install-integrated-websites.html)
Damit sich die LiveChat Clients

  • Kontaktportal
  • Multimediale Visitenkarte (Multimedia Business Card MBC)
  • Widget
  • Agentenclient

von einem separaten Webserver zu Ihrem UCServer verbinden können, haben Sie zwei Möglichkeiten.

  • Empfohlen: Sie nutzen die Dienste der estos Cloud Plattform UCConnect. Zusätzlich bietet Ihnen estos UCConnect einen STUN/TURN Service, welcher für die Echtzeitkommunikation über WebRTC z. B. für Audio-/Video-Chats benötigt wird. Um den Cloud Service estos UCConnect für LiveChat zu nutzen, ist dieser mit einer ProCall Web Communication Services Lizenz zu betreiben. 
  • Sie richten eine direkte Verbindung zu Ihrem Webserver/UCServer ein. (Hierfür sind detaillierte Fachkenntnisse und Berechtigungen erforderlich.) Falls Sie eine direkte Verbindung zu Ihrem Webserver realisieren möchten, kann dies über Portforwarding oder den Einsatz eines Proxy Mechanismus erreicht werden. Weitere Unterstützung bietet Ihnen dabei das Best Practice Dokument „UCServer veröffentlichen".

Für Standardinstallationen wird die Nutzung von UCConnect empfohlen.

LiveChat Konfiguration

Die zentrale Konfigurationsdatei (config.json) für den estos LiveChat ist ein JavaScript Object Notation Configuration File. Ein Default Template für diese Datei findet sich nach der Installation des UCServer unter
C:\Program Files\estos\UCServer\config\default{color:#ff0000}livechatconfig.json
Um dieses Template für eine update-sichere Konfiguration zu nutzen, kopieren Sie dieses eine Ebene nach oben:
C:\Program Files\estos\UCServer\config
Der Name dieser Konfigurationsdatei ist theoretisch frei wählbar, in der Praxis hat sich die Namensgebung „config.js" oder „config.json" bewährt.

Erreichbarkeit des UCServer angeben

Bei Verwendung von UCConnect 
Beispiel UCServer ID angeben
 |{ 
 "lib": { 
 "ucsid": "<your ucsid>" 
 },|

Stammdaten hinterlegen

  • Firmenname und Links zu Impressum und Datenschutzerklärung
    Beispiel-Konfiguration

    {
    "app": {
    "companyName": "YourCompany Inc.",
    "linkImpressum": "https://www.yourcompany.com/impressum.html",
    "linkPrivacy": "https://www.yourcompany.com/privacy.html",
    }
    }

    Die Beschreibung weiterer Konfiguration von Stammdaten wie favicon oder Avatar finden Sie hier.

Corporate Identity anpassen

{ 
    "colors": { 
        "headerBackground": "#00BCD4", 
        "headerFontActive": "#ffffff", 
        "headerFontInactive": "#eaeaea", 
        "highlight": "#006064" 
    } 
}

LiveChat Client Frontend Bausteine

Der estos LiveChat besteht grundsätzlich aus vier Komponenten für die Webseiten Kommunikation.

Kontaktportal

Anzeige der LiveChat Agenten zur Auswahl der Kommunikationsart

Multimediale Visitenkarte (MBC)

Widget

„Zugriffspunkt" für Kunden, um eine einfache und direkte Kommunikation mit einem passenden Agenten zu starten. Das Widget wird sinnvollerweise in bestehende Webauftritte eingebunden.

Agentenclient

Webclient zur Anmeldung für LiveChat Agenten. Über diesen kann sämtliche Kommunikation verwaltet werden: interne Kommunikation zum Beispiel mit Kollegen und externe Kommunikation zum Beispiel mit Kunden.

LiveChat Clients konfigurieren

Grundsätzlich gibt es drei unterschiedliche Konfigurationsarten. Die Hauptkonfiguration erfolgt über die erwähnte LiveChat Konfiguration. Einige Konfigurationen lassen sich aber auch über HTML Tags oder GET Parameter einstellen.
Wird eine Konfiguration mehrfach angegeben, wird sie in folgender Reihenfolge ausgelesen:

  1. config.json
  2. HTML Tag
  3. GET-Parameter

Ein GET Parameter überschreibt damit alle anderen Konfigurationen, und ein HTML Tag überschreibt eine vorhandene Konfiguration in der config.json.

Verteilungsfunktion

Ein gutes Beispiel dafür ist die Verteilungsfunktion, über die Webseitenbesucher den möglichst besten Ansprechpartner zugewiesen bekommen. Zur Auswahl eines Agenten werden deshalb folgende Kriterien herangezogen:

  • Präsenz/Verfügbarkeit (gebildet über z. B. manuell, Telefonie und Kalender)
  • Agentenstatus (z. B. Nachbearbeitung)
  • Gruppenzugehörigkeit am UCServer (auch AD)
  • Auslastung des Agenten (z. B. Anzahl der Webseitenbesucher, die einem Agenten zugeordnet sind)
  • Präferenz des Webseitenbesuchers für einen bestimmten Agenten (bspw. durch vorhergehende Chats)
  • aktueller Chatpartner (solange ein TextChat aktiv ist, wird immer derselbe Agent angezeigt)

Gruppenzugehörigkeit

Die Verteilungsfunktion nutzt die Gruppenzugehörigkeit der Benutzer, welche Sie in der UCServer Verwaltung oder in Ihrem AD konfigurieren können. Achten Sie darauf, dass Sie in der UCServer Verwaltung bei der Gruppe den Dienst „LiveChat Berater Gruppe" aktivieren.

Priorisierte Liste von Gruppen

Über das HTML Tag bzw. einen GET-Parameter kann eine priorisierte Liste von Gruppen hinterlegt werden, die zur Suche des besten Agenten herangezogen wird.

  • Es können beliebig viele Gruppen definiert werden.
  • Wenn in der Gruppe kein verfügbarer Agent aus dem „Bucket available" gefunden wird, wird in der nächsten Gruppe gesucht.
  • Wenn in keiner der Gruppen ein verfügbarer Agent gefunden wird, wird beginnend bei der ersten Gruppe nach Agenten gesucht, die im „Bucket notAvailable" sind.

Zu setzen ist das HTML-Tag innerhalb der Website, in der die estos Komponente inkludiert wird. Dieser Schritt wird in der Regel von einem Webseiten Betreuer durchgeführt.

Konfiguration über HTML Tags

Beispiel

  • 1. Schritt: Verweis auf den Gruppennamen: estos-widget group="g_1"
  • 2. Schritt: relativen Pfad zur config.json angeben: configurl="./config.json"
  • Vollständig würde das dann so aussehen:

<estos-widget group="g_1" configurl="./config.json"></estos-widget>
<estos-directchat group="g_1" configurl="./config.json"></estos-directchat>

Beispiel priorisierte Liste


Gearbeitet werden kann auch mit einer priorisierten Liste von Gruppen, die nacheinander (von links nach rechts) abgearbeitet werden:
<estos-widget groups='["g_1", "g_2", "g_3"]' configurl="./config.json"></estos-widget>
<estos-directchat groups='["g_1", "g_2", "g_3"]' configurl="./config.json"></estos-directchat>

Konfiguration über Get Parameter

Beispiel

https://your-company.com/call.html?group=g_1 https://your-company.com/call.html?group=g_1&group=g_2
Weitere Infos zur Verteilungsfunktion und dessen Logik finden Sie unter: https://livechat-doc.estos.de/features-config/features-config-ranking.html#

Content Delivery Network

Der eigentliche Content (Java Script) für die LiveChat Clients wird in unserem Content Delivery Network CDN bereit gestellt, dieses wird durch estos gepflegt und aktualisiert, so dass wir schnell auf eventuelle Probleme in aktuellen Builds, Software Verbesserungen etc. eingehen können.
Dies hat auch insbesondere für Systembetreuer den Vorteil, dass hier Client-seitig kein manuelles Eingreifen nötig ist, um aktuelle Software Updates im Unternehmen zu publishen.
Der Verweis auf das CDN muss in jeder Webkomponente, die LiveChat Inhalte nutzt, inkludiert hinterlegt sein (Portal, MBC, Widget, Agentenclient)
Abgebildet wird dies im „Head" Bereich des HTML Dokuments:
<html>
<head>
...
<script src="https://static.estos.com/p/v2/estos-components.js"></script>
...
Siehe auch: https://livechat-doc.estos.de/install/install-separate-website.html#integration-in-eigene-webseiten

STUN/TURN Konfiguration als Voraussetzung für Audio/Video-Chat

Um die im estos LiveChat verfügbaren Echtzeitkommunikationsmöglichkeiten Audio/Video-Chat nutzen zu können, ist in der Regel die Konfiguration eines STUN/TURN Services nötig, insbesondere wenn mindestens ein Client sich außerhalb des lokalen Netzwerks befindet.
Grundsätzlich gibt es drei Wege, diesen Service abzubilden:

  • eigenen STUN/TURN verwenden
  • externe Anbieter nutzen
  • estos UCConnect verwenden (für Standard-Installationen empfohlen.)