Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Help & Learning Resources
Quick Start Guide
Accessing the Platform
Navigating the XO Platform
Building a Virtual Assistant
Using Workspaces
Release Notes
Current Version
Previous Versions
Request a Feature
Conversation Designer
Dialog Tasks
Mock Scenes
Dialog Tasks
Navigate Dialog Tasks
Build Dialog Tasks
Nodes & Connections
Node Types
Intent Node
Dialog Node
Entity Node
Entity Rules
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections Setup
Sub-Intent Scoping
User Prompts
Voice Call Properties
Dialog Task Management
Supported Entity Types
Supported Company Names
Supported Colors
Knowledge AI
Knowledge Graph
Knowledge Extraction
Build Knowledge Graph
Create Node Structure
Build the Graph
Add FAQs
Add FAQs from an Existing Source
Run a Task
Traits, Synonyms, and Stop Words
Manage Variable Namespaces
Update Knowledge Graph
Move Question and Answers Between Nodes
Edit and Delete Terms
Edit Questions and Responses
Knowledge Graph Analysis
Knowledge Graph Import and Export
Prepare Data for Import
From a CSV File
From a JSON File
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
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
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
External NLU Adapters
Dialogflow Engine
Test and Debug
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
Analytics Dashboard Filters
Usage Metrics
Containment Metrics
Smart Bots
Universal Bots
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Manage Assistant
Plan & Usage
Usage Plans
Support Plans
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
Sharing Data Tables or Views
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
Using the BotKit SDK
BotKit SDK Tutorial - Blue Prism
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. Test your Bot
  5. Create a Test Suite

Create a Test Suite

A Test Suite contains a collection of test cases grouped to simulate a specific conversation between the user and the bot and used anytime for test execution. You can know the execution status and determine and analyze the results in a test suite.

In Conversation testing, you can create the test suites in the following two different ways:

Record Conversation to Create a Test Suite

The option to record the test suite captures the metadata in the background which helps to test the flow sequence, transitions, and track the test coverage.
The following step-by-step process explains how to record a conversation as a test suite, and validate and create the test cases.

Record Test Suite

  1. On the Conversation Testing page, click New Test Suite.
  2. Click the Record option to start recording the new test.
  3. In the displayed pop-up, click Proceed to record the test with the On-Connect event or click the Skip On-Connect button.
  4. Note: “On-Connect” is the message you receive as soon as you open the chat window, even before you enter any message. The option is displayed for VAs with an On-Connect message. If you skip it, the On-connect message does not get added as a test case. If you click Proceed, then the On-connect message is created as a separate test case.

  5. The Chat window is displayed. The chat transcript is recorded and the recording status is displayed at the top. You can click Stop to stop the recording.

Note: If there is an error while recording due to any limitation set on the platform, it is displayed on the page.

Validate Test Suite

The conversation is recorded and all the metadata at each test case is captured. Once the recording is completed, the Platform provides you an option to validate the test suite as follows:

  1. Upon successful completion of recording, click Validate Test Suite.
  2. The ongoing validation is displayed. You may click Cancel if you want to cancel the step or click Continue in Background to continue the validation as a background task.
  3. If you click Continue in Background, you can see the status in the top right corner of the landing page by clicking the Draft icon.
  4. Note: You can draft up to five validations on the platform. The red indicator denotes that there are pending validations. Clicking the blue arrow takes you to the Validate Test Suite page.

    If a Draft contains five validations, you cannot create a new test suite. You need to approve or discard at least one validation from the list to create a new test suite.

  5. Once the validation is complete, the platform displays the Recorded and Validated Chat transcripts in the Validate Test Suite pop-up with the following details for each VA response:
    Metadata – Details like Intent and Node Name, Transitions, etc.
    Assertions – Default assertions (Flow and Text) added based on the VA response.
  6. The following options are displayed on the Validate Test Suite pop-up:
    Approve – When you approve the validation, the platform triggers the Test Suite creation step.
    Discard – When you discard the validation, the data is deleted from the system.

Note: A test suite cannot contain more than 500 test cases, and a test input cannot have more than 8000 characters.

Capture Test Suite Metadata

Using Conversation Testing, you can test the sequence of nodes executed by the VA for user input(s) and capture the following metadata at the time of test suite creation to verify if the VA is executing the conversation flows as expected:

  • Intent ID, Intent Name
  • Node ID, Node Name
  • Transition flow

The metadata are captured in both Record and Upload scenarios for all the VA responses of all the test suites. The details to be captured vary based on the intent type of the VA response. For more information on the details captured here, see Test Editor.

Create Test Suite

  1. Upon approval, a Create Test Suite pop-up is displayed in which you can enter the following details:
  • Test Suite Name
  • Description
  • Tags
    1. You can either click Create to create the test suite or discard this step.
    2. On clicking Create, the new test suite is created. You can click the Run Test Suite button to execute the test suite.
    3. The dialog Before you execute the test Suite is displayed. Select the version of your VA to be executed. If any authorization profiles are available, they are displayed here.
    4. Click Continue to continue the execution. The test cases execution progress is displayed on the top right corner of the page.

    5. If the test cases are passed, the Result is displayed as Passed, as shown in the screenshot below.

    Upload File to Create a Test Suite

    Using this option, you can create test suites by uploading chat transcripts in a pre-defined JSON file. This alternative way of creating test suites is quick and scalable, as compared to recording the flow every time. The following step-by-step process explains how to upload a JSON file, validate and create the test suites.

    Upload a JSON File

    1. Click New Test Suite.
    2. Click the Upload option to upload a chat transcript in JSON format.
    3. You can drag and drop a predefined JSON file in the Upload pop-up or select the file in the local directory using the browse option.

    Note: Only JSON files can be uploaded. The maximum file size allowed for upload is 2MB. You can also download a sample JSON file by clicking the Download JSON Sample button.

    If there is an error during upload due to any limitation set on the platform, an error is displayed as follows.

    If an uploaded JSON file exceeds the configured size limit of 2 MB, an error is displayed as shown below.

    Validate Test Suite

    The platform processes the uploaded file to simulate the conversation flow and capture all the metadata at each test case. When validating the test suite, there is an option to go back to Conversation testing while the test suite is being validated in the background.

    The steps to validate test suites are the same as in Record Test suite Flow. See Validate Test Suite for more information. To understand more about testing the sequence of nodes and capturing metadata, see Capture Test Suite Metadata under Validate Test Suite.

    Create Test Suite

    The steps to create a test suite are the same as in Record Test suite Flow. See Create Test Suite to know more.