Agent Gadget Environment Variables

Following are the environment variables used in the agent-gadget service.

Config Parameter

Expected Value

Notes

SERVER_URL


https://<fqdn>

This is chat  service url. Only need to give Chat Server host machine FQDN here

STANDALONE_AGENTS

true/false

For stand alone user set value to ‘true’.

For contact center agents set value to ‘false’

This must match comm-server and mre service configurations

SEND_USD_EVENTS

true/false

If agent gadget  is integrated inside MS USD, set  value to ‘true’ else set it to  ‘false’

RECONNECT_TIME

30

Time in seconds, the gadget should wait before calling the logout event  in case of network or server disconnection.

All controls on agent interface will be disabled  and agent will be logged out from gadget when this time expires.

BOT_T1_SCORE

0.8

This is bot threshold

Value should be less than 1

BOT_T1_TIME

15

Value is in seconds

-1 means do not start timer.

Once message receives with score more than or equal to BOT_T1_SCORE, timer starts.

Message is sent after timer ends

BOT_T2_SCORE

0.6

This is bot threshold

Value should be less than BOT_T1_SCROE

BOT_T2_TIME

30

Set in seconds,

-1 means do not start timer.

Once message receives which score more than or equal to BOT_T2_SCORE and less than BOT_T1_SCORE, this timer starts.

Message is sent after timer ends

BOT_T3_SCORE

0

This is bot threshold

Value must be set to 0

BOT_T3_TIME

45

Set in seconds,

-1 means do not start timer.

Once message receives which score more than or equal to BOT_T3_SCORE and less than BOT_T2_SCORE, this timer starts.

Message is sent after timer ends

DEFAULT_LANGUAGE

Language code i.e. en etc

Default language is used when agent has selected no language

APP_SUPPORTED_LANGUAGES

"en:English,zh:Chinese,de:German,fr:French,ar:Arabic"

List of supported languages

To add a new language, add it as a key:value pair, such as fr:French for adding French language. The key is following ISO 639.1.

A language is added as a key-value pair, where the key is a 2 character code and the language name is the value. Pairs are separated by comma(,) and a key value pair is defined as Key:Value.

CERTIFICATE_PATH

/usr/share/nginx/html/localhost.crt

This is the path where certificate file is present

CERTIFICATE_KEY_PATH

/usr/share/nginx/html/localhost.key

This is the path where certificate key file is present

ACCEPT_NOTIF_DURATION



DB_URL

https://<fqdn>/database-connector

This is database-connector URL
QUEUE_STATS_RELOAD_TIMEThis is in seconds, data on queue stats dashboard is refreshed after every QUEUE_STATS_RELOAD_TIME seconds.
Max_Character_Count500character limit for message, it can be between 1 & 2000
FILE_SERVER_URLhttps://<fqdn>/file-engineFile Engine url to upload / download attachments
MRE_URLhttps://<fqdn>/mreMRE api url to fetch queue statistics for Supervisor Dashboard
QUEUE_STATS_RELOAD_TIME5MRE API poll time in seconds to fetch queue stats. Default is 5 seconds
ENABLE_CRM_EVENTStrue/falseIf agent-gadget is embedded in MS CRM channel integration framework that set true. Default value is false
CRM_URLurlURL of the crm in which agent-gadget is embedded
CRM_ACTIVITY_ENTITY
Name of the entity in which activity will be created, default is new_chat
ACTIVITY_ENTITY_HISTORY_FIELD
Field name in activity entity to save history page url. Default is new_history

CRM_SEARCH_FIELD


Field name against which record is searched in contact entity in MS CRM. Default is telephone1
GADGET_WIDTH360width of the agent-gadget in CIF panel. Default and min supported value is 360.


Canned Messages

For custom canned messages, mount this file /usr/share/nginx/html/assets/scripts/messages.json

canned messages for any language are supoorted only if that language is supported by agent-gadget.