Skip to main content
Skip table of contents

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
  4. Navigate to Config directory in comm_server.jar 
  5. Open config.properties file with text editor
  6. Save file and update in comm_server.jar 
  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 VariableDefault ValueExpected ValueLimitationsDescription
1NUMBER_OF_LICENSES

Not Supported anymore. Do not change.
2CUSTOMER_NAMECustomerString
Customer Name
3KEY

Not Supported anymore. Do not change.
4FINESSE_1https://finesse10-5.ef.com/finesse/api/String
Finesse main URL/IP, needs restart after change. 
5FINESSE_2https://finesse10-5.ef.com/finesse/api/String
Finesse secondary URL/IP, needs restart after change
6FINESSE_REQUEST_TIMEOUT3000Number
Finesse request timeout (in milli-seconds)
7FINESSE_HEARTBEAT_SLEEP5Number
Delay in ping to finesse servers (seconds)
8ByPass_SSLtrueBoolean true / false 
Bypass SSL Certificate, in case of false, Import SSL certificate to JVM if needed
9ByPass_TLStrueBoolean true / false 
Bypass TSL Certificate for XMPP, false by default
10BOT_URL

Not Supported anymore. Do not change.
11BOT_HEARTBEAT_SLEEP

Not Supported anymore. Do not change.
12ACTIVEMQ1localhost:61616String
Active MQ Primary URL
13ACTIVEMQ2localhost:61616String
Active MQ Secondary URL
14ACTIVEMQ_TIMEOUT30000Number
Active MQ Timeout
15AMQ_CONSUMER_PRIORITY100Number
Connector1 Queue consumer priority (Used for primary, secondary deployment of GC)(0-127)
16PRIORITY_BACKUPtrueBoolean true / false 
For ActiveMQ Failover transport. Do not change
17RANDOMIZEfalseBoolean true / false 
For ActiveMQ Failover transport. Do not change
18PREFETCH_SIZE20000Number
Prefect Size of the messages
19AGENT_STATES_PUBLISHER_DURATION

Not Supported anymore. Do not change.
20GC_HEARTBEAT_TIMEOUT

Not Supported anymore. Do not change.
21AGENT_INACTIVITY_DURATION

Not Supported anymore. Do not change.
22GC_HEARTBEAT_SLEEP

Not Supported anymore. Do not change.
23AGENT_INACTIVITY_TIME_SWITCH

Not Supported anymore. Do not change.
24DEFAULT_NOT_READY_REASON1Number
default reason code for not ready
25AGENT_XMPP_SUBS_TIME10000Number
Agent XMPP Subscription Time
26DEFAULT_LOGOUT_REASON
Number
default reason code for logout. Logout on Inactivity timeout will use this code.
27USE_ENCRYPTED_PASSWORDS

Not Supported anymore. Do not change.
28CHANGE_STATE_ON_WRAPUPtrueBoolean true / false 
Automatically change the state when wrap-up occurs
29MESSAGE_FORMATJSONStringOnly JSON format is supported yetMessage Format for communication. Expected formats DEFAULT, JSON, XML
30EXTENSION_PATTERN\\+?\\d+Regex
Extension regex validator
31AGENT_LOGS_PATH/EFLogs/chat-solution/communication-server/Agents/String
AgentLogs Storage path
32AGENT_LOGS_LEVELTRACEString
Agent Logs Level
33AGENT_LOGS_MAX_FILES10Number
Max No of Files per agent for logs
34AGENT_LOGS_FILE_SIZE100MBString
Max file size for agent logs
35UMM_PATHhttps://localhost:8443/ummNumber
UMM is used when Comm Server works standalone
36IS_STANDALONEfalseBoolean true / false 
Integrated with Finesse when false 
37IS_UMM_CERT_SELF_SIGNEDtrueBoolean true / false 
Only applicable when IS_STANDLONE is true 
38MAX_TASKS5Number
Max number of chats offered to an agent
39NOT_READY_REASON13Number
NOT_READY reason code for Chat Arrived
40ENABLE_REPORTINGtrueBoolean true / false 
true if Reporting CRD publishing via ActiveMQ reporting queue is enabled
41KAFKA_ENABLED

Not Supported anymore. Do not change.
42KAFKA_SERVER_URL

Not Supported anymore. Do not change.
43KAFKA_TOPIC

Not Supported anymore. Do not change.
44ACKS

Not Supported anymore. Do not change.
45RETRIES

Not Supported anymore. Do not change.
46BATCH_SIZE

Not Supported anymore. Do not change.
47LINGER_MS

Not Supported anymore. Do not change.
48BUFFER_MEMORY

Not Supported anymore. Do not change.
49ENABLE_SSLtrueBoolean true / false 
Specifies to host API via HTTPS
50KEYSTORE_PATH../certs/client.ksString
ActiveMQ keystore path
51TRUSTSTORE_PATH../certs/client.tsString
ActiveMQ trust store path
52KEYSTORE_PWDpasswordString
ActiveMQ keystore password
53TRUSTSTORE_PWDpasswordString
ActiveMQ truststore passowrd
54API_PORT8082Number
HTTP API port
55API_PORT_HTTPS8482Number
HTTPS API port
56JKS_KEYSTORE_PATH../certs/keystore.jksStringApplicable only when SSL is true Certificate to host Communication Server over HTTPS
57JKS_KEY_STORE_PSWDpasswordStringApplicable only when SSL is trueKeystore password
58JKS_KEY_MANAGER_PSWDpasswordStringApplicable only when SSL is trueKey Store Manager password
59DB_CONNECTOR_API_PATHhttps://localhost:8450String
Database Connector API path
60RONA_TIMEOUT30000Number
RONA timeout in milliseconds.
61REPORTING_RONA_REASONRONA


62MRE_APIhttp://localhost:8097String
MRE API path
63AUTO_ANSWER_ENABLEDfalseBoolean

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.