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
Kore.ai XO GPT Module
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
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
LLM and Generative AI Logs
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. Collections

Collections

Collections enable you to store multiple value sets for Environment Variables so that you can select the appropriate variable set while promoting the bot definition to a different environment without manual intervention.

Note: This feature was enabled in v8.1 of the platform and is available only for the on-prem installation.

Environment variables are a primary type of bot variables where you define a key-value pair and use the variable across the bot. As the variables are declared globally, they can be used at any point in the bot configuration. These can be used to manage the bot variables with environment-specific values. For example, you might have authCode for authenticating a service that your bot uses. This authCode may have different values in the test, uat, and prod environments. The bot can be exported and imported based on the environment, and the values need to modified at one place in the variable configuration file. Refer here for more on Bot Variables.

Using collections, you can define multiple value sets for these variables and designate an active collection for the values to be used while bot execution. Instead of changing the values manually while moving the bot from one environment to another, you can define the values during bot development and set the active collection in different environments to use the appropriate values.

Creation

Following are the steps in creating Collections

  1. From the left navigation menu, select Settings -> Config Settings
  2. Click the Environment Variables option
  3. On the top left click the more/ellipses to access the Manage Collections
  4. This would open the Manage Collections page
  5. Click Add New Collection
  6. Enter the following details:
    1. Collection Name,
    2. Description,
    3. Select the Collection you want to Clone From – This would create the new collection with all the values from the selected clone, you can later edit the values as per requirement.
      The first time you create a collection, a Default collection is created by the platform and is set as the Active Collection.

  7. Save the collection

Adding Values

Create Environment Variables and add collection-specific values using the following steps:

  1. From the left navigation menu, select Settings -> Config Settings
  2. Click the Environment Variables option
  3. Click Add Environment Variable. You can also use the edit icon against an existing Environment Variable to add values.
  4. This would open the Add/Edit Environment Variable page
  5. Enter the following details:
    1. Variable Name,
    2. Against the listed Collection Name, enter the appropriate Value,
    3. Enter developer notes in the Notes field. While this is an optional field, entering useful notes can help the developer working on the target bot to understand and provide relevant values.
    4. Group can be used to categorize the variable.
    5. Assign a Namespace if enabled (refer here for more).

  6. Save the Variable

Active Collection

  1. Click Manage Collections to access the Collections listing window
  2. Mark as Active any one of the Collections created. The values from the Active collection are while executing the bot definition.
  3. When exporting the bot definition, you can mark as Active the collection to be set for the target bot. The export file would contain the details of all the collections as well as the collection-specific values.
  4. Bot Import
    • To a New bot – All the collections, collection-specific values, and the active collection information would be imported into the newly created bot
    • Full Bot Import – All the details as available in the export file would be imported into the newly created bot. Any existing collections and the collection-specific values would be overwritten with the details present in the export file.If the file has multiple collections but the target bot has does not have any collections, then the collections from the file would be imported into the target bot.
      If the file does not have collections but the target bot has collections, then the collections would be removed from the target bot.
    • Incremental Bot Import – The ‘incremental import’ will be allowed only when the collections from the file exactly match with the collections in the target botWhen the collections in the export file and bot are the same, the values from the file would override the values in the target bot, and any additional variables in the file will be imported into the target bot with the corresponding values. Any additional variables in the bot target bot would be retained as-is.

Import & Export

  1. The Bot Export file would contain the details of all the collections as well as the collection-specific values. The setting of a collection as ‘active’ would be reflected in the export file
  2. Bot Import
    • To a New bot – All the collections, collection-specific values, and the active collection information would be imported into the newly created bot
    • Full Bot Import – All the details as available in the export file would be imported into the newly created bot. Any existing collections and the collection-specific values would be overwritten with the details present in the export file.If the file has multiple collections but the target bot has does not have any collections, then the collections from the file would be imported into the target bot.
      If the file does not have collections but the target bot has collections, then the collections would be removed from the target bot.
    • Incremental Bot Import – The ‘incremental import’ will be allowed only when the collections from the file exactly match with the collections in the target botWhen the collections in the export file and bot are the same, the values from the file would override the values in the target bot, and any additional variables in the file will be imported into the target bot with the corresponding values. Any additional variables in the bot target bot would be retained as-is.
  3. Variable Import – The ‘variables import’ would be allowed only when the collections from the file exactly match with the collections in the target bot.When the collections in the export file and bot are the same the values from the file would override the values in the target bot. Any additional variables in the file will be imported into the target bot with the corresponding values. Any additional variables in the bot target bot will be retained as-is.
  4. Variable Export – The Variables export would include all the collections available in the bot and mapping of variables to collections. Note if the bot does not have any collections but the account has ‘collections enabled’, the export would be restricted.

Collections

Collections enable you to store multiple value sets for Environment Variables so that you can select the appropriate variable set while promoting the bot definition to a different environment without manual intervention.

Note: This feature was enabled in v8.1 of the platform and is available only for the on-prem installation.

Environment variables are a primary type of bot variables where you define a key-value pair and use the variable across the bot. As the variables are declared globally, they can be used at any point in the bot configuration. These can be used to manage the bot variables with environment-specific values. For example, you might have authCode for authenticating a service that your bot uses. This authCode may have different values in the test, uat, and prod environments. The bot can be exported and imported based on the environment, and the values need to modified at one place in the variable configuration file. Refer here for more on Bot Variables.

Using collections, you can define multiple value sets for these variables and designate an active collection for the values to be used while bot execution. Instead of changing the values manually while moving the bot from one environment to another, you can define the values during bot development and set the active collection in different environments to use the appropriate values.

Creation

Following are the steps in creating Collections

  1. From the left navigation menu, select Settings -> Config Settings
  2. Click the Environment Variables option
  3. On the top left click the more/ellipses to access the Manage Collections
  4. This would open the Manage Collections page
  5. Click Add New Collection
  6. Enter the following details:
    1. Collection Name,
    2. Description,
    3. Select the Collection you want to Clone From – This would create the new collection with all the values from the selected clone, you can later edit the values as per requirement.
      The first time you create a collection, a Default collection is created by the platform and is set as the Active Collection.

  7. Save the collection

Adding Values

Create Environment Variables and add collection-specific values using the following steps:

  1. From the left navigation menu, select Settings -> Config Settings
  2. Click the Environment Variables option
  3. Click Add Environment Variable. You can also use the edit icon against an existing Environment Variable to add values.
  4. This would open the Add/Edit Environment Variable page
  5. Enter the following details:
    1. Variable Name,
    2. Against the listed Collection Name, enter the appropriate Value,
    3. Enter developer notes in the Notes field. While this is an optional field, entering useful notes can help the developer working on the target bot to understand and provide relevant values.
    4. Group can be used to categorize the variable.
    5. Assign a Namespace if enabled (refer here for more).

  6. Save the Variable

Active Collection

  1. Click Manage Collections to access the Collections listing window
  2. Mark as Active any one of the Collections created. The values from the Active collection are while executing the bot definition.
  3. When exporting the bot definition, you can mark as Active the collection to be set for the target bot. The export file would contain the details of all the collections as well as the collection-specific values.
  4. Bot Import
    • To a New bot – All the collections, collection-specific values, and the active collection information would be imported into the newly created bot
    • Full Bot Import – All the details as available in the export file would be imported into the newly created bot. Any existing collections and the collection-specific values would be overwritten with the details present in the export file.If the file has multiple collections but the target bot has does not have any collections, then the collections from the file would be imported into the target bot.
      If the file does not have collections but the target bot has collections, then the collections would be removed from the target bot.
    • Incremental Bot Import – The ‘incremental import’ will be allowed only when the collections from the file exactly match with the collections in the target botWhen the collections in the export file and bot are the same, the values from the file would override the values in the target bot, and any additional variables in the file will be imported into the target bot with the corresponding values. Any additional variables in the bot target bot would be retained as-is.

Import & Export

  1. The Bot Export file would contain the details of all the collections as well as the collection-specific values. The setting of a collection as ‘active’ would be reflected in the export file
  2. Bot Import
    • To a New bot – All the collections, collection-specific values, and the active collection information would be imported into the newly created bot
    • Full Bot Import – All the details as available in the export file would be imported into the newly created bot. Any existing collections and the collection-specific values would be overwritten with the details present in the export file.If the file has multiple collections but the target bot has does not have any collections, then the collections from the file would be imported into the target bot.
      If the file does not have collections but the target bot has collections, then the collections would be removed from the target bot.
    • Incremental Bot Import – The ‘incremental import’ will be allowed only when the collections from the file exactly match with the collections in the target botWhen the collections in the export file and bot are the same, the values from the file would override the values in the target bot, and any additional variables in the file will be imported into the target bot with the corresponding values. Any additional variables in the bot target bot would be retained as-is.
  3. Variable Import – The ‘variables import’ would be allowed only when the collections from the file exactly match with the collections in the target bot.When the collections in the export file and bot are the same the values from the file would override the values in the target bot. Any additional variables in the file will be imported into the target bot with the corresponding values. Any additional variables in the bot target bot will be retained as-is.
  4. Variable Export – The Variables export would include all the collections available in the bot and mapping of variables to collections. Note if the bot does not have any collections but the account has ‘collections enabled’, the export would be restricted.
Menu