Bot Connector Configuration Guide
This Bot Connector can be configured to run in integration with any of the following bots.
- Rasa Core
- Botfront
- Articulate
- Dialogflow
Environment Variables
Config Parameter | Expected Value | Description |
|---|---|---|
CHAT_SERVER_URL | This is the chat docker-service URL. | |
| FILE_ENGINE_URL | https://{FQDN}/file-engine | This is the file engine url to upload the files |
| CHANNEL_BOT_MAPPING | web:BOT_1, whatsapp: BOT_2, facebook: BOT_3 | A multiple key-value pair set where the key is the channel type and the value is the Bot number. |
| BOT_NAME | EF Bot | When the Bot joins a conversation, this is the name displayed on the customer gadget as the Bot's display name. The default value is EF Bot. It can be any alphanumeric string. |
CONNECTOR_ID | bot | This is Bot Connector ID which is used to register Bot Connector with Chat Server. Do not change this value |
AMQ_PRIM | activemq | ActiveMQ primary FQDN |
| AMQ_SEC | activemq | ActiveMQ secondary FQDN |
| AMQ_TLS_ENABLED | true | This configuration specifies STOMP TLS connection with ActiveMQ |
| AMQ_CRED_PRIM | admin:admin | Primary ActiveMQ REST API credentials |
| AMQ_CRED_SEC | admin:admin | Secondary ActiveMQ REST API credentials |
| AMQ_CONSUMER_PRIORITY | 100 | Do not change, this value is used to select master or slave when deployed in High Availability Mode. This configuration is automatically set by deployment scripts. |
| CERTIFICATE_PATH | https_things/localhost.key | Reporting Connector certificate file path. This certificate is presented by Reporting Connector to clients when ENABLE_HTTPS is true. |
| CERTIFICATE_KEY_PATH | https_things/localhost.key | Corresponding certificate key file of certificate specified in CERTIFICATE_PATH. |
| CERTIFICATE_AUTHORITY_PATH | https_things/chat-server.ca-bundle | Certificate authority file path for Reporting Connector. |
| CERTIFICATE_AUTHORITY_PASSPHRASE | password | Certificate passphrase for Reporting Connector certificate authority. |
ENABLE_REPORTING | false | Set to true if the reporting database is integrated. |
| DEFAULT_BOT | BOT_{n} | The bot that will be used if no bot match found in channel-bot-mapping. |
| BOT_{n}_ID | bot | The Bot id of this Bot needs to be updated in chat environment variables if modified. |
BOT_{n}_TYPE | Rasa | Set the value Rasa when Rasa Core is used. The value is case insensitive. |
BOT_{n}_API_URL | Only for ARTICULATE and RASA URL of Rasa Core/Articulate on which it is listening | |
BOT_{n}_TIMEOUT | 10 | Only for ARTICULATE and RASA This is the HTTP request timeout in seconds the Bot-connector awaits for a response from the Rasa bot. |
| BOT_{n}_BOOTSTRAP | false | Only for ARTICULATE
The values are case sensitive. |
| BOT_{n}_CONFIG_FILE | agent-config.json | Only for ARTICULATE The file name in which Bot configurations are defined. The default value is agent-config.json. |
| BOT_{n}_PROJECT_ID | english2-737d6 | Only for DIALOGFLOW Once you have created DialogFlow Agent, specify the Project ID against this attribute. In DialogFlow, you can find it under DialogFlow Agent Settings. The Project_ID is necessary in order to get the authentication and get access to the Dialogflow libraries. |
| BOT_{n}_KEY_FILE | dialogflow-keyfile.json | Only for DIALOGFLOW Dialogflow key file name. The default value is dialogflow-keyfile.json. |
Integration with Articulate
To access KB UI, you need to access this URL https://<machine-ip>:8282/
Volumes
The path of volume should be ${PWD}/docker/config/bot-connector/agent-config:/usr/src/app/agent-config. In agent-config folder place the agent configuration file (like agent-config.json), and mention your agent configuration file name in the BOT_{n}_CONFIG_FILE environment variable.
This file contains the settings of Articulate agents and is used to create Bot based on language. If a new Bot needs to be created then we will add the configuration in this file and set the BOT_{n}_BOOTSTRAP environment variable to true. A sample config file is available here.
Please note that the name of the agent configuration file MUST be matched with the value of the BOT_{n}_CONFIG_FILE environment variable.
Integration with Dialogflow
To integrate with DialogFlow, you should have a DialogFlow subscription. Get started following DialogFlow getting-started guide.
Volumes
The path of volume should be ${PWD}/docker/config/bot-connector/dialogflow-key:/usr/src/app/dialogflow-key. In the dialogflow-key folder, place the key file which you can get from the Dialogflow account, and mention your key file name in the BOT_{n}_KEY_FILE environment variable.
Follow this guide to get this key file. This file contains the authentication settings used to authenticate your Dialogflow client library with google.
Please note that the name of the key file MUST be matched with the value of the BOT_{n}_KEY_FILE environment variable.
Limitations
If customer enter the HANDOFF_INTENT intent (/human) in chat during the post-chat survey, the chat-server automatically reroute the chat to agents. But agents unable to accept this rerouted chat and customer unable to receive bot responses.