Customer Gadget Environment Variables

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

Config Parameter

Expected Value

Notes

SERVER_URL

https://<FQDN>/chat

This is chat server url.

SOCKET_URL

https://<FQDN>

Host machine FQDN. Only used when reverse proxy is in place. Same as SERVER_PUBLIC_URL otherwise

LANGUAGES

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

List of supported languages and codes

DEFAULT_LANGUAGE

Language code i.e. en etc

Default language is used when unable to read browser language

INACTIVITY_TIMEOUT

30

Value is in seconds

Customer is notified once inactivity time reached.

INACTIVITY_RETRIES

3

These are max retries, once customer is notified equal to NO_OF_RETRIES, chat is automatically closed.

SUBJECT_LIST

"Mobile,Fixed,Fibre,Optic,ADSL"

This subject list is mapped to Media Routing Engine (MRE) queues

IS_INTEGRATED

true/false

If customer gadget is integrated in another site than value is set to ‘true’

Otherwise value is set to ‘false’

CUSTOMER_GADGET_URL

https://<fqdn>/customer-gadget

This is base url of customer gadget

This is used once customer gadget is integrated in another site

CERTIFICATE_PATH


Path of certificate for https

CERTIFICATE_KEY


Path of the certificate key file for https

THEME

orange-theme

Default value is orange-theme

Accepted values are orange-theme, green-theme,yellow-theme,purple-theme, light-blue-theme, carrot-theme,blue-theme

AGENT_AVAILABILITY_TIMEOUT30

value is in seconds

In case of no agent available, chat is auto-ended once this timeout expires

AGENT_AVAILABILITY_TIMEOUT must be less than INACTIVITY_TIMEOUT

WORKING_HOURS_ENABLEDtrue/falseThis configuration is used to enable/disable open working hours.
WORKING_HOURS_URL

https://<fqdn>/umm

Full qualified domain name of host machine where UMM is deployed. Agent availability calendar is accessible via UMM. 
WORKING_HOURS_AGENCYexpertflowName of calendar agency where Agent availability is configured. For more info, please refer to Supervisor Tools User Guide.
EWT_URL

https://<fqdn>/mre

EWT_URL  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.
EWT_RETRY_TIME30Estimated wait time poll interval in seconds
EWT_MIN_TIME120Minimum time to wait to show customer
EWT_MAX_TIME600Maximum time to wait to show customer
EWT_MAX_POSITION10Max position to show customer e.g. queue position is 40 but EWT_MAX_POSITION is 10 so customer will see position 10 on the gadget
FILE_SERVER_URLhttps://<fqdn>/file-engine
File server url to send / receive attachments
LASTNAME_ENABLEDtrueShow this field in customer gadget
EMAIL_ENABLEDtrueShow this field in customer gagdet.
COMMENT_ENABLEDtrue/falseShow this field in customer gagdet.
SUBJECT_ENABLEDtrue/falseShow this field in customer gagdet.
DELIVERY_NUMBER_ENABLEDtrue/falseShow this field in customer gagdet.
MESSAGE_LIMIT300Default limit for message is 300 and max limit is 2000
PHONE_PREFIX
Prefix for the phone number used as country code