Sv translation

language	en

The CHAT role is used for conducting chat sessions with agents from external websites. The CHAT role is also required for WhatsApp integrations.

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

Alternatively, the chat-server can be installed on a separate server, or on the load balancer.

The following recommendations are made:

Where	Requirements
On an existing webserver	Additional 4 GB of RAM
On the load balancer	Additional 4 GB of RAM and 2 CPU cores, expand system drive (home directories) to 32 GB
On a separate server	8 GB RAM, 32 GB HDD, 2 CPU Cores (can be extended later to 4 CPU cores, depending on system load)

Installation

Java 8 Installation

First of all, Java 8 is installed:

Translations Ignore

Code Block

language	bash

wget https://cdn.jtel.de/downloads/java/jdk-8u202-linux-x64.rpm
dnf -y install ./jdk-8u202-linux-x64.rpm
rm -f jdk-8u202-linux-x64.rpm

Installing and Configuring ClientMessenger

ClientMessenger Installation

First of all, the ClientMessenger directory is copied to /home/jtel

Translations Ignore

Code Block

language	bash

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

Hazelcast Cluster Configuration File

The hazelcast.xml file is copied to the configuration directory of the chat server.

Note, this assumes that the file has been prepared already. See the installation instructions for the WEB role for details of how to prepare this file.

Translations Ignore

Code Block

language	bash

rm -f /home/jtel/ClientMessenger/conf/hazelcast.xml
cp /home/jtel/shared/hazelcast.xml /home/jtel/ClientMessenger/conf/hazelcast.xml
chown jtel:jtel /home/jtel/ClientMessenger/conf/hazelcast.xml

Client Messenger Configuration

The 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:

Status

colour	Red
title	Caution Password

Translations Ignore

Code Block

# Edit this file:
vi /home/jtel/ClientMessenger/systemd/jtel-clientmessenger.service

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

Install ClientMessenger with systemd

Translations Ignore

Code Block

language	bash

cp /home/jtel/ClientMessenger/systemd/jtel-clientmessenger.service /etc/systemd/system/jtel-clientmessenger.service
chmod +x /home/jtel/ClientMessenger/init.d/jtel-clientmessenger
systemctl daemon-reload
systemctl enable jtel-clientmessenger.service

Create the Update Script

An update script is created for updating the chat server:

Translations Ignore

Code Block

language	bash

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

Configure the Firewall

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 https (secure websocket) 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 ports)

Translations Ignore

Code Block

language	bash

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

On all LB - with http connection to the outside

Translations Ignore

Code Block

language	bash

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

Firewall configuration https

On all LB - with https connection to the outside

Translations Ignore

Code Block

language	bash

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

Load Balancer Configuration

haproxy.cfg Adjustments

For http

The following adjustments are made on the haproxy, in case of a http connection for the chat to the outside:

Translations Ignore

Code Block

language	bash

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

Translations Ignore

Code Block

language	bash

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

Then, reload the haproxy with the following command:

Translations Ignore

Code Block

language	bash

service haproxy reload

Chat Configuration

Parameters (as sysadmin)

For https / wss

ACD.Chat.Script.Library.URL	https://<load-balancer>:3003/gui/
ACD.Chat.Server.Base.URL	wss://<load-balancer>:3003

For http / ws

ACD.Chat.Script.Library.URL	https://<load-balancer>:3000/gui/
ACD.Chat.Server.Base.URL	ws://<load-balancer>:3000

Status

An appropriate agent status for "Chat" - or an existing status - must be configured so that chat is distributed to the agent:

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.

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 provider.

Warning

title	https

The load balancer must be operated with https and a valid certificate.

Additional configuration in jtel-clientmessenger

The parameter DATADIR must be checked. This must point to either the /srv/jtel/shared/Data/Clients/ directory if it is hosted directly on the chat server, or /home/jtel/shared/Data/clients/ if the server has mooted the directory.

Translations Ignore

Code Block
Environment=DATADIR=/home/jtel/shared/Data/clients/

Additional configuration on the load balancer

Additional entries are required in the frontend area for the portal:

Translations Ignore

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

Additional parameters

The following system parameters must be checked in the portal:

Parameter	Value	Comment
ACD.Whatsapp.Server.Base.URL	https://jtel-portal:3003	The URL used by the agent client to allow the agent to reply to messages. This must be resolved from all agent workstations to a valid URL via DNS, and is directed to the chat server via the haproxy.
ACD.Whatsapp.Whatsapp.Url	https://jtel-portal:3003	The URL used by the outside world (WhatsApp users) to download the attachments of the messages. This must be resolved from the Internet to a valid URL via DNS, and is directed to the chat server via the haproxy.
ACD.Whatsapp.Tyntec.Url	https://api.tyntec.com/chat-api/v2/messages	The URL of the TynTec API for WhatsApp.

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.

Setting

Value

URL

https://api.tyntec.com/chat-api/v2/applications/default

Request Type

PATCH

Authorization

apikey

Value = the generated API Key from Tyntec

Additional Headers

Accept

application/problem+json

Additional Headers

Content-Type

application/json

Body

Translations Ignore

Code Block

{
"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 incoming service number for WhatsApp is configured and in E.164 and associated with the connector

Die 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 installiert.

Sv translation

language	de

Translations Ignore

Code Block

language	bash
title	Installation java 8

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

ClientMessenger Installieren und Konfigurieren

ClientMessenger Installation

Das Verzeichnis ClientMessenger wird nach /home/jtel kopiert.

Translations Ignore

Code Block

language	bash

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

Hazelcast Cluster Konfiguration

Die Konfiguration des Hazelcast-Clusters muss geprüft werden. Bei Neuinstallationen von Release 3.11 ab 01.04.2018 sind die Einträge in hazelcast.xml vorhanden, davor hingegen nicht.

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.

Die notwendigen Konfigurationsabschnitte in hazelcast.xml sind hier aufgeführt:

Translations Ignore

Code Block

language	bash
title	hazelcast.xml

	...
 
	<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 betrachten:

Rolle DATA, DB-Master
- hazelcast.xml updaten
- updatepl.sh ausführen
Rolle TEL
- hazelcast.xml updaten
- PlatformUDPListener neu starten
Rolle WEB
- hazelcast.xml updaten
- updatejb.sh ausführen
Rolle CHAT (das System, was gerade installiert wird!)
- hazelcast.xml am besten kopieren

ClientMessenger als Daemon Prozess installieren

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 CR+LF nur LF wird.

Translations Ignore

Code Block

language	bash

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 werden:

Translations Ignore

Code Block

title	vi /home/jtel/ClientMessenger/init.d/jtel-clientmessenger

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

Anschließend, wird der Prozess als Linux Daemon installiert:

Translations Ignore

Code Block

language	bash

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

Für das Updaten des Chat-Servers wird ein Update-Skript angelegt:

Translations Ignore

Code Block

language	bash

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 Konfiguration

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:

Auf CHAT Server (hier der Chat-Port sowie die Hazelcast Cluster Ports)

Translations Ignore

Code Block

language	bash
title	configure firewall - http

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

Auf alle LB - bei http Verbindung nach Aussen
Translations Ignore

Code Block

language	bash
title	configure firewall - http

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

Firewall Konfiguration https

Auf alle LB - bei https Verbindung nach Aussen
Translations Ignore

Code Block

language	bash
title	configure firewall - https

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

Firewall Centos 6

Translations Ignore

Code Block

language	bash
title	configure firewall - https

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 Konfiguration

haproxy.cfg Anpassungen

Für http

Folgende Anpassungen werden am haproxy vorgenommen, bei einer http Verbindung für den Chat nach Aussen:

Translations Ignore

Code Block

language	bash
title	haproxy.cfg - http / ws

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

Für https

Translations Ignore

Code Block

language	bash
title	haproxy.cfg - https / wss

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

Haproxy neu laden

Anschließend, den haproxy neu laden mit folgenden Befehl:

Translations Ignore

Code Block

language	bash
title	reload haproxy

service haproxy reload

Chat Konfiguration

Parameter (als sysadmin)

Für https / wss

ACD.Chat.Script.Library.URL

https://<load-balancer>:3003/gui/

ACD.Chat.Server.Base.URLwss://<load-balancer>:3003

Für http / ws

ACD.Chat.Script.Library.URL

https://<load-balancer>:3000/gui/

ACD.Chat.Server.Base.URLws://<load-balancer>:3000

Status

Ein entsprechender Agentenstatus für "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.

Hinweis: das Einrichten vom WhatsApp Business-Konto bzw. die Anbindung an den Provider (derzeit TynTec) erfolgt direkt mit dem Provider.

Warning

title	https

Der Load-Balancer muss mit https und ein gültiges Zertifikat betrieben werden.

Zusätzliche Konfiguration im jtel-clientmessenger

Der Parameter DATADIR muss geprüft werden. Dies muss entweder auf das /srv/jtel/shared/Data/Clients/ Verzeichnis zeigen, falls dieser am Chat-Server direkt gehostet ist, oder /home/jtel/shared/Data/clients/, falls der Server das Verzeichnis gemoutet hat.

Translations Ignore

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

Zusätzliche Konfigurationen am Load-Balancer

Im Bereich frontend für das Portal sind zusätzliche Einträge nötig:

Translations Ignore

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

Zusätzliche Parameter

Folgende System-Parameter müssen im Portal geprüft werden:

ParameterWertKommentarACD.Whatsapp.Server.Base.URL

https://jtel-portal:3003

Die URL, die vom Agenten-Client genutzt wird, damit der Agent auf Nachrichten antworten kann. Dies muss von allen Agenten-Arbeitsplätze aus gesehen auf eine gültige URL per DNS aufgelöst werden, und wird über den haproxy auf den Chatserver gerichtet.ACD.Whatsapp.Whatsapp.Urlhttps://jtel-portal:3003Die URL, die von der Aussenwelt (WhatsApp Nutzer) genutzt wird, damit die Anhänge der Nachrichten heruntergeladen werden können. Dies muss vom Internet aus gesehen auf eine gültige URL per DNS aufgelöst werden, und wird über den haproxy auf den Chatserver gerichtet.ACD.Whatsapp.Tyntec.Urlhttps://api.tyntec.com/chat-api/v2/messagesDie URL des TynTec APIs für WhatsApp.

TynTec API Endpunkte anpassen

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.

EinstellungWertURLhttps://api.tyntec.com/chat-api/v2/applications/defaultRequest TypPATCHAuthorization

apikey

Wert = den generierten API Key von Tyntec

Zusätzliche Header

Accept

application/problem+json

Zusätzliche Header

Content-Type

application/json

Body

Translations Ignore

{
"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 Konfiguration

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 eingetragen.

Image Removed

Page tree

Page History

Versions Compared

Old Version 10

New Version 11

Key

Installation

Java 8 Installation

Installing and Configuring ClientMessenger

ClientMessenger Installation

Hazelcast Cluster Configuration File

Client Messenger Configuration

Install ClientMessenger with systemd

Create the Update Script

Configure the Firewall

Firewall configuration http

Firewall configuration https

Load Balancer Configuration

haproxy.cfg Adjustments

For http

For https

Reload Haproxy

Chat Configuration

Parameters (as sysadmin)

For https / wss

For http / ws

Status

Max chats per agent

Additional configurations for WhatsApp

Additional configuration in jtel-clientmessenger

Additional configuration on the load balancer

Additional parameters

Customize TynTec API endpoints

Chat Connector Configuration

Java 8 Installation

ClientMessenger Installieren und Konfigurieren

ClientMessenger Installation

Hazelcast Cluster Konfiguration

ClientMessenger als Daemon Prozess installieren

Firewall Konfiguration

Firewall Konfiguration http

Firewall Konfiguration https

Firewall Centos 6

Load Balancer Konfiguration

haproxy.cfg Anpassungen

Für http

Für https

Haproxy neu laden

Chat Konfiguration

Parameter (als sysadmin)

Für https / wss

Für http / ws

Status

Max Chats pro Agent

Zusätzliche Konfigurationen für WhatsApp

Zusätzliche Konfiguration im jtel-clientmessenger

Zusätzliche Konfigurationen am Load-Balancer

Zusätzliche Parameter

TynTec API Endpunkte anpassen

Chat-Connector Konfiguration