Customer Gadget Configurations on Windows

Following is the procedure to configure Customer Gadget:

Navigate to <installation-dir>\hybrid-chat\core\tomcat\apache-tomcat-8.5.47\webapps\customer-gadget\assets\config directory
Open config.json file with any text editor
Save the file after configuration changes

Configuration

Sample config.json file is as follows:

JavaScript

{
    "serverUrl": "https://chatsolution.expertflow.com/chat",
    "socketUrl": "https://chatsolution.expertflow.com",
    "languages": "en: English, de: German, zh: Chinese, fr: French, ar: Arabic",
    "defaultLanguage": "en",
    "inactivity": {
        "timeout": 120,
        "retries": 3
    },
    "isIntegrated": true,
    "theme": "orange-theme",
    "isFontAdjustable": true,
  "agentAvailibilityTimeout": 300,
    "callback": {
        "url": "https://chatsolution.expertflow.com/ecm"
    },
    "fileServerUrl": "https://chatsolution.expertflow.com/file-engine",
    "calendar": {
        "enabled": true,
        "url": "https://chatsolution.expertflow.com/umm",
        "agency": "expertflow"
    },
    "ewt": {
        "url": "https://chatsolution.expertflow.com/mre",
        "delay": 5,
        "minTime": 120,
        "maxTime": 600,
        "maxPosition": 2
    },
    "messageLimit": 200,
    "logs": {
        "enabled": true
    },
    "chatTranscript" : false,
    "enableFileSending":false,
    "enable_hyberlinks":true,
    "enableEmojis":true,
    "enableCloseChatNotif":true,
    "enableNotification":true,
    "showCustomerAvatar":true
}

Following table explains parameters:

	Configuration Variable	Default Value	Expected Value	Description
1	serverUrl	https://chatsolution.expertflow.com/chat	string	Chat server url to initiate chat
2	socketUrl	https://chatsolution.expertflow.com	string	Chat server url without to establish socket connection between chat-server and customer-gadget
3	languages	en: English, de: German, zh: Chinese, fr: French, ar: Arabic	string	List of supported languages and codes
4	defaultLanguage	en	string	Default language if browser language is not supported by the customer-gadget
5	inactivity.timeout	120	number	Customer is notified once inactivity time reached.
6	inactivity.retries	3	number	Once customer is notified equal to inactivity.retries, chat is automatically closed.
7	isIntegrated	true	boolean	If customer gadget is integrated in another site than value is set to true
8	theme	orange-theme	string	name of the theme.
9	isFontAdjustable	true	boolean	If the value is `true,` the widget shows 3 font size options to choose from. The default value is `true`.
10	agentAvailibilityTimeout	300	number	In case of no agent available, chat is auto-ended once this timeout expires AgentAvailibilityTimeout must be less than
11	callback.url	https://chatsolution.expertflow.com /ecm	string	Not applicable
12	fileServerUrl	https://chatsolution.expertflow.com/file-engine	string	File server url to send / receive attachments
13	calendar.enabled	true	boolean	Used to enable/disable working hours
14	calendar.url	https://chatsolution.expertflow.com/umm	string	Full qualified domain name of host machine where UMM is deployed. Agent availability calendar is accessible via UMM.
15	calendar.agency	expertflow	string	Name of calendar agency where Agent availability is configured. For more info, please refer to Supervisor Tools User Guide .
16	ewt.url	https://chatsolution.expertflow.com/mre	string	This configuration is required to check if there's any available agent in MRE when chat is initiated & to fetch estimated wait time for customer chat to be routed to an agent.
17	ewt.delay	15	number	Estimated wait time poll interval in seconds
18	ewt.minTime	120	number	min wait time configuration to show on customer screen.
19	ewt.maxTime	600	number	max wait time to show on customer screen
20	ewt.maxPosition	10	number	max queue position to show on customer screen.
21	messageLimit	200	number	This is character limit for a message, valid between 1 and 2000
22	logs.enabled	true	boolean	Used to enable/disable logs of customer gadget to track the problem
23	chatTranscript	true	boolean	Allow the user to download chat transcript after chat ended
24	enableFileSending	true	boolean	This configuration is used to enable or disable the file sending option.
25	enable_hyberlinks	true	boolean	To automatically convert a string such as `google.com` or `http://google.com` to a hyperlink, set the value to `true`.
26	enableEmojis	true	boolean	This configuration is used to enable or disable chat emoji. The default value is `true`.
27	enableCloseChatNotif	true	boolean	If set to `true`, customers will first see a confirmation alert when trying to close a chat session. So the chat session will be closed only upon closing the confirmation. The default value is `true`.
28	enableNotification	true	boolean	This enables or disables browser notifications and sound for incoming chat messages.
29	showCustomerAvatar	true	boolean	This enables showing customer avatar. If set to `false`, the customer avatar won't appear. The default value is `true`.

Now Customer Gadget is configured and we just need to specify the address where customer gadget is actually deployed by following these steps bellow:

Navigate to <installation-dir>\hybrid-chat\core\tomcat\apache-tomcat-8.5.47\webapps\customer-gadget\assets\widget directory
Open config.js file with any text editor
Save the file after configuration changes, clear browser cache and refresh /customer-gadget/ page

Configuration

Sample config.js file is as follows:

JavaScript

widgetConfig={
	"url":" https://FQDN/customer-gadget"
}

Following table explains parameters:

	Configuration Variable	Default Value	Expected Value	Limitations	Description
1.	widgetConfig.url	https://FQDN/customer-gadget	string		Customer Gadget url where it is deployed

Customer Gadget won't work standalone from 3.9.4 release and onward. To embed Customer Gadget in your website, refer to Javascript API and embed using 2020-04-21_06-38-53_Embed Customer Gadget in Website guide.