Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Navigating the XO Platform
Building a Virtual Assistant
Help & Learning Resources
Release Notes
Current Version
Recent Updates
Previous Versions
Request a Feature
Conversation Designer
Dialog Tasks
Mock Scenes
Dialog Tasks
Navigate Dialog Tasks
Build Dialog Tasks
Node Types
Intent Node
Dialog Node
Dynamic Intent Node
GenAI Node
GenAI Prompt
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections
Node Connections Setup
Sub-Intent Scoping
Entity Types
Entity Rules
User Prompts or Messages
Voice Call Properties
Knowledge AI
Knowledge Graph
Build a Knowledge Graph
Manage FAQs
Knowledge Extraction
Import or Export Knowledge Graph
Prepare Data for Import
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Knowledge Graph Analysis
Answer from Documents
Alert Tasks
Small Talk
Digital Skills
Digital Forms
Digital Views
Session and Context Variables
Context Object
Intent Discovery
NLP Optimization
ML Engine
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
LLM and Generative AI
Event Handlers
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Default Standard Responses
Ignore Words & Field Memory
Test & Debug
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Conversation Testing Overview
Create a Test Suite
Test Editor
Test Case Assertion
Test Case Execution Summary
Health and Monitoring
NLP Health
Flow Health
Actions Overview
Azure OpenAI
Google Maps
Microsoft Graph
Open AI
Agent Transfer Overview
Custom (BotKit)
NiceInContact(User Hub)
External NLU Adapters
Dialogflow Engine
Test and Debug
Dashboard Filters
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Custom Meta Tags
Create Custom Dashboard
Create Custom Dashboard Filters
NLP Insights
Conversations History
Conversation Flows
Conversation Insights
Feedback Analytics
Usage Metrics
Containment Metrics
Universal Bots
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Manage Assistant
Team Collaboration
Plan & Usage
Usage Plans
Support Plans
Conversation Sessions
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Feedback Survey
Masking PII Details
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data Table
Table Views
App Definitions
Data as Service
Build a Travel Planning Assistant
Travel Assistant Overview
Create a Travel Virtual Assistant
Design Conversation Skills
Create an ‘Update Booking’ Task
Create a Change Flight Task
Build a Knowledge Graph
Schedule a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Train the Assistant
Use Traits
Use Patterns
Manage Context Switching
Deploy the Assistant
Use Bot Functions
Use Content Variables
Use Global Variables
Use Web SDK
Build a Banking Assistant
Design Conversation Skills
Create a Sample Banking Assistant
Create a Transfer Funds Task
Create a Update Balance Task
Create a Knowledge Graph
Set Up a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Add Data to Data Tables
Update Data in Data Tables
Add Data from Digital Forms
Train the Assistant
Composite Entities
Use Traits
Use Patterns for Intents & Entities
Manage Context Switching
Deploy the Assistant
Configure an Agent Transfer
Use Assistant Functions
Use Content Variables
Use Global Variables
Intent Scoping using Group Node
Analyze the Assistant
Create a Custom Dashboard
Use Custom Meta Tags in Filters
Migrate External Bots
Google Dialogflow Bot
API Reference
API Introduction
API List
API Collection
koreUtil Libraries
SDK Reference
SDK Introduction
SDK Security
SDK Registration
Web Socket Connect and RTM
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
SDK Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
Widget SDK Tutorial
Web SDK Tutorial
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Data Tables and Views
Assistant Management
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Control
Using Single-Sign On (SSO)
Two-Factor Authentication (2FA)
Security Settings
Cloud Connector
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Bot Administration
  5. Security & Compliance
  6. Connector Connector

On the Connector page, in the Security & Control module of the Bots Admin Console, you can download and configure the Connector Agent for Bots within your secure company intranet to provide secure communications between the Bots platform in the cloud and your network.

Why Connector? Bots are designed to make updates, provide notifications to users, and perform tasks. The tasks to perform are received from or performed on third-party applications available over the Internet as web-based applications or on-premises bots applications.

In a bots on-premises system, communications security is maintained by restricting users and systems within the company intranet or by configuring specific channels for specific data exchange. On the contrary, Bots reside and process data in the cloud environment and cannot directly connect to your bots premises applications.

You can use the Connector Agent to establish and maintain secure data connectivity between and your on-premises applications within your intranet.

The Connector is a stand-alone application that is installed and configured within your company intranet configured with restricted and secure connectivity to specified bots applications. The Connector Agent is designed to pass requests for data access between your on-premises applications and to process the specific Bot tasks configured by an end-user with rights and privileges for those applications.

The following illustration shows the Connector page in the Bots Admin Console Security & Control module. Connector Page Controls

The following controls are available on the Connector page in the Bots Admin Console.

Download Connector – Click the Download Connector drop-down arrow in and then select one of the following operating systems:

  • Windows Based
  • Unix/Linux Based

Download the Connector Agent to your default browser downloads directory. Install the agent in your DMZ or Intranet. For more information, see Installing the Connector Agent.

Add Connector – Click to add up to two connectors. After a connector is added, you should install and configure the Connector Agent.

Actions Menu – On the Connector page, against each added connector, click the Ellipsis  icon to display the Actions menu to run the following commands:

  • Instructions – Displays the Connector Instructions dialog that describes the overall steps to install and configure the Connector Agent.
  • Edit – Displays the Connector Details dialog that shows the Connector name, description, ID, status as CONNECTED or DISCONNECTED, and Last Connected date.
  • Generate Certificate – Displays the Generate Signed Certificate dialog used to create a .pem file for security along with instructions on how to create the file. For more information, see Installing the Connector Agent.
  • Enable/Disable – Click to show the Are you sure you want to enable this connector? dialog. Click Continue to enable the connector. When enabling a connector, any other enabled instances of the Connector Agent are disabled.
  • Delete – Click to display the Delete Connector dialog. To permanently delete the connector, click Confirm.


The Connector is an agent that runs behind your bots firewall within your company Intranet or perimeter network (DMZ) to provide secure data exchange between which operates in the cloud and your on-premises applications.

In the following diagram, end-users configure a Bot that connects to in the cloud. The Bot servers (5) contact the Connector Gateway (2) with the Bot request. The Connector Gateway relays the request to the Connector (3) installed and securely configured in your on-premises Intranet or DMZ to interact with your bots applications. The response from your applications is sent through the Connector back out to the cloud and processed. Optionally, you can enable your on-premises applications to push data, for example, alert messages, to the cloud using webhooks.


How it Works

After you install the Connector in your network, you configure the agent with details to specifically access, communicate, and request or post data to the bots application you define.

When started, the Connector Agent initiates a persistent SSL connection with and monitors requests for data transfer to or from your bots applications and If the persistent connection is broken, the Connector automatically attempts to reestablish communication. You can monitor connectivity directly in the Bots Admin console.


This topic describes how to install and configure the Connector Agent for Bots that you can use to securely connect the cloud-based Bots platform to your on-premises applications in your company Intranet.


To install the Connector, you should review the following hardware and software requirements.

Hardware Requirements

The server hosting the Connector Agent should have:
CPU Core: 8
Hard disk space: 10 GB – To support the following:

  • Connector download – 10MB
  • Installation Files – 20MB
  • Logging and Configuration Files – < 5GB

Software Requirements

The Connector supports both Windows and Linux operating systems as follows:


The following Red Hat® Enterprise Linux® versions are supported:

  • RHEL 5 (32-bit and 64-bit)
  • RHEL 6 (32-bit and 64-bit)
  • RHEL 7 (64-bit)

The following CentOS versions are supported:

  • CentOS 5 (32-bit and 64-bit)
  • CentOS 6 (32-bit and 64-bit)
  • CentOS 7 (64-bit)

Node.js (version 10 or higher) – Required to run the Connector Agent. Download and install from on the server where the Connector Agent is installed.


The following Microsoft Windows 64-bit operating systems are supported:

  • Windows 7 (64-bit)
  • Windows 8.1 (64-bit)
  • Windows 10 (64-bit)
  • Windows Server 2008 R2 (64-bit)
  • Windows Server 2012 (64-bit)
  • Windows Server 2012 R2 (64-bit)

Node.js – Required to run the Connector Agent. Download and install from (version 10 or higher) on the server where the Connector Agent is installed. In addition, you must also install the forever module. After node.js is installed, run the following command to install the forever module.
npm  install forever -g

Installation Process

This section describes the installation and configuration of your application server where the Connector Agent is installed, the configuration required in the Bots Admin Console, and finally, enabling enterprise Bots for the Connector Agent and deploying the upgraded Bots for enterprise users.


In the Bots Admin Console, you begin by adding a connector. When you add a connection, a unique ID is created for your company and your unique Connector.

  1. In the Bots Admin Console, in the Security & Control module, on the Connector page, click Add Connector. The Add Connector dialog is displayed.
  2. Optionally, in the first field, edit the name of the connector, and then enter a Description for the connector in the second field.
  3. Click Add. The Connector Instructions dialog is displayed as shown in the following illustration.
    Bots Admin Security Module Connector Instructions Dialog
  4. In the Connector Instructions dialog, click OK. The Connector page is displayed.
  5. In the Download Connector drop-down list, select you operating system and download the Connector Agent compressed file, one of:
    1. Linux/Unix – kore-connector-1.0.0.tar.gz
    2. Windows –
  6. Copy, and then uncompress the file to your application server.
    1. For Linux, use the following command:
      tar -xvf kore-connector-X.X.X.tar.gz
    2. For Windows, in File Explorer, right-click the file and select Extract to on the command menu.

The Connector Agent file is uncompressed into the following directory structure. Connector Directories

Generating a Signed Security Certificate

For secure data exchange between the servers in the cloud and your intranet, you need to generate a signed security certificate. First, create a .csr file on your application server using the command displayed in the Bots Admin Console, and then paste the content of the .csr file into the Generate Signed Certificate dialog. The .csr content is used to generate and download the .pem file. You will then copy the .pem file back to the Connector Agent installed on your application server.

  1. In the Bots Admin Console, in the Security & Control module, on the Connector page, click the Ellipsis  icon.
  2. On the Actions menu, click Generate Certificate. The Generate Signed Certificate dialog is displayed as shown in the following illustration.
  3. Review the instructions, and then copy your custom command displayed after step 6 in the instructions as shown in the following illustration.
  4. Paste and run the command on your application server within your company intranet in the /Credentials directory created when you installed the Connector Agent.
  5. In the /Credentials directory, the Kore.aiConnector.csr file is created, along with the Kore.aiConnector.key file. Open the Kore.aiConnector.csr file using a text editor, and copy the entire contents of the file, and then paste the contents into the Certificate signing request field in the Generate Signed Certificate dialog as shown in the following illustration.
  6. Click Generate. The Download Certificate and View Certificate buttons are displayed.
  7. Click Download Certificate. The Kore.aiConnectorCert.pem file is downloaded to your local computer browser default downloads folder.
  8. Copy the Kore.aiConnectorCert.pem file to the /Credentials folder created when you installed the Connector on your application server.

Your security files are in-place on the application server.


After you install the Connector Agent software, you must verify or set the properties for:

  • Certificate Information – See credentials in the connectorconfig.json file.
  • Log Directories – See logger in the connectorconfig.json file.
  • Cluster Environment – See cluster in the connectorconfig.json file.
  • Proxy Control for Outbound Connections – See tunnel in the connectorconfig.json file.
  • Access Control for Enterprise Applications – See the accesscontrol.json file.

Default Configuration Settings – connectorconfig.json

This section shows the default configuration settings for certificate information, logging, and cluster mode settings in the < Connector agent Installation Path >/config/connectorconfig.json file:


Certificate Information

You may want to store the security keys for the Connector Agent in another location other than the installation directory for the Connector Agent. You can move the credential files to another directory on the application server or another server in the network and specify the relative or absolute path in the credentials section in the connectorconfig.json file that contains the following parameters:

  • key – The client certificate. Default setting is:
  • cert – The .pem file generated in the Bots Admin Console. Default setting is:
  • ca –  Installed as part of the Connector Agent. Default setting is:

Logging Configuration

The Connector Agent generates two logging files at runtime:

  • kore-connector.log.< dd-MM-yyyy > – Application logging events to include:
    • Connector status – Any change in status such as agent start or stop is added as a log entry.
    • Errors – Any error message for the agent is captured in the app.log file.
  • kore-connector-audit.log.< dd-MM-yyyy > – Audit logging events.
    • Configuration changes – Any changes in connectorconfig.json file and accesscontrol.json file. The original file is backed up automatically and a log entry is made.
    • Requested URLs – All requested URLs coming into the Connector are captured as a log entry.

By default, logging files for the application and auditing logs are created and stored in the default installation pat in the < Connector Agent Installation Path >/logs and < Connector Agent Installation Path >/audits. You can specify another directory on the application server or another server in the network and specify the full path.
You can also increase or decrease the logging levels as needed for either logging file as:

  • fatal – Any error that is forcing a shutdown of the service or application to prevent data loss or further data loss. Occurs only once in a process and is usually the last entry in a log.
  • critical – An error which requires immediate investigation that has not yet shut down a service or application, but is likely to do so.
  • error – Any error which is fatal to the current operation but not fatal to the service or application, for example, cannot open a file, missing file, or missing data. This type of errors usually requires administrator intervention.
  • warn – Anything that can potentially cause application abnormalities with the ability to recover, for example, switching from a primary to backup server, retrying, or missing secondary data.
  • info – General information about normal application operations such as start and planning stopping of service, configuration assumptions, and so forth. This is the default setting for the Connector Agent.
  • debug – Diagnostic information, usually for system administrators and IT personnel.
  • trace – All operational information, for example, parts of a function.

Each log level below fatal includes the information from any logging level above. For example, the default level as info includes all the information for fatal, critical, error, warn, and info in the log file.

Scalability and Cluster Configuration

The Connector Agent is scalable to handle the request load as required. When you install the Connector Agent, cluster mode settings are enabled by default, with 2 workers, or CPUs, set for use.

For increased load handling for requests by the Connector Agent, you may want to enable more workers. If you do not want to use cluster mode, set the “enabled” property to false.

You can also run cloud connectors in more than one server to meet failover as well as scalability requirements. Certificate and other configurations will remain same. Cloud Connector is a client which makes outboud connection to Cloud Gateway. When more than one connectors are connected, Cloud Gateway will distribute the load to the connectors.

Proxy Control for Outbound Connections

You can configure outbound proxy settings for the Connector Agent in the < Connector agent Installation Path >/config/connectorconfig.json file. This configuration is optional unless all of your outbound data is routed through a proxy server.
To configure outbound proxy settings, add the following configuration shown as the entry labeled tunnel in the following configuration sample:


Access Control for Applications

The Connector Agent requires an explicit set of white-listed URLs to access specific applications on your company intranet. Any other HTTP requests are denied by the Connector.
You must configure access control for each bot application that will use the Connector Agent in the accesscontrol.json file in the Connector installation directory in the …/config/configs directory with the following parameters:

  • virtualhost – Specify the virtual host name exactly as specified in the Request URL property in the Set Up Request Chain dialog while configuring on-premises bots in the Bot Builder tool. For more information, see Defining a Request Chain Object in the Bot Builder documentation.
  • virtualport – Specify the virtual port exactly as specified in the Request URL property in the Set Up Request Chain dialog while configuring on-premises bots in the Bot Builder tool. For more information, see Defining a Request Chain Object in the Bot Builder documentation.
  • internalhost – Specify the actual host name of the on-premises enterprise application used for data exchange with your Bots.
  • internalport – Specify the actual port of the on-premises enterprise application used for data exchange with your Bots.
  • protocol – Specify HTTP or HTTPS for the connection to on-premises enterprise applications.
  • allowedPaths – Specify all paths as “/*” or a specific array of paths for the host, not to include any parameters. The Connector checks the path up to, but not including parameters beginning with ” ?

The following image is an example of a configured accesscontrol.json file with four Bot configurations.

Note: Comments cannot be used in configuration files.


This section describes how to start or stop the Connector Agent on Windows or Linux operating systems.

Linux/Unix Operating Systems

On Linux operating systems, you can manually start the Connector Agent, or configure the Connector Agent to autostart on boot.

Manually Starting/Stopping the Connector on Linux

Manually start or stop the Connector Agent on the Linux/Unit application server by running the following commands in the Connector installation directory, and check the status as follows:

./ start
./ stop    
./ status

The following image shows the response for a successful start and status check of the Connector.

Configuring Connector for Autostart on Linux

This section describes how to set the Connector Agent to automatically start when the Linux server is started or rebooted.

  • To configure the autostart for the Connector Agent, on the application server, in the /etc/rc.local file, add the following command:
    cd < Connector&nbsp;Installation Root> ; ./ start

    For example:

    cd /home/CompanyAdmin/kore-connector ; ./ start

Windows Operating Systems

On Windows operating systems, you can manually start or stop the Connector Agent, and check the status of the Connector Agent.

Manually Starting/Stopping the Connector on Windows

Manually start or stop the Connector Agent on the Windows application server by running the following commands in the Connector installation directory, and check the status as follows:

.\koreconnector.cmd start
.\koreconnector.cmd stop    
.\koreconnector.cmd status

Enabling Bots 

In this section, you can verify the connection to the Connector Agent in the Bots Admin Console, and then enable the connection. When the connection is enabled, you can modify your custom Bots in the Bot Builder tool to use the Connector, publish those Bots, and then in the Bots Admin Console, deploy the published Bots and assign the Bots to users in your company.

  1. In the Bots Admin Console, in the Security & Control module, on the Connector page, verify the Connector status as CONNECTED, click the Ellipsis icon, and then on the Actions menu, click Enable as shown in the following illustration.
  2. In Bot Builder, for each Bot task that you want to run using the Connector, clone or upgrade each Bot.
    1. In the Set up Request Chain Object dialog, select Access using connector, save the changes, and then publish the Bot. For more information about configuring the request object, see Configuring an Alert Task Request Object or  Configuring an Action Task Request Object in the Bot Builder tool documentation.

      Note: The option in the Set up Request Chain Object dialog for Access using connector is only available after the connector is enabled in the Bots Admin Console.

  3. In the Bots Admin Console, deploy the published Bot and assign the users that can use the Bot tasks in your enterprise. For more information, see Bot Management.

After the Connector is installed on your application server, enabled in Bots Admin Console, and your Bots customized to use the connector, you only need to monitor the status of your connector in the Bots Admin Console.
If you cannot start the Connector, or customers are reporting errors, you may need to reconfigure Connector settings.


Installing and configuring the Connector Agent involves many steps. And even after installation, you may need additional configuration to maintain connectivity between Bots and your on-premises applications. This topic describes some of the typical issues that may arise, and how to handle those issues. Connect Agent Server Issues Connector Fails to Start

Log Error Message: TypeError: Object #<Object> has no method ‘parse’
Solution: The server may have multiple node.js installations with different versions. You may need to specify which node.js version to run.
To check for versions, run the following command:
nvm list
This command may return:

To set the version to use, run the following command:
nvm use v4.0.0
The command should return:
Now using node v4.0.0

Client Issues

Users in your organization may experience connectivity issues with the Connector.

  • Error Message: “< Enterprise application >” is not reachable. Unable to communicate with the connector. Please try again.
    • Solution: The “virtualhost” entry in the Connector Install Dir >/config/configs/accesscontrol.json file is not defined, or is incorrectly configured. Verify the entry.
  • Error Message: The server returned an error. Try again later. (404 – System not reachable). 
    • Solution: Connectivity between the Connector on your application server and the Gateway is broken. The Connector Agent may have stopped running. You may need to restart the Connector on the application server.

If you cannot resolve your issue, contact Support.

Responsive Menu
Add more content here...
Responsive Menu
Add more content here...