Breadcrumbs

Communication Server Configurations

Following is the procedure to configure Communication Server:

  1. Stop EF_CommunicationServer service in Windows Services pane

  2. Navigate to <installation-dir>\hybrid-chat\core\communication_server\ 

  3. Open comm_server.jar with WinRar
    image2019-11-13_14-10-21.png

  4. Navigate to Config directory in comm_server.jar 
    image2019-11-13_14-11-36.png

  5. Open config.properties file with text editor

  6. Save file and update in comm_server.jar 
    image2019-11-13_14-14-14.png

  7. Start EF_CommunicationServer service in Windows Services pane

  8. Communication Server logs are generated at /EFLogs/chat-solution/communication-server 

Configuration

Following is sample of config.properties file

Java
# properties file containing properties used by the server daemon
#-----------Licencing-----------#
#Number of concurrent agents, DO NOT TOUCH
NUMBER_OF_LICENSES=100
#Customer Name, DO NOT TOUCH
CUSTOMER_NAME=Customer
#LICENSE_KEY, DO NOT TOUCH
KEY=E7409F0AB1B822FDC9788646C199E722
#-----------Finesse-----------#
#Finesse main URL, needs restart after change
FINESSE_1=https://192.168.1.100:8445/finesse/api/
#Finesse secondary URL, needs restart after change
FINESSE_2=https://192.168.1.100:8445/finesse/api/
#Finesse request timeout (in milli-seconds)
FINESSE_REQUEST_TIMEOUT=3000
#Delay in ping to finesse servers (seconds)
FINESSE_HEARTBEAT_SLEEP=5
#Bypass SSL Certificate, in case of false, Import SSL certificate to JVM if needed
BYPASS_SSL=true
#Bypass TSL Certificate for XMPP, false by default
BYPASS_TLS=true
#Turn Media Blending on or off
MEDIA_BLENDING=2
#-----------BotFramework-----------#
BOT_URL=http://<fqdn>/
#Delay in ping to bot framework (in milli-seconds)
BOT_HEARTBEAT_SLEEP=3000
#-----------ActiveMQ-----------#
#Active MQ Primary URL
ACTIVEMQ1=localhost:61616
#Active MQ Secondary URL
ACTIVEMQ2=localhost:61616
#Active MQ Timeout
ACTIVEMQ_TIMEOUT=30000
#Connector1 Queue consumer priority (Used for primary, secondary deployment of GC)(0-127)
AMQ_CONSUMER_PRIORITY=100
#To connect with its primary GC
PRIORITY_BACKUP=true
#for failover url
RANDOMIZE=false
#Prefect Size of the messages
PREFETCH_SIZE=20000
#-----------Generic Connector Sync-----------#
#Time after which, states of all agents would be published on topic (In Milliseconds)
AGENT_STATES_PUBLISHER_DURATION=5000
# GC heartbeat timeout
GC_HEARTBEAT_TIMEOUT=10000
# Agent inactivity time in seconds
AGENT_INACTIVITY_DURATION=30
#gc heartbeat thread sleep time
GC_HEARTBEAT_SLEEP=10000
#-----------General Configurations-----------#
# Agent inactivity switch
AGENT_INACTIVITY_TIME_SWITCH=false
#default reason code for not ready
DEFAULT_NOT_READY_REASON=1
#Agent XMPP Subscription Time
AGENT_XMPP_SUBS_TIME=10000
#default reason code for logout. Logout on Inactivity timeout will use this code.
DEFAULT_LOGOUT_REASON=
#Use encrypted password
USE_ENCRYPTED_PASSWORDS=false
#Automatically change the state when wrap-up occurs
CHANGE_STATE_ON_WRAPUP=true
#Message Format for communication. Expected formats DEFAULT, JSON, XML
MESSAGE_FORMAT=JSON
#Extension regex validator
EXTENSION_PATTERN=\\+?\\d+
#-----------AgentWise Logging & Communication Server general configurations-----------#
#AgentLogs Storage path
AGENT_LOGS_PATH=/EFLogs/chat-solution/communication-server/Agents/
#Agent Logs Level
AGENT_LOGS_LEVEL=TRACE
#Max No of Files per agent for logs
AGENT_LOGS_MAX_FILES=10
#Max file size for agent logs
AGENT_LOGS_FILE_SIZE=100MB
#Standalone Config
UMM_PATH=https://localhost:8443/umm
IS_STANDALONE=false
IS_UMM_CERT_SELF_SIGNED=true
#Chat MRE
MAX_TASKS=5
#NOT_READY reason code for Chat Arrived
NOT_READY_REASON=13
#true if Reporting CRD publishing via ActiveMQ reporting queue is enabled
ENABLE_REPORTING=true
#-----------Apache Kafka-----------#
# This section is not in use anymore
# For detailed information of used params, please visit https://kafka.apache.org/documentation.html#producerconfigs
KAFKA_ENABLED=false
# Apache Kafka server url
KAFKA_SERVER_URL=localhost:9092
# Topic name
KAFKA_TOPIC=database-connector
# Acknowledgements, DO NOT CHANGE unless kafka is deployed in a cluster and you need to change cluster configs
ACKS=all
# Number of retries to carry out for sending a message
RETRIES=10
# Batch Size, DO NOT CHANGE
BATCH_SIZE=16384
# Linger time, milliseconds, DO NOT CHANGE
LINGER_MS=1
# Buffer Memory, DO NOT CHANGE
BUFFER_MEMORY=33554432
#---------------- SSL Properties ----------------#
ENABLE_SSL=false
KEYSTORE_PATH=../certs/client.ks
TRUSTSTORE_PATH=../certs/client.ts
KEYSTORE_PWD=password
TRUSTSTORE_PWD=password
#---------------- Jetty Server Properties --------------------#
API_PORT=8082
API_PORT_HTTPS=8482
JKS_KEYSTORE_PATH=../certs/keystore.jks
JKS_KEY_STORE_PSWD=password
JKS_KEY_MANAGER_PSWD=password
#---------------- Database connector properties -------------#
DB_CONNECTOR_API_PATH=https://localhost:8450

#---------------- RONA properties -------------#
RONA_TIMEOUT=-1
REPORTING_RONA_REASON=RONA

#-------------- MRE Path -----------------#
MRE_API=http://localhost:8097

#-------------- Auto Answer Configuration --------------#
AUTO_ANSWER_ENABLED=false

Configuration variables are explained in following table


Configuration Variable

Default Value

Expected Value

Limitations

Description

1

NUMBER_OF_LICENSES



Not Supported anymore. Do not change.


2

CUSTOMER_NAME

Customer

String


Customer Name

3

KEY



Not Supported anymore. Do not change.


4

FINESSE_1

https://finesse10-5.ef.com/finesse/api/

String


Finesse main URL/IP, needs restart after change. 

5

FINESSE_2

https://finesse10-5.ef.com/finesse/api/

String


Finesse secondary URL/IP, needs restart after change

6

FINESSE_REQUEST_TIMEOUT

3000

Number


Finesse request timeout (in milli-seconds)

7

FINESSE_HEARTBEAT_SLEEP

5

Number


Delay in ping to finesse servers (seconds)

8

ByPass_SSL

true

Boolean true / false


Bypass SSL Certificate, in case of false, Import SSL certificate to JVM if needed

9

ByPass_TLS

true

Boolean true / false


Bypass TSL Certificate for XMPP, false by default

10

BOT_URL



Not Supported anymore. Do not change.


11

BOT_HEARTBEAT_SLEEP



Not Supported anymore. Do not change.


12

ACTIVEMQ1

localhost:61616

String


Active MQ Primary URL

13

ACTIVEMQ2

localhost:61616

String


Active MQ Secondary URL

14

ACTIVEMQ_TIMEOUT

30000

Number


Active MQ Timeout

15

AMQ_CONSUMER_PRIORITY

100

Number


Connector1 Queue consumer priority (Used for primary, secondary deployment of GC)(0-127)

16

PRIORITY_BACKUP

true

Boolean true / false


For ActiveMQ Failover transport. Do not change

17

RANDOMIZE

false

Boolean true / false


For ActiveMQ Failover transport. Do not change

18

PREFETCH_SIZE

20000

Number


Prefect Size of the messages

19

AGENT_STATES_PUBLISHER_DURATION



Not Supported anymore. Do not change.


20

GC_HEARTBEAT_TIMEOUT



Not Supported anymore. Do not change.


21

AGENT_INACTIVITY_DURATION



Not Supported anymore. Do not change.


22

GC_HEARTBEAT_SLEEP



Not Supported anymore. Do not change.


23

AGENT_INACTIVITY_TIME_SWITCH



Not Supported anymore. Do not change.


24

DEFAULT_NOT_READY_REASON

1

Number


default reason code for not ready

25

AGENT_XMPP_SUBS_TIME

10000

Number


Agent XMPP Subscription Time

26

DEFAULT_LOGOUT_REASON


Number


default reason code for logout. Logout on Inactivity timeout will use this code.

27

USE_ENCRYPTED_PASSWORDS



Not Supported anymore. Do not change.


28

CHANGE_STATE_ON_WRAPUP

true

Boolean true / false


Automatically change the state when wrap-up occurs

29

MESSAGE_FORMAT

JSON

String

Only JSON format is supported yet

Message Format for communication. Expected formats DEFAULT, JSON, XML

30

EXTENSION_PATTERN

\\+?\\d+

Regex


Extension regex validator

31

AGENT_LOGS_PATH

/EFLogs/chat-solution/communication-server/Agents/

String


AgentLogs Storage path

32

AGENT_LOGS_LEVEL

TRACE

String


Agent Logs Level

33

AGENT_LOGS_MAX_FILES

10

Number


Max No of Files per agent for logs

34

AGENT_LOGS_FILE_SIZE

100MB

String


Max file size for agent logs

35

UMM_PATH

https://localhost:8443/umm

Number


UMM is used when Comm Server works standalone

36

IS_STANDALONE

false

Boolean true / false


Integrated with Finesse when false

37

IS_UMM_CERT_SELF_SIGNED

true

Boolean true / false


Only applicable when IS_STANDLONE is true

38

MAX_TASKS

5

Number


Max number of chats offered to an agent

39

NOT_READY_REASON

13

Number


NOT_READY reason code for Chat Arrived

40

ENABLE_REPORTING

true

Boolean true / false


true if Reporting CRD publishing via ActiveMQ reporting queue is enabled

41

KAFKA_ENABLED



Not Supported anymore. Do not change.


42

KAFKA_SERVER_URL



Not Supported anymore. Do not change.


43

KAFKA_TOPIC



Not Supported anymore. Do not change.


44

ACKS



Not Supported anymore. Do not change.


45

RETRIES



Not Supported anymore. Do not change.


46

BATCH_SIZE



Not Supported anymore. Do not change.


47

LINGER_MS



Not Supported anymore. Do not change.


48

BUFFER_MEMORY



Not Supported anymore. Do not change.


49

ENABLE_SSL

true

Boolean true / false


Specifies to host API via HTTPS

50

KEYSTORE_PATH

../certs/client.ks

String


ActiveMQ keystore path

51

TRUSTSTORE_PATH

../certs/client.ts

String


ActiveMQ trust store path

52

KEYSTORE_PWD

password

String


ActiveMQ keystore password

53

TRUSTSTORE_PWD

password

String


ActiveMQ truststore passowrd

54

API_PORT

8082

Number


HTTP API port

55

API_PORT_HTTPS

8482

Number


HTTPS API port

56

JKS_KEYSTORE_PATH

../certs/keystore.jks

String

Applicable only when SSL is true

Certificate to host Communication Server over HTTPS

57

JKS_KEY_STORE_PSWD

password

String

Applicable only when SSL is true

Keystore password

58

JKS_KEY_MANAGER_PSWD

password

String

Applicable only when SSL is true

Key Store Manager password

59

DB_CONNECTOR_API_PATH

https://localhost:8450

String


Database Connector API path

60

RONA_TIMEOUT

30000

Number


RONA timeout in milliseconds.

61

REPORTING_RONA_REASON

RONA




62

MRE_API

http://localhost:8097

String


MRE API path

63

AUTO_ANSWER_ENABLED

false

Boolean