Chatbot Overview
Conversational Bots
Intents & Entities
Intelligent Bots
Kore.ai's Approach
Kore.ai Conversational Platform
Bot Concepts and Terminology
Natural Language Processing (NLP)
Bot Types
Bot Tasks
Starting with Kore.ai Platform
How to Access Bot Builder
Working with Kore.ai Bot Builder
Building your first Bot
Getting Started with Building Bots
Using the Dialog Builder Tool
Creating a Simple Bot
Release Notes
Latest Updates
Older Releases
Bot Builder
Creating a Bot
Design
Develop
Storyboard
Dialog Task
User Intent Node
Dialog Node
Entity Node
Supported Entity Types
Composite Entities
Supported Time Zones
Supported Colors
Supported Company Names
Message Nodes
Confirmation Nodes
Service Node
Custom Authentication
2-way SSL for Service nodes
Script Node
Agent Transfer Node
WebHook Node
Connections & Transitions
Managing Dialogs
Prompt Editor
Alert Tasks
Alert Tasks
Ignore Words and Field Memory
Digital Views
Knowledge Graph
Terminology
Building
Generation
Importing and Exporting
Analysis
Knowledge Extraction
Small Talk
Action & Information Task
Action Tasks
Information Tasks
Establishing Flows
Natural Language
Overview
Machine Learning
ML Model
Fundamental Meaning
NLP Settings and Guidelines
Knowledge Graph Training
Traits
Ranking and Resolver
NLP Detection
Bot Intelligence
Overview
Context Management
Session and Context Variables
Context Object
Dialog Management
Sub-Intents
Amend Entity
Multi-Intent Detection
Sentiment Management
Tone Analysis
Sentiment Management
Default Conversations
Default Standard Responses
Channel Enablement
Test & Debug
Talk to Bot
Utterance Testing
Batch Testing
Record Conversations
Publishing your Bot
Analyzing your Bot
Overview
Dashboard
Custom Dashboard
Conversation Flows
Bot Metrics
Advanced Topics
Bot Authorization
Language Management
Collaborative Development
IVR Integration
koreUtil Libraries
Universal Bots
Defining
Creating
Customizing
Enabling Languages
Smart Bots
Defining
Sample Bots
Github
Asana
Travel Planning
Flight Search
Event Based Bot Actions
Bot Settings
Bot Functions
General Settings
PII Settings
Customizing Error Messages
Bot Management
Using Bot Variables
API Guide
API Overview
API List
API Collection
SDKs
SDK Overview
SDK Security
SDK App Registration
Web SDK Tutorial
Message Formatting and Templates
Mobile SDK Push Notification
Widget SDK Tutorial
Widget SDK – Message Formatting and Templates
Web Socket Connect & RTM
Using the BotKit SDK
Installing
Configuring
Events
Functions
BotKit SDK Tutorial – Agent Transfer
BotKit SDK Tutorial – Flight Search Sample Bot
Using an External NLP Engine
Bot Administration
Bots Admin Console
Dashboard
User Management
Managing Users
Managing Groups
Managing Role
Bots Management
Enrollment
Inviting Users
Bulk Invites
Importing Users
Synchronizing Users from AD
Security & Compliance
Using Single Sign-On
Security Settings
Cloud Connector
Analytics
Billing
How Tos
Creating a Simple Bot
Creating a Banking Bot
Transfer Funds Task
Update Balance Task
Context Switching
Using Traits
Schedule a Smart Alert
Configuring Digital Views
Custom Dashboard
Custom Tags to filter Bot Metrics
Patterns for Intents & Entities
Build Knowledge Graph
Global Variables
Content Variables
Using Bot Functions
Configure Agent Transfer
  1. Home
  2. Docs
  3. Bots
  4. Bot Settings
  5. Bot Management
  6. Bot Management

Bot Management

The topics dealt with in this section include Importing and Exporting Bots, Deleting Bots, and viewing Bot change logs.

You might want to refer to Bot Variables and how these can be managed. Refer here for more.

Importing and Exporting Bots

Kore.ai allows you to export and import a bot’s tasks and associated configurations into another bot. This feature helps you in the migration of bot definition, cloning of bots, or for maintaining a periodic backup of bot definitions. It is particularly helpful to test various versions of your bot at different stages of the development process before it is released for end users. The articles in this section help you understand how the Export and Import features work and how to perform them.

Exporting a Bot

You can export a bot’s definition and configuration using the Export option. When you export a bot, it downloads a zipped file with the following:

  • botDefinition.json: Includes bot metadata, tasks, bot and task-level synonyms, utterances, patterns, knowledge graph, standard responses, flows, and IDPs. You can select specific items to export from bot tasks, NLP data – NLP settings, utterances, standard responses – and Settings – bot settings, variables, IVR settings- while exporting the bot.
  • config.json: Includes bot settings, bot variables, and IVR settings.
  • Icon.png: Includes the bot icon.
  • <Custom ScriptFile Name.js> (if available): Includes a script file with JavaScript functions. When you upload this file to a bot, you can access the functions in the file from anywhere in the bot.
Note: The bot and its components are given unique Reference IDs during export. These IDs help the platform to identify matching tasks in the target bot and update them.

Export Modes

You can export bots in two modes: Published and Latest Version. Depending on the mode that is selected, the corresponding versions of the bot tasks are exported. You can select specific bot components to export from the bot tasks, NLP data, and bot settings in both the modes. Further individual Bot Tasks can also be selected.

Published Mode

When you export a bot in the Published mode, only the published versions of the bot tasks are exported, regardless of any other existing versions. For example, if a bot consists of a published version of a task and also version in Upgrade in Progress, only the published version gets exported.

Refer to the table below to understand which versions of the tasks are exported in the Published mode:

Task Status
In Progress Not exported
If a task is in progress for development, it isn’t exported in the Published mode.
Configured Not exported
If the task configuration is complete but not published for use, it doesn’t get exported in the Published mode.
Published Exported
All published bot tasks get exported
Upgrade in Progress Not exported
Task upgrade configurations that are in progress do not get exported. Only the published configurations get exported.
Rejected Not exported
Task configurations rejected by admins do not get exported.
Suspended Not exported
Suspended tasks do not get exported.
Note: In Dialog tasks, only the nodes in the Published status get exported.
Latest Version

When you export a bot in the Latest mode, the latest versions of the bot tasks get exported, regardless of their publishing status. For example, if a bot consists of a published version of a task and also the version in Upgrade in Progress, the Upgrade in Progress version gets exported, whereas if it just has a Configured version, the configured version is exported.

Refer to the table below to understand which versions of the tasks are exported in the Latest mode:

Task Status
In Progress Exported if it is the only available version
Not Exported if a later version exists
Configured Exported if it is the only available version
Not Exported if a later version exists
Published Exported if it is the only available version
Not Exported if a later version exists
Upgrade in Progress Exported regardless of any other task version in the bot
Rejected Not exported
Task configurations rejected by admins do not get exported
Suspended Not exported
Suspended tasks do not get exported

Steps in Exporting the Bot

  1. Open the bot you want to export and on left navigation menu select Settings > Bot Management.
  2. Click Export Bot.
  3. In the Export Bot window, select either Published or Latest Version exporting mode.
  4. By default, all the bot items are selected for export. Deselect the items that you do not want to export.
  5. For Tasks, you can further choose to export only select tasks. By default All Tasks are selected. Click the All Tasks link to open Select Tasks dialog to choose the tasks you want to export
  6. You can also choose to Include dependent tasks or not for export. The existence of these will be checked before import and the import will fail if the dependent tasks are missing. These dependent tasks include the following:
    • Linked Dialogs i.e. dialog nodes present in the definition of another dialog;
    • Dialogs linked in defining ‘Behavior on Exceeding Retries’ for IVR Properties of any node of the dialog;
    • Dialog linked as part of sub-intent / interruption settings;
    • Any other scenario where a dialog execution could fail if a dependent task is not included;

  7. Click Export. The export happens in the background and the Download button gets activated after it is complete. Click Download to download the file to your local computer.

Exported Bot Components

When you export a bot, the following bot components get exported, depending on your Latest or Published Mode selection:

Bot Tasks
Tasks Only
  • Task Definition (Action, Alert, Information, and Dialog)
  • Synonyms (Task, Field, and Entity)
  • Patterns (Task, Field, and Entity)
Knowledge Graph Knowledge Graph definition along with the associated synonyms and classes.
NLP Data
NLP Settings The Advanced NLP Settings and Ignore words and Field memory.
The Advanced NLP Settings ( Natural Language > Advanced Settings) include the following:

  • Auto-train settings for ML Utterances
  • Multiple intent detection settings
  • Threshold and Configurations settings for
  • Fundamental meaning
  • Knowledge Graph
  • Machine Learning
Utterances All the bot utterances of all the enabled languages
Standard Responses All the standard responses of the bot in all enabled languages
Settings
Bot Settings The following information from Bot Settings page:

  • General Settings
  • Bot name, description, and bot synonyms for each enabled language
  • Language selection time frame (Bot Settings > Language Management)
  • Welcome message
  • Hold and Resume settings (Bot level)
  • Custom Script file
  • Tenancy URLs
  • Error messages
  • Task setup and execution settings (for executing tasks using UI forms).
Bot Variables All the global and content variables present in the bot along with their values.
IVR settings All the IVR settings for the bot (Bot Settings > IVR settings).

Importing a Bot

You can import tasks and configurations of a bot into a new or existing bot using one of these import types:

  • Full import: Replaces the existing bot with the imported bot configurations. Any additional configurations in the target bot will get deleted.
    Note: We strongly recommend you to exercise caution and take a backup of the target bot before importing a bot using this option.
  • Incremental import: Upgrades the current bot with the configurations available in the import file. Any additional configurations available in the target or imported bot are retained. You can select specific bot components to import from the bot tasks, NLP data, and bot settings. Refer to the Bot Items in Incremental Import table at the end of the article to learn how the imported bot items replace the target bot’s items in incremental import.

Before you Begin
The config.json file consists of bot variables that need values for the target bot. Share the file with the relevant developers or enter suitable values yourself for the variables before importing the bot definition into a new bot.

Steps in Importing to an Existing Bot

To import a bot, follow these steps:

  1. Open the bot you want to export and on left navigation menu select Settings > Bot Management.
  2. Click Import Bot.
  3. Click the CHOOSE FILE buttons next to the BOT DEFINITION FILE field and BOT CONFIG FILE field, and upload the botDefinition.json and config.json files respectively.
  4. Optionally, upload the custom script file from the imported bot if any.
  5. Select one of these import options: Full Import or Incremental Import. If you select Incremental import, you can also choose which bot items to import.
  6. For incremental import ML Utterances can either be Appended or Replaced
    • Append option can be used when the utterances present in the file should be imported into the bot and any additional utterances in the bot should be retained (this is the default behavior)
    • Replace option can be used when the utterances present in the file should be imported into the bot. Any additional utterances in the bot will be removed.
      • In case you are importing Tasks too, the additional utterances related to tasks being imported will be removed.

  7. On the confirmation dialog that opens, click Backup to download the existing bot configuration.

    Note: While backing up is an optional choice, we strongly recommend you to do so, especially when choosing Full Import, as you cannot recover the bot configurations after the imported bot replaces them.
  8. Click Proceed to start the import.
  9. After the import is completed, the following success message appears. Click Done.

Creating a New Bot Using the Import Option

To import a bot while creating it, follow these steps:

  1. On the top-right side of the Bot Builder homepage, click New Bot > Import a Bot.
  2. Enter a Name, Target Audience, and Color for the Bot. Refer to Create a New Bot to learn more.
  3. Click the CHOOSE FILE buttons next to the BOT DEFINITION FILE field and BOT CONFIG FILE field and upload the botDefinition.json and config.json files respectively.
  4. Optionally, upload a Custom Script file from the source bot if any and click Import.
  5. On the success message after the end of importing, click Done to proceed to the Bot Tasks page.

Bot Items in Incremental Import

COMPONENT DESCRIPTION
Tasks with the same Reference ID Imported tasks replace the tasks in the target bot and their status changes to Configured, regardless of their current status (including Suspended and Rejected tasks).
Tasks in the source bot with a different Reference ID These tasks are created in the target bot with the same Reference ID.
Tasks in the target bot with a different Reference ID These tasks stay intact.
Utterances, Patterns, and Task-level Synonyms Imported utterances, patterns, and task-level synonyms replace the ones in the target bot and apply to the imported tasks. Published models in the target bot stay intact.
Knowledge Graph, Bot Synonyms and Standard Responses Existing knowledge graph, bot synonyms, and standard responses in the target bot are replaced with the imported ones.

Deleting a Bot

You cannot delete a bot if any of the bot tasks are Published. Once you publish a task, the Bots Admin must approve and assign it to users. The developer cannot delete assigned tasks. To delete a published task, the Bots Admin needs to suspend the task.
Also, you cannot delete a bot if it is part of a published flow. You must delete the flow or remove the bot from the flow before attempting to delete it.

Steps to Delete a Bot

  • Hover over the left-hand navigation panel of the bot you want to delete, and then on the Settings tab, click Delete Bot.

Viewing the Bot Change Log

After creating a bot, you may need to edit it for various reasons such as changing its settings, adding tasks, enabling channels, and add flows.

To track all the changes made to a bot, you can view the Change Logs, which shows a chronological list of modifications to your bot. It consists of all the changes from the initial save of your bot to the last update.

To view the changelog for a bot, follow these steps:

  1. Hover over the left navigation panel of the bot whose Change Logs you want to see.
  2. Select Settings > Bot Management
  3. Click Change Logs.

  • It consists of the list of changes in reverse chronological order.
  • Each page displays the ten most recent changes and the name of the user that made the change, followed by the change synopsis, and the timestamp of the applied change.
  • Logs of the Publish Event is consolidated for all selected tasks, with the tasks listed in case all tasks are not selected for publish along with the Publish Comments.
Menu