Following is the procedure to configure Customer Gadget:
-
Ensure that MSSQL server is configured and accessible, create a database for reporting and create a database user with read / write permission for reporting database. Reporting Connector will create tables automatically upon first connection if no tables exist.
-
Navigate to
<installation-dir>\hybrid-chat\core\reporting-connectordirectory -
Open
docker-variables.envfile with any text editor -
Save the file after configuration changes, clear browser cache and refresh /customer-gadget/ page
Configuration
Sample docker-variables.env file is as follows:
# External SQL Parameters
# MS SQL Server IP
DBURL=192.168.2.238
#Port of SQL Server
DBPORT=1433
# MS SQL Server Instance name, leave empty if default instance is used
INSTANCE_NAME=BNPTEST
# MS SQL User
DBUSER=sa
# MS SQL Password
DBPWD=Expertflow464
# Reporting DB Name
DBNAME=HC-3.15
# Database retries on failure
DATABASE_RETRIES=3
# Ports on which Reporting Connector is listening
HTTPS_PORT=8422
HTTP_PORT=8022
#ActiveMQ parameters
AMQ_HOST_1=localhost
AMQ_HOST_2=localhost
AMQ_PORT=61615
#AMQ_PORT=61613
#AMQ_API_URL=http://192.168.1.36:8161
AMQ_API_URL=https://localhost:8162
# Set value to 'true' for secure connection. Otherwise set value to 'false'
STOMP_TLS_ENABLED=true
ENABLE_HTTPS=true
AMQ_CERTIFICATE_PATH=https_things/client.pem
AMQ_CERTIFICATE_KEY_PATH=https_things/client.key
CERTIFICATE_PATH=https_things/localhost.cert
CERTIFICATE_KEY_PATH=https_things/localhost.key
CERTIFICATE_AUTHORITY_PATH=https_things/chat-server.ca-bundle
CERTIFICATE_PASSPHRASE=
CERTIFICATE_AUTHORITY_PASSPHRASE=password
AMQ_RETRIES=500000
AMQ_DELAY=1000
AMQ_CONSUMER_PRIORITY=100
# Chat Server URL for History in Reporting
#SERVER_PUBLIC_URL=https://jehanzeb-qa.ef.com/chat
SERVER_PUBLIC_URL=https://docker-win.expertflow.com/bnp/chat
# Enable/Disable update Inbound chat configs
UPDATE_INBOUND_CHAT=true
CRM_HOST=crm-cus-api-tw-assurance.dev.echonet
UPDATE_INBOUND_CHAT_PATH=/act/api/v1/ivr/WebChatInbound/
Following table explains parameters:
|
|
Configuration Variable |
Default Value |
Expected Value |
Limitations |
Description |
|---|---|---|---|---|---|
|
1 |
DBURL |
192.168.2.238 |
string |
|
MSSQL Server URL where reporting database is created. |
|
2 |
DBPORT |
1433 |
number |
|
MSSQL Server port on which its running. |
|
3 |
INSTANCE_NAME |
|
string |
|
MSSQL Server Instance name, leave empty if the default instance is used |
|
4 |
DBUSER |
sa |
string |
|
MSSQL Server database engine user with read write permissions for reporting database. |
|
5 |
DBPWD |
sa |
string |
|
Password for user specified in DBUSER configuration variable. |
|
6 |
DBNAME |
HybridChatReporting |
string |
|
Reporting database name. |
|
7 |
DATABASE_RETRIES |
3 |
number |
|
Number of retries for database connection when connection is lost. |
|
8 |
HTTPS_PORT |
8422 |
number |
|
Port where Reporting Connector exposes its APIs when ENABLE_HTTPS is true |
|
9 |
HTTP_PORT |
8022 |
number |
|
Port where Reporting Connector exposes its APIs when ENABLE_HTTPS is false |
|
10 |
AMQ_HOST_1 |
activemq |
string |
|
ActiveMQ primary host url. Do not change unless Reporting Connector is not deployed on HC machine. |
|
11 |
AMQ_HOST_2 |
activemq |
string |
|
ActiveMQ secondary host url. |
|
12 |
AMQ_PORT |
61615 |
number |
|
Reporting Connector connects to ActiveMQ via STOMP. Port 61615 is used when establishing STOMP connection over SSL, 61613 otherwise.
|
|
13 |
AMQ_CONSUMER_PRIORITY |
100 |
number |
|
Don't change this priority, max value is 127. |
|
14 |
AMQ_API_URL |
https://localhost:8162 |
string |
|
REST API url of ActiveMQ console. Port 8162 is used for https connection, 8161 otherwise.
|
|
15 |
STOMP_TLS_ENABLED |
true |
boolean |
|
Specifies STOMP connection is established via TLS or not. |
|
16 |
ENABLE_HTTPS |
true |
boolean |
|
Specifies Reporting Connector API will be hosted via https or http. Do not confuse this with STOMP_TLS_ENABLES, this configuration variable has no connection to ActiveMQ connection. |
|
17 |
AMQ_CERTIFICATE_PATH |
https_things/client.pem |
string |
|
ActiveMQ client certificate file path. |
|
18 |
AMQ_CERTIFICATE_KEY_PATH |
https_things/client.key |
string |
|
ActiveMQ client certificate key file path. |
|
19 |
CERTIFICATE_PATH |
https_things/localhost.cert |
string |
|
Reporting Connector certificate file path. This certificate is presented by Reporting Connector to clients when ENABLE_HTTPS is true. |
|
20 |
CERTIFICATE_KEY_PATH |
https_things/localhost.key |
string |
|
Corresponding certificate key file of certificate specified in CERTIFICATE_PATH. |
|
21 |
CERTIFICATE_AUTHORITY_PATH |
https_things/ chat-server.ca -bundle |
string |
|
Certificate authority file path for Reporting Connector. |
|
22 |
CERTIFICATE_PASSPHRASE |
|
string |
|
Certificate passphrase for certificate specified in CERTIFICATE_PATH. |
|
23 |
CERTIFICATE_AUTHORITY_PASSPHRASE |
password |
string |
|
Certificate passphrase for Reporting Connector certificate authority. |
|
24 |
AMQ_RETRIES |
500000 |
number |
|
Number of retries to connect to ActiveMQ in case of a network failure. |
|
25 |
AMQ_DELAY |
1000 |
number |
|
Delay between every retry specified in AMQ_RETRIES. This time is in ms. |
|
26 |
SERVER_PUBLIC_URL |
https://docker-win.expertflow.com/bnp/chat |
string |
|
Chat Server public url (with reverse proxy). This url is inserted into database with every record. It can be used to access transcript of that specific record.
|