Customer Gadget Environment Variables_DEPRECATED
DEPRECATED
Please check the latest configurations on Web-chat
Following are the environment variables used in the customer-gadget service.
Config Parameter | Expected Value | Notes |
|---|---|---|
SERVER_URL | This is the chat server URL. | |
SOCKET_URL | https://qa.ef.com | Host machine FQDN. Only used when the reverse proxy is in place. Same as SERVER_PUBLIC_URL otherwise. |
LANGUAGES | "en:English,fr:French,ar:Arabic" | List of supported languages and codes. |
DEFAULT_LANGUAGE | en | The default language is used when unable to read browser language. |
INACTIVITY_TIMEOUT | 300 | Value is in seconds Customer is notified once the inactivity time reached. |
INACTIVITY_RETRIES | 3 | These are max retries, once customer is notified equal to NO_OF_RETRIES, the chat is automatically closed. |
IS_INTEGRATED | true/false | If customer gadget is integrated in another site than value is set to ‘true’ Otherwise the value is set to ‘false’. |
CERTIFICATE_PATH | /usr/src/app/https/localhost.cert | Path of certificate for HTTPS. |
CERTIFICATE_KEY_PATH | /usr/src/app/https/localhost.key | Path of the certificate key file for HTTPS. |
THEME | orange-theme | Default value is orange-theme Allowed values are orange-theme, green-theme,yellow-theme,purple-theme, light-blue-theme, carrot-theme,blue-theme. |
| AGENT_AVAILABILITY_TIMEOUT | 900 | value is in seconds In case of no agent available, the chat is auto-ended once this timeout expires AGENT_AVAILABILITY_TIMEOUT must be less than INACTIVITY_TIMEOUT. |
| WORKING_HOURS_ENABLED | true/false | This configuration is used to enable/disable open working hours. |
| WORKING_HOURS_URL | Fully qualified domain name of the host machine where UMM is deployed. The agent availability calendar is accessible via UMM. | |
| WORKING_HOURS_AGENCY | expertflow | Name of calendar agency where Agent availability is configured. For more info, please refer to Supervisor Tools User Guide. |
| EWT_URL | 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_TIME | 30 | Estimated wait time poll interval in seconds. |
| EWT_MIN_TIME | 120 | Minimum time to wait to show the customer. |
| EWT_MAX_TIME | 600 | Maximum time to wait to show customer. |
| EWT_MAX_POSITION | 10 | Max 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_URL | https://qa.ef.com/file-engine | File server url to send / receive attachments. |
| CUSTOMER_GADGET_URL | This is the customer gadget URL. | |
| CALLBACK_URL | https://qa.ef.com/ecm | This the URL required to generate a callback. |
| MESSAGE_LIMIT | 300 | The default limit for the message is 300 and the max limit is 2000. |
| PHONE_PREFIX | Prefix for the phone number used as country code. | |
| CHAR_TRANSCRIPT | true/false | This configuration is used to enable or disable chat transcript. |
| ENABLE_FILE_SENDING | true/false | This configuration is used to enable disable file sending option. |
| FONT_RESIZE_ENABLED | true/false | If set to true, the user can change font size up to 3 levels. |
| ENABLE_HYPERLINKS | true/false | If set to false, hyperlinks won't work, default is true. |
ENABLE_EMOJI V3.12.2 | true/false | This configuration is used to enable or disable chat emoji. |
ENABLE_CLOSE_CHAT_NOTIF V3.12.2 | true/false | It enables or disables the notification for the chat to close. |
ENABLE_NOTIFICATION V3.12.2 | true/false | Enables or disables all kinds of chat notifications. |
SHOW_CUSTOMER_AVATAR V3.12.2 | true/false | 'True' enables the customer avatar, whereas the 'false' value disables the avatar. |