GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Working with the Builder
Building a Virtual Assistant
Using Workspaces
Release Notes
Current Version
Previous Versions
Deprecations

CONCEPTS
Design
Storyboard
Dialog Tasks
Overview
Dialog Builder
Node Types
Intent Node
Dialog Node
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Group Node
Agent Transfer
User Prompts
Voice Call Properties
Dialog Task Management
Connections & Transitions
Component Transition
Context Object
Event Handlers
Knowledge Graph
Introduction
Knowledge Extraction
Build Knowledge Graph
Add Knowledge Graph to Bot
Create the Graph
Build Knowledge Graph
Add FAQs
Run a Task
Build FAQs from an Existing Source
Traits, Synonyms, and Stop Words
Manage Variable Namespaces
Update
Move Question and Answers Between Nodes
Edit and Delete Terms
Edit Questions and Responses
Knowledge Graph Training
Knowledge Graph Analysis
Knowledge Graph Import and Export
Importing Knowledge Graph
Exporting Knowledge Graph
Creating a Knowledge Graph
From a CSV File
From a JSON file
Auto-Generate Knowledge Graph
Alert Tasks
Small Talk
Digital Skills
Digital Forms
Views
Introduction
Panels
Widgets
Train
Introduction
ML Engine
Introduction
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
NLP Configurations
NLP Guidelines
Intelligence
Introduction
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Sentinment Management
Tone Analysis
Test & Debug
Talk to Bot
Utterence Testing
Batch Testing
Conversation Testing
Deploy
Channels
Publish
Analyze
Introduction
Conversations Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Meta Tags
Dashboards and Widgets
Conversation Flows
NLP Metrics
Containment Metrics
Usage 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
Masking PII Details
Variables
IVR Settings
General Settings
Assistant Management
Data Table
Table Views
App Definitions
Sharing Data Tables or Views

HOW TOs
Build a Flight Status 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
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
Web SDK Tutorial
Widget SDK Tutorial
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

ADMINISTRATION
Introduction
Assistant 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 & Compliance
Using Single-Sign On
Security Settings
Cloud Connector
Analytics
Billing
  1. Home
  2. Docs
  3. Virtual Assistants
  4. How Tos
  5. Configuring Digital Views

Configuring Digital Views

In this How-To, we will explore a scenario in a Banking Bot, where with just one click user can view his/her account details. 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 and Panel can be used to hold these Widgets.
We will also see how the Panel can be hosted on Web/Mobile Client using the Widget SDK.

For details on what Digital Views are and how it is implemented in the Kore.ai Bots platform, refer here.

Problem Statement

Consider a Banking Bot trying to address the following scenarios:

This document gives a detailed step-by-step approach to achieving all the above-mentioned scenarios using – Digital Views (Panels, Widgets), Widget SDK and Web/Mobile Client.

Pre-requisites

  • Bot building knowledge
  • A Banking Bot with a dialog as mentioned below:
    • Get Balance – Dialog task prompting the user for their Account Number and Account Type and displaying the available balance in the account.

Configurations

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

  1. Dialog Task to display balance in a given account using Widget SDK channel.
  2. Widgets to trigger the above dialog task and a Panel set with the widgets.
  3. Panel to hold a widget displaying static JSON templace 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 account details:

var output = 'The Balance in your' + context.entities.AccountType + ' account is ' + context.GetAccountBalance.response.body.Balance;
var message = {
    "elements": [
        {
            "title": "Account View",
            "sub_title": output,
            "icon": "https://kore.ai/wp-content/uploads/banking-home.png",
        }
    ]
};
print(JSON.stringify(message));

Widgets Configuration

Dialog Task Widgets

We will be creating two Widgets to trigger a Dialog Task.

Current Account:

First, let us see how to configure a Widget to display balance from the current account of the user.

  • Ensure that Build is selected from the top menu.
  • From under Digital Skills open Digital Views.
  • Click the Create Widget button.
  • Give a Widget Name and a Display Name.
  • Set the Source, we are triggering Dialog Task, hence select Dialog Task.
  • Select Dialog Task as Get Balance, as per our use case
  • In the Entity Assignment, set the following entities (you can select from the drop box that appears as you type) as per the Dialog Task requirement:
    • AccountType to current;
    • AccountNumber to 1.
      You can use the Open Dialog Task icon, next to the select Dialog Task drop down, to open the dialog and check the entities needed.

  • 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.

Savings Account
Repeat the above steps for Account View from savings account of the same account number.

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.
  2. In the New Panel widnow, enter Panel Name, Display Name and a URL for Icon.
  3. Click the Add Widget button to open the Panel Management window.
  4. Use the Add Widget to select and add the Widgets that we want to display, in this case Account Balance and Current Account widgets.
  5. Use the Test button to see the widgets in action.

Panel with JSON Widgets

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

  1. Click on Create Panel to create a new panel and name it JSON Example.
  2. Use the more icon and select Panel Management, there you will find the option to Create Widget. Click on that.
  3. In the New Widget dialog, enter the Name, and set the source to JSON.
  4. 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));
  5. Test the panel and you will see both the panel icons, click on each to see them in action.

Publish

To publish the Bot first enable channels:

  1. From 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 Configurations tab, make a note of the Bot Name, Bot Id, Client Id and Client Secret.
  3. From left navigation menu, select Publish option. Under Tasks & languages section, ensure that the Widget and Panels we developed are selected for publication.
  4. Proceed with the Publish.

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 UI folder.
  4. Open the kore-config.js
  5. Configure your botOptions with the ‘web/mobile client’ channel configurations copied  in  above  section.
    • botOptions.botInfo
    • botOptions.clientId
    • botOptions.clientSecret

    Make other changes as per your requirements.

  6. Open the kore-widgets-config.js
  7. Configure your botOptionsWiz with the ‘Widget SDK’ channel configurations copied  in  above  section.
    • botOptionsWiz.botInfo
    • botOptionsWiz.clientId
    • botOptionsWiz.clientSecret

    Make other changes as per your requirements.

  8. Open the index_widgets_chat.html file in the browser and see the chat window along with the widgets.
  9. If you want to host the Panels individually use the index_widgets.html file. See the GitHub for hosting the same in your web site.
Menu