GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Help & Learning Resources
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Using Workspaces
Release Notes
Current Version
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
Nodes & Connections
Overview
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
Context Object
Sub-Intent Scoping
User Prompts
Voice Call Properties
Dialog Task Management
Event Handlers
Supported Entity Types
Supported Company Names
Supported Colors
Knowledge Graph
Introduction
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
Introduction
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
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
Intelligence
Introduction
Default Standard Responses
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Health and Monitoring
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
NLP Insights
Conversations History
Conversation Flows
Analytics Dashboard Filters
Usage Metrics
Containment Metrics
Smart Bots
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Plan & Usage
Overview
Usage Plans
Support Plans
Invoices
Authorization
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data as Service
Data Table
Table Views
App Definitions
Sharing Data Tables or Views
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
Configure Agent Transfer
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
APIs & SDKs
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
ADMINISTRATION
Introduction to Admin Console
Administration Dashboard
User Management
Add Users
Manage Groups
Manage Roles
Assistant Management
Enrollment
Invite Users
Send Bulk Invites
Import User Data
Synchronize Users from AD
Security & Control
Using Single-Sign On
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. How Tos
  5. Travel Planing Assistant
  6. Travel VA: Configure Digital Views

Travel VA: Configure Digital Views

In this How-To, we will explore a scenario in a Travel Planning Assistant, where with just one click a user can view upcoming bookings. We will see how this Digital View can be presented using Panels and Widgets. Widgets can be used to trigger Dialog Tasks and display appropriate messages; while Panels can be used as containers to hold these Widgets.

We will also see how the Panel can be hosted on a Web/Mobile Client using the Widget SDK.

For details on what Digital Views are and how they are implemented in the Kore.ai XO Platform, refer here.

Problem Statement

Consider a Travel Planning assistant helping a user retrieve upcoming bookings. Rather than displaying this in text form, the assistant can use Digital Views to provide the information more effectively and in a more visually appealing manner.

Prerequisites

To go through these configurations, you need to know at least the basics of the following XO Platform features:

You also need a Dialog Task that handles upcoming bookings. Read more about working with the Dialog Builder.

Configurations

Let us consider each of the following scenarios one by one:

  1. Dialog Task to display Upcoming Bookings, using the Widget SDK Channel.
  2. Widgets to trigger the above dialog task and a Panel set with the widgets.
  3. A Panel to hold a widget displaying a static JSON template message.

Message Template

First, the Dialog task which would be triggered from the Widget should have a message definition for the Widget SDK channel.

We are using the following message to display the upcoming bookings.

var lastBooking, dateAfterFifteenDays
lastBooking = BotUserSession.get('bookedFlightInfo')
if(lastBooking === undefined || lastBooking === null) {
lastBooking = {}
dateAfterFifteenDays = koreUtil.moment().add(15, 'days').format('D MMM YYYY')
lastBooking['travelDate'] = dateAfterFifteenDays
lastBooking['passengerCount'] = 1
lastBooking['flyingFrom'] = 'Orlando, FL, USA'
lastBooking['flyingTo'] = 'New York, NY, USA'
}
var message = {
"templateType": "List",
"widgetName": "Upcoming Bookings",
"description": "Shows future bookings",
"headerOptions": {
},
"elements": [
{
"image": {
"image_type": "image",
"image_src": "https://demo.kore.ai/barefoot/sites/default/files/demo_uploads/panelwidgetupcoming.png"
},
"title": "Date of Journey: " + lastBooking['travelDate'],
"subtitle": "Passengers: " + lastBooking['passengerCount'],
"value":
{
"layout":
{
"align": "centre",
"colSize": "25%"
},
"type":"button",
"text":"",
"button":
{
"title": "Web CheckIn",
"theme": "#3377FF",
"type": "postback",
"payload": "I want to do web check-in",//+title,
"utterance": "I want to do web check-in"//+title
}
},
"details": [
{
"image": {
"image_type": "image",
"image_src": "https://demo.kore.ai/barefoot/sites/default/files/demo_uploads/Panelfrom.png"
},
"description": "Flying from: " + lastBooking['flyingFrom']
},
{
"image": {
"image_type": "image",
"image_src": "https://demo.kore.ai/barefoot/sites/default/files/demo_uploads/Panelto.png"
},
"description": "Flying to: " + lastBooking['flyingTo']
}
]
}
]
}
print(JSON.stringify(message));

Widget Configuration

We will be creating a Widget that triggers a Dialog Task in order to display upcoming bookings for a user. To do so, let us follow the steps below:

  • Ensure that Build is selected from the top menu.
  • From under Digital Skills open Digital Views.
  • Click the Create Widget button.
  • Provide a Widget Name and a Display Name.
  • Set the Source, we are triggering Dialog Task, hence select Dialog Task.
  • Select Dialog Task as Upcoming Bookings, as per our use case
  • Save the widget.
  • Edit the widget and click Run & Preview to see the widget output.
  • Save as preview will set the output as the thumbnail against the widget.

Once configured, your Widget might look like this:

Panel Configuration

The Widgets thus created need to be attached to a Panel for runtime display and execution.

  1. Click the Create Panel button to create a Panel. We will be creating a Bookings Panel, within which to integrate the Widget we just created.
  2. In the New Panel window, enter Panel Name, Display Name and a URL for its Icon.

  3. Click the Add Widget button to open the Panel Management window.

  4. Use the Add Widget option to select and add the Widgets that we want to display, in this case the Upcoming Bookings widget. You can use this window to add further widgets to the Bookings panel if you like.

  5. Use the Test button to see the widget in action. This will open the Talk to Bot feature, where you can ask the VA for Upcoming Bookings. If your setup is successful, you should be shown the widget we just created. 

Panel with JSON Widgets

Next, we will see how to create Widgets with static JSON content. We will use a JSON to display a pie chart.

  1. Create a Widget and call it Travel Spend.
  2. In the New Widget dialog, enter the Name, and set the source to JSON.

    Enter the following in the JavaScript Editor. This is a message template to display a pie chart with a break up for amounts spent under various heads like travel, food, and accommodation. For more on supported message templates, refer here.

    var message =
    {
          "templateType": "piechart",
          "pie_type": "regular",
          "title": "Summary",
          "description": "monthly report",
          "elements": [
            {
              "title": "Airlines",
              "value": "1264.0",
              "displayValue": "$ 1,234"
            },
            {
              "title": "Hotels",
              "value": "568.10",
              "displayValue": "$ 568"
            },
            {
              "title": "Food",
              "value": "324.50",
              "displayValue": "$ 324"
            }
          ]
        };
    print(JSON.stringify(message));
  3. Create a Panel and name it Travel Spend Breakdown.
  4. Add the Travel Spend Widget to the Travel Spend Breakdown Panel.

  5. Test the panel and you will see it in action.

Publishing

To publish the Assistant, first enable channels:

  1. From the left navigation menu, select Channel for publishing. For our use case we will select both Web/Mobile Client and Widget SDK channels.
  2. Select the channels and from the Configurations tab, make a note of the Bot Name, Bot Id, Client Id and Client Secret.
  3. From the left navigation menu, select the Publish option. Under the Tasks & languages section, ensure that the Widget and Panels we developed are selected for publication.
  4. Proceed with the Publish.

Learn more about publishing your Virtual Assistant

Hosting

We will be hosting the Panels in the web/mobile client. See here for more details on the Widget SDK usage.

  1. Download the Kore.ai Widget SDK, go to https://github.com/Koredotcom/web-kore-sdk, and then click Download.
  2. Extract all files to the …/SDKApp/sdk folder.
  3. Open the above SDK folder, and traverse to the UI folder.
  4. Open the kore-config.js
  5. Configure your botOptions with the ‘web/mobile client’ channel configurations copied  in the above section.
    1. botOptions.botInfo
    2. botOptions.clientId
    3. botOptions.clientSecret
  6. Make other changes as per your requirements.
  7. Open the kore-widgets-config.js
  8. Configure your botOptionsWiz with the ‘Widget SDK’ channel configurations copied in the above  section.
    1. botOptionsWiz.botInfo
    2. botOptionsWiz.clientId
    3. botOptionsWiz.clientSecret
  9. Make other changes as per your requirements.
  10. Open the index_widgets_chat.html file in the browser and see the chat window along with the widgets.
  11. If you want to host the Panels individually use the index_widgets.html file.
Menu