Customer Gadget Environment Variables

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

Config Parameter

Expected Value

Notes

SERVER_PUBLIC_URL

https://<FQDN>/chat

This is chat server url.

PORT

For http 8080

or

For https 8443

This is default port, do not change it

LANGUAGES

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

List of supported languages and codes

DEFAULT_LANG

Language code i.e. en etc

Default language is used when unable to read browser language

INACTIVITY_TIMEOUT

3

Value is in minutes

Customer is notified once inactivity time reached.

NO_OF_RETRIES

3

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

INACTIVITY_MESSAGE

text

On INACTIVITY_TIMEOUT, customer receives this message

SUBJECT_LIST

"Mobile,Fixed,Fibre,Optic,ADSL"

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

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

CALLBACK_ENABLED

true/false

If callback is enable value is set to ‘true’

If callback is not enabled value is set to ‘false’

CALLBACK_URL

https://<fqdn>/ecm

URL of ECM backend

SKILLGROUPS

"97:Mobile,97:Fixed”

Id is used as campaignId for ECM/callback

INTEGRATED_IN_CUSTOMER_SITE

true/false

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

Otherwise value is set to ‘false’

ENABLE_HTTPS

true/false

For running customer gadget over https, set value to ‘true’

For http set value to ‘false’

CERTIFICATE


Path of certificate for https

CERTIFICATE_KEY


Path of the certificate key file for https

PASS_PHRASE


Password for https certificates

HANDOFF_MESSAGE


This is error message, used in case of unable to initiate chat or unable to place callback request

THEME

skyblue

Default value is skyblue

Accepted values or skyblue, orange

AgentAvailibilityTimeout30

value is in seconds

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

AgentAvailibilityTimeout must be less than INACTIVITY_TIMEOUT

CALENDAR_API_URL

https://<fqdn>/umm

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

https://<fqdn>/mre

MRE url. 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.
EWT_DELAY3Estimated wait time poll interval in seconds
FILE_SERVER_URLhttps://<fqdn>/file-engine
File server url to send / receive attachments
PRODUCTIONtrue/falseconsole logs in browser's developer console will be suppressed if true.
SOCKET_URLhttps://<fqdn>Host machine FQDN. Only used when reverse proxy is in place. Same as SERVER_PUBLIC_URL otherwise
FIRSTNAME_ENABLEDtrueShow first name in customer gadget form
FIRSTNAME_MANDATORYtrueSet this field to mandatory / optional. Possible values are true / false.
LASTNAME_ENABLEDtrueShow this field in customer gadget
LASTNAME_MANDATORYtrueSet this filed to mandatory / optional. Possible values are true / false.
EMAIL_ENABLEDtrueShow this field in customer gagdet.
EMAIL_MANDATORYtrueSet email field to mandatory / optional. Possible values are true / false.
PHONE_COUNTRYCODE+92Phone number prefix. Can be left empty if no prefix is required
PHONE_INPUT_TYPEdropdownDropdown menu or input text field
GADGET_TYPEstandard/IAM