Jump to: navigation, search


Section: channel-chatbot
Default Value: 10
Valid Values: Any integer from 0-86400
Changes Take Effect: Immediately for new connections

Specifies the delay between attempts when Bot Gateway Server tries to reconnect the bot to the chat session when there is a Chat Server disconnect.


Section: channel-chatbot
Default Value: 15
Valid Values: Any integer from 0-1000000
Changes Take Effect: Immediately for new connections

Specifies how many times Bot Gateway Server tries to reconnect the bot to the chat session when there is a Chat Server disconnect.

How to deploy Bot Gateway Server


Compatibility matrix

Component Prerequisites
Chat Server Min version or higher is required.
Digital Messaging Server (DMS)
  • For BGS, required version of DMS is
  • For BGS, required version of DMS is
Genesys Mobile Services (GMS)
  • Basic functionality (in other words, plain text messages) is supported the same way as a regular web chat.
  • Rich Media is supported from version and higher.
  • Basic functionality (in other words, plain text messages) is supported the same way as a regular web chat.
  • Rich Media support must be tracked by the Widgets Release Notes.
Workspace Desktop Edition (WDE)
  • Min version or higher is required.
  • A special icon for bot participant is supported from version or higher.

Rich Media:


  1. Install the Bot Gateway Server either by manual installation of the IP or via the GAX deployment procedure. During the installation, you'll need to select the previously installed dedicated instance of DMS. The content of the IP will be installed in the folder media-channel-drivers\channel-chatbot.
  2. In Interaction Server application, add DMS application to connections tab.
  3. Using GAX, do the following in the DMS Application object:
    1. Add connection to the following applications:
      1. Interaction Server (required for core functionality)
      2. Universal Contact Server (required for API methods for file attachments and structured messages only).
        Note: If you decide not to use these methods and not connect DMS to Universal Contact Server, you must set ucs-in-use to false.
    2. In the Application Options tab:
      1. Remove the following sections: [channel-any_name], [channel-any_name-monitor-any_name], and [endpoints:tenant_dbid].
      2. Import options from the file BotGatewayServer.cfg (located in the media-channel-drivers\channel-chatbot\options subfolder in the DMS installation folder). You must de-select the check box Overwrite existing options. This step adds sections [channel-chatbot], [channel-chatbot-monitor-addp], and [channel-chatbot-monitor-tls].
      3. In section [channel-chatbot], set the correct value for option tenant-dbid (for example, tenant-dbid=1).
      4. In section [log], add new option log4j2-config-profile with value log4j2.xml (if it doesn't already exist).
    3. Start DMS and observe logs. The following log message indicates success: Std 42111 (ChannelConnectors).(configure): channel initialized - channel-chatbot.
    4. Important
      Please note that while some configuration options which are applicable to new chat session can be updated during runtime, it is generally recommended to restart DMS upon application configuration changes.

How to uninstall or upgrade BGS

To uninstall or upgrade BGS, do the following:

  1. Backup the content of the folder “media-channel-drivers\channel-chatbot\bots-repo”.
  2. Stop the DMS/BGS application. This can be done via GAX (on Windows it can be done via Services).
  3. Uninstall the BGS application:
    • On Windows through Control Panel > Programs and Features.
    • On Linux by running the ./uninstall.sh, script from the "media-channel-drivers\channel-chatbot\uninstall" folder.
  4. Verify that the folder “media-channel-drivers\channel-chatbot" was removed.
  5. Install the new version of BGS and populate the folder “media-channel-drivers\channel-chatbot\bots-repo” from your backup.
  6. Start the DMS/BGS application.

How to test BGS

To test BGS, complete the following steps:

  1. Activate the preinstalled EchoBot:
    1. In the Application Options tab of the DMS Application object, add the section [channel-chatbot-monitor-bots] and option EchoBot.jar={}.
    2. Restart the DMS application.
      Note: Several other bot samples are provided. You can find out how to deploy and use these other sample bots by reading the "readme.txt" file located in "media-channel-drivers\channel-chatbot\samples\demo" of the DMS installation folder.
  2. Deploy the sample workflow (located in the subfolder media-channel-drivers\channel-chatbot\workflow in the DMS installation folder):
    1. Import the business process:
      • either from ChatBotsGoBP.wie (require IRD and URS). Activate strategies.
      • or from ChatBotsGo.zip (requires Composer and ORS). Run Generate All (ignore the error against "RESTProxy.jsp").
    2. If you have more than one DMS instance running (and configured in connections of Interaction Server application), you need to select your Bot Gateway Server application in the External Service block which starts the bot (located in Start strategy).
  1. Launch the Chat Widget with the following userdata:
    { ChatBotID: "EchoBot"
    , ChatBotName: "EchoBot"
    , ChatBotHoldup: "false"
    , StopBotOnAgentArrival: "false"
    , StopBotOnCustomerLeft : "false"
    , Visibility : "ALL"
    , Nickname : "Demo Echo Bot"
    , _umsChannel : "channel-chatbot"
  2. As soon as the chat session starts in the Chat Widget, EchoBot connects and it echos every posted message into the chat session. You can stop EchoBot by sending one of the following texts in the chat session:
  3. Note: In waiting mode (in other words, when ChatBotHoldup=true), with default configuration of holdup-attribute-name (which is “ScheduledAt”) Bot Gateway Server relies on the scheduled interactions functionality of Interaction Server. If this conflicts with your workflow logic, you can set holdup-attribute-name to another value. In this case you will need:

  • To modify Interaction Server database schema and create correspondeing interaction custom property of type “timestamp” (refer to Custom Properties in the eServices Interaction Properties Reference Manual).
  • To specify view condition in “Waiting” queue instead of using “Scheduling” (which then must be set to “Ignore Scheduling”).

High availability and sizing guidelines

For High Availability (HA) support, no special configuration on BGS side is required, unless you need to define a different chat session reconnect schedule with configuration options ha-chat-reconnecting-attempts and ha-chat-reconnecting-delay. BGS supports the automatic (seamless) reconnection to the chat session in case of a Chat Server failure, and it also handles the reconnection to Interaction Server and UCS (the later is needed only for Rich Media and attachments functionality). In order for the reconnection to Interaction Server and UCS to be enabled, these applications must be configured with a primary/backup pair. Genesys recommends deploying HA for Chat Server in N+1 (load-balancing) mode, along with adjusting a few configuration options as described in the topic, Configure Chat Server for HA.

For BGS, the following performance benchmarks were obtained on hardware with "Intel Xeon E7-8880L 2 GHz" and a single instance of Bot Gateway Server. The average length of a chat session was around 55 seconds (with 5 short messages from a customer and 5 short messages from an agent), which is a quite dense scenario. A single instance of BGS was capable of maintaining around 3000 concurrent bot sessions while consuming about 2 CPU cores and 3 GB of RAM. With this given scenario, on-average about 50 new bots started every second.

Configure secure and ADDP connections

You can configure the following secure and ADDP connections:

Connection Configuration
  • DMS to Configuration Server
  • DMS to Message Server
  • DMS to Interaction Server
  • DMS to Universal Contact Server
  • Interaction Server to DMS
Use standard Genesys approach to provide TLS configuration on hosts, applications, ports, and ADDP parameters in connections
DMS/BGS to Chat Server Use a special approach described below.

Secure connection to Chat server

When connecting a bot instance to a chat session, Bot Gateway Server connects to the host/port which is specified in the userdata of the interaction as ChatServerHost/ChatServerPort. If a port is configured as secure, Chat Server also attaches ChatServerConnType=tls. When Bot Gateway Server detects this property in the userdata, it tries to establish a secure connection. To configure these secure connections, you need to use section [channel-chatbot-monitor-tls] of the DMS application:

  1. Set option provider to a desired security provider (see description of options for more information). By default, a provider is set to ANY, which will allow you to establish a secure connection without using any certificate. This mode is recommended for testing purposes only.
  2. Configure option trusted-ca with corresponding certificate.
  3. Review and configure (if needed) all other options in this section.

ADDP connection to Chat server

Use section [channel-chatbot-monitor-addp] in order to configure ADDP connection to Chat Server.

Enable Reporting for BGS

Genesys Historical Reporting Solution provides reports about chat bots that are run by BGS. The reporting solution consumes reporting data from BGS via Kafka integration. For full information, see Integrating BGS with Genesys Historical Reporting.

This page was last modified on July 26, 2019, at 07:09.


Comment on this article:

blog comments powered by Disqus