GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Help & Learning Resources
Release Notes
Current Version
Recent Updates
Previous Versions
Deprecations
Request a Feature
CONCEPTS
Design
Storyboard
Overview
FAQs
Conversation Designer
Overview
Dialog Tasks
Mock Scenes
Dialog Tasks
Overview
Navigate Dialog Tasks
Build Dialog Tasks
Node Types
Overview
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
Introduction
Knowledge Graph
Introduction
Terminology
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
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Session and Context Variables
Context Object
Intent Discovery
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
LLM and Generative AI
Introduction
LLM Integration
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
Kore.ai XO GPT Model
Intelligence
Introduction
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
Overview
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
Glossary
Health and Monitoring
NLP Health
Flow Health
Integrations
Actions
Actions Overview
Asana
Configure
Templates
Azure OpenAI
Configure
Templates
BambooHR
Configure
Templates
Bitly
Configure
Templates
Confluence
Configure
Templates
DHL
Configure
Templates
Freshdesk
Configure
Templates
Freshservice
Configure
Templates
Google Maps
Configure
Templates
Here
Configure
Templates
HubSpot
Configure
Templates
JIRA
Configure
Templates
Microsoft Graph
Configure
Templates
Open AI
Configure
Templates
Salesforce
Configure
Templates
ServiceNow
Configure
Templates
Stripe
Configure
Templates
Shopify
Configure
Templates
Twilio
Configure
Templates
Zendesk
Configure
Templates
Agents
Agent Transfer Overview
Custom (BotKit)
Drift
Genesys
Intercom
NiceInContact
NiceInContact(User Hub)
Salesforce
ServiceNow
Configure Tokyo and Lower versions
Configure Utah and Higher versions
Unblu
External NLU Adapters
Overview
Dialogflow Engine
Test and Debug
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Dashboard Filters
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
Create Custom Dashboard Filters
NLP Insights
Task Execution Logs
Conversations History
Conversation Flows
Conversation Insights
Feedback Analytics
Usage Metrics
Containment Metrics
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Team Collaboration
Plan & Usage
Overview
Usage Plans
Templates
Support Plans
Invoices
Authorization
Conversation Sessions
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Feedback Survey
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data
Overview
Data Table
Table Views
App Definitions
Data as Service
HOW TOs
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
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
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
ADMINISTRATION
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Data Tables and Views
Assistant Management
Enrollment
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
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Bot Settings
  5. Bot Management
  6. Bot Management

Bot Management

This article discusses the main features that allow you to manage your assistant at a high level. These include Importing, Exporting, and Deleting assistants, as well as viewing change logs.

To learn more about Variables and how to use them, see Using Bot Variables.

Importing and Exporting Assistants

Kore.ai allows you to export and import assistant tasks and associated configurations into another assistant. This feature helps you in the migration of bot definitions, cloning of assistants, or maintaining a periodic backup of bot definitions.

This feature is particularly helpful to test various versions of your assistant 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.

NOTE: Post v8.0 release, the enableNegativePatterns flag will be included in ‘NLP Settings’ under ‘NLP Data’ in the exported and imported bot definitions. This flag is used to check if the Negative Patterns are enabled/disabled in the assistant.

Prior to this patch, this flag was part of ‘NLP Settings’ under ‘NLP Data’ in the imported bot definitions and ‘Bot Setting’ under ‘Setting’ in the exported bot definitions. This change is aimed at streamlining the functionality and might result in the failure to the incremental import of a bot from an export file generated before v8.0.)

Importing an Assistant

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

  • Full import: Replaces the existing assistant with the imported configurations. Any additional configurations in the target assistant that are not present in the import definition will be deleted. An exception to this rule is the webhook channel, which will be retained even if not present in the import bot definition.
    Note: We strongly recommend you exercise caution and take a backup of the target assistant before importing using this option.
  • Incremental import: Upgrades the current assistant 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 the 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 assistant. 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 Assistant

To import a Virtual Assistant, follow these steps:

  1. Open the assistant you want to export
  2. Select the Deploy tab from the top menu
  3. From the left menu select Bot Management -> Import & Export
  4. On the Import & Export page select the Import tab
  5. 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.
  6. Optionally, upload the custom script file from the imported assistant if any.
  7. Select one of these import options: Full Import or Incremental Import.
  8. If you select Full import, the bot definition in the in-development copy will be overwritten with the definition present in the import file.
  • If there are one or more additional tasks or languages in the assistant, and if these are not present in the import definition, then these tasks will be marked as deleted and will be removed when the bot is published.
  • You can choose to auto-publish the assistant post-import.

  • If you select Incremental import, you can also choose which components to import.

 

  • Bot Tasks: Here is where you can select to import Tasks only (with or without comments), Knowledge Graph, Small Talk or Digital Forms.
Note: If you want to import one or more Bot Tasks, also select the NLP Data settings, as they are linked. For example, the utterances assigned to dialog tasks are not imported if you don’t select the NLP Data settings, causing problems in identifying the dialog properly.
    • NLP Data: This is where you can import NLP Settings, Utterances, Patterns and Standard Responses. ML Utterances and Patterns can either be Appended or Replaced.
      • Append can be used when the utterances present in the file should be imported into the assistant and any additional utterances in the bot should be retained (this is the default behavior)
      • Replace can be used when the utterances present in the file should be imported into the assistant. Any additional utterances will be removed.
        • In case you are importing Tasks too, the additional utterances related to tasks being imported will be removed.
    • Settings: Bot Settings, Bot Variables and Voice Call Properties.
    • Custom Dashboards – This is useful in case you have created custom dashboards under the Analyze section and you want to import these to the new VA as well. 
    • On the confirmation dialog that opens, click Backup to download the existing assistant configuration.
      Note: While backing up is an optional choice, we strongly recommend you do so, especially when choosing Full Import, as you cannot recover the configurations after the imported assistant replaces them.

      • Click Proceed to start the import.
      • After the import is completed, the following success message appears. Click Done.
      Note: Bot import would fail if the assistant has been restored but not published after the restore.

      Creating a New Assistant Using the Import Option

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

      1. On the landing page, click New Bot.
      2. In the Create New Bot window, select Import a Bot.
      3. Enter a Name
      4. Select an icon or click the + icon to upload your own. Images should be in PNG format and should not exceed 40×40 pixels. The file size is limited to 80kb. 
      5. Upload the Bot Definition File.
      6. Upload the Bot Config File.
      7. Upload the Custom Script File.
      8. Click Import when ready.

      Components in the Incremental Import

      COMPONENT DESCRIPTION
      Tasks with the same Reference ID Imported tasks replace the tasks in the target assistant and their status changes to Configured, regardless of their current status (including Suspended and Rejected tasks).
      Tasks in the source assistant with a different Reference ID These tasks are created in the target assistant with the same Reference ID.
      Tasks in the target assistant 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 assistant and apply them to the imported tasks. Published models in the target assistant stay intact.
      Knowledge Graph, Bot Synonyms and Standard Responses Existing knowledge graph, bot synonyms, and standard responses in the target assistant are replaced with the imported ones.

Exporting an Assistant

You can export a bot’s definition and configuration using the Export option.

Important: Export from a lower (not an end-of-life) version to a higher supported version is allowed for all the virtual assistants. However, a VA export from a higher environment and import to an environment running a lower version or lower patch is not supported.

When you export a assistant, it downloads a zipped file with the following parameters:

  • botDefinition.json: Includes metadata, tasks, bot and task-level synonyms, utterances, patterns, knowledge graph, standard responses, flows, and IDPs. You can select specific items to export from tasks, NLP data – NLP settings, utterances, standard responses – and Settings – bot settings, variables, IVR settings- while exporting the assistant.
  • config.json: Includes bot settings, bot variables, and IVR settings.
  • Icon.png: Includes the assistant icon.
  • <Custom ScriptFile Name.js> (if available): Includes a script file with JavaScript functions. When you upload this file, you can access the functions in the file from anywhere in the assistant.
Note: The assistant 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 assistants in two modes: Published and Latest Version. Depending on the mode that is selected, the corresponding versions of the tasks are exported. You can select specific components to export from the tasks, NLP data, and bot settings in both the modes. Further individual Tasks can also be selected.

Published Mode

When you export a VA in the Published mode, only the published versions of the tasks are exported, regardless of any other existing versions. For example, if a VA 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 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 VA in the Latest mode, the latest versions of the  tasks get exported, regardless of their publishing status. For example, if a VA 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 assistant
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 Assistant

  1. Open the assistant you want to export
  2. Select Deploy tab from the top menu
  3. From the left menu select Bot Management -> Import & Export
  4. On the Import & Export page, select the Export tab
  5. In the Export tab, select either Published or Latest Version exporting mode.
  6. By default, all the components are selected for export. Deselect the items that you do not want to export.
  7. 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.
Note: If you want to export one or more Bot Tasks, also select the NLP Data settings, as they are linked. For example, the utterances assigned to dialog tasks are not exported if you don’t select the NLP Data settings, causing problems in identifying the dialog properly.
  1. 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;

  1. 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 VA, the following components get exported, depending on your Latest or Published Mode selection:

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 utterances of all the enabled languages
Standard Responses All the standard responses of the assistant 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 assistant along with their values.
IVR settings All the IVR settings for the assistant (Bot Settings > IVR settings).

Universal and Child Bot Scenarios

When exporting and importing universal and child VAs from a source environment to a destination environment, you should ensure the following:

  • All the child bots are imported before the universal bot.
  • When creating child bots, they propagate from the same source environment.

Deleting an Assistant

You cannot delete a VA if any of the 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 VA if it is part of a published flow. You must delete the flow or remove the assistant from the flow before attempting to delete it.

To delete a Virtual Assistant:

  1. Open the assistant you want to delete
  2. Select the Deploy tab from the top menu
  3. From the left navigation under the Bot Management menu, click Delete Bot.
WARNING: All the configurations will be lost and there is no way to restore your assistant after deletion. Please exercise caution when using this feature.

Viewing the Change Log

After creating a VA, 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 VA, you can view the Change Logs, which show a chronological list of modifications to your assistant. It consists of all the changes from the initial save of your assistant to the last update. To view the changelog for a VA, follow these steps:

  1. Select Deploy tab from the top menu
  2. From the left menu click Change Logs.
  3. On the Change Logs page, you will notice the following;
  • The list is sorted 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 are consolidated for all selected tasks, with the tasks listed in case all tasks are not selected for publishing along with the Publish Comments.

Following actions can be performed on the logs:

  • Using the search text box, you can enter any text and the platform will search for that text in the change description and the logs fulfilling the search criteria would be displayed.
  • The filter option can be used to filter based on:
    • Developer Name collaborating on the assistant;
    • Date Range either past 24 hrs, past 7 days, or custom date by specifying the start and end date. By default,  changes from all developers in the past 24 hours would be displayed.
  • The export icon can be used to Export the changelog in CSV format. The logs displayed after applying the search and filter criteria would be downloaded.

Bot Management

This article discusses the main features that allow you to manage your assistant at a high level. These include Importing, Exporting, and Deleting assistants, as well as viewing change logs.

To learn more about Variables and how to use them, see Using Bot Variables.

Importing and Exporting Assistants

Kore.ai allows you to export and import assistant tasks and associated configurations into another assistant. This feature helps you in the migration of bot definitions, cloning of assistants, or maintaining a periodic backup of bot definitions.

This feature is particularly helpful to test various versions of your assistant 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.

NOTE: Post v8.0 release, the enableNegativePatterns flag will be included in ‘NLP Settings’ under ‘NLP Data’ in the exported and imported bot definitions. This flag is used to check if the Negative Patterns are enabled/disabled in the assistant.

Prior to this patch, this flag was part of ‘NLP Settings’ under ‘NLP Data’ in the imported bot definitions and ‘Bot Setting’ under ‘Setting’ in the exported bot definitions. This change is aimed at streamlining the functionality and might result in the failure to the incremental import of a bot from an export file generated before v8.0.)

Importing an Assistant

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

  • Full import: Replaces the existing assistant with the imported configurations. Any additional configurations in the target assistant that are not present in the import definition will be deleted. An exception to this rule is the webhook channel, which will be retained even if not present in the import bot definition.
    Note: We strongly recommend you exercise caution and take a backup of the target assistant before importing using this option.
  • Incremental import: Upgrades the current assistant 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 the 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 assistant. 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 Assistant

To import a Virtual Assistant, follow these steps:

  1. Open the assistant you want to export
  2. Select the Deploy tab from the top menu
  3. From the left menu select Bot Management -> Import & Export
  4. On the Import & Export page select the Import tab
  5. 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.
  6. Optionally, upload the custom script file from the imported assistant if any.
  7. Select one of these import options: Full Import or Incremental Import.
  8. If you select Full import, the bot definition in the in-development copy will be overwritten with the definition present in the import file.
  • If there are one or more additional tasks or languages in the assistant, and if these are not present in the import definition, then these tasks will be marked as deleted and will be removed when the bot is published.
  • You can choose to auto-publish the assistant post-import.

  • If you select Incremental import, you can also choose which components to import.

 

  • Bot Tasks: Here is where you can select to import Tasks only (with or without comments), Knowledge Graph, Small Talk or Digital Forms.
Note: If you want to import one or more Bot Tasks, also select the NLP Data settings, as they are linked. For example, the utterances assigned to dialog tasks are not imported if you don’t select the NLP Data settings, causing problems in identifying the dialog properly.
    • NLP Data: This is where you can import NLP Settings, Utterances, Patterns and Standard Responses. ML Utterances and Patterns can either be Appended or Replaced.
      • Append can be used when the utterances present in the file should be imported into the assistant and any additional utterances in the bot should be retained (this is the default behavior)
      • Replace can be used when the utterances present in the file should be imported into the assistant. Any additional utterances will be removed.
        • In case you are importing Tasks too, the additional utterances related to tasks being imported will be removed.
    • Settings: Bot Settings, Bot Variables and Voice Call Properties.
    • Custom Dashboards – This is useful in case you have created custom dashboards under the Analyze section and you want to import these to the new VA as well. 
    • On the confirmation dialog that opens, click Backup to download the existing assistant configuration.
      Note: While backing up is an optional choice, we strongly recommend you do so, especially when choosing Full Import, as you cannot recover the configurations after the imported assistant replaces them.

      • Click Proceed to start the import.
      • After the import is completed, the following success message appears. Click Done.
      Note: Bot import would fail if the assistant has been restored but not published after the restore.

      Creating a New Assistant Using the Import Option

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

      1. On the landing page, click New Bot.
      2. In the Create New Bot window, select Import a Bot.
      3. Enter a Name
      4. Select an icon or click the + icon to upload your own. Images should be in PNG format and should not exceed 40×40 pixels. The file size is limited to 80kb. 
      5. Upload the Bot Definition File.
      6. Upload the Bot Config File.
      7. Upload the Custom Script File.
      8. Click Import when ready.

      Components in the Incremental Import

      COMPONENT DESCRIPTION
      Tasks with the same Reference ID Imported tasks replace the tasks in the target assistant and their status changes to Configured, regardless of their current status (including Suspended and Rejected tasks).
      Tasks in the source assistant with a different Reference ID These tasks are created in the target assistant with the same Reference ID.
      Tasks in the target assistant 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 assistant and apply them to the imported tasks. Published models in the target assistant stay intact.
      Knowledge Graph, Bot Synonyms and Standard Responses Existing knowledge graph, bot synonyms, and standard responses in the target assistant are replaced with the imported ones.

Exporting an Assistant

You can export a bot’s definition and configuration using the Export option.

Important: Export from a lower (not an end-of-life) version to a higher supported version is allowed for all the virtual assistants. However, a VA export from a higher environment and import to an environment running a lower version or lower patch is not supported.

When you export a assistant, it downloads a zipped file with the following parameters:

  • botDefinition.json: Includes metadata, tasks, bot and task-level synonyms, utterances, patterns, knowledge graph, standard responses, flows, and IDPs. You can select specific items to export from tasks, NLP data – NLP settings, utterances, standard responses – and Settings – bot settings, variables, IVR settings- while exporting the assistant.
  • config.json: Includes bot settings, bot variables, and IVR settings.
  • Icon.png: Includes the assistant icon.
  • <Custom ScriptFile Name.js> (if available): Includes a script file with JavaScript functions. When you upload this file, you can access the functions in the file from anywhere in the assistant.
Note: The assistant 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 assistants in two modes: Published and Latest Version. Depending on the mode that is selected, the corresponding versions of the tasks are exported. You can select specific components to export from the tasks, NLP data, and bot settings in both the modes. Further individual Tasks can also be selected.

Published Mode

When you export a VA in the Published mode, only the published versions of the tasks are exported, regardless of any other existing versions. For example, if a VA 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 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 VA in the Latest mode, the latest versions of the  tasks get exported, regardless of their publishing status. For example, if a VA 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 assistant
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 Assistant

  1. Open the assistant you want to export
  2. Select Deploy tab from the top menu
  3. From the left menu select Bot Management -> Import & Export
  4. On the Import & Export page, select the Export tab
  5. In the Export tab, select either Published or Latest Version exporting mode.
  6. By default, all the components are selected for export. Deselect the items that you do not want to export.
  7. 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.
Note: If you want to export one or more Bot Tasks, also select the NLP Data settings, as they are linked. For example, the utterances assigned to dialog tasks are not exported if you don’t select the NLP Data settings, causing problems in identifying the dialog properly.
  1. 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;

  1. 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 VA, the following components get exported, depending on your Latest or Published Mode selection:

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 utterances of all the enabled languages
Standard Responses All the standard responses of the assistant 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 assistant along with their values.
IVR settings All the IVR settings for the assistant (Bot Settings > IVR settings).

Universal and Child Bot Scenarios

When exporting and importing universal and child VAs from a source environment to a destination environment, you should ensure the following:

  • All the child bots are imported before the universal bot.
  • When creating child bots, they propagate from the same source environment.

Deleting an Assistant

You cannot delete a VA if any of the 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 VA if it is part of a published flow. You must delete the flow or remove the assistant from the flow before attempting to delete it.

To delete a Virtual Assistant:

  1. Open the assistant you want to delete
  2. Select the Deploy tab from the top menu
  3. From the left navigation under the Bot Management menu, click Delete Bot.
WARNING: All the configurations will be lost and there is no way to restore your assistant after deletion. Please exercise caution when using this feature.

Viewing the Change Log

After creating a VA, 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 VA, you can view the Change Logs, which show a chronological list of modifications to your assistant. It consists of all the changes from the initial save of your assistant to the last update. To view the changelog for a VA, follow these steps:

  1. Select Deploy tab from the top menu
  2. From the left menu click Change Logs.
  3. On the Change Logs page, you will notice the following;
  • The list is sorted 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 are consolidated for all selected tasks, with the tasks listed in case all tasks are not selected for publishing along with the Publish Comments.

Following actions can be performed on the logs:

  • Using the search text box, you can enter any text and the platform will search for that text in the change description and the logs fulfilling the search criteria would be displayed.
  • The filter option can be used to filter based on:
    • Developer Name collaborating on the assistant;
    • Date Range either past 24 hrs, past 7 days, or custom date by specifying the start and end date. By default,  changes from all developers in the past 24 hours would be displayed.
  • The export icon can be used to Export the changelog in CSV format. The logs displayed after applying the search and filter criteria would be downloaded.
Menu