The CHAT role is used for conducting chat sessions with agents from external websites. 

The chat server is a Java application, which can be installed in parallel on the web servers - with a corresponding RAM extension of about 4 GB per server - or installed on a separate server

eDie Rolle CHAT wird für das Durchführen von Chat-Sessions, ausgehend von externe Webseiten, mit den Agenten verwendet. 

Der Chat-Server ist eine Java Anwendung, was parallel auf den Webservern - bei entsprechende RAM Erweiterung um ca. 4 GB pro Server - mit installiert werden kann, oder auf einem separaten Server installiert wird.

Java 8 Installation

In diesem Schritt wird Java 8 auf dem Server installiertthis step Java 8 is installed on the server. 

yum -y install https://cdn.jtel.de/downloads/java/jdk-8u202-linux-x64.rpm

Installing and Configuring ClientMessenger

ClientMessenger Installation

Das Verzeichnis ClientMessenger wird nach The ClientMessenger directory is copied to /home/jtel kopiert. 

cp -R /home/jtel/shared/JTELCarrierPortal/Utils/Install/ClientMessenger/ /home/jtel/ClientMessenger
chown -R jtel:jtel /home/jtel/ClientMessenger

Hazelcast Cluster

Configuration

The configuration of the Hazelcast cluster must be checked. For new installations of Die Konfiguration des Hazelcast-Clusters muss geprüft werden. Bei Neuinstallationen von Release 3.11 ab 01.04.2018 sind die Einträge as of April 1, 2018, the entries in hazelcast.xml vorhanden, davor hingegen nichtare available, but not before. 

• Zum einen, wird der Chat-Server als Member im Cluster aufgenommen. 

• Zum anderen werden die CHAT Buffer und Counter der Konfiguration - falls nicht vorhanden - hinzugefügt.

• On the one hand, the chat server is accepted as a member of the cluster. 

• On the other hand the CHAT buffers and counters are added to the configuration - if not available.

The necessary configuration sections in hazelcast.xml are listed hereDie notwendigen Konfigurationsabschnitte in hazelcast.xml sind hier aufgeführt:

	...
 
	<tcp-ip enabled="true">
 		...
		<member>CHATSERVER</member>
	</tcp-ip>

	...

	<ringbuffer name="CHAT">
		<in-memory-format>BINARY</in-memory-format>
		<backup-count>1</backup-count>
		<async-backup-count>0</async-backup-count>
		<time-to-live-seconds>60</time-to-live-seconds>
		<capacity>500</capacity>
	</ringbuffer>
	
	<map name="CHATCOUNTERS">
        <backup-count>0</backup-count>
        <async-backup-count>1</async-backup-count>
        <time-to-live-seconds>600</time-to-live-seconds>
        <eviction-policy>LRU</eviction-policy>
        <max-size policy="PER_NODE">5000</max-size>
	</map>

Sämtliche Rechner im Hazelcast-Cluster betrachtenView all computers in the Hazelcast cluster:

• Rolle Role DATA, DB -Mastermaster
  
  • update hazelcast.xml updatenxml 
  • execute updatepl.sh ausführen
• Rolle Role TEL
  
  • update hazelcast.xml updaten
  • restart PlatformUDPListener neu starten
• Rolle Role WEB
  • update hazelcast.xml updaten

  • execute updatejb.sh ausführen

• Rolle CHAT (das System, was gerade installiert wirdRole CHAT (the system that is being installed!)
  • its best to copy hazelcast.xml am besten kopierenxml 

ClientMessenger als Daemon Prozess installieren

Install ClientMessenger as a daemon process

If the repositories are located on a Windows machine (this can only affect old installations), the start script Falls die Repositories auf einer Windows Maschine liegen (dies kann nur alte Installationen betreffen), muss der Start-Skript /etc/init.d/jtel-clientmessenger vorher repariert werden, damit aus must be repaired before, so that CR+LF nur becomes only LF wird.

sed -i -e 's/\r//g' /home/jtel/ClientMessenger/init.d/jtel-clientmessenger

Die Konfiguration, bzw. die Startdatei jtel-clientmessenger muss ggf. angepasst werden, damit die Datenbank-Verbindung aufgebaut werden kann. Hierbei muss <password> mit den Passwort für den root User der Datenbank ersetzt werdenThe configuration or the start file jtel-clientmessenger may have to be adapted so that the database connection can be established. Here <password> must be replaced with the password for the root user of the database:

...
                        -Dde.jtel.platform.clientmessenger.connection=jdbc:mysql://acd-dbm/JTELWeb?user=root\&password=<password>\&characterEncoding=utf8 \
...

Anschließend, wird der Prozess als Linux Daemon installiertThen, the process is installed as a Linux daemon:

cd /home/jtel/
cp /home/jtel/ClientMessenger/init.d/jtel-clientmessenger /etc/init.d/
chmod 755 /etc/init.d/jtel-clientmessenger
chkconfig jtel-clientmessenger on
service jtel-clientmessenger start

Update Skript anlegen

Create update script

An update script is created for updating the chat serverFür das Updaten des Chat-Servers wird ein Update-Skript angelegt:

cat <<EOFF>/usr/local/bin/updatesc.sh
#!/bin/bash
service jtel-clientmessenger stop
cp /home/jtel/shared/JTELCarrierPortal/Utils/Install/ClientMessenger/bin/* /home/jtel/ClientMessenger/bin
chown -R jtel:jtel /home/jtel/ClientMessenger
service jtel-clientmessenger start
EOFF
chmod +x /usr/local/bin/updatesc.sh

Firewall

configuration

Next, the open ports for the chat service must be entered in the firewall and saved persistently. Here you can distinguish whether http (speak unsecure websocket) or Als nächstes müssen in der Firewall die Port-Freigaben für den Chat Dienst eingetragen und persistent gespeichert werden. Hierbei kann unterschieden werden, ob http (sprich unsecure websocket) oder https (secure websocket) genutzt wird.

Da der Load-Balancer den https üblicherweise entschlüsselt, muss bei https nur der Port 3003 auf den Load-Balancer geöffnet werden.

Firewall Konfiguration http

Folgende Befehle, auf folgende Maschinen ausführen:

is used.

Since the load balancer usually decrypts the https, for https only port 3003 needs to be opened to the load balancer.

Firewall configuration http

Execute the following commands, on the following machines:

• On CHAT server (here the chat port and the Hazelcast Cluster portsAuf CHAT Server (hier der Chat-Port sowie die Hazelcast Cluster Ports)
  
  

firewall-cmd --zone=public --add-port=5701-5801/tcp --permanent
firewall-cmd --zone=public --add-port=3000/tcp --permanent
firewall-cmd --reload

• Auf alle On all LB - bei http Verbindung nach Aussenwith http connection to the outside
  
  

firewall-cmd --zone=public --add-port=3000/tcp --permanent
firewall-cmd --reload

Firewall

configuration https

• Auf alle On all LB - bei https Verbindung nach Aussenwith https connection to the outside
  
  

firewall-cmd --zone=public --add-port=3003/tcp --permanent
firewall-cmd --reload

Firewall Centos 6

service iptables status
iptables -I INPUT 4 -p tcp -m tcp --dport 5701:5801 -j ACCEPT
iptables -I INPUT 4 -p tcp -m tcp --dport 3000:3003 -j ACCEPT
service iptables save
service iptables restart

Load Balancer

Configuration

haproxy.

cfg Adjustments

For http

Folgende Anpassungen werden am haproxy vorgenommen, bei einer http Verbindung für den Chat nach AussenThe following adjustments are made on the haproxy, in case of a http connection for the chat to the outside:

frontend acdportal_chat_ws
        mode            http
        bind            :3000 
        timeout         client 1d
        default_backend backend_chat_ws

backend backend_chat_ws
        mode            http
        balance         leastconn # roundrobin
        server          chatserver1 <ip_addresse_oder_name>:3000 weight 1 check inter 1m
        server          chatserver2 <ip_addresse_oder_name>:3000 weight 1 check inter 1m

For https

frontend acdportal_chat_wss
        mode            http
        bind            :3003 ssl crt /etc/haproxy/haproxy.pem
        timeout         client 1d
        default_backend backend_chat_ws

backend backend_chat_ws
        mode            http
        balance         leastconn # roundrobin
        server          chatserver1 <ip_addresse_oder_name>:3000 weight 1 check inter 1m
        server          chatserver2 <ip_addresse_oder_name>:3000 weight 1 check inter 1m

Reload Haproxy

AnschließendThen, den haproxy neu laden mit folgenden Befehlreload the haproxy with the following command:

Code Block
language bash title reload haproxy neu laden
service haproxy reload

Chat

Configuration

Parameters (

as sysadmin)

For https / wss

For http / ws

Status

Ein entsprechender Agentenstatus für An appropriate agent status for "Chat" - oder einen vorhandenen Status - muss konfiguriert werden, sodass der Chat an den Agenten verteilt wird:

Image Removed

Max Chats pro Agent

Die maximale Anzahl an parallele Chats pro Agent muss konfiguriert werden. Dieser Wert ist standardmäßig bei allen Agenten auf 0 eingestellt.

Image Removed

Zusätzliche Konfigurationen für WhatsApp

Damt What's App funktioniert, müssen weitere Konfigurationen noch getätigt werden.

or an existing status - must be configured so that chat is distributed to the agent:

Image Added

Max chats per agent

The maximum number of parallel chats per agent must be configured. This value is set to 0 by default for all agents.

Image Added

Additional configurations for WhatsApp

In order for What's App to work, further configurations still need to be made.

Note: setting up the WhatsApp business account or connecting to the provider (currently TynTec) is done directly with the providerHinweis: das Einrichten vom WhatsApp Business-Konto bzw. die Anbindung an den Provider (derzeit TynTec) erfolgt direkt mit dem Provider.

Additional configuration in jtel-clientmessenger

Der Parameter DATADIR muss geprüft werden. Dies muss entweder auf das The parameter DATADIR must be checked. This must point to either the /srv/jtel/shared/Data/Clients/ Verzeichnis zeigen, falls dieser am Chat-Server direkt gehostet ist, oder directory if it is hosted directly on the chat server, or /home/jtel/shared/Data/clients/, falls der Server das Verzeichnis gemoutet hat if the server has mooted the directory.

DATADIR="/home/jtel/shared/Data/clients/"

Zusätzliche Konfigurationen am Load-Balancer

Additional configurations on the load balancer

Additional entries are required in the frontend area for the portalIm Bereich frontend für das Portal sind zusätzliche Einträge nötig:

frontend acdportal_https
...
        acl whatsapp_req    path /incoming
        acl whatsapp_req    path /delivery
...
        use_backend     backend_chat_ws if whatsapp_req

Zusätzliche Parameter

Additional parameters

The following system parameters must be checked in the portalFolgende System-Parameter müssen im Portal geprüft werden:

Customize TynTec API

endpoints

It may be necessary to adjust the API endpoints to which the messages are sent. Currently TynTec does not offer the possibility to do this via a web configuration, this must be done via a REST call. The easiest way to do this is to use Postman.

The following parameters are required, both callback URLs are adjusted according to the end point of the system.

Es kann notwendig sein, die API Endpunkte anzupassen, auf den die Nachrichten gesendet werden. Derzeit bietet TynTec keine Möglichkeit dies über eine Web-Konfiguration durchzuführen, dies muss über ein REST Aufruf geschehen. Dies kann am einfachsten mit Postman erfolgen.

Folgende Parameter werden benötigt, hierbei werden beide Callback-URL entsprechend des Endpunktes des Systems angepasst.

{
 "webhooks": [
 {
 "events": [
 "MoMessage"
 ],
 "callbackUrl": "https://jtel-portal/incoming"
 },
 {
 "events": [
 "MessageStatus::accepted",
 "MessageStatus::delivered",
 "MessageStatus::seen",
 "MessageStatus::failed",
 "MessageStatus::channelFailed",
 "MessageStatus::deleted",
 "WhatsAppGroupEvent::userJoined",
 "WhatsAppGroupEvent::userLeft",
 "WhatsAppGroupEvent::subjectChanged",
 "WhatsAppGroupEvent::descriptionChanged"
 ],
 "callbackUrl": "https://jtel-portal/delivery"
 }
 ]
}

Chat

Connector

Configuration

The following additional parameters are configured in the Chat Connector:

• The check mark Whatsapp is set.
• The TynTec API Key is entered.
• The phone number is entered

Folgende zusätzliche Parameter werden beim Chat-Connector konfiguriert:

• Der Haken Whatsapp wird gesetzt.
• Der TynTec API Key wird eingetragen.
• Die Rufnummer wird in E.164 Format eingetragenformat.